migration: Remove unused functions
[qemu/ar7.git] / qapi-schema.json
blobd1f65a14524e176f6048b0bf043f8f3feb1bc817
1 # -*- Mode: Python -*-
3 # QAPI Schema
5 # QAPI common definitions
6 { 'include': 'qapi/common.json' }
8 # QAPI block definitions
9 { 'include': 'qapi/block.json' }
11 # QAPI event definitions
12 { 'include': 'qapi/event.json' }
14 # Tracing commands
15 { 'include': 'qapi/trace.json' }
18 # LostTickPolicy:
20 # Policy for handling lost ticks in timer devices.
22 # @discard: throw away the missed tick(s) and continue with future injection
23 #           normally.  Guest time may be delayed, unless the OS has explicit
24 #           handling of lost ticks
26 # @delay: continue to deliver ticks at the normal rate.  Guest time will be
27 #         delayed due to the late tick
29 # @merge: merge the missed tick(s) into one tick and inject.  Guest time
30 #         may be delayed, depending on how the OS reacts to the merging
31 #         of ticks
33 # @slew: deliver ticks at a higher rate to catch up with the missed tick. The
34 #        guest time should not be delayed once catchup is complete.
36 # Since: 2.0
38 { 'enum': 'LostTickPolicy',
39   'data': ['discard', 'delay', 'merge', 'slew' ] }
41 # @add_client
43 # Allow client connections for VNC, Spice and socket based
44 # character devices to be passed in to QEMU via SCM_RIGHTS.
46 # @protocol: protocol name. Valid names are "vnc", "spice" or the
47 #            name of a character device (eg. from -chardev id=XXXX)
49 # @fdname: file descriptor name previously passed via 'getfd' command
51 # @skipauth: #optional whether to skip authentication. Only applies
52 #            to "vnc" and "spice" protocols
54 # @tls: #optional whether to perform TLS. Only applies to the "spice"
55 #       protocol
57 # Returns: nothing on success.
59 # Since: 0.14.0
61 { 'command': 'add_client',
62   'data': { 'protocol': 'str', 'fdname': 'str', '*skipauth': 'bool',
63             '*tls': 'bool' } }
66 # @NameInfo:
68 # Guest name information.
70 # @name: #optional The name of the guest
72 # Since 0.14.0
74 { 'type': 'NameInfo', 'data': {'*name': 'str'} }
77 # @query-name:
79 # Return the name information of a guest.
81 # Returns: @NameInfo of the guest
83 # Since 0.14.0
85 { 'command': 'query-name', 'returns': 'NameInfo' }
88 # @KvmInfo:
90 # Information about support for KVM acceleration
92 # @enabled: true if KVM acceleration is active
94 # @present: true if KVM acceleration is built into this executable
96 # Since: 0.14.0
98 { 'type': 'KvmInfo', 'data': {'enabled': 'bool', 'present': 'bool'} }
101 # @query-kvm:
103 # Returns information about KVM acceleration
105 # Returns: @KvmInfo
107 # Since: 0.14.0
109 { 'command': 'query-kvm', 'returns': 'KvmInfo' }
112 # @RunState
114 # An enumeration of VM run states.
116 # @debug: QEMU is running on a debugger
118 # @finish-migrate: guest is paused to finish the migration process
120 # @inmigrate: guest is paused waiting for an incoming migration.  Note
121 # that this state does not tell whether the machine will start at the
122 # end of the migration.  This depends on the command-line -S option and
123 # any invocation of 'stop' or 'cont' that has happened since QEMU was
124 # started.
126 # @internal-error: An internal error that prevents further guest execution
127 # has occurred
129 # @io-error: the last IOP has failed and the device is configured to pause
130 # on I/O errors
132 # @paused: guest has been paused via the 'stop' command
134 # @postmigrate: guest is paused following a successful 'migrate'
136 # @prelaunch: QEMU was started with -S and guest has not started
138 # @restore-vm: guest is paused to restore VM state
140 # @running: guest is actively running
142 # @save-vm: guest is paused to save the VM state
144 # @shutdown: guest is shut down (and -no-shutdown is in use)
146 # @suspended: guest is suspended (ACPI S3)
148 # @watchdog: the watchdog action is configured to pause and has been triggered
150 # @guest-panicked: guest has been panicked as a result of guest OS panic
152 { 'enum': 'RunState',
153   'data': [ 'debug', 'inmigrate', 'internal-error', 'io-error', 'paused',
154             'postmigrate', 'prelaunch', 'finish-migrate', 'restore-vm',
155             'running', 'save-vm', 'shutdown', 'suspended', 'watchdog',
156             'guest-panicked' ] }
159 # @StatusInfo:
161 # Information about VCPU run state
163 # @running: true if all VCPUs are runnable, false if not runnable
165 # @singlestep: true if VCPUs are in single-step mode
167 # @status: the virtual machine @RunState
169 # Since:  0.14.0
171 # Notes: @singlestep is enabled through the GDB stub
173 { 'type': 'StatusInfo',
174   'data': {'running': 'bool', 'singlestep': 'bool', 'status': 'RunState'} }
177 # @query-status:
179 # Query the run status of all VCPUs
181 # Returns: @StatusInfo reflecting all VCPUs
183 # Since:  0.14.0
185 { 'command': 'query-status', 'returns': 'StatusInfo' }
188 # @UuidInfo:
190 # Guest UUID information.
192 # @UUID: the UUID of the guest
194 # Since: 0.14.0
196 # Notes: If no UUID was specified for the guest, a null UUID is returned.
198 { 'type': 'UuidInfo', 'data': {'UUID': 'str'} }
201 # @query-uuid:
203 # Query the guest UUID information.
205 # Returns: The @UuidInfo for the guest
207 # Since 0.14.0
209 { 'command': 'query-uuid', 'returns': 'UuidInfo' }
212 # @ChardevInfo:
214 # Information about a character device.
216 # @label: the label of the character device
218 # @filename: the filename of the character device
220 # @frontend-open: shows whether the frontend device attached to this backend
221 #                 (eg. with the chardev=... option) is in open or closed state
222 #                 (since 2.1)
224 # Notes: @filename is encoded using the QEMU command line character device
225 #        encoding.  See the QEMU man page for details.
227 # Since: 0.14.0
229 { 'type': 'ChardevInfo', 'data': {'label': 'str',
230                                   'filename': 'str',
231                                   'frontend-open': 'bool'} }
234 # @query-chardev:
236 # Returns information about current character devices.
238 # Returns: a list of @ChardevInfo
240 # Since: 0.14.0
242 { 'command': 'query-chardev', 'returns': ['ChardevInfo'] }
245 # @ChardevBackendInfo:
247 # Information about a character device backend
249 # @name: The backend name
251 # Since: 2.0
253 { 'type': 'ChardevBackendInfo', 'data': {'name': 'str'} }
256 # @query-chardev-backends:
258 # Returns information about character device backends.
260 # Returns: a list of @ChardevBackendInfo
262 # Since: 2.0
264 { 'command': 'query-chardev-backends', 'returns': ['ChardevBackendInfo'] }
267 # @DataFormat:
269 # An enumeration of data format.
271 # @utf8: Data is a UTF-8 string (RFC 3629)
273 # @base64: Data is Base64 encoded binary (RFC 3548)
275 # Since: 1.4
277 { 'enum': 'DataFormat',
278   'data': [ 'utf8', 'base64' ] }
281 # @ringbuf-write:
283 # Write to a ring buffer character device.
285 # @device: the ring buffer character device name
287 # @data: data to write
289 # @format: #optional data encoding (default 'utf8').
290 #          - base64: data must be base64 encoded text.  Its binary
291 #            decoding gets written.
292 #            Bug: invalid base64 is currently not rejected.
293 #            Whitespace *is* invalid.
294 #          - utf8: data's UTF-8 encoding is written
295 #          - data itself is always Unicode regardless of format, like
296 #            any other string.
298 # Returns: Nothing on success
300 # Since: 1.4
302 { 'command': 'ringbuf-write',
303   'data': {'device': 'str', 'data': 'str',
304            '*format': 'DataFormat'} }
307 # @ringbuf-read:
309 # Read from a ring buffer character device.
311 # @device: the ring buffer character device name
313 # @size: how many bytes to read at most
315 # @format: #optional data encoding (default 'utf8').
316 #          - base64: the data read is returned in base64 encoding.
317 #          - utf8: the data read is interpreted as UTF-8.
318 #            Bug: can screw up when the buffer contains invalid UTF-8
319 #            sequences, NUL characters, after the ring buffer lost
320 #            data, and when reading stops because the size limit is
321 #            reached.
322 #          - The return value is always Unicode regardless of format,
323 #            like any other string.
325 # Returns: data read from the device
327 # Since: 1.4
329 { 'command': 'ringbuf-read',
330   'data': {'device': 'str', 'size': 'int', '*format': 'DataFormat'},
331   'returns': 'str' }
334 # @EventInfo:
336 # Information about a QMP event
338 # @name: The event name
340 # Since: 1.2.0
342 { 'type': 'EventInfo', 'data': {'name': 'str'} }
345 # @query-events:
347 # Return a list of supported QMP events by this server
349 # Returns: A list of @EventInfo for all supported events
351 # Since: 1.2.0
353 { 'command': 'query-events', 'returns': ['EventInfo'] }
356 # @MigrationStats
358 # Detailed migration status.
360 # @transferred: amount of bytes already transferred to the target VM
362 # @remaining: amount of bytes remaining to be transferred to the target VM
364 # @total: total amount of bytes involved in the migration process
366 # @duplicate: number of duplicate (zero) pages (since 1.2)
368 # @skipped: number of skipped zero pages (since 1.5)
370 # @normal : number of normal pages (since 1.2)
372 # @normal-bytes: number of normal bytes sent (since 1.2)
374 # @dirty-pages-rate: number of pages dirtied by second by the
375 #        guest (since 1.3)
377 # @mbps: throughput in megabits/sec. (since 1.6)
379 # @dirty-sync-count: number of times that dirty ram was synchronized (since 2.1)
381 # Since: 0.14.0
383 { 'type': 'MigrationStats',
384   'data': {'transferred': 'int', 'remaining': 'int', 'total': 'int' ,
385            'duplicate': 'int', 'skipped': 'int', 'normal': 'int',
386            'normal-bytes': 'int', 'dirty-pages-rate' : 'int',
387            'mbps' : 'number', 'dirty-sync-count' : 'int' } }
390 # @XBZRLECacheStats
392 # Detailed XBZRLE migration cache statistics
394 # @cache-size: XBZRLE cache size
396 # @bytes: amount of bytes already transferred to the target VM
398 # @pages: amount of pages transferred to the target VM
400 # @cache-miss: number of cache miss
402 # @cache-miss-rate: rate of cache miss (since 2.1)
404 # @overflow: number of overflows
406 # Since: 1.2
408 { 'type': 'XBZRLECacheStats',
409   'data': {'cache-size': 'int', 'bytes': 'int', 'pages': 'int',
410            'cache-miss': 'int', 'cache-miss-rate': 'number',
411            'overflow': 'int' } }
414 # @MigrationInfo
416 # Information about current migration process.
418 # @status: #optional string describing the current migration status.
419 #          As of 0.14.0 this can be 'setup', 'active', 'completed', 'failed' or
420 #          'cancelled'. If this field is not returned, no migration process
421 #          has been initiated
423 # @ram: #optional @MigrationStats containing detailed migration
424 #       status, only returned if status is 'active' or
425 #       'completed'. 'comppleted' (since 1.2)
427 # @disk: #optional @MigrationStats containing detailed disk migration
428 #        status, only returned if status is 'active' and it is a block
429 #        migration
431 # @xbzrle-cache: #optional @XBZRLECacheStats containing detailed XBZRLE
432 #                migration statistics, only returned if XBZRLE feature is on and
433 #                status is 'active' or 'completed' (since 1.2)
435 # @total-time: #optional total amount of milliseconds since migration started.
436 #        If migration has ended, it returns the total migration
437 #        time. (since 1.2)
439 # @downtime: #optional only present when migration finishes correctly
440 #        total downtime in milliseconds for the guest.
441 #        (since 1.3)
443 # @expected-downtime: #optional only present while migration is active
444 #        expected downtime in milliseconds for the guest in last walk
445 #        of the dirty bitmap. (since 1.3)
447 # @setup-time: #optional amount of setup time in milliseconds _before_ the
448 #        iterations begin but _after_ the QMP command is issued. This is designed
449 #        to provide an accounting of any activities (such as RDMA pinning) which
450 #        may be expensive, but do not actually occur during the iterative
451 #        migration rounds themselves. (since 1.6)
453 # Since: 0.14.0
455 { 'type': 'MigrationInfo',
456   'data': {'*status': 'str', '*ram': 'MigrationStats',
457            '*disk': 'MigrationStats',
458            '*xbzrle-cache': 'XBZRLECacheStats',
459            '*total-time': 'int',
460            '*expected-downtime': 'int',
461            '*downtime': 'int',
462            '*setup-time': 'int'} }
465 # @query-migrate
467 # Returns information about current migration process.
469 # Returns: @MigrationInfo
471 # Since: 0.14.0
473 { 'command': 'query-migrate', 'returns': 'MigrationInfo' }
476 # @MigrationCapability
478 # Migration capabilities enumeration
480 # @xbzrle: Migration supports xbzrle (Xor Based Zero Run Length Encoding).
481 #          This feature allows us to minimize migration traffic for certain work
482 #          loads, by sending compressed difference of the pages
484 # @rdma-pin-all: Controls whether or not the entire VM memory footprint is
485 #          mlock()'d on demand or all at once. Refer to docs/rdma.txt for usage.
486 #          Disabled by default. (since 2.0)
488 # @zero-blocks: During storage migration encode blocks of zeroes efficiently. This
489 #          essentially saves 1MB of zeroes per block on the wire. Enabling requires
490 #          source and target VM to support this feature. To enable it is sufficient
491 #          to enable the capability on the source VM. The feature is disabled by
492 #          default. (since 1.6)
494 # @auto-converge: If enabled, QEMU will automatically throttle down the guest
495 #          to speed up convergence of RAM migration. (since 1.6)
497 # Since: 1.2
499 { 'enum': 'MigrationCapability',
500   'data': ['xbzrle', 'rdma-pin-all', 'auto-converge', 'zero-blocks'] }
503 # @MigrationCapabilityStatus
505 # Migration capability information
507 # @capability: capability enum
509 # @state: capability state bool
511 # Since: 1.2
513 { 'type': 'MigrationCapabilityStatus',
514   'data': { 'capability' : 'MigrationCapability', 'state' : 'bool' } }
517 # @migrate-set-capabilities
519 # Enable/Disable the following migration capabilities (like xbzrle)
521 # @capabilities: json array of capability modifications to make
523 # Since: 1.2
525 { 'command': 'migrate-set-capabilities',
526   'data': { 'capabilities': ['MigrationCapabilityStatus'] } }
529 # @query-migrate-capabilities
531 # Returns information about the current migration capabilities status
533 # Returns: @MigrationCapabilitiesStatus
535 # Since: 1.2
537 { 'command': 'query-migrate-capabilities', 'returns':   ['MigrationCapabilityStatus']}
540 # @MouseInfo:
542 # Information about a mouse device.
544 # @name: the name of the mouse device
546 # @index: the index of the mouse device
548 # @current: true if this device is currently receiving mouse events
550 # @absolute: true if this device supports absolute coordinates as input
552 # Since: 0.14.0
554 { 'type': 'MouseInfo',
555   'data': {'name': 'str', 'index': 'int', 'current': 'bool',
556            'absolute': 'bool'} }
559 # @query-mice:
561 # Returns information about each active mouse device
563 # Returns: a list of @MouseInfo for each device
565 # Since: 0.14.0
567 { 'command': 'query-mice', 'returns': ['MouseInfo'] }
570 # @CpuInfo:
572 # Information about a virtual CPU
574 # @CPU: the index of the virtual CPU
576 # @current: this only exists for backwards compatible and should be ignored
578 # @halted: true if the virtual CPU is in the halt state.  Halt usually refers
579 #          to a processor specific low power mode.
581 # @pc: #optional If the target is i386 or x86_64, this is the 64-bit instruction
582 #                pointer.
583 #                If the target is Sparc, this is the PC component of the
584 #                instruction pointer.
586 # @nip: #optional If the target is PPC, the instruction pointer
588 # @npc: #optional If the target is Sparc, the NPC component of the instruction
589 #                 pointer
591 # @PC: #optional If the target is MIPS, the instruction pointer
593 # @thread_id: ID of the underlying host thread
595 # Since: 0.14.0
597 # Notes: @halted is a transient state that changes frequently.  By the time the
598 #        data is sent to the client, the guest may no longer be halted.
600 { 'type': 'CpuInfo',
601   'data': {'CPU': 'int', 'current': 'bool', 'halted': 'bool', '*pc': 'int',
602            '*nip': 'int', '*npc': 'int', '*PC': 'int', 'thread_id': 'int'} }
605 # @query-cpus:
607 # Returns a list of information about each virtual CPU.
609 # Returns: a list of @CpuInfo for each virtual CPU
611 # Since: 0.14.0
613 { 'command': 'query-cpus', 'returns': ['CpuInfo'] }
616 # @IOThreadInfo:
618 # Information about an iothread
620 # @id: the identifier of the iothread
622 # @thread-id: ID of the underlying host thread
624 # Since: 2.0
626 { 'type': 'IOThreadInfo',
627   'data': {'id': 'str', 'thread-id': 'int'} }
630 # @query-iothreads:
632 # Returns a list of information about each iothread.
634 # Note this list excludes the QEMU main loop thread, which is not declared
635 # using the -object iothread command-line option.  It is always the main thread
636 # of the process.
638 # Returns: a list of @IOThreadInfo for each iothread
640 # Since: 2.0
642 { 'command': 'query-iothreads', 'returns': ['IOThreadInfo'] }
645 # @NetworkAddressFamily
647 # The network address family
649 # @ipv4: IPV4 family
651 # @ipv6: IPV6 family
653 # @unix: unix socket
655 # @unknown: otherwise
657 # Since: 2.1
659 { 'enum': 'NetworkAddressFamily',
660   'data': [ 'ipv4', 'ipv6', 'unix', 'unknown' ] }
663 # @VncBasicInfo
665 # The basic information for vnc network connection
667 # @host: IP address
669 # @service: The service name of the vnc port. This may depend on the host
670 #           system's service database so symbolic names should not be relied
671 #           on.
673 # @family: address family
675 # @websocket: true in case the socket is a websocket (since 2.3).
677 # Since: 2.1
679 { 'type': 'VncBasicInfo',
680   'data': { 'host': 'str',
681             'service': 'str',
682             'family': 'NetworkAddressFamily',
683             'websocket': 'bool' } }
686 # @VncServerInfo
688 # The network connection information for server
690 # @auth: #optional, authentication method
692 # Since: 2.1
694 { 'type': 'VncServerInfo',
695   'base': 'VncBasicInfo',
696   'data': { '*auth': 'str' } }
699 # @VncClientInfo:
701 # Information about a connected VNC client.
703 # @x509_dname: #optional If x509 authentication is in use, the Distinguished
704 #              Name of the client.
706 # @sasl_username: #optional If SASL authentication is in use, the SASL username
707 #                 used for authentication.
709 # Since: 0.14.0
711 { 'type': 'VncClientInfo',
712   'base': 'VncBasicInfo',
713   'data': { '*x509_dname': 'str', '*sasl_username': 'str' } }
716 # @VncInfo:
718 # Information about the VNC session.
720 # @enabled: true if the VNC server is enabled, false otherwise
722 # @host: #optional The hostname the VNC server is bound to.  This depends on
723 #        the name resolution on the host and may be an IP address.
725 # @family: #optional 'ipv6' if the host is listening for IPv6 connections
726 #                    'ipv4' if the host is listening for IPv4 connections
727 #                    'unix' if the host is listening on a unix domain socket
728 #                    'unknown' otherwise
730 # @service: #optional The service name of the server's port.  This may depends
731 #           on the host system's service database so symbolic names should not
732 #           be relied on.
734 # @auth: #optional the current authentication type used by the server
735 #        'none' if no authentication is being used
736 #        'vnc' if VNC authentication is being used
737 #        'vencrypt+plain' if VEncrypt is used with plain text authentication
738 #        'vencrypt+tls+none' if VEncrypt is used with TLS and no authentication
739 #        'vencrypt+tls+vnc' if VEncrypt is used with TLS and VNC authentication
740 #        'vencrypt+tls+plain' if VEncrypt is used with TLS and plain text auth
741 #        'vencrypt+x509+none' if VEncrypt is used with x509 and no auth
742 #        'vencrypt+x509+vnc' if VEncrypt is used with x509 and VNC auth
743 #        'vencrypt+x509+plain' if VEncrypt is used with x509 and plain text auth
744 #        'vencrypt+tls+sasl' if VEncrypt is used with TLS and SASL auth
745 #        'vencrypt+x509+sasl' if VEncrypt is used with x509 and SASL auth
747 # @clients: a list of @VncClientInfo of all currently connected clients
749 # Since: 0.14.0
751 { 'type': 'VncInfo',
752   'data': {'enabled': 'bool', '*host': 'str',
753            '*family': 'NetworkAddressFamily',
754            '*service': 'str', '*auth': 'str', '*clients': ['VncClientInfo']} }
757 # @VncPriAuth:
759 # vnc primary authentication method.
761 # Since: 2.3
763 { 'enum': 'VncPrimaryAuth',
764   'data': [ 'none', 'vnc', 'ra2', 'ra2ne', 'tight', 'ultra',
765             'tls', 'vencrypt', 'sasl' ] }
768 # @VncVencryptSubAuth:
770 # vnc sub authentication method with vencrypt.
772 # Since: 2.3
774 { 'enum': 'VncVencryptSubAuth',
775   'data': [ 'plain',
776             'tls-none',  'x509-none',
777             'tls-vnc',   'x509-vnc',
778             'tls-plain', 'x509-plain',
779             'tls-sasl',  'x509-sasl' ] }
782 # @VncInfo2:
784 # Information about a vnc server
786 # @id: vnc server name.
788 # @server: A list of @VncBasincInfo describing all listening sockets.
789 #          The list can be empty (in case the vnc server is disabled).
790 #          It also may have multiple entries: normal + websocket,
791 #          possibly also ipv4 + ipv6 in the future.
793 # @clients: A list of @VncClientInfo of all currently connected clients.
794 #           The list can be empty, for obvious reasons.
796 # @auth: The current authentication type used by the server
798 # @vencrypt: #optional The vencrypt sub authentication type used by the server,
799 #            only specified in case auth == vencrypt.
801 # @display: #optional The display device the vnc server is linked to.
803 # Since: 2.3
805 { 'type': 'VncInfo2',
806   'data': { 'id'        : 'str',
807             'server'    : ['VncBasicInfo'],
808             'clients'   : ['VncClientInfo'],
809             'auth'      : 'VncPrimaryAuth',
810             '*vencrypt' : 'VncVencryptSubAuth',
811             '*display'  : 'str' } }
814 # @query-vnc:
816 # Returns information about the current VNC server
818 # Returns: @VncInfo
820 # Since: 0.14.0
822 { 'command': 'query-vnc', 'returns': 'VncInfo' }
825 # @query-vnc-servers:
827 # Returns a list of vnc servers.  The list can be empty.
829 # Returns: a list of @VncInfo2
831 # Since: 2.3
833 { 'command': 'query-vnc-servers', 'returns': ['VncInfo2'] }
836 # @SpiceBasicInfo
838 # The basic information for SPICE network connection
840 # @host: IP address
842 # @port: port number
844 # @family: address family
846 # Since: 2.1
848 { 'type': 'SpiceBasicInfo',
849   'data': { 'host': 'str',
850             'port': 'str',
851             'family': 'NetworkAddressFamily' } }
854 # @SpiceServerInfo
856 # Information about a SPICE server
858 # @auth: #optional, authentication method
860 # Since: 2.1
862 { 'type': 'SpiceServerInfo',
863   'base': 'SpiceBasicInfo',
864   'data': { '*auth': 'str' } }
867 # @SpiceChannel
869 # Information about a SPICE client channel.
871 # @connection-id: SPICE connection id number.  All channels with the same id
872 #                 belong to the same SPICE session.
874 # @channel-type: SPICE channel type number.  "1" is the main control
875 #                channel, filter for this one if you want to track spice
876 #                sessions only
878 # @channel-id: SPICE channel ID number.  Usually "0", might be different when
879 #              multiple channels of the same type exist, such as multiple
880 #              display channels in a multihead setup
882 # @tls: true if the channel is encrypted, false otherwise.
884 # Since: 0.14.0
886 { 'type': 'SpiceChannel',
887   'base': 'SpiceBasicInfo',
888   'data': {'connection-id': 'int', 'channel-type': 'int', 'channel-id': 'int',
889            'tls': 'bool'} }
892 # @SpiceQueryMouseMode
894 # An enumeration of Spice mouse states.
896 # @client: Mouse cursor position is determined by the client.
898 # @server: Mouse cursor position is determined by the server.
900 # @unknown: No information is available about mouse mode used by
901 #           the spice server.
903 # Note: spice/enums.h has a SpiceMouseMode already, hence the name.
905 # Since: 1.1
907 { 'enum': 'SpiceQueryMouseMode',
908   'data': [ 'client', 'server', 'unknown' ] }
911 # @SpiceInfo
913 # Information about the SPICE session.
915 # @enabled: true if the SPICE server is enabled, false otherwise
917 # @migrated: true if the last guest migration completed and spice
918 #            migration had completed as well. false otherwise.
920 # @host: #optional The hostname the SPICE server is bound to.  This depends on
921 #        the name resolution on the host and may be an IP address.
923 # @port: #optional The SPICE server's port number.
925 # @compiled-version: #optional SPICE server version.
927 # @tls-port: #optional The SPICE server's TLS port number.
929 # @auth: #optional the current authentication type used by the server
930 #        'none'  if no authentication is being used
931 #        'spice' uses SASL or direct TLS authentication, depending on command
932 #                line options
934 # @mouse-mode: The mode in which the mouse cursor is displayed currently. Can
935 #              be determined by the client or the server, or unknown if spice
936 #              server doesn't provide this information.
938 #              Since: 1.1
940 # @channels: a list of @SpiceChannel for each active spice channel
942 # Since: 0.14.0
944 { 'type': 'SpiceInfo',
945   'data': {'enabled': 'bool', 'migrated': 'bool', '*host': 'str', '*port': 'int',
946            '*tls-port': 'int', '*auth': 'str', '*compiled-version': 'str',
947            'mouse-mode': 'SpiceQueryMouseMode', '*channels': ['SpiceChannel']} }
950 # @query-spice
952 # Returns information about the current SPICE server
954 # Returns: @SpiceInfo
956 # Since: 0.14.0
958 { 'command': 'query-spice', 'returns': 'SpiceInfo' }
961 # @BalloonInfo:
963 # Information about the guest balloon device.
965 # @actual: the number of bytes the balloon currently contains
967 # Since: 0.14.0
970 { 'type': 'BalloonInfo', 'data': {'actual': 'int' } }
973 # @query-balloon:
975 # Return information about the balloon device.
977 # Returns: @BalloonInfo on success
978 #          If the balloon driver is enabled but not functional because the KVM
979 #          kernel module cannot support it, KvmMissingCap
980 #          If no balloon device is present, DeviceNotActive
982 # Since: 0.14.0
984 { 'command': 'query-balloon', 'returns': 'BalloonInfo' }
987 # @PciMemoryRange:
989 # A PCI device memory region
991 # @base: the starting address (guest physical)
993 # @limit: the ending address (guest physical)
995 # Since: 0.14.0
997 { 'type': 'PciMemoryRange', 'data': {'base': 'int', 'limit': 'int'} }
1000 # @PciMemoryRegion
1002 # Information about a PCI device I/O region.
1004 # @bar: the index of the Base Address Register for this region
1006 # @type: 'io' if the region is a PIO region
1007 #        'memory' if the region is a MMIO region
1009 # @prefetch: #optional if @type is 'memory', true if the memory is prefetchable
1011 # @mem_type_64: #optional if @type is 'memory', true if the BAR is 64-bit
1013 # Since: 0.14.0
1015 { 'type': 'PciMemoryRegion',
1016   'data': {'bar': 'int', 'type': 'str', 'address': 'int', 'size': 'int',
1017            '*prefetch': 'bool', '*mem_type_64': 'bool' } }
1020 # @PciBridgeInfo:
1022 # Information about a PCI Bridge device
1024 # @bus.number: primary bus interface number.  This should be the number of the
1025 #              bus the device resides on.
1027 # @bus.secondary: secondary bus interface number.  This is the number of the
1028 #                 main bus for the bridge
1030 # @bus.subordinate: This is the highest number bus that resides below the
1031 #                   bridge.
1033 # @bus.io_range: The PIO range for all devices on this bridge
1035 # @bus.memory_range: The MMIO range for all devices on this bridge
1037 # @bus.prefetchable_range: The range of prefetchable MMIO for all devices on
1038 #                          this bridge
1040 # @devices: a list of @PciDeviceInfo for each device on this bridge
1042 # Since: 0.14.0
1044 { 'type': 'PciBridgeInfo',
1045   'data': {'bus': { 'number': 'int', 'secondary': 'int', 'subordinate': 'int',
1046                     'io_range': 'PciMemoryRange',
1047                     'memory_range': 'PciMemoryRange',
1048                     'prefetchable_range': 'PciMemoryRange' },
1049            '*devices': ['PciDeviceInfo']} }
1052 # @PciDeviceInfo:
1054 # Information about a PCI device
1056 # @bus: the bus number of the device
1058 # @slot: the slot the device is located in
1060 # @function: the function of the slot used by the device
1062 # @class_info.desc: #optional a string description of the device's class
1064 # @class_info.class: the class code of the device
1066 # @id.device: the PCI device id
1068 # @id.vendor: the PCI vendor id
1070 # @irq: #optional if an IRQ is assigned to the device, the IRQ number
1072 # @qdev_id: the device name of the PCI device
1074 # @pci_bridge: if the device is a PCI bridge, the bridge information
1076 # @regions: a list of the PCI I/O regions associated with the device
1078 # Notes: the contents of @class_info.desc are not stable and should only be
1079 #        treated as informational.
1081 # Since: 0.14.0
1083 { 'type': 'PciDeviceInfo',
1084   'data': {'bus': 'int', 'slot': 'int', 'function': 'int',
1085            'class_info': {'*desc': 'str', 'class': 'int'},
1086            'id': {'device': 'int', 'vendor': 'int'},
1087            '*irq': 'int', 'qdev_id': 'str', '*pci_bridge': 'PciBridgeInfo',
1088            'regions': ['PciMemoryRegion']} }
1091 # @PciInfo:
1093 # Information about a PCI bus
1095 # @bus: the bus index
1097 # @devices: a list of devices on this bus
1099 # Since: 0.14.0
1101 { 'type': 'PciInfo', 'data': {'bus': 'int', 'devices': ['PciDeviceInfo']} }
1104 # @query-pci:
1106 # Return information about the PCI bus topology of the guest.
1108 # Returns: a list of @PciInfo for each PCI bus
1110 # Since: 0.14.0
1112 { 'command': 'query-pci', 'returns': ['PciInfo'] }
1115 # @quit:
1117 # This command will cause the QEMU process to exit gracefully.  While every
1118 # attempt is made to send the QMP response before terminating, this is not
1119 # guaranteed.  When using this interface, a premature EOF would not be
1120 # unexpected.
1122 # Since: 0.14.0
1124 { 'command': 'quit' }
1127 # @stop:
1129 # Stop all guest VCPU execution.
1131 # Since:  0.14.0
1133 # Notes:  This function will succeed even if the guest is already in the stopped
1134 #         state.  In "inmigrate" state, it will ensure that the guest
1135 #         remains paused once migration finishes, as if the -S option was
1136 #         passed on the command line.
1138 { 'command': 'stop' }
1141 # @system_reset:
1143 # Performs a hard reset of a guest.
1145 # Since: 0.14.0
1147 { 'command': 'system_reset' }
1150 # @system_powerdown:
1152 # Requests that a guest perform a powerdown operation.
1154 # Since: 0.14.0
1156 # Notes: A guest may or may not respond to this command.  This command
1157 #        returning does not indicate that a guest has accepted the request or
1158 #        that it has shut down.  Many guests will respond to this command by
1159 #        prompting the user in some way.
1161 { 'command': 'system_powerdown' }
1164 # @cpu:
1166 # This command is a nop that is only provided for the purposes of compatibility.
1168 # Since: 0.14.0
1170 # Notes: Do not use this command.
1172 { 'command': 'cpu', 'data': {'index': 'int'} }
1175 # @cpu-add
1177 # Adds CPU with specified ID
1179 # @id: ID of CPU to be created, valid values [0..max_cpus)
1181 # Returns: Nothing on success
1183 # Since 1.5
1185 { 'command': 'cpu-add', 'data': {'id': 'int'} }
1188 # @memsave:
1190 # Save a portion of guest memory to a file.
1192 # @val: the virtual address of the guest to start from
1194 # @size: the size of memory region to save
1196 # @filename: the file to save the memory to as binary data
1198 # @cpu-index: #optional the index of the virtual CPU to use for translating the
1199 #                       virtual address (defaults to CPU 0)
1201 # Returns: Nothing on success
1203 # Since: 0.14.0
1205 # Notes: Errors were not reliably returned until 1.1
1207 { 'command': 'memsave',
1208   'data': {'val': 'int', 'size': 'int', 'filename': 'str', '*cpu-index': 'int'} }
1211 # @pmemsave:
1213 # Save a portion of guest physical memory to a file.
1215 # @val: the physical address of the guest to start from
1217 # @size: the size of memory region to save
1219 # @filename: the file to save the memory to as binary data
1221 # Returns: Nothing on success
1223 # Since: 0.14.0
1225 # Notes: Errors were not reliably returned until 1.1
1227 { 'command': 'pmemsave',
1228   'data': {'val': 'int', 'size': 'int', 'filename': 'str'} }
1231 # @cont:
1233 # Resume guest VCPU execution.
1235 # Since:  0.14.0
1237 # Returns:  If successful, nothing
1238 #           If QEMU was started with an encrypted block device and a key has
1239 #              not yet been set, DeviceEncrypted.
1241 # Notes:  This command will succeed if the guest is currently running.  It
1242 #         will also succeed if the guest is in the "inmigrate" state; in
1243 #         this case, the effect of the command is to make sure the guest
1244 #         starts once migration finishes, removing the effect of the -S
1245 #         command line option if it was passed.
1247 { 'command': 'cont' }
1250 # @system_wakeup:
1252 # Wakeup guest from suspend.  Does nothing in case the guest isn't suspended.
1254 # Since:  1.1
1256 # Returns:  nothing.
1258 { 'command': 'system_wakeup' }
1261 # @inject-nmi:
1263 # Injects a Non-Maskable Interrupt into the default CPU (x86/s390) or all CPUs (ppc64).
1265 # Returns:  If successful, nothing
1267 # Since:  0.14.0
1269 # Note: prior to 2.1, this command was only supported for x86 and s390 VMs
1271 { 'command': 'inject-nmi' }
1274 # @set_link:
1276 # Sets the link status of a virtual network adapter.
1278 # @name: the device name of the virtual network adapter
1280 # @up: true to set the link status to be up
1282 # Returns: Nothing on success
1283 #          If @name is not a valid network device, DeviceNotFound
1285 # Since: 0.14.0
1287 # Notes: Not all network adapters support setting link status.  This command
1288 #        will succeed even if the network adapter does not support link status
1289 #        notification.
1291 { 'command': 'set_link', 'data': {'name': 'str', 'up': 'bool'} }
1294 # @balloon:
1296 # Request the balloon driver to change its balloon size.
1298 # @value: the target size of the balloon in bytes
1300 # Returns: Nothing on success
1301 #          If the balloon driver is enabled but not functional because the KVM
1302 #            kernel module cannot support it, KvmMissingCap
1303 #          If no balloon device is present, DeviceNotActive
1305 # Notes: This command just issues a request to the guest.  When it returns,
1306 #        the balloon size may not have changed.  A guest can change the balloon
1307 #        size independent of this command.
1309 # Since: 0.14.0
1311 { 'command': 'balloon', 'data': {'value': 'int'} }
1314 # @Abort
1316 # This action can be used to test transaction failure.
1318 # Since: 1.6
1320 { 'type': 'Abort',
1321   'data': { } }
1324 # @TransactionAction
1326 # A discriminated record of operations that can be performed with
1327 # @transaction.
1329 # Since 1.1
1331 # drive-backup since 1.6
1332 # abort since 1.6
1333 # blockdev-snapshot-internal-sync since 1.7
1334 # blockdev-backup since 2.3
1336 { 'union': 'TransactionAction',
1337   'data': {
1338        'blockdev-snapshot-sync': 'BlockdevSnapshot',
1339        'drive-backup': 'DriveBackup',
1340        'blockdev-backup': 'BlockdevBackup',
1341        'abort': 'Abort',
1342        'blockdev-snapshot-internal-sync': 'BlockdevSnapshotInternal'
1343    } }
1346 # @transaction
1348 # Executes a number of transactionable QMP commands atomically. If any
1349 # operation fails, then the entire set of actions will be abandoned and the
1350 # appropriate error returned.
1352 #  List of:
1353 #  @TransactionAction: information needed for the respective operation
1355 # Returns: nothing on success
1356 #          Errors depend on the operations of the transaction
1358 # Note: The transaction aborts on the first failure.  Therefore, there will be
1359 # information on only one failed operation returned in an error condition, and
1360 # subsequent actions will not have been attempted.
1362 # Since 1.1
1364 { 'command': 'transaction',
1365   'data': { 'actions': [ 'TransactionAction' ] } }
1368 # @human-monitor-command:
1370 # Execute a command on the human monitor and return the output.
1372 # @command-line: the command to execute in the human monitor
1374 # @cpu-index: #optional The CPU to use for commands that require an implicit CPU
1376 # Returns: the output of the command as a string
1378 # Since: 0.14.0
1380 # Notes: This command only exists as a stop-gap.  Its use is highly
1381 #        discouraged.  The semantics of this command are not guaranteed.
1383 #        Known limitations:
1385 #        o This command is stateless, this means that commands that depend
1386 #          on state information (such as getfd) might not work
1388 #       o Commands that prompt the user for data (eg. 'cont' when the block
1389 #         device is encrypted) don't currently work
1391 { 'command': 'human-monitor-command',
1392   'data': {'command-line': 'str', '*cpu-index': 'int'},
1393   'returns': 'str' }
1396 # @migrate_cancel
1398 # Cancel the current executing migration process.
1400 # Returns: nothing on success
1402 # Notes: This command succeeds even if there is no migration process running.
1404 # Since: 0.14.0
1406 { 'command': 'migrate_cancel' }
1409 # @migrate_set_downtime
1411 # Set maximum tolerated downtime for migration.
1413 # @value: maximum downtime in seconds
1415 # Returns: nothing on success
1417 # Since: 0.14.0
1419 { 'command': 'migrate_set_downtime', 'data': {'value': 'number'} }
1422 # @migrate_set_speed
1424 # Set maximum speed for migration.
1426 # @value: maximum speed in bytes.
1428 # Returns: nothing on success
1430 # Notes: A value lesser than zero will be automatically round up to zero.
1432 # Since: 0.14.0
1434 { 'command': 'migrate_set_speed', 'data': {'value': 'int'} }
1437 # @migrate-set-cache-size
1439 # Set XBZRLE cache size
1441 # @value: cache size in bytes
1443 # The size will be rounded down to the nearest power of 2.
1444 # The cache size can be modified before and during ongoing migration
1446 # Returns: nothing on success
1448 # Since: 1.2
1450 { 'command': 'migrate-set-cache-size', 'data': {'value': 'int'} }
1453 # @query-migrate-cache-size
1455 # query XBZRLE cache size
1457 # Returns: XBZRLE cache size in bytes
1459 # Since: 1.2
1461 { 'command': 'query-migrate-cache-size', 'returns': 'int' }
1464 # @ObjectPropertyInfo:
1466 # @name: the name of the property
1468 # @type: the type of the property.  This will typically come in one of four
1469 #        forms:
1471 #        1) A primitive type such as 'u8', 'u16', 'bool', 'str', or 'double'.
1472 #           These types are mapped to the appropriate JSON type.
1474 #        2) A legacy type in the form 'legacy<subtype>' where subtype is the
1475 #           legacy qdev typename.  These types are always treated as strings.
1477 #        3) A child type in the form 'child<subtype>' where subtype is a qdev
1478 #           device type name.  Child properties create the composition tree.
1480 #        4) A link type in the form 'link<subtype>' where subtype is a qdev
1481 #           device type name.  Link properties form the device model graph.
1483 # Since: 1.2
1485 { 'type': 'ObjectPropertyInfo',
1486   'data': { 'name': 'str', 'type': 'str' } }
1489 # @qom-list:
1491 # This command will list any properties of a object given a path in the object
1492 # model.
1494 # @path: the path within the object model.  See @qom-get for a description of
1495 #        this parameter.
1497 # Returns: a list of @ObjectPropertyInfo that describe the properties of the
1498 #          object.
1500 # Since: 1.2
1502 { 'command': 'qom-list',
1503   'data': { 'path': 'str' },
1504   'returns': [ 'ObjectPropertyInfo' ] }
1507 # @qom-get:
1509 # This command will get a property from a object model path and return the
1510 # value.
1512 # @path: The path within the object model.  There are two forms of supported
1513 #        paths--absolute and partial paths.
1515 #        Absolute paths are derived from the root object and can follow child<>
1516 #        or link<> properties.  Since they can follow link<> properties, they
1517 #        can be arbitrarily long.  Absolute paths look like absolute filenames
1518 #        and are prefixed  with a leading slash.
1520 #        Partial paths look like relative filenames.  They do not begin
1521 #        with a prefix.  The matching rules for partial paths are subtle but
1522 #        designed to make specifying objects easy.  At each level of the
1523 #        composition tree, the partial path is matched as an absolute path.
1524 #        The first match is not returned.  At least two matches are searched
1525 #        for.  A successful result is only returned if only one match is
1526 #        found.  If more than one match is found, a flag is return to
1527 #        indicate that the match was ambiguous.
1529 # @property: The property name to read
1531 # Returns: The property value.  The type depends on the property type.  legacy<>
1532 #          properties are returned as #str.  child<> and link<> properties are
1533 #          returns as #str pathnames.  All integer property types (u8, u16, etc)
1534 #          are returned as #int.
1536 # Since: 1.2
1538 { 'command': 'qom-get',
1539   'data': { 'path': 'str', 'property': 'str' },
1540   'returns': 'visitor',
1541   'gen': 'no' }
1544 # @qom-set:
1546 # This command will set a property from a object model path.
1548 # @path: see @qom-get for a description of this parameter
1550 # @property: the property name to set
1552 # @value: a value who's type is appropriate for the property type.  See @qom-get
1553 #         for a description of type mapping.
1555 # Since: 1.2
1557 { 'command': 'qom-set',
1558   'data': { 'path': 'str', 'property': 'str', 'value': 'visitor' },
1559   'gen': 'no' }
1562 # @set_password:
1564 # Sets the password of a remote display session.
1566 # @protocol: `vnc' to modify the VNC server password
1567 #            `spice' to modify the Spice server password
1569 # @password: the new password
1571 # @connected: #optional how to handle existing clients when changing the
1572 #                       password.  If nothing is specified, defaults to `keep'
1573 #                       `fail' to fail the command if clients are connected
1574 #                       `disconnect' to disconnect existing clients
1575 #                       `keep' to maintain existing clients
1577 # Returns: Nothing on success
1578 #          If Spice is not enabled, DeviceNotFound
1580 # Since: 0.14.0
1582 { 'command': 'set_password',
1583   'data': {'protocol': 'str', 'password': 'str', '*connected': 'str'} }
1586 # @expire_password:
1588 # Expire the password of a remote display server.
1590 # @protocol: the name of the remote display protocol `vnc' or `spice'
1592 # @time: when to expire the password.
1593 #        `now' to expire the password immediately
1594 #        `never' to cancel password expiration
1595 #        `+INT' where INT is the number of seconds from now (integer)
1596 #        `INT' where INT is the absolute time in seconds
1598 # Returns: Nothing on success
1599 #          If @protocol is `spice' and Spice is not active, DeviceNotFound
1601 # Since: 0.14.0
1603 # Notes: Time is relative to the server and currently there is no way to
1604 #        coordinate server time with client time.  It is not recommended to
1605 #        use the absolute time version of the @time parameter unless you're
1606 #        sure you are on the same machine as the QEMU instance.
1608 { 'command': 'expire_password', 'data': {'protocol': 'str', 'time': 'str'} }
1611 # @change-vnc-password:
1613 # Change the VNC server password.
1615 # @password:  the new password to use with VNC authentication
1617 # Since: 1.1
1619 # Notes:  An empty password in this command will set the password to the empty
1620 #         string.  Existing clients are unaffected by executing this command.
1622 { 'command': 'change-vnc-password', 'data': {'password': 'str'} }
1625 # @change:
1627 # This command is multiple commands multiplexed together.
1629 # @device: This is normally the name of a block device but it may also be 'vnc'.
1630 #          when it's 'vnc', then sub command depends on @target
1632 # @target: If @device is a block device, then this is the new filename.
1633 #          If @device is 'vnc', then if the value 'password' selects the vnc
1634 #          change password command.   Otherwise, this specifies a new server URI
1635 #          address to listen to for VNC connections.
1637 # @arg:    If @device is a block device, then this is an optional format to open
1638 #          the device with.
1639 #          If @device is 'vnc' and @target is 'password', this is the new VNC
1640 #          password to set.  If this argument is an empty string, then no future
1641 #          logins will be allowed.
1643 # Returns: Nothing on success.
1644 #          If @device is not a valid block device, DeviceNotFound
1645 #          If the new block device is encrypted, DeviceEncrypted.  Note that
1646 #          if this error is returned, the device has been opened successfully
1647 #          and an additional call to @block_passwd is required to set the
1648 #          device's password.  The behavior of reads and writes to the block
1649 #          device between when these calls are executed is undefined.
1651 # Notes:  It is strongly recommended that this interface is not used especially
1652 #         for changing block devices.
1654 # Since: 0.14.0
1656 { 'command': 'change',
1657   'data': {'device': 'str', 'target': 'str', '*arg': 'str'} }
1660 # @ObjectTypeInfo:
1662 # This structure describes a search result from @qom-list-types
1664 # @name: the type name found in the search
1666 # Since: 1.1
1668 # Notes: This command is experimental and may change syntax in future releases.
1670 { 'type': 'ObjectTypeInfo',
1671   'data': { 'name': 'str' } }
1674 # @qom-list-types:
1676 # This command will return a list of types given search parameters
1678 # @implements: if specified, only return types that implement this type name
1680 # @abstract: if true, include abstract types in the results
1682 # Returns: a list of @ObjectTypeInfo or an empty list if no results are found
1684 # Since: 1.1
1686 { 'command': 'qom-list-types',
1687   'data': { '*implements': 'str', '*abstract': 'bool' },
1688   'returns': [ 'ObjectTypeInfo' ] }
1691 # @DevicePropertyInfo:
1693 # Information about device properties.
1695 # @name: the name of the property
1696 # @type: the typename of the property
1697 # @description: #optional if specified, the description of the property.
1698 #               (since 2.2)
1700 # Since: 1.2
1702 { 'type': 'DevicePropertyInfo',
1703   'data': { 'name': 'str', 'type': 'str', '*description': 'str' } }
1706 # @device-list-properties:
1708 # List properties associated with a device.
1710 # @typename: the type name of a device
1712 # Returns: a list of DevicePropertyInfo describing a devices properties
1714 # Since: 1.2
1716 { 'command': 'device-list-properties',
1717   'data': { 'typename': 'str'},
1718   'returns': [ 'DevicePropertyInfo' ] }
1721 # @migrate
1723 # Migrates the current running guest to another Virtual Machine.
1725 # @uri: the Uniform Resource Identifier of the destination VM
1727 # @blk: #optional do block migration (full disk copy)
1729 # @inc: #optional incremental disk copy migration
1731 # @detach: this argument exists only for compatibility reasons and
1732 #          is ignored by QEMU
1734 # Returns: nothing on success
1736 # Since: 0.14.0
1738 { 'command': 'migrate',
1739   'data': {'uri': 'str', '*blk': 'bool', '*inc': 'bool', '*detach': 'bool' } }
1742 # @migrate-incoming
1744 # Start an incoming migration, the qemu must have been started
1745 # with -incoming defer
1747 # @uri: The Uniform Resource Identifier identifying the source or
1748 #       address to listen on
1750 # Returns: nothing on success
1752 # Since: 2.3
1753 # Note: It's a bad idea to use a string for the uri, but it needs to stay
1754 # compatible with -incoming and the format of the uri is already exposed
1755 # above libvirt
1757 { 'command': 'migrate-incoming', 'data': {'uri': 'str' } }
1759 # @xen-save-devices-state:
1761 # Save the state of all devices to file. The RAM and the block devices
1762 # of the VM are not saved by this command.
1764 # @filename: the file to save the state of the devices to as binary
1765 # data. See xen-save-devices-state.txt for a description of the binary
1766 # format.
1768 # Returns: Nothing on success
1770 # Since: 1.1
1772 { 'command': 'xen-save-devices-state', 'data': {'filename': 'str'} }
1775 # @xen-set-global-dirty-log
1777 # Enable or disable the global dirty log mode.
1779 # @enable: true to enable, false to disable.
1781 # Returns: nothing
1783 # Since: 1.3
1785 { 'command': 'xen-set-global-dirty-log', 'data': { 'enable': 'bool' } }
1788 # @device_del:
1790 # Remove a device from a guest
1792 # @id: the name of the device
1794 # Returns: Nothing on success
1795 #          If @id is not a valid device, DeviceNotFound
1797 # Notes: When this command completes, the device may not be removed from the
1798 #        guest.  Hot removal is an operation that requires guest cooperation.
1799 #        This command merely requests that the guest begin the hot removal
1800 #        process.  Completion of the device removal process is signaled with a
1801 #        DEVICE_DELETED event. Guest reset will automatically complete removal
1802 #        for all devices.
1804 # Since: 0.14.0
1806 { 'command': 'device_del', 'data': {'id': 'str'} }
1809 # @DumpGuestMemoryFormat:
1811 # An enumeration of guest-memory-dump's format.
1813 # @elf: elf format
1815 # @kdump-zlib: kdump-compressed format with zlib-compressed
1817 # @kdump-lzo: kdump-compressed format with lzo-compressed
1819 # @kdump-snappy: kdump-compressed format with snappy-compressed
1821 # Since: 2.0
1823 { 'enum': 'DumpGuestMemoryFormat',
1824   'data': [ 'elf', 'kdump-zlib', 'kdump-lzo', 'kdump-snappy' ] }
1827 # @dump-guest-memory
1829 # Dump guest's memory to vmcore. It is a synchronous operation that can take
1830 # very long depending on the amount of guest memory. This command is only
1831 # supported on i386 and x86_64.
1833 # @paging: if true, do paging to get guest's memory mapping. This allows
1834 #          using gdb to process the core file.
1836 #          IMPORTANT: this option can make QEMU allocate several gigabytes
1837 #                     of RAM. This can happen for a large guest, or a
1838 #                     malicious guest pretending to be large.
1840 #          Also, paging=true has the following limitations:
1842 #             1. The guest may be in a catastrophic state or can have corrupted
1843 #                memory, which cannot be trusted
1844 #             2. The guest can be in real-mode even if paging is enabled. For
1845 #                example, the guest uses ACPI to sleep, and ACPI sleep state
1846 #                goes in real-mode
1848 # @protocol: the filename or file descriptor of the vmcore. The supported
1849 #            protocols are:
1851 #            1. file: the protocol starts with "file:", and the following
1852 #               string is the file's path.
1853 #            2. fd: the protocol starts with "fd:", and the following string
1854 #               is the fd's name.
1856 # @begin: #optional if specified, the starting physical address.
1858 # @length: #optional if specified, the memory size, in bytes. If you don't
1859 #          want to dump all guest's memory, please specify the start @begin
1860 #          and @length
1862 # @format: #optional if specified, the format of guest memory dump. But non-elf
1863 #          format is conflict with paging and filter, ie. @paging, @begin and
1864 #          @length is not allowed to be specified with non-elf @format at the
1865 #          same time (since 2.0)
1867 # Returns: nothing on success
1869 # Since: 1.2
1871 { 'command': 'dump-guest-memory',
1872   'data': { 'paging': 'bool', 'protocol': 'str', '*begin': 'int',
1873             '*length': 'int', '*format': 'DumpGuestMemoryFormat' } }
1876 # @DumpGuestMemoryCapability:
1878 # A list of the available formats for dump-guest-memory
1880 # Since: 2.0
1882 { 'type': 'DumpGuestMemoryCapability',
1883   'data': {
1884       'formats': ['DumpGuestMemoryFormat'] } }
1887 # @query-dump-guest-memory-capability:
1889 # Returns the available formats for dump-guest-memory
1891 # Returns:  A @DumpGuestMemoryCapability object listing available formats for
1892 #           dump-guest-memory
1894 # Since: 2.0
1896 { 'command': 'query-dump-guest-memory-capability',
1897   'returns': 'DumpGuestMemoryCapability' }
1900 # @netdev_add:
1902 # Add a network backend.
1904 # @type: the type of network backend.  Current valid values are 'user', 'tap',
1905 #        'vde', 'socket', 'dump' and 'bridge'
1907 # @id: the name of the new network backend
1909 # @props: #optional a list of properties to be passed to the backend in
1910 #         the format 'name=value', like 'ifname=tap0,script=no'
1912 # Notes: The semantics of @props is not well defined.  Future commands will be
1913 #        introduced that provide stronger typing for backend creation.
1915 # Since: 0.14.0
1917 # Returns: Nothing on success
1918 #          If @type is not a valid network backend, DeviceNotFound
1920 { 'command': 'netdev_add',
1921   'data': {'type': 'str', 'id': 'str', '*props': '**'},
1922   'gen': 'no' }
1925 # @netdev_del:
1927 # Remove a network backend.
1929 # @id: the name of the network backend to remove
1931 # Returns: Nothing on success
1932 #          If @id is not a valid network backend, DeviceNotFound
1934 # Since: 0.14.0
1936 { 'command': 'netdev_del', 'data': {'id': 'str'} }
1939 # @object-add:
1941 # Create a QOM object.
1943 # @qom-type: the class name for the object to be created
1945 # @id: the name of the new object
1947 # @props: #optional a dictionary of properties to be passed to the backend
1949 # Returns: Nothing on success
1950 #          Error if @qom-type is not a valid class name
1952 # Since: 2.0
1954 { 'command': 'object-add',
1955   'data': {'qom-type': 'str', 'id': 'str', '*props': 'dict'},
1956   'gen': 'no' }
1959 # @object-del:
1961 # Remove a QOM object.
1963 # @id: the name of the QOM object to remove
1965 # Returns: Nothing on success
1966 #          Error if @id is not a valid id for a QOM object
1968 # Since: 2.0
1970 { 'command': 'object-del', 'data': {'id': 'str'} }
1973 # @NetdevNoneOptions
1975 # Use it alone to have zero network devices.
1977 # Since 1.2
1979 { 'type': 'NetdevNoneOptions',
1980   'data': { } }
1983 # @NetLegacyNicOptions
1985 # Create a new Network Interface Card.
1987 # @netdev: #optional id of -netdev to connect to
1989 # @macaddr: #optional MAC address
1991 # @model: #optional device model (e1000, rtl8139, virtio etc.)
1993 # @addr: #optional PCI device address
1995 # @vectors: #optional number of MSI-x vectors, 0 to disable MSI-X
1997 # Since 1.2
1999 { 'type': 'NetLegacyNicOptions',
2000   'data': {
2001     '*netdev':  'str',
2002     '*macaddr': 'str',
2003     '*model':   'str',
2004     '*addr':    'str',
2005     '*vectors': 'uint32' } }
2008 # @String
2010 # A fat type wrapping 'str', to be embedded in lists.
2012 # Since 1.2
2014 { 'type': 'String',
2015   'data': {
2016     'str': 'str' } }
2019 # @NetdevUserOptions
2021 # Use the user mode network stack which requires no administrator privilege to
2022 # run.
2024 # @hostname: #optional client hostname reported by the builtin DHCP server
2026 # @restrict: #optional isolate the guest from the host
2028 # @ip: #optional legacy parameter, use net= instead
2030 # @net: #optional IP address and optional netmask
2032 # @host: #optional guest-visible address of the host
2034 # @tftp: #optional root directory of the built-in TFTP server
2036 # @bootfile: #optional BOOTP filename, for use with tftp=
2038 # @dhcpstart: #optional the first of the 16 IPs the built-in DHCP server can
2039 #             assign
2041 # @dns: #optional guest-visible address of the virtual nameserver
2043 # @dnssearch: #optional list of DNS suffixes to search, passed as DHCP option
2044 #             to the guest
2046 # @smb: #optional root directory of the built-in SMB server
2048 # @smbserver: #optional IP address of the built-in SMB server
2050 # @hostfwd: #optional redirect incoming TCP or UDP host connections to guest
2051 #           endpoints
2053 # @guestfwd: #optional forward guest TCP connections
2055 # Since 1.2
2057 { 'type': 'NetdevUserOptions',
2058   'data': {
2059     '*hostname':  'str',
2060     '*restrict':  'bool',
2061     '*ip':        'str',
2062     '*net':       'str',
2063     '*host':      'str',
2064     '*tftp':      'str',
2065     '*bootfile':  'str',
2066     '*dhcpstart': 'str',
2067     '*dns':       'str',
2068     '*dnssearch': ['String'],
2069     '*smb':       'str',
2070     '*smbserver': 'str',
2071     '*hostfwd':   ['String'],
2072     '*guestfwd':  ['String'] } }
2075 # @NetdevTapOptions
2077 # Connect the host TAP network interface name to the VLAN.
2079 # @ifname: #optional interface name
2081 # @fd: #optional file descriptor of an already opened tap
2083 # @fds: #optional multiple file descriptors of already opened multiqueue capable
2084 # tap
2086 # @script: #optional script to initialize the interface
2088 # @downscript: #optional script to shut down the interface
2090 # @helper: #optional command to execute to configure bridge
2092 # @sndbuf: #optional send buffer limit. Understands [TGMKkb] suffixes.
2094 # @vnet_hdr: #optional enable the IFF_VNET_HDR flag on the tap interface
2096 # @vhost: #optional enable vhost-net network accelerator
2098 # @vhostfd: #optional file descriptor of an already opened vhost net device
2100 # @vhostfds: #optional file descriptors of multiple already opened vhost net
2101 # devices
2103 # @vhostforce: #optional vhost on for non-MSIX virtio guests
2105 # @queues: #optional number of queues to be created for multiqueue capable tap
2107 # Since 1.2
2109 { 'type': 'NetdevTapOptions',
2110   'data': {
2111     '*ifname':     'str',
2112     '*fd':         'str',
2113     '*fds':        'str',
2114     '*script':     'str',
2115     '*downscript': 'str',
2116     '*helper':     'str',
2117     '*sndbuf':     'size',
2118     '*vnet_hdr':   'bool',
2119     '*vhost':      'bool',
2120     '*vhostfd':    'str',
2121     '*vhostfds':   'str',
2122     '*vhostforce': 'bool',
2123     '*queues':     'uint32'} }
2126 # @NetdevSocketOptions
2128 # Connect the VLAN to a remote VLAN in another QEMU virtual machine using a TCP
2129 # socket connection.
2131 # @fd: #optional file descriptor of an already opened socket
2133 # @listen: #optional port number, and optional hostname, to listen on
2135 # @connect: #optional port number, and optional hostname, to connect to
2137 # @mcast: #optional UDP multicast address and port number
2139 # @localaddr: #optional source address and port for multicast and udp packets
2141 # @udp: #optional UDP unicast address and port number
2143 # Since 1.2
2145 { 'type': 'NetdevSocketOptions',
2146   'data': {
2147     '*fd':        'str',
2148     '*listen':    'str',
2149     '*connect':   'str',
2150     '*mcast':     'str',
2151     '*localaddr': 'str',
2152     '*udp':       'str' } }
2155 # @NetdevL2TPv3Options
2157 # Connect the VLAN to Ethernet over L2TPv3 Static tunnel
2159 # @src: source address
2161 # @dst: destination address
2163 # @srcport: #optional source port - mandatory for udp, optional for ip
2165 # @dstport: #optional destination port - mandatory for udp, optional for ip
2167 # @ipv6: #optional - force the use of ipv6
2169 # @udp: #optional - use the udp version of l2tpv3 encapsulation
2171 # @cookie64: #optional - use 64 bit coookies
2173 # @counter: #optional have sequence counter
2175 # @pincounter: #optional pin sequence counter to zero -
2176 #              workaround for buggy implementations or
2177 #              networks with packet reorder
2179 # @txcookie: #optional 32 or 64 bit transmit cookie
2181 # @rxcookie: #optional 32 or 64 bit receive cookie
2183 # @txsession: 32 bit transmit session
2185 # @rxsession: #optional 32 bit receive session - if not specified
2186 #             set to the same value as transmit
2188 # @offset: #optional additional offset - allows the insertion of
2189 #          additional application-specific data before the packet payload
2191 # Since 2.1
2193 { 'type': 'NetdevL2TPv3Options',
2194   'data': {
2195     'src':          'str',
2196     'dst':          'str',
2197     '*srcport':     'str',
2198     '*dstport':     'str',
2199     '*ipv6':        'bool',
2200     '*udp':         'bool',
2201     '*cookie64':    'bool',
2202     '*counter':     'bool',
2203     '*pincounter':  'bool',
2204     '*txcookie':    'uint64',
2205     '*rxcookie':    'uint64',
2206     'txsession':    'uint32',
2207     '*rxsession':   'uint32',
2208     '*offset':      'uint32' } }
2211 # @NetdevVdeOptions
2213 # Connect the VLAN to a vde switch running on the host.
2215 # @sock: #optional socket path
2217 # @port: #optional port number
2219 # @group: #optional group owner of socket
2221 # @mode: #optional permissions for socket
2223 # Since 1.2
2225 { 'type': 'NetdevVdeOptions',
2226   'data': {
2227     '*sock':  'str',
2228     '*port':  'uint16',
2229     '*group': 'str',
2230     '*mode':  'uint16' } }
2233 # @NetdevDumpOptions
2235 # Dump VLAN network traffic to a file.
2237 # @len: #optional per-packet size limit (64k default). Understands [TGMKkb]
2238 # suffixes.
2240 # @file: #optional dump file path (default is qemu-vlan0.pcap)
2242 # Since 1.2
2244 { 'type': 'NetdevDumpOptions',
2245   'data': {
2246     '*len':  'size',
2247     '*file': 'str' } }
2250 # @NetdevBridgeOptions
2252 # Connect a host TAP network interface to a host bridge device.
2254 # @br: #optional bridge name
2256 # @helper: #optional command to execute to configure bridge
2258 # Since 1.2
2260 { 'type': 'NetdevBridgeOptions',
2261   'data': {
2262     '*br':     'str',
2263     '*helper': 'str' } }
2266 # @NetdevHubPortOptions
2268 # Connect two or more net clients through a software hub.
2270 # @hubid: hub identifier number
2272 # Since 1.2
2274 { 'type': 'NetdevHubPortOptions',
2275   'data': {
2276     'hubid':     'int32' } }
2279 # @NetdevNetmapOptions
2281 # Connect a client to a netmap-enabled NIC or to a VALE switch port
2283 # @ifname: Either the name of an existing network interface supported by
2284 #          netmap, or the name of a VALE port (created on the fly).
2285 #          A VALE port name is in the form 'valeXXX:YYY', where XXX and
2286 #          YYY are non-negative integers. XXX identifies a switch and
2287 #          YYY identifies a port of the switch. VALE ports having the
2288 #          same XXX are therefore connected to the same switch.
2290 # @devname: #optional path of the netmap device (default: '/dev/netmap').
2292 # Since 2.0
2294 { 'type': 'NetdevNetmapOptions',
2295   'data': {
2296     'ifname':     'str',
2297     '*devname':    'str' } }
2300 # @NetdevVhostUserOptions
2302 # Vhost-user network backend
2304 # @chardev: name of a unix socket chardev
2306 # @vhostforce: #optional vhost on for non-MSIX virtio guests (default: false).
2308 # Since 2.1
2310 { 'type': 'NetdevVhostUserOptions',
2311   'data': {
2312     'chardev':        'str',
2313     '*vhostforce':    'bool' } }
2316 # @NetClientOptions
2318 # A discriminated record of network device traits.
2320 # Since 1.2
2322 # 'l2tpv3' - since 2.1
2325 { 'union': 'NetClientOptions',
2326   'data': {
2327     'none':     'NetdevNoneOptions',
2328     'nic':      'NetLegacyNicOptions',
2329     'user':     'NetdevUserOptions',
2330     'tap':      'NetdevTapOptions',
2331     'l2tpv3':   'NetdevL2TPv3Options',
2332     'socket':   'NetdevSocketOptions',
2333     'vde':      'NetdevVdeOptions',
2334     'dump':     'NetdevDumpOptions',
2335     'bridge':   'NetdevBridgeOptions',
2336     'hubport':  'NetdevHubPortOptions',
2337     'netmap':   'NetdevNetmapOptions',
2338     'vhost-user': 'NetdevVhostUserOptions' } }
2341 # @NetLegacy
2343 # Captures the configuration of a network device; legacy.
2345 # @vlan: #optional vlan number
2347 # @id: #optional identifier for monitor commands
2349 # @name: #optional identifier for monitor commands, ignored if @id is present
2351 # @opts: device type specific properties (legacy)
2353 # Since 1.2
2355 { 'type': 'NetLegacy',
2356   'data': {
2357     '*vlan': 'int32',
2358     '*id':   'str',
2359     '*name': 'str',
2360     'opts':  'NetClientOptions' } }
2363 # @Netdev
2365 # Captures the configuration of a network device.
2367 # @id: identifier for monitor commands.
2369 # @opts: device type specific properties
2371 # Since 1.2
2373 { 'type': 'Netdev',
2374   'data': {
2375     'id':   'str',
2376     'opts': 'NetClientOptions' } }
2379 # @InetSocketAddress
2381 # Captures a socket address or address range in the Internet namespace.
2383 # @host: host part of the address
2385 # @port: port part of the address, or lowest port if @to is present
2387 # @to: highest port to try
2389 # @ipv4: whether to accept IPv4 addresses, default try both IPv4 and IPv6
2390 #        #optional
2392 # @ipv6: whether to accept IPv6 addresses, default try both IPv4 and IPv6
2393 #        #optional
2395 # Since 1.3
2397 { 'type': 'InetSocketAddress',
2398   'data': {
2399     'host': 'str',
2400     'port': 'str',
2401     '*to': 'uint16',
2402     '*ipv4': 'bool',
2403     '*ipv6': 'bool' } }
2406 # @UnixSocketAddress
2408 # Captures a socket address in the local ("Unix socket") namespace.
2410 # @path: filesystem path to use
2412 # Since 1.3
2414 { 'type': 'UnixSocketAddress',
2415   'data': {
2416     'path': 'str' } }
2419 # @SocketAddress
2421 # Captures the address of a socket, which could also be a named file descriptor
2423 # Since 1.3
2425 { 'union': 'SocketAddress',
2426   'data': {
2427     'inet': 'InetSocketAddress',
2428     'unix': 'UnixSocketAddress',
2429     'fd': 'String' } }
2432 # @getfd:
2434 # Receive a file descriptor via SCM rights and assign it a name
2436 # @fdname: file descriptor name
2438 # Returns: Nothing on success
2440 # Since: 0.14.0
2442 # Notes: If @fdname already exists, the file descriptor assigned to
2443 #        it will be closed and replaced by the received file
2444 #        descriptor.
2445 #        The 'closefd' command can be used to explicitly close the
2446 #        file descriptor when it is no longer needed.
2448 { 'command': 'getfd', 'data': {'fdname': 'str'} }
2451 # @closefd:
2453 # Close a file descriptor previously passed via SCM rights
2455 # @fdname: file descriptor name
2457 # Returns: Nothing on success
2459 # Since: 0.14.0
2461 { 'command': 'closefd', 'data': {'fdname': 'str'} }
2464 # @MachineInfo:
2466 # Information describing a machine.
2468 # @name: the name of the machine
2470 # @alias: #optional an alias for the machine name
2472 # @default: #optional whether the machine is default
2474 # @cpu-max: maximum number of CPUs supported by the machine type
2475 #           (since 1.5.0)
2477 # Since: 1.2.0
2479 { 'type': 'MachineInfo',
2480   'data': { 'name': 'str', '*alias': 'str',
2481             '*is-default': 'bool', 'cpu-max': 'int' } }
2484 # @query-machines:
2486 # Return a list of supported machines
2488 # Returns: a list of MachineInfo
2490 # Since: 1.2.0
2492 { 'command': 'query-machines', 'returns': ['MachineInfo'] }
2495 # @CpuDefinitionInfo:
2497 # Virtual CPU definition.
2499 # @name: the name of the CPU definition
2501 # Since: 1.2.0
2503 { 'type': 'CpuDefinitionInfo',
2504   'data': { 'name': 'str' } }
2507 # @query-cpu-definitions:
2509 # Return a list of supported virtual CPU definitions
2511 # Returns: a list of CpuDefInfo
2513 # Since: 1.2.0
2515 { 'command': 'query-cpu-definitions', 'returns': ['CpuDefinitionInfo'] }
2517 # @AddfdInfo:
2519 # Information about a file descriptor that was added to an fd set.
2521 # @fdset-id: The ID of the fd set that @fd was added to.
2523 # @fd: The file descriptor that was received via SCM rights and
2524 #      added to the fd set.
2526 # Since: 1.2.0
2528 { 'type': 'AddfdInfo', 'data': {'fdset-id': 'int', 'fd': 'int'} }
2531 # @add-fd:
2533 # Add a file descriptor, that was passed via SCM rights, to an fd set.
2535 # @fdset-id: #optional The ID of the fd set to add the file descriptor to.
2537 # @opaque: #optional A free-form string that can be used to describe the fd.
2539 # Returns: @AddfdInfo on success
2540 #          If file descriptor was not received, FdNotSupplied
2541 #          If @fdset-id is a negative value, InvalidParameterValue
2543 # Notes: The list of fd sets is shared by all monitor connections.
2545 #        If @fdset-id is not specified, a new fd set will be created.
2547 # Since: 1.2.0
2549 { 'command': 'add-fd', 'data': {'*fdset-id': 'int', '*opaque': 'str'},
2550   'returns': 'AddfdInfo' }
2553 # @remove-fd:
2555 # Remove a file descriptor from an fd set.
2557 # @fdset-id: The ID of the fd set that the file descriptor belongs to.
2559 # @fd: #optional The file descriptor that is to be removed.
2561 # Returns: Nothing on success
2562 #          If @fdset-id or @fd is not found, FdNotFound
2564 # Since: 1.2.0
2566 # Notes: The list of fd sets is shared by all monitor connections.
2568 #        If @fd is not specified, all file descriptors in @fdset-id
2569 #        will be removed.
2571 { 'command': 'remove-fd', 'data': {'fdset-id': 'int', '*fd': 'int'} }
2574 # @FdsetFdInfo:
2576 # Information about a file descriptor that belongs to an fd set.
2578 # @fd: The file descriptor value.
2580 # @opaque: #optional A free-form string that can be used to describe the fd.
2582 # Since: 1.2.0
2584 { 'type': 'FdsetFdInfo',
2585   'data': {'fd': 'int', '*opaque': 'str'} }
2588 # @FdsetInfo:
2590 # Information about an fd set.
2592 # @fdset-id: The ID of the fd set.
2594 # @fds: A list of file descriptors that belong to this fd set.
2596 # Since: 1.2.0
2598 { 'type': 'FdsetInfo',
2599   'data': {'fdset-id': 'int', 'fds': ['FdsetFdInfo']} }
2602 # @query-fdsets:
2604 # Return information describing all fd sets.
2606 # Returns: A list of @FdsetInfo
2608 # Since: 1.2.0
2610 # Note: The list of fd sets is shared by all monitor connections.
2613 { 'command': 'query-fdsets', 'returns': ['FdsetInfo'] }
2616 # @TargetInfo:
2618 # Information describing the QEMU target.
2620 # @arch: the target architecture (eg "x86_64", "i386", etc)
2622 # Since: 1.2.0
2624 { 'type': 'TargetInfo',
2625   'data': { 'arch': 'str' } }
2628 # @query-target:
2630 # Return information about the target for this QEMU
2632 # Returns: TargetInfo
2634 # Since: 1.2.0
2636 { 'command': 'query-target', 'returns': 'TargetInfo' }
2639 # @QKeyCode:
2641 # An enumeration of key name.
2643 # This is used by the send-key command.
2645 # Since: 1.3.0
2647 # 'unmapped' and 'pause' since 2.0
2649 { 'enum': 'QKeyCode',
2650   'data': [ 'unmapped',
2651             'shift', 'shift_r', 'alt', 'alt_r', 'altgr', 'altgr_r', 'ctrl',
2652             'ctrl_r', 'menu', 'esc', '1', '2', '3', '4', '5', '6', '7', '8',
2653             '9', '0', 'minus', 'equal', 'backspace', 'tab', 'q', 'w', 'e',
2654             'r', 't', 'y', 'u', 'i', 'o', 'p', 'bracket_left', 'bracket_right',
2655             'ret', 'a', 's', 'd', 'f', 'g', 'h', 'j', 'k', 'l', 'semicolon',
2656             'apostrophe', 'grave_accent', 'backslash', 'z', 'x', 'c', 'v', 'b',
2657             'n', 'm', 'comma', 'dot', 'slash', 'asterisk', 'spc', 'caps_lock',
2658             'f1', 'f2', 'f3', 'f4', 'f5', 'f6', 'f7', 'f8', 'f9', 'f10',
2659             'num_lock', 'scroll_lock', 'kp_divide', 'kp_multiply',
2660             'kp_subtract', 'kp_add', 'kp_enter', 'kp_decimal', 'sysrq', 'kp_0',
2661             'kp_1', 'kp_2', 'kp_3', 'kp_4', 'kp_5', 'kp_6', 'kp_7', 'kp_8',
2662             'kp_9', 'less', 'f11', 'f12', 'print', 'home', 'pgup', 'pgdn', 'end',
2663             'left', 'up', 'down', 'right', 'insert', 'delete', 'stop', 'again',
2664             'props', 'undo', 'front', 'copy', 'open', 'paste', 'find', 'cut',
2665              'lf', 'help', 'meta_l', 'meta_r', 'compose', 'pause' ] }
2668 # @KeyValue
2670 # Represents a keyboard key.
2672 # Since: 1.3.0
2674 { 'union': 'KeyValue',
2675   'data': {
2676     'number': 'int',
2677     'qcode': 'QKeyCode' } }
2680 # @send-key:
2682 # Send keys to guest.
2684 # @keys: An array of @KeyValue elements. All @KeyValues in this array are
2685 #        simultaneously sent to the guest. A @KeyValue.number value is sent
2686 #        directly to the guest, while @KeyValue.qcode must be a valid
2687 #        @QKeyCode value
2689 # @hold-time: #optional time to delay key up events, milliseconds. Defaults
2690 #             to 100
2692 # Returns: Nothing on success
2693 #          If key is unknown or redundant, InvalidParameter
2695 # Since: 1.3.0
2698 { 'command': 'send-key',
2699   'data': { 'keys': ['KeyValue'], '*hold-time': 'int' } }
2702 # @screendump:
2704 # Write a PPM of the VGA screen to a file.
2706 # @filename: the path of a new PPM file to store the image
2708 # Returns: Nothing on success
2710 # Since: 0.14.0
2712 { 'command': 'screendump', 'data': {'filename': 'str'} }
2715 # @ChardevFile:
2717 # Configuration info for file chardevs.
2719 # @in:  #optional The name of the input file
2720 # @out: The name of the output file
2722 # Since: 1.4
2724 { 'type': 'ChardevFile', 'data': { '*in' : 'str',
2725                                    'out' : 'str' } }
2728 # @ChardevHostdev:
2730 # Configuration info for device and pipe chardevs.
2732 # @device: The name of the special file for the device,
2733 #          i.e. /dev/ttyS0 on Unix or COM1: on Windows
2734 # @type: What kind of device this is.
2736 # Since: 1.4
2738 { 'type': 'ChardevHostdev', 'data': { 'device' : 'str' } }
2741 # @ChardevSocket:
2743 # Configuration info for (stream) socket chardevs.
2745 # @addr: socket address to listen on (server=true)
2746 #        or connect to (server=false)
2747 # @server: #optional create server socket (default: true)
2748 # @wait: #optional wait for incoming connection on server
2749 #        sockets (default: false).
2750 # @nodelay: #optional set TCP_NODELAY socket option (default: false)
2751 # @telnet: #optional enable telnet protocol on server
2752 #          sockets (default: false)
2753 # @reconnect: #optional For a client socket, if a socket is disconnected,
2754 #          then attempt a reconnect after the given number of seconds.
2755 #          Setting this to zero disables this function. (default: 0)
2756 #          (Since: 2.2)
2758 # Since: 1.4
2760 { 'type': 'ChardevSocket', 'data': { 'addr'       : 'SocketAddress',
2761                                      '*server'    : 'bool',
2762                                      '*wait'      : 'bool',
2763                                      '*nodelay'   : 'bool',
2764                                      '*telnet'    : 'bool',
2765                                      '*reconnect' : 'int' } }
2768 # @ChardevUdp:
2770 # Configuration info for datagram socket chardevs.
2772 # @remote: remote address
2773 # @local: #optional local address
2775 # Since: 1.5
2777 { 'type': 'ChardevUdp', 'data': { 'remote' : 'SocketAddress',
2778                                   '*local' : 'SocketAddress' } }
2781 # @ChardevMux:
2783 # Configuration info for mux chardevs.
2785 # @chardev: name of the base chardev.
2787 # Since: 1.5
2789 { 'type': 'ChardevMux', 'data': { 'chardev' : 'str' } }
2792 # @ChardevStdio:
2794 # Configuration info for stdio chardevs.
2796 # @signal: #optional Allow signals (such as SIGINT triggered by ^C)
2797 #          be delivered to qemu.  Default: true in -nographic mode,
2798 #          false otherwise.
2800 # Since: 1.5
2802 { 'type': 'ChardevStdio', 'data': { '*signal' : 'bool' } }
2805 # @ChardevSpiceChannel:
2807 # Configuration info for spice vm channel chardevs.
2809 # @type: kind of channel (for example vdagent).
2811 # Since: 1.5
2813 { 'type': 'ChardevSpiceChannel', 'data': { 'type'  : 'str' } }
2816 # @ChardevSpicePort:
2818 # Configuration info for spice port chardevs.
2820 # @fqdn: name of the channel (see docs/spice-port-fqdn.txt)
2822 # Since: 1.5
2824 { 'type': 'ChardevSpicePort', 'data': { 'fqdn'  : 'str' } }
2827 # @ChardevVC:
2829 # Configuration info for virtual console chardevs.
2831 # @width:  console width,  in pixels
2832 # @height: console height, in pixels
2833 # @cols:   console width,  in chars
2834 # @rows:   console height, in chars
2836 # Since: 1.5
2838 { 'type': 'ChardevVC', 'data': { '*width'  : 'int',
2839                                  '*height' : 'int',
2840                                  '*cols'   : 'int',
2841                                  '*rows'   : 'int' } }
2844 # @ChardevRingbuf:
2846 # Configuration info for ring buffer chardevs.
2848 # @size: #optional ring buffer size, must be power of two, default is 65536
2850 # Since: 1.5
2852 { 'type': 'ChardevRingbuf', 'data': { '*size'  : 'int' } }
2855 # @ChardevBackend:
2857 # Configuration info for the new chardev backend.
2859 # Since: 1.4 (testdev since 2.2)
2861 { 'type': 'ChardevDummy', 'data': { } }
2863 { 'union': 'ChardevBackend', 'data': { 'file'   : 'ChardevFile',
2864                                        'serial' : 'ChardevHostdev',
2865                                        'parallel': 'ChardevHostdev',
2866                                        'pipe'   : 'ChardevHostdev',
2867                                        'socket' : 'ChardevSocket',
2868                                        'udp'    : 'ChardevUdp',
2869                                        'pty'    : 'ChardevDummy',
2870                                        'null'   : 'ChardevDummy',
2871                                        'mux'    : 'ChardevMux',
2872                                        'msmouse': 'ChardevDummy',
2873                                        'braille': 'ChardevDummy',
2874                                        'testdev': 'ChardevDummy',
2875                                        'stdio'  : 'ChardevStdio',
2876                                        'console': 'ChardevDummy',
2877                                        'spicevmc' : 'ChardevSpiceChannel',
2878                                        'spiceport' : 'ChardevSpicePort',
2879                                        'vc'     : 'ChardevVC',
2880                                        'ringbuf': 'ChardevRingbuf',
2881                                        # next one is just for compatibility
2882                                        'memory' : 'ChardevRingbuf' } }
2885 # @ChardevReturn:
2887 # Return info about the chardev backend just created.
2889 # @pty: #optional name of the slave pseudoterminal device, present if
2890 #       and only if a chardev of type 'pty' was created
2892 # Since: 1.4
2894 { 'type' : 'ChardevReturn', 'data': { '*pty' : 'str' } }
2897 # @chardev-add:
2899 # Add a character device backend
2901 # @id: the chardev's ID, must be unique
2902 # @backend: backend type and parameters
2904 # Returns: ChardevReturn.
2906 # Since: 1.4
2908 { 'command': 'chardev-add', 'data': {'id'      : 'str',
2909                                      'backend' : 'ChardevBackend' },
2910   'returns': 'ChardevReturn' }
2913 # @chardev-remove:
2915 # Remove a character device backend
2917 # @id: the chardev's ID, must exist and not be in use
2919 # Returns: Nothing on success
2921 # Since: 1.4
2923 { 'command': 'chardev-remove', 'data': {'id': 'str'} }
2926 # @TpmModel:
2928 # An enumeration of TPM models
2930 # @tpm-tis: TPM TIS model
2932 # Since: 1.5
2934 { 'enum': 'TpmModel', 'data': [ 'tpm-tis' ] }
2937 # @query-tpm-models:
2939 # Return a list of supported TPM models
2941 # Returns: a list of TpmModel
2943 # Since: 1.5
2945 { 'command': 'query-tpm-models', 'returns': ['TpmModel'] }
2948 # @TpmType:
2950 # An enumeration of TPM types
2952 # @passthrough: TPM passthrough type
2954 # Since: 1.5
2956 { 'enum': 'TpmType', 'data': [ 'passthrough' ] }
2959 # @query-tpm-types:
2961 # Return a list of supported TPM types
2963 # Returns: a list of TpmType
2965 # Since: 1.5
2967 { 'command': 'query-tpm-types', 'returns': ['TpmType'] }
2970 # @TPMPassthroughOptions:
2972 # Information about the TPM passthrough type
2974 # @path: #optional string describing the path used for accessing the TPM device
2976 # @cancel-path: #optional string showing the TPM's sysfs cancel file
2977 #               for cancellation of TPM commands while they are executing
2979 # Since: 1.5
2981 { 'type': 'TPMPassthroughOptions', 'data': { '*path' : 'str',
2982                                              '*cancel-path' : 'str'} }
2985 # @TpmTypeOptions:
2987 # A union referencing different TPM backend types' configuration options
2989 # @passthrough: The configuration options for the TPM passthrough type
2991 # Since: 1.5
2993 { 'union': 'TpmTypeOptions',
2994    'data': { 'passthrough' : 'TPMPassthroughOptions' } }
2997 # @TpmInfo:
2999 # Information about the TPM
3001 # @id: The Id of the TPM
3003 # @model: The TPM frontend model
3005 # @options: The TPM (backend) type configuration options
3007 # Since: 1.5
3009 { 'type': 'TPMInfo',
3010   'data': {'id': 'str',
3011            'model': 'TpmModel',
3012            'options': 'TpmTypeOptions' } }
3015 # @query-tpm:
3017 # Return information about the TPM device
3019 # Returns: @TPMInfo on success
3021 # Since: 1.5
3023 { 'command': 'query-tpm', 'returns': ['TPMInfo'] }
3026 # @AcpiTableOptions
3028 # Specify an ACPI table on the command line to load.
3030 # At most one of @file and @data can be specified. The list of files specified
3031 # by any one of them is loaded and concatenated in order. If both are omitted,
3032 # @data is implied.
3034 # Other fields / optargs can be used to override fields of the generic ACPI
3035 # table header; refer to the ACPI specification 5.0, section 5.2.6 System
3036 # Description Table Header. If a header field is not overridden, then the
3037 # corresponding value from the concatenated blob is used (in case of @file), or
3038 # it is filled in with a hard-coded value (in case of @data).
3040 # String fields are copied into the matching ACPI member from lowest address
3041 # upwards, and silently truncated / NUL-padded to length.
3043 # @sig: #optional table signature / identifier (4 bytes)
3045 # @rev: #optional table revision number (dependent on signature, 1 byte)
3047 # @oem_id: #optional OEM identifier (6 bytes)
3049 # @oem_table_id: #optional OEM table identifier (8 bytes)
3051 # @oem_rev: #optional OEM-supplied revision number (4 bytes)
3053 # @asl_compiler_id: #optional identifier of the utility that created the table
3054 #                   (4 bytes)
3056 # @asl_compiler_rev: #optional revision number of the utility that created the
3057 #                    table (4 bytes)
3059 # @file: #optional colon (:) separated list of pathnames to load and
3060 #        concatenate as table data. The resultant binary blob is expected to
3061 #        have an ACPI table header. At least one file is required. This field
3062 #        excludes @data.
3064 # @data: #optional colon (:) separated list of pathnames to load and
3065 #        concatenate as table data. The resultant binary blob must not have an
3066 #        ACPI table header. At least one file is required. This field excludes
3067 #        @file.
3069 # Since 1.5
3071 { 'type': 'AcpiTableOptions',
3072   'data': {
3073     '*sig':               'str',
3074     '*rev':               'uint8',
3075     '*oem_id':            'str',
3076     '*oem_table_id':      'str',
3077     '*oem_rev':           'uint32',
3078     '*asl_compiler_id':   'str',
3079     '*asl_compiler_rev':  'uint32',
3080     '*file':              'str',
3081     '*data':              'str' }}
3084 # @CommandLineParameterType:
3086 # Possible types for an option parameter.
3088 # @string: accepts a character string
3090 # @boolean: accepts "on" or "off"
3092 # @number: accepts a number
3094 # @size: accepts a number followed by an optional suffix (K)ilo,
3095 #        (M)ega, (G)iga, (T)era
3097 # Since 1.5
3099 { 'enum': 'CommandLineParameterType',
3100   'data': ['string', 'boolean', 'number', 'size'] }
3103 # @CommandLineParameterInfo:
3105 # Details about a single parameter of a command line option.
3107 # @name: parameter name
3109 # @type: parameter @CommandLineParameterType
3111 # @help: #optional human readable text string, not suitable for parsing.
3113 # @default: #optional default value string (since 2.1)
3115 # Since 1.5
3117 { 'type': 'CommandLineParameterInfo',
3118   'data': { 'name': 'str',
3119             'type': 'CommandLineParameterType',
3120             '*help': 'str',
3121             '*default': 'str' } }
3124 # @CommandLineOptionInfo:
3126 # Details about a command line option, including its list of parameter details
3128 # @option: option name
3130 # @parameters: an array of @CommandLineParameterInfo
3132 # Since 1.5
3134 { 'type': 'CommandLineOptionInfo',
3135   'data': { 'option': 'str', 'parameters': ['CommandLineParameterInfo'] } }
3138 # @query-command-line-options:
3140 # Query command line option schema.
3142 # @option: #optional option name
3144 # Returns: list of @CommandLineOptionInfo for all options (or for the given
3145 #          @option).  Returns an error if the given @option doesn't exist.
3147 # Since 1.5
3149 {'command': 'query-command-line-options', 'data': { '*option': 'str' },
3150  'returns': ['CommandLineOptionInfo'] }
3153 # @X86CPURegister32
3155 # A X86 32-bit register
3157 # Since: 1.5
3159 { 'enum': 'X86CPURegister32',
3160   'data': [ 'EAX', 'EBX', 'ECX', 'EDX', 'ESP', 'EBP', 'ESI', 'EDI' ] }
3163 # @X86CPUFeatureWordInfo
3165 # Information about a X86 CPU feature word
3167 # @cpuid-input-eax: Input EAX value for CPUID instruction for that feature word
3169 # @cpuid-input-ecx: #optional Input ECX value for CPUID instruction for that
3170 #                   feature word
3172 # @cpuid-register: Output register containing the feature bits
3174 # @features: value of output register, containing the feature bits
3176 # Since: 1.5
3178 { 'type': 'X86CPUFeatureWordInfo',
3179   'data': { 'cpuid-input-eax': 'int',
3180             '*cpuid-input-ecx': 'int',
3181             'cpuid-register': 'X86CPURegister32',
3182             'features': 'int' } }
3185 # @RxState:
3187 # Packets receiving state
3189 # @normal: filter assigned packets according to the mac-table
3191 # @none: don't receive any assigned packet
3193 # @all: receive all assigned packets
3195 # Since: 1.6
3197 { 'enum': 'RxState', 'data': [ 'normal', 'none', 'all' ] }
3200 # @RxFilterInfo:
3202 # Rx-filter information for a NIC.
3204 # @name: net client name
3206 # @promiscuous: whether promiscuous mode is enabled
3208 # @multicast: multicast receive state
3210 # @unicast: unicast receive state
3212 # @vlan: vlan receive state (Since 2.0)
3214 # @broadcast-allowed: whether to receive broadcast
3216 # @multicast-overflow: multicast table is overflowed or not
3218 # @unicast-overflow: unicast table is overflowed or not
3220 # @main-mac: the main macaddr string
3222 # @vlan-table: a list of active vlan id
3224 # @unicast-table: a list of unicast macaddr string
3226 # @multicast-table: a list of multicast macaddr string
3228 # Since 1.6
3231 { 'type': 'RxFilterInfo',
3232   'data': {
3233     'name':               'str',
3234     'promiscuous':        'bool',
3235     'multicast':          'RxState',
3236     'unicast':            'RxState',
3237     'vlan':               'RxState',
3238     'broadcast-allowed':  'bool',
3239     'multicast-overflow': 'bool',
3240     'unicast-overflow':   'bool',
3241     'main-mac':           'str',
3242     'vlan-table':         ['int'],
3243     'unicast-table':      ['str'],
3244     'multicast-table':    ['str'] }}
3247 # @query-rx-filter:
3249 # Return rx-filter information for all NICs (or for the given NIC).
3251 # @name: #optional net client name
3253 # Returns: list of @RxFilterInfo for all NICs (or for the given NIC).
3254 #          Returns an error if the given @name doesn't exist, or given
3255 #          NIC doesn't support rx-filter querying, or given net client
3256 #          isn't a NIC.
3258 # Since: 1.6
3260 { 'command': 'query-rx-filter', 'data': { '*name': 'str' },
3261   'returns': ['RxFilterInfo'] }
3264 # @InputButton
3266 # Button of a pointer input device (mouse, tablet).
3268 # Since: 2.0
3270 { 'enum'  : 'InputButton',
3271   'data'  : [ 'Left', 'Middle', 'Right', 'WheelUp', 'WheelDown' ] }
3274 # @InputButton
3276 # Position axis of a pointer input device (mouse, tablet).
3278 # Since: 2.0
3280 { 'enum'  : 'InputAxis',
3281   'data'  : [ 'X', 'Y' ] }
3284 # @InputKeyEvent
3286 # Keyboard input event.
3288 # @key:    Which key this event is for.
3289 # @down:   True for key-down and false for key-up events.
3291 # Since: 2.0
3293 { 'type'  : 'InputKeyEvent',
3294   'data'  : { 'key'     : 'KeyValue',
3295               'down'    : 'bool' } }
3298 # @InputBtnEvent
3300 # Pointer button input event.
3302 # @button: Which button this event is for.
3303 # @down:   True for key-down and false for key-up events.
3305 # Since: 2.0
3307 { 'type'  : 'InputBtnEvent',
3308   'data'  : { 'button'  : 'InputButton',
3309               'down'    : 'bool' } }
3312 # @InputMoveEvent
3314 # Pointer motion input event.
3316 # @axis:   Which axis is referenced by @value.
3317 # @value:  Pointer position.  For absolute coordinates the
3318 #          valid range is 0 -> 0x7ffff
3320 # Since: 2.0
3322 { 'type'  : 'InputMoveEvent',
3323   'data'  : { 'axis'    : 'InputAxis',
3324               'value'   : 'int' } }
3327 # @InputEvent
3329 # Input event union.
3331 # @key: Input event of Keyboard
3332 # @btn: Input event of pointer buttons
3333 # @rel: Input event of relative pointer motion
3334 # @abs: Input event of absolute pointer motion
3336 # Since: 2.0
3338 { 'union' : 'InputEvent',
3339   'data'  : { 'key'     : 'InputKeyEvent',
3340               'btn'     : 'InputBtnEvent',
3341               'rel'     : 'InputMoveEvent',
3342               'abs'     : 'InputMoveEvent' } }
3345 # @x-input-send-event
3347 # Send input event(s) to guest.
3349 # @console: #optional console to send event(s) to.
3350 #           This parameter can be used to send the input event to
3351 #           specific input devices in case (a) multiple input devices
3352 #           of the same kind are added to the virtual machine and (b)
3353 #           you have configured input routing (see docs/multiseat.txt)
3354 #           for those input devices.  If input routing is not
3355 #           configured this parameter has no effect.
3356 #           If @console is missing, only devices that aren't associated
3357 #           with a console are admissible.
3358 #           If @console is specified, it must exist, and both devices
3359 #           associated with that console and devices not associated with a
3360 #           console are admissible, but the former take precedence.
3363 # @events: List of InputEvent union.
3365 # Returns: Nothing on success.
3367 # Since: 2.2
3369 # Note: this command is experimental, and not a stable API.
3372 { 'command': 'x-input-send-event',
3373   'data': { '*console':'int', 'events': [ 'InputEvent' ] } }
3376 # @NumaOptions
3378 # A discriminated record of NUMA options. (for OptsVisitor)
3380 # Since 2.1
3382 { 'union': 'NumaOptions',
3383   'data': {
3384     'node': 'NumaNodeOptions' }}
3387 # @NumaNodeOptions
3389 # Create a guest NUMA node. (for OptsVisitor)
3391 # @nodeid: #optional NUMA node ID (increase by 1 from 0 if omitted)
3393 # @cpus: #optional VCPUs belonging to this node (assign VCPUS round-robin
3394 #         if omitted)
3396 # @mem: #optional memory size of this node; mutually exclusive with @memdev.
3397 #       Equally divide total memory among nodes if both @mem and @memdev are
3398 #       omitted.
3400 # @memdev: #optional memory backend object.  If specified for one node,
3401 #          it must be specified for all nodes.
3403 # Since: 2.1
3405 { 'type': 'NumaNodeOptions',
3406   'data': {
3407    '*nodeid': 'uint16',
3408    '*cpus':   ['uint16'],
3409    '*mem':    'size',
3410    '*memdev': 'str' }}
3413 # @HostMemPolicy
3415 # Host memory policy types
3417 # @default: restore default policy, remove any nondefault policy
3419 # @preferred: set the preferred host nodes for allocation
3421 # @bind: a strict policy that restricts memory allocation to the
3422 #        host nodes specified
3424 # @interleave: memory allocations are interleaved across the set
3425 #              of host nodes specified
3427 # Since 2.1
3429 { 'enum': 'HostMemPolicy',
3430   'data': [ 'default', 'preferred', 'bind', 'interleave' ] }
3433 # @Memdev:
3435 # Information about memory backend
3437 # @size: memory backend size
3439 # @merge: enables or disables memory merge support
3441 # @dump: includes memory backend's memory in a core dump or not
3443 # @prealloc: enables or disables memory preallocation
3445 # @host-nodes: host nodes for its memory policy
3447 # @policy: memory policy of memory backend
3449 # Since: 2.1
3452 { 'type': 'Memdev',
3453   'data': {
3454     'size':       'size',
3455     'merge':      'bool',
3456     'dump':       'bool',
3457     'prealloc':   'bool',
3458     'host-nodes': ['uint16'],
3459     'policy':     'HostMemPolicy' }}
3462 # @query-memdev:
3464 # Returns information for all memory backends.
3466 # Returns: a list of @Memdev.
3468 # Since: 2.1
3470 { 'command': 'query-memdev', 'returns': ['Memdev'] }
3473 # @PCDIMMDeviceInfo:
3475 # PCDIMMDevice state information
3477 # @id: #optional device's ID
3479 # @addr: physical address, where device is mapped
3481 # @size: size of memory that the device provides
3483 # @slot: slot number at which device is plugged in
3485 # @node: NUMA node number where device is plugged in
3487 # @memdev: memory backend linked with device
3489 # @hotplugged: true if device was hotplugged
3491 # @hotpluggable: true if device if could be added/removed while machine is running
3493 # Since: 2.1
3495 { 'type': 'PCDIMMDeviceInfo',
3496   'data': { '*id': 'str',
3497             'addr': 'int',
3498             'size': 'int',
3499             'slot': 'int',
3500             'node': 'int',
3501             'memdev': 'str',
3502             'hotplugged': 'bool',
3503             'hotpluggable': 'bool'
3504           }
3508 # @MemoryDeviceInfo:
3510 # Union containing information about a memory device
3512 # Since: 2.1
3514 { 'union': 'MemoryDeviceInfo', 'data': {'dimm': 'PCDIMMDeviceInfo'} }
3517 # @query-memory-devices
3519 # Lists available memory devices and their state
3521 # Since: 2.1
3523 { 'command': 'query-memory-devices', 'returns': ['MemoryDeviceInfo'] }
3525 ## @ACPISlotType
3527 # @DIMM: memory slot
3529 { 'enum': 'ACPISlotType', 'data': [ 'DIMM' ] }
3531 ## @ACPIOSTInfo
3533 # OSPM Status Indication for a device
3534 # For description of possible values of @source and @status fields
3535 # see "_OST (OSPM Status Indication)" chapter of ACPI5.0 spec.
3537 # @device: #optional device ID associated with slot
3539 # @slot: slot ID, unique per slot of a given @slot-type
3541 # @slot-type: type of the slot
3543 # @source: an integer containing the source event
3545 # @status: an integer containing the status code
3547 # Since: 2.1
3549 { 'type': 'ACPIOSTInfo',
3550   'data'  : { '*device': 'str',
3551               'slot': 'str',
3552               'slot-type': 'ACPISlotType',
3553               'source': 'int',
3554               'status': 'int' } }
3557 # @query-acpi-ospm-status
3559 # Lists ACPI OSPM status of ACPI device objects,
3560 # which might be reported via _OST method
3562 # Since: 2.1
3564 { 'command': 'query-acpi-ospm-status', 'returns': ['ACPIOSTInfo'] }
3567 # @WatchdogExpirationAction
3569 # An enumeration of the actions taken when the watchdog device's timer is
3570 # expired
3572 # @reset: system resets
3574 # @shutdown: system shutdown, note that it is similar to @powerdown, which
3575 #            tries to set to system status and notify guest
3577 # @poweroff: system poweroff, the emulator program exits
3579 # @pause: system pauses, similar to @stop
3581 # @debug: system enters debug state
3583 # @none: nothing is done
3585 # Since: 2.1
3587 { 'enum': 'WatchdogExpirationAction',
3588   'data': [ 'reset', 'shutdown', 'poweroff', 'pause', 'debug', 'none' ] }
3591 # @IoOperationType
3593 # An enumeration of the I/O operation types
3595 # @read: read operation
3597 # @write: write operation
3599 # Since: 2.1
3601 { 'enum': 'IoOperationType',
3602   'data': [ 'read', 'write' ] }
3605 # @GuestPanicAction
3607 # An enumeration of the actions taken when guest OS panic is detected
3609 # @pause: system pauses
3611 # Since: 2.1
3613 { 'enum': 'GuestPanicAction',
3614   'data': [ 'pause' ] }
3617 # @rtc-reset-reinjection
3619 # This command will reset the RTC interrupt reinjection backlog.
3620 # Can be used if another mechanism to synchronize guest time
3621 # is in effect, for example QEMU guest agent's guest-set-time
3622 # command.
3624 # Since: 2.1
3626 { 'command': 'rtc-reset-reinjection' }