From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from eggs.gnu.org ([2001:4830:134:3::10]:48333) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1bjnNF-0005Ck-0K for qemu-devel@nongnu.org; Tue, 13 Sep 2016 09:03:47 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1bjnN9-0004fp-OI for qemu-devel@nongnu.org; Tue, 13 Sep 2016 09:03:40 -0400 Received: from mx1.redhat.com ([209.132.183.28]:44788) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1bjnN9-0004fi-HJ for qemu-devel@nongnu.org; Tue, 13 Sep 2016 09:03:35 -0400 Received: from int-mx09.intmail.prod.int.phx2.redhat.com (int-mx09.intmail.prod.int.phx2.redhat.com [10.5.11.22]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mx1.redhat.com (Postfix) with ESMTPS id F10698553C for ; Tue, 13 Sep 2016 13:03:33 +0000 (UTC) From: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Date: Tue, 13 Sep 2016 17:02:00 +0400 Message-Id: <20160913130209.695-22-marcandre.lureau@redhat.com> In-Reply-To: <20160913130209.695-1-marcandre.lureau@redhat.com> References: <20160913130209.695-1-marcandre.lureau@redhat.com> MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: quoted-printable Subject: [Qemu-devel] [PATCH 21/30] qmp-commands: move 'query-vnc' doc to schema List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , To: qemu-devel@nongnu.org Cc: eblake@redhat.com, armbru@redhat.com, =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= Signed-off-by: Marc-Andr=C3=A9 Lureau --- 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: =20 Note: This example has been shortened as the real response is too long. =20 -query-vnc ---------- - -Show VNC server information. - -Return a json-object with server information. Connected clients are retu= rned -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", "venc= rypt", - "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 ----------- =20 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' } =20 --=20 2.10.0