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>
This commit is contained in:
parent
85f9654910
commit
bc7e260271
|
@ -2153,73 +2153,6 @@ Example:
|
||||||
|
|
||||||
Note: This example has been shortened as the real response is too long.
|
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
|
query-command-line-options
|
||||||
--------------------------
|
--------------------------
|
||||||
|
|
||||||
|
|
|
@ -1701,7 +1701,7 @@
|
||||||
# @enabled: true if the SPICE server is enabled, false otherwise
|
# @enabled: true if the SPICE server is enabled, false otherwise
|
||||||
#
|
#
|
||||||
# @migrated: true if the last guest migration completed and spice
|
# @migrated: true if the last guest migration completed and spice
|
||||||
# migration had completed as well. false otherwise.
|
# migration had completed as well. false otherwise. (since 1.4)
|
||||||
#
|
#
|
||||||
# @host: #optional The hostname the SPICE server is bound to. This depends on
|
# @host: #optional The hostname the SPICE server is bound to. This depends on
|
||||||
# the name resolution on the host and may be an IP address.
|
# the name resolution on the host and may be an IP address.
|
||||||
|
@ -1719,9 +1719,7 @@
|
||||||
#
|
#
|
||||||
# @mouse-mode: The mode in which the mouse cursor is displayed currently. Can
|
# @mouse-mode: The mode in which the mouse cursor is displayed currently. Can
|
||||||
# be determined by the client or the server, or unknown if spice
|
# be determined by the client or the server, or unknown if spice
|
||||||
# server doesn't provide this information.
|
# server doesn't provide this information. (since: 1.1)
|
||||||
#
|
|
||||||
# Since: 1.1
|
|
||||||
#
|
#
|
||||||
# @channels: a list of @SpiceChannel for each active spice channel
|
# @channels: a list of @SpiceChannel for each active spice channel
|
||||||
#
|
#
|
||||||
|
@ -1740,6 +1738,40 @@
|
||||||
# Returns: @SpiceInfo
|
# Returns: @SpiceInfo
|
||||||
#
|
#
|
||||||
# Since: 0.14.0
|
# Since: 0.14.0
|
||||||
|
#
|
||||||
|
# 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 ... ]
|
||||||
|
# ]
|
||||||
|
# }
|
||||||
|
# }
|
||||||
|
#
|
||||||
##
|
##
|
||||||
{ 'command': 'query-spice', 'returns': 'SpiceInfo' }
|
{ 'command': 'query-spice', 'returns': 'SpiceInfo' }
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue