[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Qemu-devel] [PATCH 21/30] qmp-commands: move 'query-vnc' doc to schema
From: |
Marc-André Lureau |
Subject: |
[Qemu-devel] [PATCH 21/30] qmp-commands: move 'query-vnc' doc to schema |
Date: |
Tue, 13 Sep 2016 17:02:00 +0400 |
Signed-off-by: Marc-André Lureau <address@hidden>
---
docs/qmp-commands.txt | 54 ---------------------------------------------------
qapi-schema.json | 22 ++++++++++++++++++++-
2 files changed, 21 insertions(+), 55 deletions(-)
diff --git a/docs/qmp-commands.txt b/docs/qmp-commands.txt
index bd0d6c1..ca75716 100644
--- a/docs/qmp-commands.txt
+++ b/docs/qmp-commands.txt
@@ -2137,60 +2137,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 a7872c4..f169b08 100644
--- a/qapi-schema.json
+++ b/qapi-schema.json
@@ -1494,11 +1494,31 @@
##
# @query-vnc:
#
-# Returns information about the current VNC server
+# Returns information about the current VNC server.
#
# 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' }
--
2.10.0
- [Qemu-devel] [PATCH 13/30] qmp-commands: move 'query-migrate-capabilities' doc to schema, (continued)
- [Qemu-devel] [PATCH 13/30] qmp-commands: move 'query-migrate-capabilities' doc to schema, Marc-André Lureau, 2016/09/13
- [Qemu-devel] [PATCH 14/30] qmp-commands: move 'migrate-set-parameters' doc to schema, Marc-André Lureau, 2016/09/13
- [Qemu-devel] [PATCH 15/30] qmp-commands: move 'query-migrate-parameters' doc to schema, Marc-André Lureau, 2016/09/13
- [Qemu-devel] [PATCH 16/30] qmp-commands: move 'client_migrate_info' doc to schema, Marc-André Lureau, 2016/09/13
- [Qemu-devel] [PATCH 17/30] qmp-commands: move 'migrate-start-postcopy' doc to schema, Marc-André Lureau, 2016/09/13
- [Qemu-devel] [PATCH 18/30] qmp-commands: move 'query-mice' doc to schema, Marc-André Lureau, 2016/09/13
- [Qemu-devel] [PATCH 19/30] qmp-commands: move 'query-cpus' doc to schema, Marc-André Lureau, 2016/09/13
- [Qemu-devel] [PATCH 20/30] qmp-commands: move 'query-iothreads' doc to schema, Marc-André Lureau, 2016/09/13
- [Qemu-devel] [PATCH 23/30] qmp-commands: move 'query-balloon' doc to schema, Marc-André Lureau, 2016/09/13
- [Qemu-devel] [PATCH 21/30] qmp-commands: move 'query-vnc' doc to schema,
Marc-André Lureau <=
- [Qemu-devel] [PATCH 22/30] qmp-commands: move 'query-spice' doc to schema, Marc-André Lureau, 2016/09/13
- [Qemu-devel] [PATCH 25/30] qmp-commands: move 'quit' doc to schema, Marc-André Lureau, 2016/09/13
- [Qemu-devel] [PATCH 24/30] qmp-commands: move 'query-pci' doc to schema, Marc-André Lureau, 2016/09/13
- [Qemu-devel] [PATCH 27/30] qmp-commands: move 'system_reset' doc to schema, Marc-André Lureau, 2016/09/13
- [Qemu-devel] [PATCH 26/30] qmp-commands: move 'stop' doc to schema, Marc-André Lureau, 2016/09/13
- [Qemu-devel] [PATCH 28/30] qmp-commands: move 'system_powerdown' doc to schema, Marc-André Lureau, 2016/09/13
- [Qemu-devel] [PATCH 29/30] qmp-commands: move 'cpu-add' doc to schema, Marc-André Lureau, 2016/09/13
- [Qemu-devel] [PATCH 30/30] qmp-commands: move 'memsave' doc to schema, Marc-André Lureau, 2016/09/13
- Re: [Qemu-devel] [PATCH 00/30] Move qapi documentation to schema (part 1/5), Markus Armbruster, 2016/09/13