mirror of
https://github.com/qemu/qemu.git
synced 2025-08-09 01:50:43 +00:00
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>
This commit is contained in:
parent
fdf4d34f83
commit
85f9654910
@ -2153,60 +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-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
|
query-spice
|
||||||
-----------
|
-----------
|
||||||
|
|
||||||
|
@ -1584,6 +1584,26 @@
|
|||||||
# Returns: @VncInfo
|
# Returns: @VncInfo
|
||||||
#
|
#
|
||||||
# Since: 0.14.0
|
# 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' }
|
{ 'command': 'query-vnc', 'returns': 'VncInfo' }
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user