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