1# -*- Mode: Python -*- 2# vim: filetype=python 3# 4 5## 6# ************** 7# Remote desktop 8# ************** 9## 10 11{ 'include': 'common.json' } 12{ 'include': 'sockets.json' } 13 14## 15# @DisplayProtocol: 16# 17# Display protocols which support changing password options. 18# 19# Since: 7.0 20## 21{ 'enum': 'DisplayProtocol', 22 'data': [ 'vnc', 'spice' ] } 23 24## 25# @SetPasswordAction: 26# 27# An action to take on changing a password on a connection with active 28# clients. 29# 30# @keep: maintain existing clients 31# 32# @fail: fail the command if clients are connected 33# 34# @disconnect: disconnect existing clients 35# 36# Since: 7.0 37## 38{ 'enum': 'SetPasswordAction', 39 'data': [ 'keep', 'fail', 'disconnect' ] } 40 41## 42# @SetPasswordOptions: 43# 44# Options for `set_password`. 45# 46# @protocol: 47# - 'vnc' to modify the VNC server password 48# - 'spice' to modify the Spice server password 49# 50# @password: the new password 51# 52# @connected: How to handle existing clients when changing the 53# password. If nothing is specified, defaults to 'keep'. For 54# VNC, only 'keep' is currently implemented. 55# 56# Since: 7.0 57## 58{ 'union': 'SetPasswordOptions', 59 'base': { 'protocol': 'DisplayProtocol', 60 'password': 'str', 61 '*connected': 'SetPasswordAction' }, 62 'discriminator': 'protocol', 63 'data': { 'vnc': 'SetPasswordOptionsVnc' } } 64 65## 66# @SetPasswordOptionsVnc: 67# 68# Options for `set_password` specific to the VNC protocol. 69# 70# @display: The id of the display where the password should be 71# changed. Defaults to the first. 72# 73# Since: 7.0 74## 75{ 'struct': 'SetPasswordOptionsVnc', 76 'data': { '*display': 'str' } } 77 78## 79# @set_password: 80# 81# Set the password of a remote display server. 82# 83# Errors: 84# - If Spice is not enabled, DeviceNotFound 85# 86# Since: 0.14 87# 88# .. qmp-example:: 89# 90# -> { "execute": "set_password", "arguments": { "protocol": "vnc", 91# "password": "secret" } } 92# <- { "return": {} } 93## 94{ 'command': 'set_password', 'boxed': true, 'data': 'SetPasswordOptions' } 95 96## 97# @ExpirePasswordOptions: 98# 99# General options for `expire_password`. 100# 101# @protocol: 102# - 'vnc' to modify the VNC server expiration 103# - 'spice' to modify the Spice server expiration 104# 105# @time: when to expire the password. 106# 107# - 'now' to expire the password immediately 108# - 'never' to cancel password expiration 109# - '+INT' where INT is the number of seconds from now (integer) 110# - 'INT' where INT is the absolute time in seconds 111# 112# .. note:: Time is relative to the server and currently there is no 113# way to coordinate server time with client time. It is not 114# recommended to use the absolute time version of the @time 115# parameter unless you're sure you are on the same machine as the 116# QEMU instance. 117# 118# Since: 7.0 119## 120{ 'union': 'ExpirePasswordOptions', 121 'base': { 'protocol': 'DisplayProtocol', 122 'time': 'str' }, 123 'discriminator': 'protocol', 124 'data': { 'vnc': 'ExpirePasswordOptionsVnc' } } 125 126## 127# @ExpirePasswordOptionsVnc: 128# 129# Options for `expire_password` specific to the VNC protocol. 130# 131# @display: The id of the display where the expiration should be 132# changed. Defaults to the first. 133# 134# Since: 7.0 135## 136{ 'struct': 'ExpirePasswordOptionsVnc', 137 'data': { '*display': 'str' } } 138 139## 140# @expire_password: 141# 142# Expire the password of a remote display server. 143# 144# Errors: 145# - If @protocol is 'spice' and Spice is not active, 146# DeviceNotFound 147# 148# Since: 0.14 149# 150# .. qmp-example:: 151# 152# -> { "execute": "expire_password", "arguments": { "protocol": "vnc", 153# "time": "+60" } } 154# <- { "return": {} } 155## 156{ 'command': 'expire_password', 'boxed': true, 'data': 'ExpirePasswordOptions' } 157 158## 159# @ImageFormat: 160# 161# Supported image format types. 162# 163# @png: PNG format 164# 165# @ppm: PPM format 166# 167# Since: 7.1 168## 169{ 'enum': 'ImageFormat', 170 'data': ['ppm', 'png'] } 171 172## 173# @screendump: 174# 175# Capture the contents of a screen and write it to a file. 176# 177# @filename: the path of a new file to store the image 178# 179# @device: ID of the display device that should be dumped. If this 180# parameter is missing, the primary display will be used. 181# (Since 2.12) 182# 183# @head: head to use in case the device supports multiple heads. If 184# this parameter is missing, head #0 will be used. Also note that 185# the head can only be specified in conjunction with the device 186# ID. (Since 2.12) 187# 188# @format: image format for `screendump`. (default: ppm) (Since 7.1) 189# 190# Since: 0.14 191# 192# .. qmp-example:: 193# 194# -> { "execute": "screendump", 195# "arguments": { "filename": "/tmp/image" } } 196# <- { "return": {} } 197## 198{ 'command': 'screendump', 199 'data': {'filename': 'str', '*device': 'str', '*head': 'int', 200 '*format': 'ImageFormat'}, 201 'coroutine': true, 202 'if': 'CONFIG_PIXMAN' } 203 204## 205# Spice 206# ===== 207## 208 209## 210# @SpiceBasicInfo: 211# 212# The basic information for SPICE network connection 213# 214# @host: IP address 215# 216# @port: port number 217# 218# @family: address family 219# 220# Since: 2.1 221## 222{ 'struct': 'SpiceBasicInfo', 223 'data': { 'host': 'str', 224 'port': 'str', 225 'family': 'NetworkAddressFamily' }, 226 'if': 'CONFIG_SPICE' } 227 228## 229# @SpiceServerInfo: 230# 231# Information about a SPICE server 232# 233# @auth: authentication method 234# 235# Since: 2.1 236## 237{ 'struct': 'SpiceServerInfo', 238 'base': 'SpiceBasicInfo', 239 'data': { '*auth': 'str' }, 240 'if': 'CONFIG_SPICE' } 241 242## 243# @SpiceChannel: 244# 245# Information about a SPICE client channel. 246# 247# @connection-id: SPICE connection id number. All channels with the 248# same id belong to the same SPICE session. 249# 250# @channel-type: SPICE channel type number. "1" is the main control 251# channel, filter for this one if you want to track spice sessions 252# only 253# 254# @channel-id: SPICE channel ID number. Usually "0", might be 255# different when multiple channels of the same type exist, such as 256# multiple display channels in a multihead setup 257# 258# @tls: true if the channel is encrypted, false otherwise. 259# 260# Since: 0.14 261## 262{ 'struct': 'SpiceChannel', 263 'base': 'SpiceBasicInfo', 264 'data': {'connection-id': 'int', 'channel-type': 'int', 'channel-id': 'int', 265 'tls': 'bool'}, 266 'if': 'CONFIG_SPICE' } 267 268## 269# @SpiceQueryMouseMode: 270# 271# An enumeration of Spice mouse states. 272# 273# @client: Mouse cursor position is determined by the client. 274# 275# @server: Mouse cursor position is determined by the server. 276# 277# @unknown: No information is available about mouse mode used by the 278# spice server. 279# 280# Since: 1.1 281## 282{ 'enum': 'SpiceQueryMouseMode', 283 'data': [ 'client', 'server', 'unknown' ], 284 'if': 'CONFIG_SPICE' } 285 286## 287# @SpiceInfo: 288# 289# Information about the SPICE session. 290# 291# @enabled: true if the SPICE server is enabled, false otherwise 292# 293# @migrated: true if the last guest migration completed and spice 294# migration had completed as well, false otherwise (since 1.4) 295# 296# @host: The hostname the SPICE server is bound to. This depends on 297# the name resolution on the host and may be an IP address. 298# 299# @port: The SPICE server's port number. 300# 301# @compiled-version: SPICE server version. 302# 303# @tls-port: The SPICE server's TLS port number. 304# 305# @auth: the current authentication type used by the server 306# 307# - 'none' if no authentication is being used 308# - 'spice' uses SASL or direct TLS authentication, depending on 309# command line options 310# 311# @mouse-mode: The mode in which the mouse cursor is displayed 312# currently. Can be determined by the client or the server, or 313# unknown if spice server doesn't provide this information. 314# (since: 1.1) 315# 316# @channels: a list of `SpiceChannel` for each active spice channel 317# 318# Since: 0.14 319## 320{ 'struct': 'SpiceInfo', 321 'data': {'enabled': 'bool', 'migrated': 'bool', '*host': 'str', '*port': 'int', 322 '*tls-port': 'int', '*auth': 'str', '*compiled-version': 'str', 323 'mouse-mode': 'SpiceQueryMouseMode', '*channels': ['SpiceChannel']}, 324 'if': 'CONFIG_SPICE' } 325 326## 327# @query-spice: 328# 329# Return information about the current SPICE server 330# 331# Since: 0.14 332# 333# .. qmp-example:: 334# 335# -> { "execute": "query-spice" } 336# <- { "return": { 337# "enabled": true, 338# "auth": "spice", 339# "port": 5920, 340# "migrated":false, 341# "tls-port": 5921, 342# "host": "0.0.0.0", 343# "mouse-mode":"client", 344# "channels": [ 345# { 346# "port": "54924", 347# "family": "ipv4", 348# "channel-type": 1, 349# "connection-id": 1804289383, 350# "host": "127.0.0.1", 351# "channel-id": 0, 352# "tls": true 353# }, 354# { 355# "port": "36710", 356# "family": "ipv4", 357# "channel-type": 4, 358# "connection-id": 1804289383, 359# "host": "127.0.0.1", 360# "channel-id": 0, 361# "tls": false 362# }, 363# ... 364# ] 365# } 366# } 367## 368{ 'command': 'query-spice', 'returns': 'SpiceInfo', 369 'if': 'CONFIG_SPICE' } 370 371## 372# @SPICE_CONNECTED: 373# 374# Emitted when a SPICE client establishes a connection 375# 376# @server: server information 377# 378# @client: client information 379# 380# Since: 0.14 381# 382# .. qmp-example:: 383# 384# <- { "timestamp": {"seconds": 1290688046, "microseconds": 388707}, 385# "event": "SPICE_CONNECTED", 386# "data": { 387# "server": { "port": "5920", "family": "ipv4", "host": "127.0.0.1"}, 388# "client": {"port": "52873", "family": "ipv4", "host": "127.0.0.1"} 389# }} 390## 391{ 'event': 'SPICE_CONNECTED', 392 'data': { 'server': 'SpiceBasicInfo', 393 'client': 'SpiceBasicInfo' }, 394 'if': 'CONFIG_SPICE' } 395 396## 397# @SPICE_INITIALIZED: 398# 399# Emitted after initial handshake and authentication takes place (if 400# any) and the SPICE channel is up and running 401# 402# @server: server information 403# 404# @client: client information 405# 406# Since: 0.14 407# 408# .. qmp-example:: 409# 410# <- { "timestamp": {"seconds": 1290688046, "microseconds": 417172}, 411# "event": "SPICE_INITIALIZED", 412# "data": {"server": {"auth": "spice", "port": "5921", 413# "family": "ipv4", "host": "127.0.0.1"}, 414# "client": {"port": "49004", "family": "ipv4", "channel-type": 3, 415# "connection-id": 1804289383, "host": "127.0.0.1", 416# "channel-id": 0, "tls": true} 417# }} 418## 419{ 'event': 'SPICE_INITIALIZED', 420 'data': { 'server': 'SpiceServerInfo', 421 'client': 'SpiceChannel' }, 422 'if': 'CONFIG_SPICE' } 423 424## 425# @SPICE_DISCONNECTED: 426# 427# Emitted when the SPICE connection is closed 428# 429# @server: server information 430# 431# @client: client information 432# 433# Since: 0.14 434# 435# .. qmp-example:: 436# 437# <- { "timestamp": {"seconds": 1290688046, "microseconds": 388707}, 438# "event": "SPICE_DISCONNECTED", 439# "data": { 440# "server": { "port": "5920", "family": "ipv4", "host": "127.0.0.1"}, 441# "client": {"port": "52873", "family": "ipv4", "host": "127.0.0.1"} 442# }} 443## 444{ 'event': 'SPICE_DISCONNECTED', 445 'data': { 'server': 'SpiceBasicInfo', 446 'client': 'SpiceBasicInfo' }, 447 'if': 'CONFIG_SPICE' } 448 449## 450# @SPICE_MIGRATE_COMPLETED: 451# 452# Emitted when SPICE migration has completed 453# 454# Since: 1.3 455# 456# .. qmp-example:: 457# 458# <- { "timestamp": {"seconds": 1290688046, "microseconds": 417172}, 459# "event": "SPICE_MIGRATE_COMPLETED" } 460## 461{ 'event': 'SPICE_MIGRATE_COMPLETED', 462 'if': 'CONFIG_SPICE' } 463 464## 465# VNC 466# === 467## 468 469## 470# @VncBasicInfo: 471# 472# The basic information for vnc network connection 473# 474# @host: IP address 475# 476# @service: The service name of the vnc port. This may depend on the 477# host system's service database so symbolic names should not be 478# relied on. 479# 480# @family: address family 481# 482# @websocket: true in case the socket is a websocket (since 2.3). 483# 484# Since: 2.1 485## 486{ 'struct': 'VncBasicInfo', 487 'data': { 'host': 'str', 488 'service': 'str', 489 'family': 'NetworkAddressFamily', 490 'websocket': 'bool' }, 491 'if': 'CONFIG_VNC' } 492 493## 494# @VncServerInfo: 495# 496# The network connection information for server 497# 498# @auth: authentication method used for the plain (non-websocket) VNC 499# server 500# 501# Since: 2.1 502## 503{ 'struct': 'VncServerInfo', 504 'base': 'VncBasicInfo', 505 'data': { '*auth': 'str' }, 506 'if': 'CONFIG_VNC' } 507 508## 509# @VncClientInfo: 510# 511# Information about a connected VNC client. 512# 513# @x509_dname: If x509 authentication is in use, the Distinguished 514# Name of the client. 515# 516# @sasl_username: If SASL authentication is in use, the SASL username 517# used for authentication. 518# 519# Since: 0.14 520## 521{ 'struct': 'VncClientInfo', 522 'base': 'VncBasicInfo', 523 'data': { '*x509_dname': 'str', '*sasl_username': 'str' }, 524 'if': 'CONFIG_VNC' } 525 526## 527# @VncInfo: 528# 529# Information about the VNC session. 530# 531# @enabled: true if the VNC server is enabled, false otherwise 532# 533# @host: The hostname the VNC server is bound to. This depends on the 534# name resolution on the host and may be an IP address. 535# 536# @family: 537# - 'ipv6' if the host is listening for IPv6 connections 538# - 'ipv4' if the host is listening for IPv4 connections 539# - 'unix' if the host is listening on a unix domain socket 540# - 'unknown' otherwise 541# 542# @service: The service name of the server's port. This may depends 543# on the host system's service database so symbolic names should 544# not be relied on. 545# 546# @auth: the current authentication type used by the server 547# 548# - 'none' if no authentication is being used 549# - 'vnc' if VNC authentication is being used 550# - 'vencrypt+plain' if VEncrypt is used with plain text 551# authentication 552# - 'vencrypt+tls+none' if VEncrypt is used with TLS and no 553# authentication 554# - 'vencrypt+tls+vnc' if VEncrypt is used with TLS and VNC 555# authentication 556# - 'vencrypt+tls+plain' if VEncrypt is used with TLS and plain 557# text auth 558# - 'vencrypt+x509+none' if VEncrypt is used with x509 and no auth 559# - 'vencrypt+x509+vnc' if VEncrypt is used with x509 and VNC auth 560# - 'vencrypt+x509+plain' if VEncrypt is used with x509 and plain 561# text auth 562# - 'vencrypt+tls+sasl' if VEncrypt is used with TLS and SASL auth 563# - 'vencrypt+x509+sasl' if VEncrypt is used with x509 and SASL 564# auth 565# 566# @clients: a list of `VncClientInfo` of all currently connected 567# clients 568# 569# Since: 0.14 570## 571{ 'struct': 'VncInfo', 572 'data': {'enabled': 'bool', '*host': 'str', 573 '*family': 'NetworkAddressFamily', 574 '*service': 'str', '*auth': 'str', '*clients': ['VncClientInfo']}, 575 'if': 'CONFIG_VNC' } 576 577## 578# @VncPrimaryAuth: 579# 580# vnc primary authentication method. 581# 582# Since: 2.3 583## 584{ 'enum': 'VncPrimaryAuth', 585 'data': [ 'none', 'vnc', 'ra2', 'ra2ne', 'tight', 'ultra', 586 'tls', 'vencrypt', 'sasl' ], 587 'if': 'CONFIG_VNC' } 588 589## 590# @VncVencryptSubAuth: 591# 592# vnc sub authentication method with vencrypt. 593# 594# Since: 2.3 595## 596{ 'enum': 'VncVencryptSubAuth', 597 'data': [ 'plain', 598 'tls-none', 'x509-none', 599 'tls-vnc', 'x509-vnc', 600 'tls-plain', 'x509-plain', 601 'tls-sasl', 'x509-sasl' ], 602 'if': 'CONFIG_VNC' } 603 604## 605# @VncServerInfo2: 606# 607# The network connection information for server 608# 609# @auth: The current authentication type used by the servers 610# 611# @vencrypt: The vencrypt sub authentication type used by the servers, 612# only specified in case auth == vencrypt. 613# 614# Since: 2.9 615## 616{ 'struct': 'VncServerInfo2', 617 'base': 'VncBasicInfo', 618 'data': { 'auth' : 'VncPrimaryAuth', 619 '*vencrypt' : 'VncVencryptSubAuth' }, 620 'if': 'CONFIG_VNC' } 621 622## 623# @VncInfo2: 624# 625# Information about a vnc server 626# 627# @id: vnc server name. 628# 629# @server: A list of `VncBasicInfo` describing all listening sockets. 630# The list can be empty (in case the vnc server is disabled). It 631# also may have multiple entries: normal + websocket, possibly 632# also ipv4 + ipv6 in the future. 633# 634# @clients: A list of `VncClientInfo` of all currently connected 635# clients. The list can be empty, for obvious reasons. 636# 637# @auth: The current authentication type used by the non-websockets 638# servers 639# 640# @vencrypt: The vencrypt authentication type used by the servers, 641# only specified in case auth == vencrypt. 642# 643# @display: The display device the vnc server is linked to. 644# 645# Since: 2.3 646## 647{ 'struct': 'VncInfo2', 648 'data': { 'id' : 'str', 649 'server' : ['VncServerInfo2'], 650 'clients' : ['VncClientInfo'], 651 'auth' : 'VncPrimaryAuth', 652 '*vencrypt' : 'VncVencryptSubAuth', 653 '*display' : 'str' }, 654 'if': 'CONFIG_VNC' } 655 656## 657# @query-vnc: 658# 659# Return information about the current VNC server 660# 661# Since: 0.14 662# 663# .. qmp-example:: 664# 665# -> { "execute": "query-vnc" } 666# <- { "return": { 667# "enabled":true, 668# "host":"0.0.0.0", 669# "service":"50402", 670# "auth":"vnc", 671# "family":"ipv4", 672# "clients":[ 673# { 674# "host":"127.0.0.1", 675# "service":"50401", 676# "family":"ipv4", 677# "websocket":false 678# } 679# ] 680# } 681# } 682## 683{ 'command': 'query-vnc', 'returns': 'VncInfo', 684 'if': 'CONFIG_VNC' } 685## 686# @query-vnc-servers: 687# 688# Return a list of vnc servers. The list can be empty. 689# 690# Since: 2.3 691## 692{ 'command': 'query-vnc-servers', 'returns': ['VncInfo2'], 693 'if': 'CONFIG_VNC' } 694 695## 696# @change-vnc-password: 697# 698# Change the VNC server password. 699# 700# @password: the new password to use with VNC authentication 701# 702# Since: 1.1 703# 704# .. note:: An empty password in this command will set the password to 705# the empty string. Existing clients are unaffected by executing 706# this command. 707## 708{ 'command': 'change-vnc-password', 709 'data': { 'password': 'str' }, 710 'if': 'CONFIG_VNC' } 711 712## 713# @VNC_CONNECTED: 714# 715# Emitted when a VNC client establishes a connection 716# 717# @server: server information 718# 719# @client: client information 720# 721# .. note:: This event is emitted before any authentication takes 722# place, thus the authentication ID is not provided. 723# 724# Since: 0.13 725# 726# .. qmp-example:: 727# 728# <- { "event": "VNC_CONNECTED", 729# "data": { 730# "server": { "auth": "sasl", "family": "ipv4", "websocket": false, 731# "service": "5901", "host": "0.0.0.0" }, 732# "client": { "family": "ipv4", "service": "58425", 733# "host": "127.0.0.1", "websocket": false } }, 734# "timestamp": { "seconds": 1262976601, "microseconds": 975795 } } 735## 736{ 'event': 'VNC_CONNECTED', 737 'data': { 'server': 'VncServerInfo', 738 'client': 'VncBasicInfo' }, 739 'if': 'CONFIG_VNC' } 740 741## 742# @VNC_INITIALIZED: 743# 744# Emitted after authentication takes place (if any) and the VNC 745# session is made active 746# 747# @server: server information 748# 749# @client: client information 750# 751# Since: 0.13 752# 753# .. qmp-example:: 754# 755# <- { "event": "VNC_INITIALIZED", 756# "data": { 757# "server": { "auth": "sasl", "family": "ipv4", "websocket": false, 758# "service": "5901", "host": "0.0.0.0"}, 759# "client": { "family": "ipv4", "service": "46089", "websocket": false, 760# "host": "127.0.0.1", "sasl_username": "luiz" } }, 761# "timestamp": { "seconds": 1263475302, "microseconds": 150772 } } 762## 763{ 'event': 'VNC_INITIALIZED', 764 'data': { 'server': 'VncServerInfo', 765 'client': 'VncClientInfo' }, 766 'if': 'CONFIG_VNC' } 767 768## 769# @VNC_DISCONNECTED: 770# 771# Emitted when the connection is closed 772# 773# @server: server information 774# 775# @client: client information 776# 777# Since: 0.13 778# 779# .. qmp-example:: 780# 781# <- { "event": "VNC_DISCONNECTED", 782# "data": { 783# "server": { "auth": "sasl", "family": "ipv4", "websocket": false, 784# "service": "5901", "host": "0.0.0.0" }, 785# "client": { "family": "ipv4", "service": "58425", "websocket": false, 786# "host": "127.0.0.1", "sasl_username": "luiz" } }, 787# "timestamp": { "seconds": 1262976601, "microseconds": 975795 } } 788## 789{ 'event': 'VNC_DISCONNECTED', 790 'data': { 'server': 'VncServerInfo', 791 'client': 'VncClientInfo' }, 792 'if': 'CONFIG_VNC' } 793 794## 795# ***** 796# Input 797# ***** 798## 799 800## 801# @MouseInfo: 802# 803# Information about a mouse device. 804# 805# @name: the name of the mouse device 806# 807# @index: the index of the mouse device 808# 809# @current: true if this device is currently receiving mouse events 810# 811# @absolute: true if this device supports absolute coordinates as 812# input 813# 814# Since: 0.14 815## 816{ 'struct': 'MouseInfo', 817 'data': {'name': 'str', 'index': 'int', 'current': 'bool', 818 'absolute': 'bool'} } 819 820## 821# @query-mice: 822# 823# Return information about each active mouse device 824# 825# Returns: a list of info for each device 826# 827# Since: 0.14 828# 829# .. qmp-example:: 830# 831# -> { "execute": "query-mice" } 832# <- { "return": [ 833# { 834# "name":"QEMU Microsoft Mouse", 835# "index":0, 836# "current":false, 837# "absolute":false 838# }, 839# { 840# "name":"QEMU PS/2 Mouse", 841# "index":1, 842# "current":true, 843# "absolute":true 844# } 845# ] 846# } 847## 848{ 'command': 'query-mice', 'returns': ['MouseInfo'] } 849 850## 851# @QKeyCode: 852# 853# An enumeration of key name. 854# 855# This is used by the `send-key` command. 856# 857# @unmapped: since 2.0 858# 859# @pause: since 2.0 860# 861# @ro: since 2.4 862# 863# @kp_comma: since 2.4 864# 865# @kp_equals: since 2.6 866# 867# @power: since 2.6 868# 869# @hiragana: since 2.9 870# 871# @henkan: since 2.9 872# 873# @yen: since 2.9 874# 875# @sleep: since 2.10 876# 877# @wake: since 2.10 878# 879# @audionext: since 2.10 880# 881# @audioprev: since 2.10 882# 883# @audiostop: since 2.10 884# 885# @audioplay: since 2.10 886# 887# @audiomute: since 2.10 888# 889# @volumeup: since 2.10 890# 891# @volumedown: since 2.10 892# 893# @mediaselect: since 2.10 894# 895# @mail: since 2.10 896# 897# @calculator: since 2.10 898# 899# @computer: since 2.10 900# 901# @ac_home: since 2.10 902# 903# @ac_back: since 2.10 904# 905# @ac_forward: since 2.10 906# 907# @ac_refresh: since 2.10 908# 909# @ac_bookmarks: since 2.10 910# 911# @muhenkan: since 2.12 912# 913# @katakanahiragana: since 2.12 914# 915# @lang1: since 6.1 916# 917# @lang2: since 6.1 918# 919# @f13: since 8.0 920# 921# @f14: since 8.0 922# 923# @f15: since 8.0 924# 925# @f16: since 8.0 926# 927# @f17: since 8.0 928# 929# @f18: since 8.0 930# 931# @f19: since 8.0 932# 933# @f20: since 8.0 934# 935# @f21: since 8.0 936# 937# @f22: since 8.0 938# 939# @f23: since 8.0 940# 941# @f24: since 8.0 942# 943# 'sysrq' was mistakenly added to hack around the fact that the ps2 944# driver was not generating correct scancodes sequences when 945# 'alt+print' was pressed. This flaw is now fixed and the 'sysrq' key 946# serves no further purpose. Any further use of 'sysrq' will be 947# transparently changed to 'print', so they are effectively synonyms. 948# 949# Since: 1.3 950## 951{ 'enum': 'QKeyCode', 952 'prefix': 'Q_KEY_CODE', 953 'data': [ 'unmapped', 954 'shift', 'shift_r', 'alt', 'alt_r', 'ctrl', 955 'ctrl_r', 'menu', 'esc', '1', '2', '3', '4', '5', '6', '7', '8', 956 '9', '0', 'minus', 'equal', 'backspace', 'tab', 'q', 'w', 'e', 957 'r', 't', 'y', 'u', 'i', 'o', 'p', 'bracket_left', 'bracket_right', 958 'ret', 'a', 's', 'd', 'f', 'g', 'h', 'j', 'k', 'l', 'semicolon', 959 'apostrophe', 'grave_accent', 'backslash', 'z', 'x', 'c', 'v', 'b', 960 'n', 'm', 'comma', 'dot', 'slash', 'asterisk', 'spc', 'caps_lock', 961 'f1', 'f2', 'f3', 'f4', 'f5', 'f6', 'f7', 'f8', 'f9', 'f10', 962 'num_lock', 'scroll_lock', 'kp_divide', 'kp_multiply', 963 'kp_subtract', 'kp_add', 'kp_enter', 'kp_decimal', 'sysrq', 'kp_0', 964 'kp_1', 'kp_2', 'kp_3', 'kp_4', 'kp_5', 'kp_6', 'kp_7', 'kp_8', 965 'kp_9', 'less', 'f11', 'f12', 'print', 'home', 'pgup', 'pgdn', 'end', 966 'left', 'up', 'down', 'right', 'insert', 'delete', 'stop', 'again', 967 'props', 'undo', 'front', 'copy', 'open', 'paste', 'find', 'cut', 968 'lf', 'help', 'meta_l', 'meta_r', 'compose', 'pause', 969 'ro', 'hiragana', 'henkan', 'yen', 'muhenkan', 'katakanahiragana', 970 'kp_comma', 'kp_equals', 'power', 'sleep', 'wake', 971 'audionext', 'audioprev', 'audiostop', 'audioplay', 'audiomute', 972 'volumeup', 'volumedown', 'mediaselect', 973 'mail', 'calculator', 'computer', 974 'ac_home', 'ac_back', 'ac_forward', 'ac_refresh', 'ac_bookmarks', 975 'lang1', 'lang2','f13','f14','f15','f16','f17','f18','f19','f20','f21','f22','f23','f24' ] } 976 977## 978# @KeyValueKind: 979# 980# Since: 1.3 981## 982{ 'enum': 'KeyValueKind', 983 'data': [ 'number', 'qcode' ] } 984 985## 986# @IntWrapper: 987# 988# @data: a numeric key code 989# 990# Since: 1.3 991## 992{ 'struct': 'IntWrapper', 993 'data': { 'data': 'int' } } 994 995## 996# @QKeyCodeWrapper: 997# 998# @data: An enumeration of key name 999# 1000# Since: 1.3 1001## 1002{ 'struct': 'QKeyCodeWrapper', 1003 'data': { 'data': 'QKeyCode' } } 1004 1005## 1006# @KeyValue: 1007# 1008# Represents a keyboard key. 1009# 1010# @type: key encoding 1011# 1012# Since: 1.3 1013## 1014{ 'union': 'KeyValue', 1015 'base': { 'type': 'KeyValueKind' }, 1016 'discriminator': 'type', 1017 'data': { 1018 'number': 'IntWrapper', 1019 'qcode': 'QKeyCodeWrapper' } } 1020 1021## 1022# @send-key: 1023# 1024# Send keys to guest. 1025# 1026# @keys: An array of `KeyValue` elements. All @KeyValues in this array 1027# are simultaneously sent to the guest. A `KeyValue`.number value 1028# is sent directly to the guest, while `KeyValue`.qcode must be a 1029# valid `QKeyCode` value 1030# 1031# @hold-time: time to delay key up events, milliseconds. Defaults to 1032# 100 1033# 1034# Errors: 1035# - If key is unknown or redundant, GenericError 1036# 1037# Since: 1.3 1038# 1039# .. qmp-example:: 1040# 1041# -> { "execute": "send-key", 1042# "arguments": { "keys": [ { "type": "qcode", "data": "ctrl" }, 1043# { "type": "qcode", "data": "alt" }, 1044# { "type": "qcode", "data": "delete" } ] } } 1045# <- { "return": {} } 1046## 1047{ 'command': 'send-key', 1048 'data': { 'keys': ['KeyValue'], '*hold-time': 'int' } } 1049 1050## 1051# @InputButton: 1052# 1053# Button of a pointer input device (mouse, tablet). 1054# 1055# @side: front side button of a 5-button mouse (since 2.9) 1056# 1057# @extra: rear side button of a 5-button mouse (since 2.9) 1058# 1059# @touch: screen contact on a multi-touch device (since 8.1) 1060# 1061# Since: 2.0 1062## 1063{ 'enum' : 'InputButton', 1064 'data' : [ 'left', 'middle', 'right', 'wheel-up', 'wheel-down', 'side', 1065 'extra', 'wheel-left', 'wheel-right', 'touch' ] } 1066 1067## 1068# @InputAxis: 1069# 1070# Position axis of a pointer input device (mouse, tablet). 1071# 1072# Since: 2.0 1073## 1074{ 'enum' : 'InputAxis', 1075 'data' : [ 'x', 'y' ] } 1076 1077## 1078# @InputMultiTouchType: 1079# 1080# Type of a multi-touch event. 1081# 1082# @begin: A new touch event sequence has just started. 1083# 1084# @update: A touch event sequence has been updated. 1085# 1086# @end: A touch event sequence has finished. 1087# 1088# @cancel: A touch event sequence has been canceled. 1089# 1090# @data: Absolute position data. 1091# 1092# Since: 8.1 1093## 1094{ 'enum' : 'InputMultiTouchType', 1095 'data' : [ 'begin', 'update', 'end', 'cancel', 'data' ] } 1096 1097 1098## 1099# @InputKeyEvent: 1100# 1101# Keyboard input event. 1102# 1103# @key: Which key this event is for. 1104# 1105# @down: True for key-down and false for key-up events. 1106# 1107# Since: 2.0 1108## 1109{ 'struct' : 'InputKeyEvent', 1110 'data' : { 'key' : 'KeyValue', 1111 'down' : 'bool' } } 1112 1113## 1114# @InputBtnEvent: 1115# 1116# Pointer button input event. 1117# 1118# @button: Which button this event is for. 1119# 1120# @down: True for key-down and false for key-up events. 1121# 1122# Since: 2.0 1123## 1124{ 'struct' : 'InputBtnEvent', 1125 'data' : { 'button' : 'InputButton', 1126 'down' : 'bool' } } 1127 1128## 1129# @InputMoveEvent: 1130# 1131# Pointer motion input event. 1132# 1133# @axis: Which axis is referenced by @value. 1134# 1135# @value: Pointer position. For absolute coordinates the valid range 1136# is 0 to 0x7fff. 1137# 1138# Since: 2.0 1139## 1140{ 'struct' : 'InputMoveEvent', 1141 'data' : { 'axis' : 'InputAxis', 1142 'value' : 'int' } } 1143 1144## 1145# @InputMultiTouchEvent: 1146# 1147# MultiTouch input event. 1148# 1149# @type: The type of multi-touch event. 1150# 1151# @slot: Which slot has generated the event. 1152# 1153# @tracking-id: ID to correlate this event with previously generated 1154# events. 1155# 1156# @axis: Which axis is referenced by @value. 1157# 1158# @value: Contact position. 1159# 1160# Since: 8.1 1161## 1162{ 'struct' : 'InputMultiTouchEvent', 1163 'data' : { 'type' : 'InputMultiTouchType', 1164 'slot' : 'int', 1165 'tracking-id': 'int', 1166 'axis' : 'InputAxis', 1167 'value' : 'int' } } 1168 1169## 1170# @InputEventKind: 1171# 1172# @key: a keyboard input event 1173# 1174# @btn: a pointer button input event 1175# 1176# @rel: a relative pointer motion input event 1177# 1178# @abs: an absolute pointer motion input event 1179# 1180# @mtt: a multi-touch input event 1181# 1182# Since: 2.0 1183## 1184{ 'enum': 'InputEventKind', 1185 'data': [ 'key', 'btn', 'rel', 'abs', 'mtt' ] } 1186 1187## 1188# @InputKeyEventWrapper: 1189# 1190# @data: Keyboard input event 1191# 1192# Since: 2.0 1193## 1194{ 'struct': 'InputKeyEventWrapper', 1195 'data': { 'data': 'InputKeyEvent' } } 1196 1197## 1198# @InputBtnEventWrapper: 1199# 1200# @data: Pointer button input event 1201# 1202# Since: 2.0 1203## 1204{ 'struct': 'InputBtnEventWrapper', 1205 'data': { 'data': 'InputBtnEvent' } } 1206 1207## 1208# @InputMoveEventWrapper: 1209# 1210# @data: Pointer motion input event 1211# 1212# Since: 2.0 1213## 1214{ 'struct': 'InputMoveEventWrapper', 1215 'data': { 'data': 'InputMoveEvent' } } 1216 1217## 1218# @InputMultiTouchEventWrapper: 1219# 1220# @data: MultiTouch input event 1221# 1222# Since: 8.1 1223## 1224{ 'struct': 'InputMultiTouchEventWrapper', 1225 'data': { 'data': 'InputMultiTouchEvent' } } 1226 1227## 1228# @InputEvent: 1229# 1230# Input event union. 1231# 1232# @type: the type of input event 1233# 1234# Since: 2.0 1235## 1236{ 'union' : 'InputEvent', 1237 'base': { 'type': 'InputEventKind' }, 1238 'discriminator': 'type', 1239 'data' : { 'key' : 'InputKeyEventWrapper', 1240 'btn' : 'InputBtnEventWrapper', 1241 'rel' : 'InputMoveEventWrapper', 1242 'abs' : 'InputMoveEventWrapper', 1243 'mtt' : 'InputMultiTouchEventWrapper' } } 1244 1245## 1246# @input-send-event: 1247# 1248# Send input event(s) to guest. 1249# 1250# The @device and @head parameters can be used to send the input event 1251# to specific input devices in case (a) multiple input devices of the 1252# same kind are added to the virtual machine and (b) you have 1253# configured input routing (see docs/multiseat.txt) for those input 1254# devices. The parameters work exactly like the device and head 1255# properties of input devices. If @device is missing, only devices 1256# that have no input routing config are admissible. If @device is 1257# specified, both input devices with and without input routing config 1258# are admissible, but devices with input routing config take 1259# precedence. 1260# 1261# @device: display device to send event(s) to. 1262# 1263# @head: head to send event(s) to, in case the display device supports 1264# multiple scanouts. 1265# 1266# @events: List of `InputEvent` union. 1267# 1268# Since: 2.6 1269# 1270# .. note:: The consoles are visible in the qom tree, under 1271# ``/backend/console[$index]``. They have a device link and head 1272# property, so it is possible to map which console belongs to which 1273# device and display. 1274# 1275# .. qmp-example:: 1276# :title: Press left mouse button 1277# 1278# -> { "execute": "input-send-event", 1279# "arguments": { "device": "video0", 1280# "events": [ { "type": "btn", 1281# "data" : { "down": true, "button": "left" } } ] } } 1282# <- { "return": {} } 1283# 1284# -> { "execute": "input-send-event", 1285# "arguments": { "device": "video0", 1286# "events": [ { "type": "btn", 1287# "data" : { "down": false, "button": "left" } } ] } } 1288# <- { "return": {} } 1289# 1290# .. qmp-example:: 1291# :title: Press ctrl-alt-del 1292# 1293# -> { "execute": "input-send-event", 1294# "arguments": { "events": [ 1295# { "type": "key", "data" : { "down": true, 1296# "key": {"type": "qcode", "data": "ctrl" } } }, 1297# { "type": "key", "data" : { "down": true, 1298# "key": {"type": "qcode", "data": "alt" } } }, 1299# { "type": "key", "data" : { "down": true, 1300# "key": {"type": "qcode", "data": "delete" } } } ] } } 1301# <- { "return": {} } 1302# 1303# .. qmp-example:: 1304# :title: Move mouse pointer to absolute coordinates 1305# 1306# -> { "execute": "input-send-event" , 1307# "arguments": { "events": [ 1308# { "type": "abs", "data" : { "axis": "x", "value" : 20000 } }, 1309# { "type": "abs", "data" : { "axis": "y", "value" : 400 } } ] } } 1310# <- { "return": {} } 1311## 1312{ 'command': 'input-send-event', 1313 'data': { '*device': 'str', 1314 '*head' : 'int', 1315 'events' : [ 'InputEvent' ] } } 1316 1317## 1318# @DisplayGTK: 1319# 1320# GTK display options. 1321# 1322# @grab-on-hover: Grab keyboard input on mouse hover. 1323# 1324# @zoom-to-fit: Zoom guest display to fit into the host window. When 1325# turned off the host window will be resized instead. In case the 1326# display device can notify the guest on window resizes 1327# (virtio-gpu) this will default to "on", assuming the guest will 1328# resize the display to match the window size then. Otherwise it 1329# defaults to "off". (Since 3.1) 1330# 1331# @show-tabs: Display the tab bar for switching between the various 1332# graphical interfaces (e.g. VGA and virtual console character 1333# devices) by default. (Since 7.1) 1334# 1335# @show-menubar: Display the main window menubar. Defaults to "on". 1336# (Since 8.0) 1337# 1338# @keep-aspect-ratio: Keep width/height aspect ratio of guest content when 1339# resizing host window. Defaults to "on". (Since 10.1) 1340# 1341# @scale: Set preferred scale of the display. Defaults to 1.0. (Since 10.1) 1342# 1343# Since: 2.12 1344## 1345{ 'struct' : 'DisplayGTK', 1346 'data' : { '*grab-on-hover' : 'bool', 1347 '*zoom-to-fit' : 'bool', 1348 '*show-tabs' : 'bool', 1349 '*show-menubar' : 'bool', 1350 '*keep-aspect-ratio' : 'bool', 1351 '*scale' : 'number' } } 1352 1353## 1354# @DisplayEGLHeadless: 1355# 1356# EGL headless display options. 1357# 1358# @rendernode: Which DRM render node should be used. Default is the 1359# first available node on the host. 1360# 1361# Since: 3.1 1362## 1363{ 'struct' : 'DisplayEGLHeadless', 1364 'data' : { '*rendernode' : 'str' } } 1365 1366## 1367# @DisplayDBus: 1368# 1369# DBus display options. 1370# 1371# @addr: The D-Bus bus address (default to the session bus). 1372# 1373# @rendernode: Which DRM render node should be used. Default is the 1374# first available node on the host. 1375# 1376# @p2p: Whether to use peer-to-peer connections (accepted through 1377# `add_client`). 1378# 1379# @audiodev: Use the specified DBus audiodev to export audio. 1380# 1381# Since: 7.0 1382## 1383{ 'struct' : 'DisplayDBus', 1384 'data' : { '*rendernode' : 'str', 1385 '*addr': 'str', 1386 '*p2p': 'bool', 1387 '*audiodev': 'str' } } 1388 1389## 1390# @DisplayGLMode: 1391# 1392# Display OpenGL mode. 1393# 1394# @off: Disable OpenGL (default). 1395# 1396# @on: Use OpenGL, pick context type automatically. Would better be 1397# named 'auto' but is called 'on' for backward compatibility with 1398# bool type. 1399# 1400# @core: Use OpenGL with Core (desktop) Context. 1401# 1402# @es: Use OpenGL with ES (embedded systems) Context. 1403# 1404# Since: 3.0 1405## 1406{ 'enum' : 'DisplayGLMode', 1407 'data' : [ 'off', 'on', 'core', 'es' ] } 1408 1409## 1410# @DisplayCurses: 1411# 1412# Curses display options. 1413# 1414# @charset: Font charset used by guest (default: CP437). 1415# 1416# Since: 4.0 1417## 1418{ 'struct' : 'DisplayCurses', 1419 'data' : { '*charset' : 'str' } } 1420 1421## 1422# @DisplayCocoa: 1423# 1424# Cocoa display options. 1425# 1426# @left-command-key: Enable/disable forwarding of left command key to 1427# guest. Allows command-tab window switching on the host without 1428# sending this key to the guest when "off". Defaults to "on" 1429# 1430# @full-grab: Capture all key presses, including system combos. This 1431# requires accessibility permissions, since it performs a global 1432# grab on key events. (default: off) See 1433# https://support.apple.com/en-in/guide/mac-help/mh32356/mac 1434# 1435# @swap-opt-cmd: Swap the Option and Command keys so that their key 1436# codes match their position on non-Mac keyboards and you can use 1437# Meta/Super and Alt where you expect them. (default: off) 1438# 1439# @zoom-to-fit: Zoom guest display to fit into the host window. When 1440# turned off the host window will be resized instead. Defaults to 1441# "off". (Since 8.2) 1442# 1443# @zoom-interpolation: Apply interpolation to smooth output when 1444# zoom-to-fit is enabled. Defaults to "off". (Since 9.0) 1445# 1446# Since: 7.0 1447## 1448{ 'struct': 'DisplayCocoa', 1449 'data': { 1450 '*left-command-key': 'bool', 1451 '*full-grab': 'bool', 1452 '*swap-opt-cmd': 'bool', 1453 '*zoom-to-fit': 'bool', 1454 '*zoom-interpolation': 'bool' 1455 } } 1456 1457## 1458# @HotKeyMod: 1459# 1460# Set of modifier keys that need to be held for shortcut key actions. 1461# 1462# Since: 7.1 1463## 1464{ 'enum' : 'HotKeyMod', 1465 'data' : [ 'lctrl-lalt', 'lshift-lctrl-lalt', 'rctrl' ] } 1466 1467## 1468# @DisplaySDL: 1469# 1470# SDL2 display options. 1471# 1472# @grab-mod: Modifier keys that should be pressed together with the 1473# "G" key to release the mouse grab. 1474# 1475# Since: 7.1 1476## 1477{ 'struct' : 'DisplaySDL', 1478 'data' : { '*grab-mod' : 'HotKeyMod' } } 1479 1480## 1481# @DisplayType: 1482# 1483# Display (user interface) type. 1484# 1485# @default: The default user interface, selecting from the first 1486# available of gtk, sdl, cocoa, and vnc. 1487# 1488# @none: No user interface or video output display. The guest will 1489# still see an emulated graphics card, but its output will not be 1490# displayed to the QEMU user. 1491# 1492# @gtk: The GTK user interface. 1493# 1494# @sdl: The SDL user interface. 1495# 1496# @egl-headless: No user interface, offload GL operations to a local 1497# DRI device. Graphical display need to be paired with VNC or 1498# Spice. (Since 3.1) 1499# 1500# @curses: Display video output via curses. For graphics device 1501# models which support a text mode, QEMU can display this output 1502# using a curses/ncurses interface. Nothing is displayed when the 1503# graphics device is in graphical mode or if the graphics device 1504# does not support a text mode. Generally only the VGA device 1505# models support text mode. 1506# 1507# @cocoa: The Cocoa user interface. 1508# 1509# @spice-app: Set up a Spice server and run the default associated 1510# application to connect to it. The server will redirect the 1511# serial console and QEMU monitors. (Since 4.0) 1512# 1513# @dbus: Start a D-Bus service for the display. (Since 7.0) 1514# 1515# Since: 2.12 1516## 1517{ 'enum' : 'DisplayType', 1518 'data' : [ 1519 { 'name': 'default' }, 1520 { 'name': 'none' }, 1521 { 'name': 'gtk', 'if': 'CONFIG_GTK' }, 1522 { 'name': 'sdl', 'if': 'CONFIG_SDL' }, 1523 { 'name': 'egl-headless', 'if': 'CONFIG_OPENGL' }, 1524 { 'name': 'curses', 'if': 'CONFIG_CURSES' }, 1525 { 'name': 'cocoa', 'if': 'CONFIG_COCOA' }, 1526 { 'name': 'spice-app', 'if': 'CONFIG_SPICE' }, 1527 { 'name': 'dbus', 'if': 'CONFIG_DBUS_DISPLAY' } 1528 ] 1529} 1530 1531## 1532# @DisplayOptions: 1533# 1534# Display (user interface) options. 1535# 1536# @type: Which `DisplayType` QEMU should use. 1537# 1538# @full-screen: Start user interface in fullscreen mode 1539# (default: off). 1540# 1541# @window-close: Allow to quit QEMU with window close button 1542# (default: on). 1543# 1544# @show-cursor: Force showing the mouse cursor (default: off). 1545# (since: 5.0) 1546# 1547# @gl: Enable OpenGL support (default: off). 1548# 1549# Since: 2.12 1550## 1551{ 'union' : 'DisplayOptions', 1552 'base' : { 'type' : 'DisplayType', 1553 '*full-screen' : 'bool', 1554 '*window-close' : 'bool', 1555 '*show-cursor' : 'bool', 1556 '*gl' : 'DisplayGLMode' }, 1557 'discriminator' : 'type', 1558 'data' : { 1559 'gtk': { 'type': 'DisplayGTK', 'if': 'CONFIG_GTK' }, 1560 'cocoa': { 'type': 'DisplayCocoa', 'if': 'CONFIG_COCOA' }, 1561 'curses': { 'type': 'DisplayCurses', 'if': 'CONFIG_CURSES' }, 1562 'egl-headless': { 'type': 'DisplayEGLHeadless', 1563 'if': 'CONFIG_OPENGL' }, 1564 'dbus': { 'type': 'DisplayDBus', 'if': 'CONFIG_DBUS_DISPLAY' }, 1565 'sdl': { 'type': 'DisplaySDL', 'if': 'CONFIG_SDL' } 1566 } 1567} 1568 1569## 1570# @query-display-options: 1571# 1572# Return information about display configuration 1573# 1574# Since: 3.1 1575## 1576{ 'command': 'query-display-options', 1577 'returns': 'DisplayOptions' } 1578 1579## 1580# @DisplayReloadType: 1581# 1582# Available DisplayReload types. 1583# 1584# @vnc: VNC display 1585# 1586# Since: 6.0 1587## 1588{ 'enum': 'DisplayReloadType', 1589 'data': ['vnc'] } 1590 1591## 1592# @DisplayReloadOptionsVNC: 1593# 1594# Specify the VNC reload options. 1595# 1596# @tls-certs: reload tls certs or not. 1597# 1598# Since: 6.0 1599## 1600{ 'struct': 'DisplayReloadOptionsVNC', 1601 'data': { '*tls-certs': 'bool' } } 1602 1603## 1604# @DisplayReloadOptions: 1605# 1606# Options of the display configuration reload. 1607# 1608# @type: Specify the display type. 1609# 1610# Since: 6.0 1611## 1612{ 'union': 'DisplayReloadOptions', 1613 'base': {'type': 'DisplayReloadType'}, 1614 'discriminator': 'type', 1615 'data': { 'vnc': 'DisplayReloadOptionsVNC' } } 1616 1617## 1618# @display-reload: 1619# 1620# Reload display configuration. 1621# 1622# Since: 6.0 1623# 1624# .. qmp-example:: 1625# 1626# -> { "execute": "display-reload", 1627# "arguments": { "type": "vnc", "tls-certs": true } } 1628# <- { "return": {} } 1629## 1630{ 'command': 'display-reload', 1631 'data': 'DisplayReloadOptions', 1632 'boxed' : true } 1633 1634## 1635# @DisplayUpdateType: 1636# 1637# Available DisplayUpdate types. 1638# 1639# @vnc: VNC display 1640# 1641# Since: 7.1 1642## 1643{ 'enum': 'DisplayUpdateType', 1644 'data': ['vnc'] } 1645 1646## 1647# @DisplayUpdateOptionsVNC: 1648# 1649# Specify the VNC reload options. 1650# 1651# @addresses: If specified, change set of addresses to listen for 1652# connections. Addresses configured for websockets are not 1653# touched. 1654# 1655# Since: 7.1 1656## 1657{ 'struct': 'DisplayUpdateOptionsVNC', 1658 'data': { '*addresses': ['SocketAddress'] } } 1659 1660## 1661# @DisplayUpdateOptions: 1662# 1663# Options of the display configuration reload. 1664# 1665# @type: Specify the display type. 1666# 1667# Since: 7.1 1668## 1669{ 'union': 'DisplayUpdateOptions', 1670 'base': {'type': 'DisplayUpdateType'}, 1671 'discriminator': 'type', 1672 'data': { 'vnc': 'DisplayUpdateOptionsVNC' } } 1673 1674## 1675# @display-update: 1676# 1677# Update display configuration. 1678# 1679# Since: 7.1 1680# 1681# .. qmp-example:: 1682# 1683# -> { "execute": "display-update", 1684# "arguments": { "type": "vnc", "addresses": 1685# [ { "type": "inet", "host": "0.0.0.0", 1686# "port": "5901" } ] } } 1687# <- { "return": {} } 1688## 1689{ 'command': 'display-update', 1690 'data': 'DisplayUpdateOptions', 1691 'boxed' : true } 1692 1693## 1694# @client_migrate_info: 1695# 1696# Set migration information for remote display. This makes the server 1697# ask the client to automatically reconnect using the new parameters 1698# once migration finished successfully. Only implemented for SPICE. 1699# 1700# @protocol: must be "spice" 1701# 1702# @hostname: migration target hostname 1703# 1704# @port: spice tcp port for plaintext channels 1705# 1706# @tls-port: spice tcp port for tls-secured channels 1707# 1708# @cert-subject: server certificate subject 1709# 1710# Since: 0.14 1711# 1712# .. qmp-example:: 1713# 1714# -> { "execute": "client_migrate_info", 1715# "arguments": { "protocol": "spice", 1716# "hostname": "virt42.lab.kraxel.org", 1717# "port": 1234 } } 1718# <- { "return": {} } 1719## 1720{ 'command': 'client_migrate_info', 1721 'data': { 'protocol': 'str', 'hostname': 'str', '*port': 'int', 1722 '*tls-port': 'int', '*cert-subject': 'str' } } 1723