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