diff options
author | Marc-André Lureau <marcandre.lureau@redhat.com> | 2016-06-23 11:37:09 +0200 |
---|---|---|
committer | Markus Armbruster <armbru@redhat.com> | 2017-01-16 09:15:26 +0100 |
commit | bc7e260271f98d44006d4e14bcb05647b8f2606e (patch) | |
tree | 8cb1f394255d1acbd9daecd19285f5a7b8ce3a0b /docs/qmp-commands.txt | |
parent | 85f96549100a7239ceae15c9a5b0ba8cdd95bdaa (diff) |
qmp-commands: move 'query-spice' doc to schema
Signed-off-by: Marc-André Lureau <marcandre.lureau@redhat.com>
Signed-off-by: Markus Armbruster <armbru@redhat.com>
Diffstat (limited to 'docs/qmp-commands.txt')
-rw-r--r-- | docs/qmp-commands.txt | 67 |
1 files changed, 0 insertions, 67 deletions
diff --git a/docs/qmp-commands.txt b/docs/qmp-commands.txt index c56d0eff8b..d018480a28 100644 --- a/docs/qmp-commands.txt +++ b/docs/qmp-commands.txt @@ -2153,73 +2153,6 @@ Example: Note: This example has been shortened as the real response is too long. -query-spice ------------ - -Show SPICE 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) -- "port": server's port number (json-int, optional) -- "tls-port": server's port number (json-int, optional) -- "auth": authentication method (json-string) - - Possible values: "none", "spice" -- "channels": a json-array of all active channels clients - -Channels 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" -- "port": client's port number (json-string) -- "connection-id": spice connection id. All channels with the same id - belong to the same spice session (json-int) -- "channel-type": channel type. "1" is the main control channel, filter for - this one if you want track spice sessions only (json-int) -- "channel-id": channel id. Usually "0", might be different needed when - multiple channels of the same type exist, such as multiple - display channels in a multihead setup (json-int) -- "tls": whether the channel is encrypted (json-bool) - -Example: - --> { "execute": "query-spice" } -<- { - "return": { - "enabled": true, - "auth": "spice", - "port": 5920, - "tls-port": 5921, - "host": "0.0.0.0", - "channels": [ - { - "port": "54924", - "family": "ipv4", - "channel-type": 1, - "connection-id": 1804289383, - "host": "127.0.0.1", - "channel-id": 0, - "tls": true - }, - { - "port": "36710", - "family": "ipv4", - "channel-type": 4, - "connection-id": 1804289383, - "host": "127.0.0.1", - "channel-id": 0, - "tls": false - }, - [ ... more channels follow ... ] - ] - } - } - query-command-line-options -------------------------- |