diff options
author | Marc-André Lureau <marcandre.lureau@redhat.com> | 2016-06-23 11:36:11 +0200 |
---|---|---|
committer | Markus Armbruster <armbru@redhat.com> | 2017-01-16 09:15:26 +0100 |
commit | 85f96549100a7239ceae15c9a5b0ba8cdd95bdaa (patch) | |
tree | d6356c0524f749548aa8db13ee8b48d38a2ac729 | |
parent | fdf4d34f8398099431888d3f7522a7b71df0ba58 (diff) |
qmp-commands: move 'query-vnc' doc to schema
Signed-off-by: Marc-André Lureau <marcandre.lureau@redhat.com>
Signed-off-by: Markus Armbruster <armbru@redhat.com>
-rw-r--r-- | docs/qmp-commands.txt | 54 | ||||
-rw-r--r-- | qapi-schema.json | 20 |
2 files changed, 20 insertions, 54 deletions
diff --git a/docs/qmp-commands.txt b/docs/qmp-commands.txt index e7d47d3be0..c56d0eff8b 100644 --- a/docs/qmp-commands.txt +++ b/docs/qmp-commands.txt @@ -2153,60 +2153,6 @@ Example: Note: This example has been shortened as the real response is too long. -query-vnc ---------- - -Show VNC server information. - -Return a json-object with server information. Connected clients are returned -as a json-array of json-objects. - -The main json-object contains the following: - -- "enabled": true or false (json-bool) -- "host": server's IP address (json-string) -- "family": address family (json-string) - - Possible values: "ipv4", "ipv6", "unix", "unknown" -- "service": server's port number (json-string) -- "auth": authentication method (json-string) - - Possible values: "invalid", "none", "ra2", "ra2ne", "sasl", "tight", - "tls", "ultra", "unknown", "vencrypt", "vencrypt", - "vencrypt+plain", "vencrypt+tls+none", - "vencrypt+tls+plain", "vencrypt+tls+sasl", - "vencrypt+tls+vnc", "vencrypt+x509+none", - "vencrypt+x509+plain", "vencrypt+x509+sasl", - "vencrypt+x509+vnc", "vnc" -- "clients": a json-array of all connected clients - -Clients are described by a json-object, each one contain the following: - -- "host": client's IP address (json-string) -- "family": address family (json-string) - - Possible values: "ipv4", "ipv6", "unix", "unknown" -- "service": client's port number (json-string) -- "x509_dname": TLS dname (json-string, optional) -- "sasl_username": SASL username (json-string, optional) - -Example: - --> { "execute": "query-vnc" } -<- { - "return":{ - "enabled":true, - "host":"0.0.0.0", - "service":"50402", - "auth":"vnc", - "family":"ipv4", - "clients":[ - { - "host":"127.0.0.1", - "service":"50401", - "family":"ipv4" - } - ] - } - } - query-spice ----------- diff --git a/qapi-schema.json b/qapi-schema.json index 2e5375da1b..5d51cf0834 100644 --- a/qapi-schema.json +++ b/qapi-schema.json @@ -1584,6 +1584,26 @@ # Returns: @VncInfo # # Since: 0.14.0 +# +# Example: +# +# -> { "execute": "query-vnc" } +# <- { "return": { +# "enabled":true, +# "host":"0.0.0.0", +# "service":"50402", +# "auth":"vnc", +# "family":"ipv4", +# "clients":[ +# { +# "host":"127.0.0.1", +# "service":"50401", +# "family":"ipv4" +# } +# ] +# } +# } +# ## { 'command': 'query-vnc', 'returns': 'VncInfo' } |