5 # QAPI common definitions
6 { 'include': 'qapi/common.json' }
8 # QAPI crypto definitions
9 { 'include': 'qapi/crypto.json' }
11 # QAPI block definitions
12 { 'include': 'qapi/block.json' }
14 # QAPI event definitions
15 { 'include': 'qapi/event.json' }
18 { 'include': 'qapi/trace.json' }
21 { 'include': 'qapi/introspect.json' }
26 # Policy for handling lost ticks in timer devices.
28 # @discard: throw away the missed tick(s) and continue with future injection
29 # normally. Guest time may be delayed, unless the OS has explicit
30 # handling of lost ticks
32 # @delay: continue to deliver ticks at the normal rate. Guest time will be
33 # delayed due to the late tick
35 # @merge: merge the missed tick(s) into one tick and inject. Guest time
36 # may be delayed, depending on how the OS reacts to the merging
39 # @slew: deliver ticks at a higher rate to catch up with the missed tick. The
40 # guest time should not be delayed once catchup is complete.
44 { 'enum': 'LostTickPolicy',
45 'data': ['discard', 'delay', 'merge', 'slew' ] }
49 # Allow client connections for VNC, Spice and socket based
50 # character devices to be passed in to QEMU via SCM_RIGHTS.
52 # @protocol: protocol name. Valid names are "vnc", "spice" or the
53 # name of a character device (eg. from -chardev id=XXXX)
55 # @fdname: file descriptor name previously passed via 'getfd' command
57 # @skipauth: #optional whether to skip authentication. Only applies
58 # to "vnc" and "spice" protocols
60 # @tls: #optional whether to perform TLS. Only applies to the "spice"
63 # Returns: nothing on success.
67 { 'command': 'add_client',
68 'data': { 'protocol': 'str', 'fdname': 'str', '*skipauth': 'bool',
74 # Guest name information.
76 # @name: #optional The name of the guest
80 { 'struct': 'NameInfo', 'data': {'*name': 'str'} }
85 # Return the name information of a guest.
87 # Returns: @NameInfo of the guest
91 { 'command': 'query-name', 'returns': 'NameInfo' }
96 # Information about support for KVM acceleration
98 # @enabled: true if KVM acceleration is active
100 # @present: true if KVM acceleration is built into this executable
104 { 'struct': 'KvmInfo', 'data': {'enabled': 'bool', 'present': 'bool'} }
109 # Returns information about KVM acceleration
115 { 'command': 'query-kvm', 'returns': 'KvmInfo' }
120 # An enumeration of VM run states.
122 # @debug: QEMU is running on a debugger
124 # @finish-migrate: guest is paused to finish the migration process
126 # @inmigrate: guest is paused waiting for an incoming migration. Note
127 # that this state does not tell whether the machine will start at the
128 # end of the migration. This depends on the command-line -S option and
129 # any invocation of 'stop' or 'cont' that has happened since QEMU was
132 # @internal-error: An internal error that prevents further guest execution
135 # @io-error: the last IOP has failed and the device is configured to pause
138 # @paused: guest has been paused via the 'stop' command
140 # @postmigrate: guest is paused following a successful 'migrate'
142 # @prelaunch: QEMU was started with -S and guest has not started
144 # @restore-vm: guest is paused to restore VM state
146 # @running: guest is actively running
148 # @save-vm: guest is paused to save the VM state
150 # @shutdown: guest is shut down (and -no-shutdown is in use)
152 # @suspended: guest is suspended (ACPI S3)
154 # @watchdog: the watchdog action is configured to pause and has been triggered
156 # @guest-panicked: guest has been panicked as a result of guest OS panic
158 { 'enum': 'RunState',
159 'data': [ 'debug', 'inmigrate', 'internal-error', 'io-error', 'paused',
160 'postmigrate', 'prelaunch', 'finish-migrate', 'restore-vm',
161 'running', 'save-vm', 'shutdown', 'suspended', 'watchdog',
167 # Information about VCPU run state
169 # @running: true if all VCPUs are runnable, false if not runnable
171 # @singlestep: true if VCPUs are in single-step mode
173 # @status: the virtual machine @RunState
177 # Notes: @singlestep is enabled through the GDB stub
179 { 'struct': 'StatusInfo',
180 'data': {'running': 'bool', 'singlestep': 'bool', 'status': 'RunState'} }
185 # Query the run status of all VCPUs
187 # Returns: @StatusInfo reflecting all VCPUs
191 { 'command': 'query-status', 'returns': 'StatusInfo' }
196 # Guest UUID information.
198 # @UUID: the UUID of the guest
202 # Notes: If no UUID was specified for the guest, a null UUID is returned.
204 { 'struct': 'UuidInfo', 'data': {'UUID': 'str'} }
209 # Query the guest UUID information.
211 # Returns: The @UuidInfo for the guest
215 { 'command': 'query-uuid', 'returns': 'UuidInfo' }
220 # Information about a character device.
222 # @label: the label of the character device
224 # @filename: the filename of the character device
226 # @frontend-open: shows whether the frontend device attached to this backend
227 # (eg. with the chardev=... option) is in open or closed state
230 # Notes: @filename is encoded using the QEMU command line character device
231 # encoding. See the QEMU man page for details.
235 { 'struct': 'ChardevInfo', 'data': {'label': 'str',
237 'frontend-open': 'bool'} }
242 # Returns information about current character devices.
244 # Returns: a list of @ChardevInfo
248 { 'command': 'query-chardev', 'returns': ['ChardevInfo'] }
251 # @ChardevBackendInfo:
253 # Information about a character device backend
255 # @name: The backend name
259 { 'struct': 'ChardevBackendInfo', 'data': {'name': 'str'} }
262 # @query-chardev-backends:
264 # Returns information about character device backends.
266 # Returns: a list of @ChardevBackendInfo
270 { 'command': 'query-chardev-backends', 'returns': ['ChardevBackendInfo'] }
275 # An enumeration of data format.
277 # @utf8: Data is a UTF-8 string (RFC 3629)
279 # @base64: Data is Base64 encoded binary (RFC 3548)
283 { 'enum': 'DataFormat',
284 'data': [ 'utf8', 'base64' ] }
289 # Write to a ring buffer character device.
291 # @device: the ring buffer character device name
293 # @data: data to write
295 # @format: #optional data encoding (default 'utf8').
296 # - base64: data must be base64 encoded text. Its binary
297 # decoding gets written.
298 # - utf8: data's UTF-8 encoding is written
299 # - data itself is always Unicode regardless of format, like
302 # Returns: Nothing on success
306 { 'command': 'ringbuf-write',
307 'data': {'device': 'str', 'data': 'str',
308 '*format': 'DataFormat'} }
313 # Read from a ring buffer character device.
315 # @device: the ring buffer character device name
317 # @size: how many bytes to read at most
319 # @format: #optional data encoding (default 'utf8').
320 # - base64: the data read is returned in base64 encoding.
321 # - utf8: the data read is interpreted as UTF-8.
322 # Bug: can screw up when the buffer contains invalid UTF-8
323 # sequences, NUL characters, after the ring buffer lost
324 # data, and when reading stops because the size limit is
326 # - The return value is always Unicode regardless of format,
327 # like any other string.
329 # Returns: data read from the device
333 { 'command': 'ringbuf-read',
334 'data': {'device': 'str', 'size': 'int', '*format': 'DataFormat'},
340 # Information about a QMP event
342 # @name: The event name
346 { 'struct': 'EventInfo', 'data': {'name': 'str'} }
351 # Return a list of supported QMP events by this server
353 # Returns: A list of @EventInfo for all supported events
357 { 'command': 'query-events', 'returns': ['EventInfo'] }
362 # Detailed migration status.
364 # @transferred: amount of bytes already transferred to the target VM
366 # @remaining: amount of bytes remaining to be transferred to the target VM
368 # @total: total amount of bytes involved in the migration process
370 # @duplicate: number of duplicate (zero) pages (since 1.2)
372 # @skipped: number of skipped zero pages (since 1.5)
374 # @normal : number of normal pages (since 1.2)
376 # @normal-bytes: number of normal bytes sent (since 1.2)
378 # @dirty-pages-rate: number of pages dirtied by second by the
381 # @mbps: throughput in megabits/sec. (since 1.6)
383 # @dirty-sync-count: number of times that dirty ram was synchronized (since 2.1)
385 # @postcopy-requests: The number of page requests received from the destination
390 { 'struct': 'MigrationStats',
391 'data': {'transferred': 'int', 'remaining': 'int', 'total': 'int' ,
392 'duplicate': 'int', 'skipped': 'int', 'normal': 'int',
393 'normal-bytes': 'int', 'dirty-pages-rate' : 'int',
394 'mbps' : 'number', 'dirty-sync-count' : 'int',
395 'postcopy-requests' : 'int' } }
400 # Detailed XBZRLE migration cache statistics
402 # @cache-size: XBZRLE cache size
404 # @bytes: amount of bytes already transferred to the target VM
406 # @pages: amount of pages transferred to the target VM
408 # @cache-miss: number of cache miss
410 # @cache-miss-rate: rate of cache miss (since 2.1)
412 # @overflow: number of overflows
416 { 'struct': 'XBZRLECacheStats',
417 'data': {'cache-size': 'int', 'bytes': 'int', 'pages': 'int',
418 'cache-miss': 'int', 'cache-miss-rate': 'number',
419 'overflow': 'int' } }
423 # An enumeration of migration status.
425 # @none: no migration has ever happened.
427 # @setup: migration process has been initiated.
429 # @cancelling: in the process of cancelling migration.
431 # @cancelled: cancelling migration is finished.
433 # @active: in the process of doing migration.
435 # @postcopy-active: like active, but now in postcopy mode. (since 2.5)
437 # @completed: migration is finished.
439 # @failed: some error occurred during migration process.
444 { 'enum': 'MigrationStatus',
445 'data': [ 'none', 'setup', 'cancelling', 'cancelled',
446 'active', 'postcopy-active', 'completed', 'failed' ] }
451 # Information about current migration process.
453 # @status: #optional @MigrationStatus describing the current migration status.
454 # If this field is not returned, no migration process
457 # @ram: #optional @MigrationStats containing detailed migration
458 # status, only returned if status is 'active' or
459 # 'completed'(since 1.2)
461 # @disk: #optional @MigrationStats containing detailed disk migration
462 # status, only returned if status is 'active' and it is a block
465 # @xbzrle-cache: #optional @XBZRLECacheStats containing detailed XBZRLE
466 # migration statistics, only returned if XBZRLE feature is on and
467 # status is 'active' or 'completed' (since 1.2)
469 # @total-time: #optional total amount of milliseconds since migration started.
470 # If migration has ended, it returns the total migration
473 # @downtime: #optional only present when migration finishes correctly
474 # total downtime in milliseconds for the guest.
477 # @expected-downtime: #optional only present while migration is active
478 # expected downtime in milliseconds for the guest in last walk
479 # of the dirty bitmap. (since 1.3)
481 # @setup-time: #optional amount of setup time in milliseconds _before_ the
482 # iterations begin but _after_ the QMP command is issued. This is designed
483 # to provide an accounting of any activities (such as RDMA pinning) which
484 # may be expensive, but do not actually occur during the iterative
485 # migration rounds themselves. (since 1.6)
487 # @cpu-throttle-percentage: #optional percentage of time guest cpus are being
488 # throttled during auto-converge. This is only present when auto-converge
489 # has started throttling guest cpus. (Since 2.7)
491 # @error-desc: #optional the human readable error description string, when
492 # @status is 'failed'. Clients should not attempt to parse the
493 # error strings. (Since 2.7)
497 { 'struct': 'MigrationInfo',
498 'data': {'*status': 'MigrationStatus', '*ram': 'MigrationStats',
499 '*disk': 'MigrationStats',
500 '*xbzrle-cache': 'XBZRLECacheStats',
501 '*total-time': 'int',
502 '*expected-downtime': 'int',
504 '*setup-time': 'int',
505 '*cpu-throttle-percentage': 'int',
506 '*error-desc': 'str'} }
511 # Returns information about current migration process.
513 # Returns: @MigrationInfo
517 { 'command': 'query-migrate', 'returns': 'MigrationInfo' }
520 # @MigrationCapability
522 # Migration capabilities enumeration
524 # @xbzrle: Migration supports xbzrle (Xor Based Zero Run Length Encoding).
525 # This feature allows us to minimize migration traffic for certain work
526 # loads, by sending compressed difference of the pages
528 # @rdma-pin-all: Controls whether or not the entire VM memory footprint is
529 # mlock()'d on demand or all at once. Refer to docs/rdma.txt for usage.
530 # Disabled by default. (since 2.0)
532 # @zero-blocks: During storage migration encode blocks of zeroes efficiently. This
533 # essentially saves 1MB of zeroes per block on the wire. Enabling requires
534 # source and target VM to support this feature. To enable it is sufficient
535 # to enable the capability on the source VM. The feature is disabled by
536 # default. (since 1.6)
538 # @compress: Use multiple compression threads to accelerate live migration.
539 # This feature can help to reduce the migration traffic, by sending
540 # compressed pages. Please note that if compress and xbzrle are both
541 # on, compress only takes effect in the ram bulk stage, after that,
542 # it will be disabled and only xbzrle takes effect, this can help to
543 # minimize migration traffic. The feature is disabled by default.
546 # @events: generate events for each migration state change
549 # @auto-converge: If enabled, QEMU will automatically throttle down the guest
550 # to speed up convergence of RAM migration. (since 1.6)
552 # @postcopy-ram: Start executing on the migration target before all of RAM has
553 # been migrated, pulling the remaining pages along as needed. NOTE: If
554 # the migration fails during postcopy the VM will fail. (since 2.6)
558 { 'enum': 'MigrationCapability',
559 'data': ['xbzrle', 'rdma-pin-all', 'auto-converge', 'zero-blocks',
560 'compress', 'events', 'postcopy-ram'] }
563 # @MigrationCapabilityStatus
565 # Migration capability information
567 # @capability: capability enum
569 # @state: capability state bool
573 { 'struct': 'MigrationCapabilityStatus',
574 'data': { 'capability' : 'MigrationCapability', 'state' : 'bool' } }
577 # @migrate-set-capabilities
579 # Enable/Disable the following migration capabilities (like xbzrle)
581 # @capabilities: json array of capability modifications to make
585 { 'command': 'migrate-set-capabilities',
586 'data': { 'capabilities': ['MigrationCapabilityStatus'] } }
589 # @query-migrate-capabilities
591 # Returns information about the current migration capabilities status
593 # Returns: @MigrationCapabilitiesStatus
597 { 'command': 'query-migrate-capabilities', 'returns': ['MigrationCapabilityStatus']}
599 # @MigrationParameter
601 # Migration parameters enumeration
603 # @compress-level: Set the compression level to be used in live migration,
604 # the compression level is an integer between 0 and 9, where 0 means
605 # no compression, 1 means the best compression speed, and 9 means best
606 # compression ratio which will consume more CPU.
608 # @compress-threads: Set compression thread count to be used in live migration,
609 # the compression thread count is an integer between 1 and 255.
611 # @decompress-threads: Set decompression thread count to be used in live
612 # migration, the decompression thread count is an integer between 1
613 # and 255. Usually, decompression is at least 4 times as fast as
614 # compression, so set the decompress-threads to the number about 1/4
615 # of compress-threads is adequate.
617 # @cpu-throttle-initial: Initial percentage of time guest cpus are throttled
618 # when migration auto-converge is activated. The
619 # default value is 20. (Since 2.7)
621 # @cpu-throttle-increment: throttle percentage increase each time
622 # auto-converge detects that migration is not making
623 # progress. The default value is 10. (Since 2.7)
625 # @tls-creds: ID of the 'tls-creds' object that provides credentials for
626 # establishing a TLS connection over the migration data channel.
627 # On the outgoing side of the migration, the credentials must
628 # be for a 'client' endpoint, while for the incoming side the
629 # credentials must be for a 'server' endpoint. Setting this
630 # will enable TLS for all migrations. The default is unset,
631 # resulting in unsecured migration at the QEMU level. (Since 2.7)
633 # @tls-hostname: hostname of the target host for the migration. This is
634 # required when using x509 based TLS credentials and the
635 # migration URI does not already include a hostname. For
636 # example if using fd: or exec: based migration, the
637 # hostname must be provided so that the server's x509
638 # certificate identity can be validated. (Since 2.7)
642 { 'enum': 'MigrationParameter',
643 'data': ['compress-level', 'compress-threads', 'decompress-threads',
644 'cpu-throttle-initial', 'cpu-throttle-increment',
645 'tls-creds', 'tls-hostname'] }
648 # @migrate-set-parameters
650 # Set the following migration parameters
652 # @compress-level: compression level
654 # @compress-threads: compression thread count
656 # @decompress-threads: decompression thread count
658 # @cpu-throttle-initial: Initial percentage of time guest cpus are throttled
659 # when migration auto-converge is activated. The
660 # default value is 20. (Since 2.7)
662 # @cpu-throttle-increment: throttle percentage increase each time
663 # auto-converge detects that migration is not making
664 # progress. The default value is 10. (Since 2.7)
666 # @tls-creds: ID of the 'tls-creds' object that provides credentials for
667 # establishing a TLS connection over the migration data channel.
668 # On the outgoing side of the migration, the credentials must
669 # be for a 'client' endpoint, while for the incoming side the
670 # credentials must be for a 'server' endpoint. Setting this
671 # will enable TLS for all migrations. The default is unset,
672 # resulting in unsecured migration at the QEMU level. (Since 2.7)
674 # @tls-hostname: hostname of the target host for the migration. This is
675 # required when using x509 based TLS credentials and the
676 # migration URI does not already include a hostname. For
677 # example if using fd: or exec: based migration, the
678 # hostname must be provided so that the server's x509
679 # certificate identity can be validated. (Since 2.7)
683 { 'command': 'migrate-set-parameters',
684 'data': { '*compress-level': 'int',
685 '*compress-threads': 'int',
686 '*decompress-threads': 'int',
687 '*cpu-throttle-initial': 'int',
688 '*cpu-throttle-increment': 'int',
690 '*tls-hostname': 'str'} }
693 # @MigrationParameters
695 # @compress-level: compression level
697 # @compress-threads: compression thread count
699 # @decompress-threads: decompression thread count
701 # @cpu-throttle-initial: Initial percentage of time guest cpus are throttled
702 # when migration auto-converge is activated. The
703 # default value is 20. (Since 2.7)
705 # @cpu-throttle-increment: throttle percentage increase each time
706 # auto-converge detects that migration is not making
707 # progress. The default value is 10. (Since 2.7)
709 # @tls-creds: ID of the 'tls-creds' object that provides credentials for
710 # establishing a TLS connection over the migration data channel.
711 # On the outgoing side of the migration, the credentials must
712 # be for a 'client' endpoint, while for the incoming side the
713 # credentials must be for a 'server' endpoint. Setting this
714 # will enable TLS for all migrations. The default is unset,
715 # resulting in unsecured migration at the QEMU level. (Since 2.7)
717 # @tls-hostname: hostname of the target host for the migration. This is
718 # required when using x509 based TLS credentials and the
719 # migration URI does not already include a hostname. For
720 # example if using fd: or exec: based migration, the
721 # hostname must be provided so that the server's x509
722 # certificate identity can be validated. (Since 2.7)
726 { 'struct': 'MigrationParameters',
727 'data': { 'compress-level': 'int',
728 'compress-threads': 'int',
729 'decompress-threads': 'int',
730 'cpu-throttle-initial': 'int',
731 'cpu-throttle-increment': 'int',
733 'tls-hostname': 'str'} }
735 # @query-migrate-parameters
737 # Returns information about the current migration parameters
739 # Returns: @MigrationParameters
743 { 'command': 'query-migrate-parameters',
744 'returns': 'MigrationParameters' }
747 # @client_migrate_info
749 # Set migration information for remote display. This makes the server
750 # ask the client to automatically reconnect using the new parameters
751 # once migration finished successfully. Only implemented for SPICE.
753 # @protocol: must be "spice"
754 # @hostname: migration target hostname
755 # @port: #optional spice tcp port for plaintext channels
756 # @tls-port: #optional spice tcp port for tls-secured channels
757 # @cert-subject: #optional server certificate subject
761 { 'command': 'client_migrate_info',
762 'data': { 'protocol': 'str', 'hostname': 'str', '*port': 'int',
763 '*tls-port': 'int', '*cert-subject': 'str' } }
766 # @migrate-start-postcopy
768 # Followup to a migration command to switch the migration to postcopy mode.
769 # The postcopy-ram capability must be set before the original migration
773 { 'command': 'migrate-start-postcopy' }
778 # Information about a mouse device.
780 # @name: the name of the mouse device
782 # @index: the index of the mouse device
784 # @current: true if this device is currently receiving mouse events
786 # @absolute: true if this device supports absolute coordinates as input
790 { 'struct': 'MouseInfo',
791 'data': {'name': 'str', 'index': 'int', 'current': 'bool',
792 'absolute': 'bool'} }
797 # Returns information about each active mouse device
799 # Returns: a list of @MouseInfo for each device
803 { 'command': 'query-mice', 'returns': ['MouseInfo'] }
808 # An enumeration of cpu types that enable additional information during
813 { 'enum': 'CpuInfoArch',
814 'data': ['x86', 'sparc', 'ppc', 'mips', 'tricore', 'other' ] }
819 # Information about a virtual CPU
821 # @CPU: the index of the virtual CPU
823 # @current: this only exists for backwards compatibility and should be ignored
825 # @halted: true if the virtual CPU is in the halt state. Halt usually refers
826 # to a processor specific low power mode.
828 # @qom_path: path to the CPU object in the QOM tree (since 2.4)
830 # @thread_id: ID of the underlying host thread
832 # @arch: architecture of the cpu, which determines which additional fields
833 # will be listed (since 2.6)
837 # Notes: @halted is a transient state that changes frequently. By the time the
838 # data is sent to the client, the guest may no longer be halted.
840 { 'union': 'CpuInfo',
841 'base': {'CPU': 'int', 'current': 'bool', 'halted': 'bool',
842 'qom_path': 'str', 'thread_id': 'int', 'arch': 'CpuInfoArch' },
843 'discriminator': 'arch',
844 'data': { 'x86': 'CpuInfoX86',
845 'sparc': 'CpuInfoSPARC',
847 'mips': 'CpuInfoMIPS',
848 'tricore': 'CpuInfoTricore',
849 'other': 'CpuInfoOther' } }
854 # Additional information about a virtual i386 or x86_64 CPU
856 # @pc: the 64-bit instruction pointer
860 { 'struct': 'CpuInfoX86', 'data': { 'pc': 'int' } }
865 # Additional information about a virtual SPARC CPU
867 # @pc: the PC component of the instruction pointer
869 # @npc: the NPC component of the instruction pointer
873 { 'struct': 'CpuInfoSPARC', 'data': { 'pc': 'int', 'npc': 'int' } }
878 # Additional information about a virtual PPC CPU
880 # @nip: the instruction pointer
884 { 'struct': 'CpuInfoPPC', 'data': { 'nip': 'int' } }
889 # Additional information about a virtual MIPS CPU
891 # @PC: the instruction pointer
895 { 'struct': 'CpuInfoMIPS', 'data': { 'PC': 'int' } }
900 # Additional information about a virtual Tricore CPU
902 # @PC: the instruction pointer
906 { 'struct': 'CpuInfoTricore', 'data': { 'PC': 'int' } }
911 # No additional information is available about the virtual CPU
916 { 'struct': 'CpuInfoOther', 'data': { } }
921 # Returns a list of information about each virtual CPU.
923 # Returns: a list of @CpuInfo for each virtual CPU
927 { 'command': 'query-cpus', 'returns': ['CpuInfo'] }
932 # Information about an iothread
934 # @id: the identifier of the iothread
936 # @thread-id: ID of the underlying host thread
940 { 'struct': 'IOThreadInfo',
941 'data': {'id': 'str', 'thread-id': 'int'} }
946 # Returns a list of information about each iothread.
948 # Note this list excludes the QEMU main loop thread, which is not declared
949 # using the -object iothread command-line option. It is always the main thread
952 # Returns: a list of @IOThreadInfo for each iothread
956 { 'command': 'query-iothreads', 'returns': ['IOThreadInfo'] }
959 # @NetworkAddressFamily
961 # The network address family
969 # @unknown: otherwise
973 { 'enum': 'NetworkAddressFamily',
974 'data': [ 'ipv4', 'ipv6', 'unix', 'unknown' ] }
979 # The basic information for vnc network connection
983 # @service: The service name of the vnc port. This may depend on the host
984 # system's service database so symbolic names should not be relied
987 # @family: address family
989 # @websocket: true in case the socket is a websocket (since 2.3).
993 { 'struct': 'VncBasicInfo',
994 'data': { 'host': 'str',
996 'family': 'NetworkAddressFamily',
997 'websocket': 'bool' } }
1002 # The network connection information for server
1004 # @auth: #optional, authentication method
1008 { 'struct': 'VncServerInfo',
1009 'base': 'VncBasicInfo',
1010 'data': { '*auth': 'str' } }
1015 # Information about a connected VNC client.
1017 # @x509_dname: #optional If x509 authentication is in use, the Distinguished
1018 # Name of the client.
1020 # @sasl_username: #optional If SASL authentication is in use, the SASL username
1021 # used for authentication.
1025 { 'struct': 'VncClientInfo',
1026 'base': 'VncBasicInfo',
1027 'data': { '*x509_dname': 'str', '*sasl_username': 'str' } }
1032 # Information about the VNC session.
1034 # @enabled: true if the VNC server is enabled, false otherwise
1036 # @host: #optional The hostname the VNC server is bound to. This depends on
1037 # the name resolution on the host and may be an IP address.
1039 # @family: #optional 'ipv6' if the host is listening for IPv6 connections
1040 # 'ipv4' if the host is listening for IPv4 connections
1041 # 'unix' if the host is listening on a unix domain socket
1042 # 'unknown' otherwise
1044 # @service: #optional The service name of the server's port. This may depends
1045 # on the host system's service database so symbolic names should not
1048 # @auth: #optional the current authentication type used by the server
1049 # 'none' if no authentication is being used
1050 # 'vnc' if VNC authentication is being used
1051 # 'vencrypt+plain' if VEncrypt is used with plain text authentication
1052 # 'vencrypt+tls+none' if VEncrypt is used with TLS and no authentication
1053 # 'vencrypt+tls+vnc' if VEncrypt is used with TLS and VNC authentication
1054 # 'vencrypt+tls+plain' if VEncrypt is used with TLS and plain text auth
1055 # 'vencrypt+x509+none' if VEncrypt is used with x509 and no auth
1056 # 'vencrypt+x509+vnc' if VEncrypt is used with x509 and VNC auth
1057 # 'vencrypt+x509+plain' if VEncrypt is used with x509 and plain text auth
1058 # 'vencrypt+tls+sasl' if VEncrypt is used with TLS and SASL auth
1059 # 'vencrypt+x509+sasl' if VEncrypt is used with x509 and SASL auth
1061 # @clients: a list of @VncClientInfo of all currently connected clients
1065 { 'struct': 'VncInfo',
1066 'data': {'enabled': 'bool', '*host': 'str',
1067 '*family': 'NetworkAddressFamily',
1068 '*service': 'str', '*auth': 'str', '*clients': ['VncClientInfo']} }
1073 # vnc primary authentication method.
1077 { 'enum': 'VncPrimaryAuth',
1078 'data': [ 'none', 'vnc', 'ra2', 'ra2ne', 'tight', 'ultra',
1079 'tls', 'vencrypt', 'sasl' ] }
1082 # @VncVencryptSubAuth:
1084 # vnc sub authentication method with vencrypt.
1088 { 'enum': 'VncVencryptSubAuth',
1090 'tls-none', 'x509-none',
1091 'tls-vnc', 'x509-vnc',
1092 'tls-plain', 'x509-plain',
1093 'tls-sasl', 'x509-sasl' ] }
1098 # Information about a vnc server
1100 # @id: vnc server name.
1102 # @server: A list of @VncBasincInfo describing all listening sockets.
1103 # The list can be empty (in case the vnc server is disabled).
1104 # It also may have multiple entries: normal + websocket,
1105 # possibly also ipv4 + ipv6 in the future.
1107 # @clients: A list of @VncClientInfo of all currently connected clients.
1108 # The list can be empty, for obvious reasons.
1110 # @auth: The current authentication type used by the server
1112 # @vencrypt: #optional The vencrypt sub authentication type used by the server,
1113 # only specified in case auth == vencrypt.
1115 # @display: #optional The display device the vnc server is linked to.
1119 { 'struct': 'VncInfo2',
1120 'data': { 'id' : 'str',
1121 'server' : ['VncBasicInfo'],
1122 'clients' : ['VncClientInfo'],
1123 'auth' : 'VncPrimaryAuth',
1124 '*vencrypt' : 'VncVencryptSubAuth',
1125 '*display' : 'str' } }
1130 # Returns information about the current VNC server
1136 { 'command': 'query-vnc', 'returns': 'VncInfo' }
1139 # @query-vnc-servers:
1141 # Returns a list of vnc servers. The list can be empty.
1143 # Returns: a list of @VncInfo2
1147 { 'command': 'query-vnc-servers', 'returns': ['VncInfo2'] }
1152 # The basic information for SPICE network connection
1156 # @port: port number
1158 # @family: address family
1162 { 'struct': 'SpiceBasicInfo',
1163 'data': { 'host': 'str',
1165 'family': 'NetworkAddressFamily' } }
1170 # Information about a SPICE server
1172 # @auth: #optional, authentication method
1176 { 'struct': 'SpiceServerInfo',
1177 'base': 'SpiceBasicInfo',
1178 'data': { '*auth': 'str' } }
1183 # Information about a SPICE client channel.
1185 # @connection-id: SPICE connection id number. All channels with the same id
1186 # belong to the same SPICE session.
1188 # @channel-type: SPICE channel type number. "1" is the main control
1189 # channel, filter for this one if you want to track spice
1192 # @channel-id: SPICE channel ID number. Usually "0", might be different when
1193 # multiple channels of the same type exist, such as multiple
1194 # display channels in a multihead setup
1196 # @tls: true if the channel is encrypted, false otherwise.
1200 { 'struct': 'SpiceChannel',
1201 'base': 'SpiceBasicInfo',
1202 'data': {'connection-id': 'int', 'channel-type': 'int', 'channel-id': 'int',
1206 # @SpiceQueryMouseMode
1208 # An enumeration of Spice mouse states.
1210 # @client: Mouse cursor position is determined by the client.
1212 # @server: Mouse cursor position is determined by the server.
1214 # @unknown: No information is available about mouse mode used by
1217 # Note: spice/enums.h has a SpiceMouseMode already, hence the name.
1221 { 'enum': 'SpiceQueryMouseMode',
1222 'data': [ 'client', 'server', 'unknown' ] }
1227 # Information about the SPICE session.
1229 # @enabled: true if the SPICE server is enabled, false otherwise
1231 # @migrated: true if the last guest migration completed and spice
1232 # migration had completed as well. false otherwise.
1234 # @host: #optional The hostname the SPICE server is bound to. This depends on
1235 # the name resolution on the host and may be an IP address.
1237 # @port: #optional The SPICE server's port number.
1239 # @compiled-version: #optional SPICE server version.
1241 # @tls-port: #optional The SPICE server's TLS port number.
1243 # @auth: #optional the current authentication type used by the server
1244 # 'none' if no authentication is being used
1245 # 'spice' uses SASL or direct TLS authentication, depending on command
1248 # @mouse-mode: The mode in which the mouse cursor is displayed currently. Can
1249 # be determined by the client or the server, or unknown if spice
1250 # server doesn't provide this information.
1254 # @channels: a list of @SpiceChannel for each active spice channel
1258 { 'struct': 'SpiceInfo',
1259 'data': {'enabled': 'bool', 'migrated': 'bool', '*host': 'str', '*port': 'int',
1260 '*tls-port': 'int', '*auth': 'str', '*compiled-version': 'str',
1261 'mouse-mode': 'SpiceQueryMouseMode', '*channels': ['SpiceChannel']} }
1266 # Returns information about the current SPICE server
1268 # Returns: @SpiceInfo
1272 { 'command': 'query-spice', 'returns': 'SpiceInfo' }
1277 # Information about the guest balloon device.
1279 # @actual: the number of bytes the balloon currently contains
1284 { 'struct': 'BalloonInfo', 'data': {'actual': 'int' } }
1289 # Return information about the balloon device.
1291 # Returns: @BalloonInfo on success
1292 # If the balloon driver is enabled but not functional because the KVM
1293 # kernel module cannot support it, KvmMissingCap
1294 # If no balloon device is present, DeviceNotActive
1298 { 'command': 'query-balloon', 'returns': 'BalloonInfo' }
1303 # A PCI device memory region
1305 # @base: the starting address (guest physical)
1307 # @limit: the ending address (guest physical)
1311 { 'struct': 'PciMemoryRange', 'data': {'base': 'int', 'limit': 'int'} }
1316 # Information about a PCI device I/O region.
1318 # @bar: the index of the Base Address Register for this region
1320 # @type: 'io' if the region is a PIO region
1321 # 'memory' if the region is a MMIO region
1323 # @prefetch: #optional if @type is 'memory', true if the memory is prefetchable
1325 # @mem_type_64: #optional if @type is 'memory', true if the BAR is 64-bit
1329 { 'struct': 'PciMemoryRegion',
1330 'data': {'bar': 'int', 'type': 'str', 'address': 'int', 'size': 'int',
1331 '*prefetch': 'bool', '*mem_type_64': 'bool' } }
1336 # Information about a bus of a PCI Bridge device
1338 # @number: primary bus interface number. This should be the number of the
1339 # bus the device resides on.
1341 # @secondary: secondary bus interface number. This is the number of the
1342 # main bus for the bridge
1344 # @subordinate: This is the highest number bus that resides below the
1347 # @io_range: The PIO range for all devices on this bridge
1349 # @memory_range: The MMIO range for all devices on this bridge
1351 # @prefetchable_range: The range of prefetchable MMIO for all devices on
1356 { 'struct': 'PciBusInfo',
1357 'data': {'number': 'int', 'secondary': 'int', 'subordinate': 'int',
1358 'io_range': 'PciMemoryRange',
1359 'memory_range': 'PciMemoryRange',
1360 'prefetchable_range': 'PciMemoryRange' } }
1365 # Information about a PCI Bridge device
1367 # @bus: information about the bus the device resides on
1369 # @devices: a list of @PciDeviceInfo for each device on this bridge
1373 { 'struct': 'PciBridgeInfo',
1374 'data': {'bus': 'PciBusInfo', '*devices': ['PciDeviceInfo']} }
1379 # Information about the Class of a PCI device
1381 # @desc: #optional a string description of the device's class
1383 # @class: the class code of the device
1387 { 'struct': 'PciDeviceClass',
1388 'data': {'*desc': 'str', 'class': 'int'} }
1393 # Information about the Id of a PCI device
1395 # @device: the PCI device id
1397 # @vendor: the PCI vendor id
1401 { 'struct': 'PciDeviceId',
1402 'data': {'device': 'int', 'vendor': 'int'} }
1407 # Information about a PCI device
1409 # @bus: the bus number of the device
1411 # @slot: the slot the device is located in
1413 # @function: the function of the slot used by the device
1415 # @class_info: the class of the device
1417 # @id: the PCI device id
1419 # @irq: #optional if an IRQ is assigned to the device, the IRQ number
1421 # @qdev_id: the device name of the PCI device
1423 # @pci_bridge: if the device is a PCI bridge, the bridge information
1425 # @regions: a list of the PCI I/O regions associated with the device
1427 # Notes: the contents of @class_info.desc are not stable and should only be
1428 # treated as informational.
1432 { 'struct': 'PciDeviceInfo',
1433 'data': {'bus': 'int', 'slot': 'int', 'function': 'int',
1434 'class_info': 'PciDeviceClass', 'id': 'PciDeviceId',
1435 '*irq': 'int', 'qdev_id': 'str', '*pci_bridge': 'PciBridgeInfo',
1436 'regions': ['PciMemoryRegion']} }
1441 # Information about a PCI bus
1443 # @bus: the bus index
1445 # @devices: a list of devices on this bus
1449 { 'struct': 'PciInfo', 'data': {'bus': 'int', 'devices': ['PciDeviceInfo']} }
1454 # Return information about the PCI bus topology of the guest.
1456 # Returns: a list of @PciInfo for each PCI bus
1460 { 'command': 'query-pci', 'returns': ['PciInfo'] }
1465 # This command will cause the QEMU process to exit gracefully. While every
1466 # attempt is made to send the QMP response before terminating, this is not
1467 # guaranteed. When using this interface, a premature EOF would not be
1472 { 'command': 'quit' }
1477 # Stop all guest VCPU execution.
1481 # Notes: This function will succeed even if the guest is already in the stopped
1482 # state. In "inmigrate" state, it will ensure that the guest
1483 # remains paused once migration finishes, as if the -S option was
1484 # passed on the command line.
1486 { 'command': 'stop' }
1491 # Performs a hard reset of a guest.
1495 { 'command': 'system_reset' }
1498 # @system_powerdown:
1500 # Requests that a guest perform a powerdown operation.
1504 # Notes: A guest may or may not respond to this command. This command
1505 # returning does not indicate that a guest has accepted the request or
1506 # that it has shut down. Many guests will respond to this command by
1507 # prompting the user in some way.
1509 { 'command': 'system_powerdown' }
1514 # This command is a nop that is only provided for the purposes of compatibility.
1518 # Notes: Do not use this command.
1520 { 'command': 'cpu', 'data': {'index': 'int'} }
1525 # Adds CPU with specified ID
1527 # @id: ID of CPU to be created, valid values [0..max_cpus)
1529 # Returns: Nothing on success
1533 { 'command': 'cpu-add', 'data': {'id': 'int'} }
1538 # Save a portion of guest memory to a file.
1540 # @val: the virtual address of the guest to start from
1542 # @size: the size of memory region to save
1544 # @filename: the file to save the memory to as binary data
1546 # @cpu-index: #optional the index of the virtual CPU to use for translating the
1547 # virtual address (defaults to CPU 0)
1549 # Returns: Nothing on success
1553 # Notes: Errors were not reliably returned until 1.1
1555 { 'command': 'memsave',
1556 'data': {'val': 'int', 'size': 'int', 'filename': 'str', '*cpu-index': 'int'} }
1561 # Save a portion of guest physical memory to a file.
1563 # @val: the physical address of the guest to start from
1565 # @size: the size of memory region to save
1567 # @filename: the file to save the memory to as binary data
1569 # Returns: Nothing on success
1573 # Notes: Errors were not reliably returned until 1.1
1575 { 'command': 'pmemsave',
1576 'data': {'val': 'int', 'size': 'int', 'filename': 'str'} }
1581 # Resume guest VCPU execution.
1585 # Returns: If successful, nothing
1586 # If QEMU was started with an encrypted block device and a key has
1587 # not yet been set, DeviceEncrypted.
1589 # Notes: This command will succeed if the guest is currently running. It
1590 # will also succeed if the guest is in the "inmigrate" state; in
1591 # this case, the effect of the command is to make sure the guest
1592 # starts once migration finishes, removing the effect of the -S
1593 # command line option if it was passed.
1595 { 'command': 'cont' }
1600 # Wakeup guest from suspend. Does nothing in case the guest isn't suspended.
1606 { 'command': 'system_wakeup' }
1611 # Injects a Non-Maskable Interrupt into the default CPU (x86/s390) or all CPUs (ppc64).
1613 # Returns: If successful, nothing
1617 # Note: prior to 2.1, this command was only supported for x86 and s390 VMs
1619 { 'command': 'inject-nmi' }
1624 # Sets the link status of a virtual network adapter.
1626 # @name: the device name of the virtual network adapter
1628 # @up: true to set the link status to be up
1630 # Returns: Nothing on success
1631 # If @name is not a valid network device, DeviceNotFound
1635 # Notes: Not all network adapters support setting link status. This command
1636 # will succeed even if the network adapter does not support link status
1639 { 'command': 'set_link', 'data': {'name': 'str', 'up': 'bool'} }
1644 # Gets the link status of a virtual network adapter.
1646 # @name: the device name of the virtual network adapter
1648 # Returns: on|off on success
1649 # If @name is not a valid network device, DeviceNotFound
1653 # Notes: Not all network adapters support setting link status. This command
1654 # will succeed even if the network adapter does not support link status
1658 { 'struct': 'LinkInfo', 'data': {'is_up': 'bool'} }
1659 { 'command': 'get_link', 'data': {'name': 'str'}, 'returns': 'LinkInfo' }
1664 # Request the balloon driver to change its balloon size.
1666 # @value: the target size of the balloon in bytes
1668 # Returns: Nothing on success
1669 # If the balloon driver is enabled but not functional because the KVM
1670 # kernel module cannot support it, KvmMissingCap
1671 # If no balloon device is present, DeviceNotActive
1673 # Notes: This command just issues a request to the guest. When it returns,
1674 # the balloon size may not have changed. A guest can change the balloon
1675 # size independent of this command.
1679 { 'command': 'balloon', 'data': {'value': 'int'} }
1684 # This action can be used to test transaction failure.
1688 { 'struct': 'Abort',
1692 # @ActionCompletionMode
1694 # An enumeration of Transactional completion modes.
1696 # @individual: Do not attempt to cancel any other Actions if any Actions fail
1697 # after the Transaction request succeeds. All Actions that
1698 # can complete successfully will do so without waiting on others.
1699 # This is the default.
1701 # @grouped: If any Action fails after the Transaction succeeds, cancel all
1702 # Actions. Actions do not complete until all Actions are ready to
1703 # complete. May be rejected by Actions that do not support this
1708 { 'enum': 'ActionCompletionMode',
1709 'data': [ 'individual', 'grouped' ] }
1712 # @TransactionAction
1714 # A discriminated record of operations that can be performed with
1719 # drive-backup since 1.6
1721 # blockdev-snapshot-internal-sync since 1.7
1722 # blockdev-backup since 2.3
1723 # blockdev-snapshot since 2.5
1724 # block-dirty-bitmap-add since 2.5
1725 # block-dirty-bitmap-clear since 2.5
1727 { 'union': 'TransactionAction',
1729 'blockdev-snapshot': 'BlockdevSnapshot',
1730 'blockdev-snapshot-sync': 'BlockdevSnapshotSync',
1731 'drive-backup': 'DriveBackup',
1732 'blockdev-backup': 'BlockdevBackup',
1734 'blockdev-snapshot-internal-sync': 'BlockdevSnapshotInternal',
1735 'block-dirty-bitmap-add': 'BlockDirtyBitmapAdd',
1736 'block-dirty-bitmap-clear': 'BlockDirtyBitmap'
1740 # @TransactionProperties
1742 # Optional arguments to modify the behavior of a Transaction.
1744 # @completion-mode: #optional Controls how jobs launched asynchronously by
1745 # Actions will complete or fail as a group.
1746 # See @ActionCompletionMode for details.
1750 { 'struct': 'TransactionProperties',
1752 '*completion-mode': 'ActionCompletionMode'
1759 # Executes a number of transactionable QMP commands atomically. If any
1760 # operation fails, then the entire set of actions will be abandoned and the
1761 # appropriate error returned.
1763 # @actions: List of @TransactionAction;
1764 # information needed for the respective operations.
1766 # @properties: #optional structure of additional options to control the
1767 # execution of the transaction. See @TransactionProperties
1768 # for additional detail.
1770 # Returns: nothing on success
1771 # Errors depend on the operations of the transaction
1773 # Note: The transaction aborts on the first failure. Therefore, there will be
1774 # information on only one failed operation returned in an error condition, and
1775 # subsequent actions will not have been attempted.
1779 { 'command': 'transaction',
1780 'data': { 'actions': [ 'TransactionAction' ],
1781 '*properties': 'TransactionProperties'
1786 # @human-monitor-command:
1788 # Execute a command on the human monitor and return the output.
1790 # @command-line: the command to execute in the human monitor
1792 # @cpu-index: #optional The CPU to use for commands that require an implicit CPU
1794 # Returns: the output of the command as a string
1798 # Notes: This command only exists as a stop-gap. Its use is highly
1799 # discouraged. The semantics of this command are not guaranteed.
1801 # Known limitations:
1803 # o This command is stateless, this means that commands that depend
1804 # on state information (such as getfd) might not work
1806 # o Commands that prompt the user for data (eg. 'cont' when the block
1807 # device is encrypted) don't currently work
1809 { 'command': 'human-monitor-command',
1810 'data': {'command-line': 'str', '*cpu-index': 'int'},
1816 # Cancel the current executing migration process.
1818 # Returns: nothing on success
1820 # Notes: This command succeeds even if there is no migration process running.
1824 { 'command': 'migrate_cancel' }
1827 # @migrate_set_downtime
1829 # Set maximum tolerated downtime for migration.
1831 # @value: maximum downtime in seconds
1833 # Returns: nothing on success
1837 { 'command': 'migrate_set_downtime', 'data': {'value': 'number'} }
1840 # @migrate_set_speed
1842 # Set maximum speed for migration.
1844 # @value: maximum speed in bytes.
1846 # Returns: nothing on success
1848 # Notes: A value lesser than zero will be automatically round up to zero.
1852 { 'command': 'migrate_set_speed', 'data': {'value': 'int'} }
1855 # @migrate-set-cache-size
1857 # Set XBZRLE cache size
1859 # @value: cache size in bytes
1861 # The size will be rounded down to the nearest power of 2.
1862 # The cache size can be modified before and during ongoing migration
1864 # Returns: nothing on success
1868 { 'command': 'migrate-set-cache-size', 'data': {'value': 'int'} }
1871 # @query-migrate-cache-size
1873 # query XBZRLE cache size
1875 # Returns: XBZRLE cache size in bytes
1879 { 'command': 'query-migrate-cache-size', 'returns': 'int' }
1882 # @ObjectPropertyInfo:
1884 # @name: the name of the property
1886 # @type: the type of the property. This will typically come in one of four
1889 # 1) A primitive type such as 'u8', 'u16', 'bool', 'str', or 'double'.
1890 # These types are mapped to the appropriate JSON type.
1892 # 2) A child type in the form 'child<subtype>' where subtype is a qdev
1893 # device type name. Child properties create the composition tree.
1895 # 3) A link type in the form 'link<subtype>' where subtype is a qdev
1896 # device type name. Link properties form the device model graph.
1900 { 'struct': 'ObjectPropertyInfo',
1901 'data': { 'name': 'str', 'type': 'str' } }
1906 # This command will list any properties of a object given a path in the object
1909 # @path: the path within the object model. See @qom-get for a description of
1912 # Returns: a list of @ObjectPropertyInfo that describe the properties of the
1917 { 'command': 'qom-list',
1918 'data': { 'path': 'str' },
1919 'returns': [ 'ObjectPropertyInfo' ] }
1924 # This command will get a property from a object model path and return the
1927 # @path: The path within the object model. There are two forms of supported
1928 # paths--absolute and partial paths.
1930 # Absolute paths are derived from the root object and can follow child<>
1931 # or link<> properties. Since they can follow link<> properties, they
1932 # can be arbitrarily long. Absolute paths look like absolute filenames
1933 # and are prefixed with a leading slash.
1935 # Partial paths look like relative filenames. They do not begin
1936 # with a prefix. The matching rules for partial paths are subtle but
1937 # designed to make specifying objects easy. At each level of the
1938 # composition tree, the partial path is matched as an absolute path.
1939 # The first match is not returned. At least two matches are searched
1940 # for. A successful result is only returned if only one match is
1941 # found. If more than one match is found, a flag is return to
1942 # indicate that the match was ambiguous.
1944 # @property: The property name to read
1946 # Returns: The property value. The type depends on the property
1947 # type. child<> and link<> properties are returned as #str
1948 # pathnames. All integer property types (u8, u16, etc) are
1953 { 'command': 'qom-get',
1954 'data': { 'path': 'str', 'property': 'str' },
1960 # This command will set a property from a object model path.
1962 # @path: see @qom-get for a description of this parameter
1964 # @property: the property name to set
1966 # @value: a value who's type is appropriate for the property type. See @qom-get
1967 # for a description of type mapping.
1971 { 'command': 'qom-set',
1972 'data': { 'path': 'str', 'property': 'str', 'value': 'any' } }
1977 # Sets the password of a remote display session.
1979 # @protocol: `vnc' to modify the VNC server password
1980 # `spice' to modify the Spice server password
1982 # @password: the new password
1984 # @connected: #optional how to handle existing clients when changing the
1985 # password. If nothing is specified, defaults to `keep'
1986 # `fail' to fail the command if clients are connected
1987 # `disconnect' to disconnect existing clients
1988 # `keep' to maintain existing clients
1990 # Returns: Nothing on success
1991 # If Spice is not enabled, DeviceNotFound
1995 { 'command': 'set_password',
1996 'data': {'protocol': 'str', 'password': 'str', '*connected': 'str'} }
2001 # Expire the password of a remote display server.
2003 # @protocol: the name of the remote display protocol `vnc' or `spice'
2005 # @time: when to expire the password.
2006 # `now' to expire the password immediately
2007 # `never' to cancel password expiration
2008 # `+INT' where INT is the number of seconds from now (integer)
2009 # `INT' where INT is the absolute time in seconds
2011 # Returns: Nothing on success
2012 # If @protocol is `spice' and Spice is not active, DeviceNotFound
2016 # Notes: Time is relative to the server and currently there is no way to
2017 # coordinate server time with client time. It is not recommended to
2018 # use the absolute time version of the @time parameter unless you're
2019 # sure you are on the same machine as the QEMU instance.
2021 { 'command': 'expire_password', 'data': {'protocol': 'str', 'time': 'str'} }
2024 # @change-vnc-password:
2026 # Change the VNC server password.
2028 # @password: the new password to use with VNC authentication
2032 # Notes: An empty password in this command will set the password to the empty
2033 # string. Existing clients are unaffected by executing this command.
2035 { 'command': 'change-vnc-password', 'data': {'password': 'str'} }
2040 # This command is multiple commands multiplexed together.
2042 # @device: This is normally the name of a block device but it may also be 'vnc'.
2043 # when it's 'vnc', then sub command depends on @target
2045 # @target: If @device is a block device, then this is the new filename.
2046 # If @device is 'vnc', then if the value 'password' selects the vnc
2047 # change password command. Otherwise, this specifies a new server URI
2048 # address to listen to for VNC connections.
2050 # @arg: If @device is a block device, then this is an optional format to open
2052 # If @device is 'vnc' and @target is 'password', this is the new VNC
2053 # password to set. If this argument is an empty string, then no future
2054 # logins will be allowed.
2056 # Returns: Nothing on success.
2057 # If @device is not a valid block device, DeviceNotFound
2058 # If the new block device is encrypted, DeviceEncrypted. Note that
2059 # if this error is returned, the device has been opened successfully
2060 # and an additional call to @block_passwd is required to set the
2061 # device's password. The behavior of reads and writes to the block
2062 # device between when these calls are executed is undefined.
2064 # Notes: This interface is deprecated, and it is strongly recommended that you
2065 # avoid using it. For changing block devices, use
2066 # blockdev-change-medium; for changing VNC parameters, use
2067 # change-vnc-password.
2071 { 'command': 'change',
2072 'data': {'device': 'str', 'target': 'str', '*arg': 'str'} }
2077 # This structure describes a search result from @qom-list-types
2079 # @name: the type name found in the search
2083 # Notes: This command is experimental and may change syntax in future releases.
2085 { 'struct': 'ObjectTypeInfo',
2086 'data': { 'name': 'str' } }
2091 # This command will return a list of types given search parameters
2093 # @implements: if specified, only return types that implement this type name
2095 # @abstract: if true, include abstract types in the results
2097 # Returns: a list of @ObjectTypeInfo or an empty list if no results are found
2101 { 'command': 'qom-list-types',
2102 'data': { '*implements': 'str', '*abstract': 'bool' },
2103 'returns': [ 'ObjectTypeInfo' ] }
2106 # @DevicePropertyInfo:
2108 # Information about device properties.
2110 # @name: the name of the property
2111 # @type: the typename of the property
2112 # @description: #optional if specified, the description of the property.
2117 { 'struct': 'DevicePropertyInfo',
2118 'data': { 'name': 'str', 'type': 'str', '*description': 'str' } }
2121 # @device-list-properties:
2123 # List properties associated with a device.
2125 # @typename: the type name of a device
2127 # Returns: a list of DevicePropertyInfo describing a devices properties
2131 { 'command': 'device-list-properties',
2132 'data': { 'typename': 'str'},
2133 'returns': [ 'DevicePropertyInfo' ] }
2138 # Migrates the current running guest to another Virtual Machine.
2140 # @uri: the Uniform Resource Identifier of the destination VM
2142 # @blk: #optional do block migration (full disk copy)
2144 # @inc: #optional incremental disk copy migration
2146 # @detach: this argument exists only for compatibility reasons and
2147 # is ignored by QEMU
2149 # Returns: nothing on success
2153 { 'command': 'migrate',
2154 'data': {'uri': 'str', '*blk': 'bool', '*inc': 'bool', '*detach': 'bool' } }
2159 # Start an incoming migration, the qemu must have been started
2160 # with -incoming defer
2162 # @uri: The Uniform Resource Identifier identifying the source or
2163 # address to listen on
2165 # Returns: nothing on success
2168 # Note: It's a bad idea to use a string for the uri, but it needs to stay
2169 # compatible with -incoming and the format of the uri is already exposed
2172 { 'command': 'migrate-incoming', 'data': {'uri': 'str' } }
2174 # @xen-save-devices-state:
2176 # Save the state of all devices to file. The RAM and the block devices
2177 # of the VM are not saved by this command.
2179 # @filename: the file to save the state of the devices to as binary
2180 # data. See xen-save-devices-state.txt for a description of the binary
2183 # Returns: Nothing on success
2187 { 'command': 'xen-save-devices-state', 'data': {'filename': 'str'} }
2190 # @xen-set-global-dirty-log
2192 # Enable or disable the global dirty log mode.
2194 # @enable: true to enable, false to disable.
2200 { 'command': 'xen-set-global-dirty-log', 'data': { 'enable': 'bool' } }
2205 # Remove a device from a guest
2207 # @id: the name or QOM path of the device
2209 # Returns: Nothing on success
2210 # If @id is not a valid device, DeviceNotFound
2212 # Notes: When this command completes, the device may not be removed from the
2213 # guest. Hot removal is an operation that requires guest cooperation.
2214 # This command merely requests that the guest begin the hot removal
2215 # process. Completion of the device removal process is signaled with a
2216 # DEVICE_DELETED event. Guest reset will automatically complete removal
2221 { 'command': 'device_del', 'data': {'id': 'str'} }
2224 # @DumpGuestMemoryFormat:
2226 # An enumeration of guest-memory-dump's format.
2230 # @kdump-zlib: kdump-compressed format with zlib-compressed
2232 # @kdump-lzo: kdump-compressed format with lzo-compressed
2234 # @kdump-snappy: kdump-compressed format with snappy-compressed
2238 { 'enum': 'DumpGuestMemoryFormat',
2239 'data': [ 'elf', 'kdump-zlib', 'kdump-lzo', 'kdump-snappy' ] }
2242 # @dump-guest-memory
2244 # Dump guest's memory to vmcore. It is a synchronous operation that can take
2245 # very long depending on the amount of guest memory.
2247 # @paging: if true, do paging to get guest's memory mapping. This allows
2248 # using gdb to process the core file.
2250 # IMPORTANT: this option can make QEMU allocate several gigabytes
2251 # of RAM. This can happen for a large guest, or a
2252 # malicious guest pretending to be large.
2254 # Also, paging=true has the following limitations:
2256 # 1. The guest may be in a catastrophic state or can have corrupted
2257 # memory, which cannot be trusted
2258 # 2. The guest can be in real-mode even if paging is enabled. For
2259 # example, the guest uses ACPI to sleep, and ACPI sleep state
2261 # 3. Currently only supported on i386 and x86_64.
2263 # @protocol: the filename or file descriptor of the vmcore. The supported
2266 # 1. file: the protocol starts with "file:", and the following
2267 # string is the file's path.
2268 # 2. fd: the protocol starts with "fd:", and the following string
2271 # @detach: #optional if true, QMP will return immediately rather than
2272 # waiting for the dump to finish. The user can track progress
2273 # using "query-dump". (since 2.6).
2275 # @begin: #optional if specified, the starting physical address.
2277 # @length: #optional if specified, the memory size, in bytes. If you don't
2278 # want to dump all guest's memory, please specify the start @begin
2281 # @format: #optional if specified, the format of guest memory dump. But non-elf
2282 # format is conflict with paging and filter, ie. @paging, @begin and
2283 # @length is not allowed to be specified with non-elf @format at the
2284 # same time (since 2.0)
2286 # Returns: nothing on success
2290 { 'command': 'dump-guest-memory',
2291 'data': { 'paging': 'bool', 'protocol': 'str', '*detach': 'bool',
2292 '*begin': 'int', '*length': 'int',
2293 '*format': 'DumpGuestMemoryFormat'} }
2298 # Describe the status of a long-running background guest memory dump.
2300 # @none: no dump-guest-memory has started yet.
2302 # @active: there is one dump running in background.
2304 # @completed: the last dump has finished successfully.
2306 # @failed: the last dump has failed.
2310 { 'enum': 'DumpStatus',
2311 'data': [ 'none', 'active', 'completed', 'failed' ] }
2316 # The result format for 'query-dump'.
2318 # @status: enum of @DumpStatus, which shows current dump status
2320 # @completed: bytes written in latest dump (uncompressed)
2322 # @total: total bytes to be written in latest dump (uncompressed)
2326 { 'struct': 'DumpQueryResult',
2327 'data': { 'status': 'DumpStatus',
2334 # Query latest dump status.
2336 # Returns: A @DumpStatus object showing the dump status.
2340 { 'command': 'query-dump', 'returns': 'DumpQueryResult' }
2343 # @DumpGuestMemoryCapability:
2345 # A list of the available formats for dump-guest-memory
2349 { 'struct': 'DumpGuestMemoryCapability',
2351 'formats': ['DumpGuestMemoryFormat'] } }
2354 # @query-dump-guest-memory-capability:
2356 # Returns the available formats for dump-guest-memory
2358 # Returns: A @DumpGuestMemoryCapability object listing available formats for
2363 { 'command': 'query-dump-guest-memory-capability',
2364 'returns': 'DumpGuestMemoryCapability' }
2369 # Dump guest's storage keys
2371 # @filename: the path to the file to dump to
2373 # This command is only supported on s390 architecture.
2377 { 'command': 'dump-skeys',
2378 'data': { 'filename': 'str' } }
2383 # Add a network backend.
2385 # @type: the type of network backend. Current valid values are 'user', 'tap',
2386 # 'vde', 'socket', 'dump' and 'bridge'
2388 # @id: the name of the new network backend
2390 # Additional arguments depend on the type.
2392 # TODO This command effectively bypasses QAPI completely due to its
2393 # "additional arguments" business. It shouldn't have been added to
2394 # the schema in this form. It should be qapified properly, or
2395 # replaced by a properly qapified command.
2399 # Returns: Nothing on success
2400 # If @type is not a valid network backend, DeviceNotFound
2402 { 'command': 'netdev_add',
2403 'data': {'type': 'str', 'id': 'str'},
2404 'gen': false } # so we can get the additional arguments
2409 # Remove a network backend.
2411 # @id: the name of the network backend to remove
2413 # Returns: Nothing on success
2414 # If @id is not a valid network backend, DeviceNotFound
2418 { 'command': 'netdev_del', 'data': {'id': 'str'} }
2423 # Create a QOM object.
2425 # @qom-type: the class name for the object to be created
2427 # @id: the name of the new object
2429 # @props: #optional a dictionary of properties to be passed to the backend
2431 # Returns: Nothing on success
2432 # Error if @qom-type is not a valid class name
2436 { 'command': 'object-add',
2437 'data': {'qom-type': 'str', 'id': 'str', '*props': 'any'} }
2442 # Remove a QOM object.
2444 # @id: the name of the QOM object to remove
2446 # Returns: Nothing on success
2447 # Error if @id is not a valid id for a QOM object
2451 { 'command': 'object-del', 'data': {'id': 'str'} }
2454 # @NetdevNoneOptions
2456 # Use it alone to have zero network devices.
2460 { 'struct': 'NetdevNoneOptions',
2464 # @NetLegacyNicOptions
2466 # Create a new Network Interface Card.
2468 # @netdev: #optional id of -netdev to connect to
2470 # @macaddr: #optional MAC address
2472 # @model: #optional device model (e1000, rtl8139, virtio etc.)
2474 # @addr: #optional PCI device address
2476 # @vectors: #optional number of MSI-x vectors, 0 to disable MSI-X
2480 { 'struct': 'NetLegacyNicOptions',
2486 '*vectors': 'uint32' } }
2491 # A fat type wrapping 'str', to be embedded in lists.
2495 { 'struct': 'String',
2500 # @NetdevUserOptions
2502 # Use the user mode network stack which requires no administrator privilege to
2505 # @hostname: #optional client hostname reported by the builtin DHCP server
2507 # @restrict: #optional isolate the guest from the host
2509 # @ipv4: #optional whether to support IPv4, default true for enabled
2512 # @ipv6: #optional whether to support IPv6, default true for enabled
2515 # @ip: #optional legacy parameter, use net= instead
2517 # @net: #optional IP network address that the guest will see, in the
2518 # form addr[/netmask] The netmask is optional, and can be
2519 # either in the form a.b.c.d or as a number of valid top-most
2520 # bits. Default is 10.0.2.0/24.
2522 # @host: #optional guest-visible address of the host
2524 # @tftp: #optional root directory of the built-in TFTP server
2526 # @bootfile: #optional BOOTP filename, for use with tftp=
2528 # @dhcpstart: #optional the first of the 16 IPs the built-in DHCP server can
2531 # @dns: #optional guest-visible address of the virtual nameserver
2533 # @dnssearch: #optional list of DNS suffixes to search, passed as DHCP option
2536 # @ipv6-prefix: #optional IPv6 network prefix (default is fec0::) (since
2537 # 2.6). The network prefix is given in the usual
2538 # hexadecimal IPv6 address notation.
2540 # @ipv6-prefixlen: #optional IPv6 network prefix length (default is 64)
2543 # @ipv6-host: #optional guest-visible IPv6 address of the host (since 2.6)
2545 # @ipv6-dns: #optional guest-visible IPv6 address of the virtual
2546 # nameserver (since 2.6)
2548 # @smb: #optional root directory of the built-in SMB server
2550 # @smbserver: #optional IP address of the built-in SMB server
2552 # @hostfwd: #optional redirect incoming TCP or UDP host connections to guest
2555 # @guestfwd: #optional forward guest TCP connections
2559 { 'struct': 'NetdevUserOptions',
2562 '*restrict': 'bool',
2570 '*dhcpstart': 'str',
2572 '*dnssearch': ['String'],
2573 '*ipv6-prefix': 'str',
2574 '*ipv6-prefixlen': 'int',
2575 '*ipv6-host': 'str',
2578 '*smbserver': 'str',
2579 '*hostfwd': ['String'],
2580 '*guestfwd': ['String'] } }
2585 # Connect the host TAP network interface name to the VLAN.
2587 # @ifname: #optional interface name
2589 # @fd: #optional file descriptor of an already opened tap
2591 # @fds: #optional multiple file descriptors of already opened multiqueue capable
2594 # @script: #optional script to initialize the interface
2596 # @downscript: #optional script to shut down the interface
2598 # @helper: #optional command to execute to configure bridge
2600 # @sndbuf: #optional send buffer limit. Understands [TGMKkb] suffixes.
2602 # @vnet_hdr: #optional enable the IFF_VNET_HDR flag on the tap interface
2604 # @vhost: #optional enable vhost-net network accelerator
2606 # @vhostfd: #optional file descriptor of an already opened vhost net device
2608 # @vhostfds: #optional file descriptors of multiple already opened vhost net
2611 # @vhostforce: #optional vhost on for non-MSIX virtio guests
2613 # @queues: #optional number of queues to be created for multiqueue capable tap
2615 # @poll-us: #optional maximum number of microseconds that could
2616 # be spent on busy polling for tap (since 2.7)
2620 { 'struct': 'NetdevTapOptions',
2626 '*downscript': 'str',
2629 '*vnet_hdr': 'bool',
2633 '*vhostforce': 'bool',
2634 '*queues': 'uint32',
2635 '*poll-us': 'uint32'} }
2638 # @NetdevSocketOptions
2640 # Connect the VLAN to a remote VLAN in another QEMU virtual machine using a TCP
2641 # socket connection.
2643 # @fd: #optional file descriptor of an already opened socket
2645 # @listen: #optional port number, and optional hostname, to listen on
2647 # @connect: #optional port number, and optional hostname, to connect to
2649 # @mcast: #optional UDP multicast address and port number
2651 # @localaddr: #optional source address and port for multicast and udp packets
2653 # @udp: #optional UDP unicast address and port number
2657 { 'struct': 'NetdevSocketOptions',
2663 '*localaddr': 'str',
2667 # @NetdevL2TPv3Options
2669 # Connect the VLAN to Ethernet over L2TPv3 Static tunnel
2671 # @src: source address
2673 # @dst: destination address
2675 # @srcport: #optional source port - mandatory for udp, optional for ip
2677 # @dstport: #optional destination port - mandatory for udp, optional for ip
2679 # @ipv6: #optional - force the use of ipv6
2681 # @udp: #optional - use the udp version of l2tpv3 encapsulation
2683 # @cookie64: #optional - use 64 bit coookies
2685 # @counter: #optional have sequence counter
2687 # @pincounter: #optional pin sequence counter to zero -
2688 # workaround for buggy implementations or
2689 # networks with packet reorder
2691 # @txcookie: #optional 32 or 64 bit transmit cookie
2693 # @rxcookie: #optional 32 or 64 bit receive cookie
2695 # @txsession: 32 bit transmit session
2697 # @rxsession: #optional 32 bit receive session - if not specified
2698 # set to the same value as transmit
2700 # @offset: #optional additional offset - allows the insertion of
2701 # additional application-specific data before the packet payload
2705 { 'struct': 'NetdevL2TPv3Options',
2713 '*cookie64': 'bool',
2715 '*pincounter': 'bool',
2716 '*txcookie': 'uint64',
2717 '*rxcookie': 'uint64',
2718 'txsession': 'uint32',
2719 '*rxsession': 'uint32',
2720 '*offset': 'uint32' } }
2725 # Connect the VLAN to a vde switch running on the host.
2727 # @sock: #optional socket path
2729 # @port: #optional port number
2731 # @group: #optional group owner of socket
2733 # @mode: #optional permissions for socket
2737 { 'struct': 'NetdevVdeOptions',
2742 '*mode': 'uint16' } }
2745 # @NetdevDumpOptions
2747 # Dump VLAN network traffic to a file.
2749 # @len: #optional per-packet size limit (64k default). Understands [TGMKkb]
2752 # @file: #optional dump file path (default is qemu-vlan0.pcap)
2756 { 'struct': 'NetdevDumpOptions',
2762 # @NetdevBridgeOptions
2764 # Connect a host TAP network interface to a host bridge device.
2766 # @br: #optional bridge name
2768 # @helper: #optional command to execute to configure bridge
2772 { 'struct': 'NetdevBridgeOptions',
2775 '*helper': 'str' } }
2778 # @NetdevHubPortOptions
2780 # Connect two or more net clients through a software hub.
2782 # @hubid: hub identifier number
2786 { 'struct': 'NetdevHubPortOptions',
2788 'hubid': 'int32' } }
2791 # @NetdevNetmapOptions
2793 # Connect a client to a netmap-enabled NIC or to a VALE switch port
2795 # @ifname: Either the name of an existing network interface supported by
2796 # netmap, or the name of a VALE port (created on the fly).
2797 # A VALE port name is in the form 'valeXXX:YYY', where XXX and
2798 # YYY are non-negative integers. XXX identifies a switch and
2799 # YYY identifies a port of the switch. VALE ports having the
2800 # same XXX are therefore connected to the same switch.
2802 # @devname: #optional path of the netmap device (default: '/dev/netmap').
2806 { 'struct': 'NetdevNetmapOptions',
2809 '*devname': 'str' } }
2812 # @NetdevVhostUserOptions
2814 # Vhost-user network backend
2816 # @chardev: name of a unix socket chardev
2818 # @vhostforce: #optional vhost on for non-MSIX virtio guests (default: false).
2820 # @queues: #optional number of queues to be created for multiqueue vhost-user
2821 # (default: 1) (Since 2.5)
2825 { 'struct': 'NetdevVhostUserOptions',
2828 '*vhostforce': 'bool',
2829 '*queues': 'int' } }
2834 # Available netdev drivers.
2838 { 'enum': 'NetClientDriver',
2839 'data': [ 'none', 'nic', 'user', 'tap', 'l2tpv3', 'socket', 'vde', 'dump',
2840 'bridge', 'hubport', 'netmap', 'vhost-user' ] }
2845 # Captures the configuration of a network device.
2847 # @id: identifier for monitor commands.
2849 # @type: Specify the driver used for interpreting remaining arguments.
2853 # 'l2tpv3' - since 2.1
2855 { 'union': 'Netdev',
2856 'base': { 'id': 'str', 'type': 'NetClientDriver' },
2857 'discriminator': 'type',
2859 'none': 'NetdevNoneOptions',
2860 'nic': 'NetLegacyNicOptions',
2861 'user': 'NetdevUserOptions',
2862 'tap': 'NetdevTapOptions',
2863 'l2tpv3': 'NetdevL2TPv3Options',
2864 'socket': 'NetdevSocketOptions',
2865 'vde': 'NetdevVdeOptions',
2866 'dump': 'NetdevDumpOptions',
2867 'bridge': 'NetdevBridgeOptions',
2868 'hubport': 'NetdevHubPortOptions',
2869 'netmap': 'NetdevNetmapOptions',
2870 'vhost-user': 'NetdevVhostUserOptions' } }
2875 # Captures the configuration of a network device; legacy.
2877 # @vlan: #optional vlan number
2879 # @id: #optional identifier for monitor commands
2881 # @name: #optional identifier for monitor commands, ignored if @id is present
2883 # @opts: device type specific properties (legacy)
2887 { 'struct': 'NetLegacy',
2892 'opts': 'NetLegacyOptions' } }
2897 # Like Netdev, but for use only by the legacy command line options
2901 { 'union': 'NetLegacyOptions',
2903 'none': 'NetdevNoneOptions',
2904 'nic': 'NetLegacyNicOptions',
2905 'user': 'NetdevUserOptions',
2906 'tap': 'NetdevTapOptions',
2907 'l2tpv3': 'NetdevL2TPv3Options',
2908 'socket': 'NetdevSocketOptions',
2909 'vde': 'NetdevVdeOptions',
2910 'dump': 'NetdevDumpOptions',
2911 'bridge': 'NetdevBridgeOptions',
2912 'netmap': 'NetdevNetmapOptions',
2913 'vhost-user': 'NetdevVhostUserOptions' } }
2916 # @NetFilterDirection
2918 # Indicates whether a netfilter is attached to a netdev's transmit queue or
2919 # receive queue or both.
2921 # @all: the filter is attached both to the receive and the transmit
2922 # queue of the netdev (default).
2924 # @rx: the filter is attached to the receive queue of the netdev,
2925 # where it will receive packets sent to the netdev.
2927 # @tx: the filter is attached to the transmit queue of the netdev,
2928 # where it will receive packets sent by the netdev.
2932 { 'enum': 'NetFilterDirection',
2933 'data': [ 'all', 'rx', 'tx' ] }
2936 # @InetSocketAddress
2938 # Captures a socket address or address range in the Internet namespace.
2940 # @host: host part of the address
2942 # @port: port part of the address, or lowest port if @to is present
2944 # @to: highest port to try
2946 # @ipv4: whether to accept IPv4 addresses, default try both IPv4 and IPv6
2949 # @ipv6: whether to accept IPv6 addresses, default try both IPv4 and IPv6
2954 { 'struct': 'InetSocketAddress',
2963 # @UnixSocketAddress
2965 # Captures a socket address in the local ("Unix socket") namespace.
2967 # @path: filesystem path to use
2971 { 'struct': 'UnixSocketAddress',
2978 # Captures the address of a socket, which could also be a named file descriptor
2982 { 'union': 'SocketAddress',
2984 'inet': 'InetSocketAddress',
2985 'unix': 'UnixSocketAddress',
2991 # Receive a file descriptor via SCM rights and assign it a name
2993 # @fdname: file descriptor name
2995 # Returns: Nothing on success
2999 # Notes: If @fdname already exists, the file descriptor assigned to
3000 # it will be closed and replaced by the received file
3002 # The 'closefd' command can be used to explicitly close the
3003 # file descriptor when it is no longer needed.
3005 { 'command': 'getfd', 'data': {'fdname': 'str'} }
3010 # Close a file descriptor previously passed via SCM rights
3012 # @fdname: file descriptor name
3014 # Returns: Nothing on success
3018 { 'command': 'closefd', 'data': {'fdname': 'str'} }
3023 # Information describing a machine.
3025 # @name: the name of the machine
3027 # @alias: #optional an alias for the machine name
3029 # @default: #optional whether the machine is default
3031 # @cpu-max: maximum number of CPUs supported by the machine type
3034 # @hotpluggable-cpus: cpu hotplug via -device is supported (since 2.7.0)
3038 { 'struct': 'MachineInfo',
3039 'data': { 'name': 'str', '*alias': 'str',
3040 '*is-default': 'bool', 'cpu-max': 'int',
3041 'hotpluggable-cpus': 'bool'} }
3046 # Return a list of supported machines
3048 # Returns: a list of MachineInfo
3052 { 'command': 'query-machines', 'returns': ['MachineInfo'] }
3055 # @CpuDefinitionInfo:
3057 # Virtual CPU definition.
3059 # @name: the name of the CPU definition
3063 { 'struct': 'CpuDefinitionInfo',
3064 'data': { 'name': 'str' } }
3067 # @query-cpu-definitions:
3069 # Return a list of supported virtual CPU definitions
3071 # Returns: a list of CpuDefInfo
3075 { 'command': 'query-cpu-definitions', 'returns': ['CpuDefinitionInfo'] }
3079 # Information about a file descriptor that was added to an fd set.
3081 # @fdset-id: The ID of the fd set that @fd was added to.
3083 # @fd: The file descriptor that was received via SCM rights and
3084 # added to the fd set.
3088 { 'struct': 'AddfdInfo', 'data': {'fdset-id': 'int', 'fd': 'int'} }
3093 # Add a file descriptor, that was passed via SCM rights, to an fd set.
3095 # @fdset-id: #optional The ID of the fd set to add the file descriptor to.
3097 # @opaque: #optional A free-form string that can be used to describe the fd.
3099 # Returns: @AddfdInfo on success
3100 # If file descriptor was not received, FdNotSupplied
3101 # If @fdset-id is a negative value, InvalidParameterValue
3103 # Notes: The list of fd sets is shared by all monitor connections.
3105 # If @fdset-id is not specified, a new fd set will be created.
3109 { 'command': 'add-fd', 'data': {'*fdset-id': 'int', '*opaque': 'str'},
3110 'returns': 'AddfdInfo' }
3115 # Remove a file descriptor from an fd set.
3117 # @fdset-id: The ID of the fd set that the file descriptor belongs to.
3119 # @fd: #optional The file descriptor that is to be removed.
3121 # Returns: Nothing on success
3122 # If @fdset-id or @fd is not found, FdNotFound
3126 # Notes: The list of fd sets is shared by all monitor connections.
3128 # If @fd is not specified, all file descriptors in @fdset-id
3131 { 'command': 'remove-fd', 'data': {'fdset-id': 'int', '*fd': 'int'} }
3136 # Information about a file descriptor that belongs to an fd set.
3138 # @fd: The file descriptor value.
3140 # @opaque: #optional A free-form string that can be used to describe the fd.
3144 { 'struct': 'FdsetFdInfo',
3145 'data': {'fd': 'int', '*opaque': 'str'} }
3150 # Information about an fd set.
3152 # @fdset-id: The ID of the fd set.
3154 # @fds: A list of file descriptors that belong to this fd set.
3158 { 'struct': 'FdsetInfo',
3159 'data': {'fdset-id': 'int', 'fds': ['FdsetFdInfo']} }
3164 # Return information describing all fd sets.
3166 # Returns: A list of @FdsetInfo
3170 # Note: The list of fd sets is shared by all monitor connections.
3173 { 'command': 'query-fdsets', 'returns': ['FdsetInfo'] }
3178 # Information describing the QEMU target.
3180 # @arch: the target architecture (eg "x86_64", "i386", etc)
3184 { 'struct': 'TargetInfo',
3185 'data': { 'arch': 'str' } }
3190 # Return information about the target for this QEMU
3192 # Returns: TargetInfo
3196 { 'command': 'query-target', 'returns': 'TargetInfo' }
3201 # An enumeration of key name.
3203 # This is used by the send-key command.
3207 # 'unmapped' and 'pause' since 2.0
3208 # 'ro' and 'kp_comma' since 2.4
3209 # 'kp_equals' and 'power' since 2.6
3211 { 'enum': 'QKeyCode',
3212 'data': [ 'unmapped',
3213 'shift', 'shift_r', 'alt', 'alt_r', 'altgr', 'altgr_r', 'ctrl',
3214 'ctrl_r', 'menu', 'esc', '1', '2', '3', '4', '5', '6', '7', '8',
3215 '9', '0', 'minus', 'equal', 'backspace', 'tab', 'q', 'w', 'e',
3216 'r', 't', 'y', 'u', 'i', 'o', 'p', 'bracket_left', 'bracket_right',
3217 'ret', 'a', 's', 'd', 'f', 'g', 'h', 'j', 'k', 'l', 'semicolon',
3218 'apostrophe', 'grave_accent', 'backslash', 'z', 'x', 'c', 'v', 'b',
3219 'n', 'm', 'comma', 'dot', 'slash', 'asterisk', 'spc', 'caps_lock',
3220 'f1', 'f2', 'f3', 'f4', 'f5', 'f6', 'f7', 'f8', 'f9', 'f10',
3221 'num_lock', 'scroll_lock', 'kp_divide', 'kp_multiply',
3222 'kp_subtract', 'kp_add', 'kp_enter', 'kp_decimal', 'sysrq', 'kp_0',
3223 'kp_1', 'kp_2', 'kp_3', 'kp_4', 'kp_5', 'kp_6', 'kp_7', 'kp_8',
3224 'kp_9', 'less', 'f11', 'f12', 'print', 'home', 'pgup', 'pgdn', 'end',
3225 'left', 'up', 'down', 'right', 'insert', 'delete', 'stop', 'again',
3226 'props', 'undo', 'front', 'copy', 'open', 'paste', 'find', 'cut',
3227 'lf', 'help', 'meta_l', 'meta_r', 'compose', 'pause', 'ro',
3228 'kp_comma', 'kp_equals', 'power' ] }
3233 # Represents a keyboard key.
3237 { 'union': 'KeyValue',
3240 'qcode': 'QKeyCode' } }
3245 # Send keys to guest.
3247 # @keys: An array of @KeyValue elements. All @KeyValues in this array are
3248 # simultaneously sent to the guest. A @KeyValue.number value is sent
3249 # directly to the guest, while @KeyValue.qcode must be a valid
3252 # @hold-time: #optional time to delay key up events, milliseconds. Defaults
3255 # Returns: Nothing on success
3256 # If key is unknown or redundant, InvalidParameter
3261 { 'command': 'send-key',
3262 'data': { 'keys': ['KeyValue'], '*hold-time': 'int' } }
3267 # Write a PPM of the VGA screen to a file.
3269 # @filename: the path of a new PPM file to store the image
3271 # Returns: Nothing on success
3275 { 'command': 'screendump', 'data': {'filename': 'str'} }
3281 # Configuration shared across all chardev backends
3283 # @logfile: #optional The name of a logfile to save output
3284 # @logappend: #optional true to append instead of truncate
3285 # (default to false to truncate)
3289 { 'struct': 'ChardevCommon', 'data': { '*logfile': 'str',
3290 '*logappend': 'bool' } }
3295 # Configuration info for file chardevs.
3297 # @in: #optional The name of the input file
3298 # @out: The name of the output file
3299 # @append: #optional Open the file in append mode (default false to
3300 # truncate) (Since 2.6)
3304 { 'struct': 'ChardevFile', 'data': { '*in' : 'str',
3306 '*append': 'bool' },
3307 'base': 'ChardevCommon' }
3312 # Configuration info for device and pipe chardevs.
3314 # @device: The name of the special file for the device,
3315 # i.e. /dev/ttyS0 on Unix or COM1: on Windows
3316 # @type: What kind of device this is.
3320 { 'struct': 'ChardevHostdev', 'data': { 'device' : 'str' },
3321 'base': 'ChardevCommon' }
3326 # Configuration info for (stream) socket chardevs.
3328 # @addr: socket address to listen on (server=true)
3329 # or connect to (server=false)
3330 # @tls-creds: #optional the ID of the TLS credentials object (since 2.6)
3331 # @server: #optional create server socket (default: true)
3332 # @wait: #optional wait for incoming connection on server
3333 # sockets (default: false).
3334 # @nodelay: #optional set TCP_NODELAY socket option (default: false)
3335 # @telnet: #optional enable telnet protocol on server
3336 # sockets (default: false)
3337 # @reconnect: #optional For a client socket, if a socket is disconnected,
3338 # then attempt a reconnect after the given number of seconds.
3339 # Setting this to zero disables this function. (default: 0)
3344 { 'struct': 'ChardevSocket', 'data': { 'addr' : 'SocketAddress',
3345 '*tls-creds' : 'str',
3348 '*nodelay' : 'bool',
3350 '*reconnect' : 'int' },
3351 'base': 'ChardevCommon' }
3356 # Configuration info for datagram socket chardevs.
3358 # @remote: remote address
3359 # @local: #optional local address
3363 { 'struct': 'ChardevUdp', 'data': { 'remote' : 'SocketAddress',
3364 '*local' : 'SocketAddress' },
3365 'base': 'ChardevCommon' }
3370 # Configuration info for mux chardevs.
3372 # @chardev: name of the base chardev.
3376 { 'struct': 'ChardevMux', 'data': { 'chardev' : 'str' },
3377 'base': 'ChardevCommon' }
3382 # Configuration info for stdio chardevs.
3384 # @signal: #optional Allow signals (such as SIGINT triggered by ^C)
3385 # be delivered to qemu. Default: true in -nographic mode,
3390 { 'struct': 'ChardevStdio', 'data': { '*signal' : 'bool' },
3391 'base': 'ChardevCommon' }
3395 # @ChardevSpiceChannel:
3397 # Configuration info for spice vm channel chardevs.
3399 # @type: kind of channel (for example vdagent).
3403 { 'struct': 'ChardevSpiceChannel', 'data': { 'type' : 'str' },
3404 'base': 'ChardevCommon' }
3407 # @ChardevSpicePort:
3409 # Configuration info for spice port chardevs.
3411 # @fqdn: name of the channel (see docs/spice-port-fqdn.txt)
3415 { 'struct': 'ChardevSpicePort', 'data': { 'fqdn' : 'str' },
3416 'base': 'ChardevCommon' }
3421 # Configuration info for virtual console chardevs.
3423 # @width: console width, in pixels
3424 # @height: console height, in pixels
3425 # @cols: console width, in chars
3426 # @rows: console height, in chars
3430 { 'struct': 'ChardevVC', 'data': { '*width' : 'int',
3434 'base': 'ChardevCommon' }
3439 # Configuration info for ring buffer chardevs.
3441 # @size: #optional ring buffer size, must be power of two, default is 65536
3445 { 'struct': 'ChardevRingbuf', 'data': { '*size' : 'int' },
3446 'base': 'ChardevCommon' }
3451 # Configuration info for the new chardev backend.
3453 # Since: 1.4 (testdev since 2.2)
3455 { 'union': 'ChardevBackend', 'data': { 'file' : 'ChardevFile',
3456 'serial' : 'ChardevHostdev',
3457 'parallel': 'ChardevHostdev',
3458 'pipe' : 'ChardevHostdev',
3459 'socket' : 'ChardevSocket',
3460 'udp' : 'ChardevUdp',
3461 'pty' : 'ChardevCommon',
3462 'null' : 'ChardevCommon',
3463 'mux' : 'ChardevMux',
3464 'msmouse': 'ChardevCommon',
3465 'braille': 'ChardevCommon',
3466 'testdev': 'ChardevCommon',
3467 'stdio' : 'ChardevStdio',
3468 'console': 'ChardevCommon',
3469 'spicevmc' : 'ChardevSpiceChannel',
3470 'spiceport' : 'ChardevSpicePort',
3472 'ringbuf': 'ChardevRingbuf',
3473 # next one is just for compatibility
3474 'memory' : 'ChardevRingbuf' } }
3479 # Return info about the chardev backend just created.
3481 # @pty: #optional name of the slave pseudoterminal device, present if
3482 # and only if a chardev of type 'pty' was created
3486 { 'struct' : 'ChardevReturn', 'data': { '*pty' : 'str' } }
3491 # Add a character device backend
3493 # @id: the chardev's ID, must be unique
3494 # @backend: backend type and parameters
3496 # Returns: ChardevReturn.
3500 { 'command': 'chardev-add', 'data': {'id' : 'str',
3501 'backend' : 'ChardevBackend' },
3502 'returns': 'ChardevReturn' }
3507 # Remove a character device backend
3509 # @id: the chardev's ID, must exist and not be in use
3511 # Returns: Nothing on success
3515 { 'command': 'chardev-remove', 'data': {'id': 'str'} }
3520 # An enumeration of TPM models
3522 # @tpm-tis: TPM TIS model
3526 { 'enum': 'TpmModel', 'data': [ 'tpm-tis' ] }
3529 # @query-tpm-models:
3531 # Return a list of supported TPM models
3533 # Returns: a list of TpmModel
3537 { 'command': 'query-tpm-models', 'returns': ['TpmModel'] }
3542 # An enumeration of TPM types
3544 # @passthrough: TPM passthrough type
3548 { 'enum': 'TpmType', 'data': [ 'passthrough' ] }
3553 # Return a list of supported TPM types
3555 # Returns: a list of TpmType
3559 { 'command': 'query-tpm-types', 'returns': ['TpmType'] }
3562 # @TPMPassthroughOptions:
3564 # Information about the TPM passthrough type
3566 # @path: #optional string describing the path used for accessing the TPM device
3568 # @cancel-path: #optional string showing the TPM's sysfs cancel file
3569 # for cancellation of TPM commands while they are executing
3573 { 'struct': 'TPMPassthroughOptions', 'data': { '*path' : 'str',
3574 '*cancel-path' : 'str'} }
3579 # A union referencing different TPM backend types' configuration options
3581 # @passthrough: The configuration options for the TPM passthrough type
3585 { 'union': 'TpmTypeOptions',
3586 'data': { 'passthrough' : 'TPMPassthroughOptions' } }
3591 # Information about the TPM
3593 # @id: The Id of the TPM
3595 # @model: The TPM frontend model
3597 # @options: The TPM (backend) type configuration options
3601 { 'struct': 'TPMInfo',
3602 'data': {'id': 'str',
3603 'model': 'TpmModel',
3604 'options': 'TpmTypeOptions' } }
3609 # Return information about the TPM device
3611 # Returns: @TPMInfo on success
3615 { 'command': 'query-tpm', 'returns': ['TPMInfo'] }
3620 # Specify an ACPI table on the command line to load.
3622 # At most one of @file and @data can be specified. The list of files specified
3623 # by any one of them is loaded and concatenated in order. If both are omitted,
3626 # Other fields / optargs can be used to override fields of the generic ACPI
3627 # table header; refer to the ACPI specification 5.0, section 5.2.6 System
3628 # Description Table Header. If a header field is not overridden, then the
3629 # corresponding value from the concatenated blob is used (in case of @file), or
3630 # it is filled in with a hard-coded value (in case of @data).
3632 # String fields are copied into the matching ACPI member from lowest address
3633 # upwards, and silently truncated / NUL-padded to length.
3635 # @sig: #optional table signature / identifier (4 bytes)
3637 # @rev: #optional table revision number (dependent on signature, 1 byte)
3639 # @oem_id: #optional OEM identifier (6 bytes)
3641 # @oem_table_id: #optional OEM table identifier (8 bytes)
3643 # @oem_rev: #optional OEM-supplied revision number (4 bytes)
3645 # @asl_compiler_id: #optional identifier of the utility that created the table
3648 # @asl_compiler_rev: #optional revision number of the utility that created the
3651 # @file: #optional colon (:) separated list of pathnames to load and
3652 # concatenate as table data. The resultant binary blob is expected to
3653 # have an ACPI table header. At least one file is required. This field
3656 # @data: #optional colon (:) separated list of pathnames to load and
3657 # concatenate as table data. The resultant binary blob must not have an
3658 # ACPI table header. At least one file is required. This field excludes
3663 { 'struct': 'AcpiTableOptions',
3668 '*oem_table_id': 'str',
3669 '*oem_rev': 'uint32',
3670 '*asl_compiler_id': 'str',
3671 '*asl_compiler_rev': 'uint32',
3676 # @CommandLineParameterType:
3678 # Possible types for an option parameter.
3680 # @string: accepts a character string
3682 # @boolean: accepts "on" or "off"
3684 # @number: accepts a number
3686 # @size: accepts a number followed by an optional suffix (K)ilo,
3687 # (M)ega, (G)iga, (T)era
3691 { 'enum': 'CommandLineParameterType',
3692 'data': ['string', 'boolean', 'number', 'size'] }
3695 # @CommandLineParameterInfo:
3697 # Details about a single parameter of a command line option.
3699 # @name: parameter name
3701 # @type: parameter @CommandLineParameterType
3703 # @help: #optional human readable text string, not suitable for parsing.
3705 # @default: #optional default value string (since 2.1)
3709 { 'struct': 'CommandLineParameterInfo',
3710 'data': { 'name': 'str',
3711 'type': 'CommandLineParameterType',
3713 '*default': 'str' } }
3716 # @CommandLineOptionInfo:
3718 # Details about a command line option, including its list of parameter details
3720 # @option: option name
3722 # @parameters: an array of @CommandLineParameterInfo
3726 { 'struct': 'CommandLineOptionInfo',
3727 'data': { 'option': 'str', 'parameters': ['CommandLineParameterInfo'] } }
3730 # @query-command-line-options:
3732 # Query command line option schema.
3734 # @option: #optional option name
3736 # Returns: list of @CommandLineOptionInfo for all options (or for the given
3737 # @option). Returns an error if the given @option doesn't exist.
3741 {'command': 'query-command-line-options', 'data': { '*option': 'str' },
3742 'returns': ['CommandLineOptionInfo'] }
3747 # A X86 32-bit register
3751 { 'enum': 'X86CPURegister32',
3752 'data': [ 'EAX', 'EBX', 'ECX', 'EDX', 'ESP', 'EBP', 'ESI', 'EDI' ] }
3755 # @X86CPUFeatureWordInfo
3757 # Information about a X86 CPU feature word
3759 # @cpuid-input-eax: Input EAX value for CPUID instruction for that feature word
3761 # @cpuid-input-ecx: #optional Input ECX value for CPUID instruction for that
3764 # @cpuid-register: Output register containing the feature bits
3766 # @features: value of output register, containing the feature bits
3770 { 'struct': 'X86CPUFeatureWordInfo',
3771 'data': { 'cpuid-input-eax': 'int',
3772 '*cpuid-input-ecx': 'int',
3773 'cpuid-register': 'X86CPURegister32',
3774 'features': 'int' } }
3779 # Not used by QMP; hack to let us use X86CPUFeatureWordInfoList internally
3783 { 'struct': 'DummyForceArrays',
3784 'data': { 'unused': ['X86CPUFeatureWordInfo'] } }
3790 # Packets receiving state
3792 # @normal: filter assigned packets according to the mac-table
3794 # @none: don't receive any assigned packet
3796 # @all: receive all assigned packets
3800 { 'enum': 'RxState', 'data': [ 'normal', 'none', 'all' ] }
3805 # Rx-filter information for a NIC.
3807 # @name: net client name
3809 # @promiscuous: whether promiscuous mode is enabled
3811 # @multicast: multicast receive state
3813 # @unicast: unicast receive state
3815 # @vlan: vlan receive state (Since 2.0)
3817 # @broadcast-allowed: whether to receive broadcast
3819 # @multicast-overflow: multicast table is overflowed or not
3821 # @unicast-overflow: unicast table is overflowed or not
3823 # @main-mac: the main macaddr string
3825 # @vlan-table: a list of active vlan id
3827 # @unicast-table: a list of unicast macaddr string
3829 # @multicast-table: a list of multicast macaddr string
3834 { 'struct': 'RxFilterInfo',
3837 'promiscuous': 'bool',
3838 'multicast': 'RxState',
3839 'unicast': 'RxState',
3841 'broadcast-allowed': 'bool',
3842 'multicast-overflow': 'bool',
3843 'unicast-overflow': 'bool',
3845 'vlan-table': ['int'],
3846 'unicast-table': ['str'],
3847 'multicast-table': ['str'] }}
3852 # Return rx-filter information for all NICs (or for the given NIC).
3854 # @name: #optional net client name
3856 # Returns: list of @RxFilterInfo for all NICs (or for the given NIC).
3857 # Returns an error if the given @name doesn't exist, or given
3858 # NIC doesn't support rx-filter querying, or given net client
3863 { 'command': 'query-rx-filter', 'data': { '*name': 'str' },
3864 'returns': ['RxFilterInfo'] }
3869 # Button of a pointer input device (mouse, tablet).
3873 { 'enum' : 'InputButton',
3874 'data' : [ 'left', 'middle', 'right', 'wheel-up', 'wheel-down' ] }
3879 # Position axis of a pointer input device (mouse, tablet).
3883 { 'enum' : 'InputAxis',
3884 'data' : [ 'x', 'y' ] }
3889 # Keyboard input event.
3891 # @key: Which key this event is for.
3892 # @down: True for key-down and false for key-up events.
3896 { 'struct' : 'InputKeyEvent',
3897 'data' : { 'key' : 'KeyValue',
3903 # Pointer button input event.
3905 # @button: Which button this event is for.
3906 # @down: True for key-down and false for key-up events.
3910 { 'struct' : 'InputBtnEvent',
3911 'data' : { 'button' : 'InputButton',
3917 # Pointer motion input event.
3919 # @axis: Which axis is referenced by @value.
3920 # @value: Pointer position. For absolute coordinates the
3921 # valid range is 0 -> 0x7ffff
3925 { 'struct' : 'InputMoveEvent',
3926 'data' : { 'axis' : 'InputAxis',
3932 # Input event union.
3934 # @key: Input event of Keyboard
3935 # @btn: Input event of pointer buttons
3936 # @rel: Input event of relative pointer motion
3937 # @abs: Input event of absolute pointer motion
3941 { 'union' : 'InputEvent',
3942 'data' : { 'key' : 'InputKeyEvent',
3943 'btn' : 'InputBtnEvent',
3944 'rel' : 'InputMoveEvent',
3945 'abs' : 'InputMoveEvent' } }
3950 # Send input event(s) to guest.
3952 # @device: #optional display device to send event(s) to.
3953 # @head: #optional head to send event(s) to, in case the
3954 # display device supports multiple scanouts.
3955 # @events: List of InputEvent union.
3957 # Returns: Nothing on success.
3959 # The @display and @head parameters can be used to send the input
3960 # event to specific input devices in case (a) multiple input devices
3961 # of the same kind are added to the virtual machine and (b) you have
3962 # configured input routing (see docs/multiseat.txt) for those input
3963 # devices. The parameters work exactly like the device and head
3964 # properties of input devices. If @device is missing, only devices
3965 # that have no input routing config are admissible. If @device is
3966 # specified, both input devices with and without input routing config
3967 # are admissible, but devices with input routing config take
3972 { 'command': 'input-send-event',
3973 'data': { '*device': 'str',
3975 'events' : [ 'InputEvent' ] } }
3980 # A discriminated record of NUMA options. (for OptsVisitor)
3984 { 'union': 'NumaOptions',
3986 'node': 'NumaNodeOptions' }}
3991 # Create a guest NUMA node. (for OptsVisitor)
3993 # @nodeid: #optional NUMA node ID (increase by 1 from 0 if omitted)
3995 # @cpus: #optional VCPUs belonging to this node (assign VCPUS round-robin
3998 # @mem: #optional memory size of this node; mutually exclusive with @memdev.
3999 # Equally divide total memory among nodes if both @mem and @memdev are
4002 # @memdev: #optional memory backend object. If specified for one node,
4003 # it must be specified for all nodes.
4007 { 'struct': 'NumaNodeOptions',
4009 '*nodeid': 'uint16',
4010 '*cpus': ['uint16'],
4017 # Host memory policy types
4019 # @default: restore default policy, remove any nondefault policy
4021 # @preferred: set the preferred host nodes for allocation
4023 # @bind: a strict policy that restricts memory allocation to the
4024 # host nodes specified
4026 # @interleave: memory allocations are interleaved across the set
4027 # of host nodes specified
4031 { 'enum': 'HostMemPolicy',
4032 'data': [ 'default', 'preferred', 'bind', 'interleave' ] }
4037 # Information about memory backend
4039 # @size: memory backend size
4041 # @merge: enables or disables memory merge support
4043 # @dump: includes memory backend's memory in a core dump or not
4045 # @prealloc: enables or disables memory preallocation
4047 # @host-nodes: host nodes for its memory policy
4049 # @policy: memory policy of memory backend
4054 { 'struct': 'Memdev',
4060 'host-nodes': ['uint16'],
4061 'policy': 'HostMemPolicy' }}
4066 # Returns information for all memory backends.
4068 # Returns: a list of @Memdev.
4072 { 'command': 'query-memdev', 'returns': ['Memdev'] }
4075 # @PCDIMMDeviceInfo:
4077 # PCDIMMDevice state information
4079 # @id: #optional device's ID
4081 # @addr: physical address, where device is mapped
4083 # @size: size of memory that the device provides
4085 # @slot: slot number at which device is plugged in
4087 # @node: NUMA node number where device is plugged in
4089 # @memdev: memory backend linked with device
4091 # @hotplugged: true if device was hotplugged
4093 # @hotpluggable: true if device if could be added/removed while machine is running
4097 { 'struct': 'PCDIMMDeviceInfo',
4098 'data': { '*id': 'str',
4104 'hotplugged': 'bool',
4105 'hotpluggable': 'bool'
4110 # @MemoryDeviceInfo:
4112 # Union containing information about a memory device
4116 { 'union': 'MemoryDeviceInfo', 'data': {'dimm': 'PCDIMMDeviceInfo'} }
4119 # @query-memory-devices
4121 # Lists available memory devices and their state
4125 { 'command': 'query-memory-devices', 'returns': ['MemoryDeviceInfo'] }
4129 # @DIMM: memory slot
4130 # @CPU: logical CPU slot (since 2.7)
4132 { 'enum': 'ACPISlotType', 'data': [ 'DIMM', 'CPU' ] }
4136 # OSPM Status Indication for a device
4137 # For description of possible values of @source and @status fields
4138 # see "_OST (OSPM Status Indication)" chapter of ACPI5.0 spec.
4140 # @device: #optional device ID associated with slot
4142 # @slot: slot ID, unique per slot of a given @slot-type
4144 # @slot-type: type of the slot
4146 # @source: an integer containing the source event
4148 # @status: an integer containing the status code
4152 { 'struct': 'ACPIOSTInfo',
4153 'data' : { '*device': 'str',
4155 'slot-type': 'ACPISlotType',
4160 # @query-acpi-ospm-status
4162 # Lists ACPI OSPM status of ACPI device objects,
4163 # which might be reported via _OST method
4167 { 'command': 'query-acpi-ospm-status', 'returns': ['ACPIOSTInfo'] }
4170 # @WatchdogExpirationAction
4172 # An enumeration of the actions taken when the watchdog device's timer is
4175 # @reset: system resets
4177 # @shutdown: system shutdown, note that it is similar to @powerdown, which
4178 # tries to set to system status and notify guest
4180 # @poweroff: system poweroff, the emulator program exits
4182 # @pause: system pauses, similar to @stop
4184 # @debug: system enters debug state
4186 # @none: nothing is done
4188 # @inject-nmi: a non-maskable interrupt is injected into the first VCPU (all
4189 # VCPUS on x86) (since 2.4)
4193 { 'enum': 'WatchdogExpirationAction',
4194 'data': [ 'reset', 'shutdown', 'poweroff', 'pause', 'debug', 'none',
4200 # An enumeration of the I/O operation types
4202 # @read: read operation
4204 # @write: write operation
4208 { 'enum': 'IoOperationType',
4209 'data': [ 'read', 'write' ] }
4214 # An enumeration of the actions taken when guest OS panic is detected
4216 # @pause: system pauses
4220 { 'enum': 'GuestPanicAction',
4221 'data': [ 'pause' ] }
4224 # @rtc-reset-reinjection
4226 # This command will reset the RTC interrupt reinjection backlog.
4227 # Can be used if another mechanism to synchronize guest time
4228 # is in effect, for example QEMU guest agent's guest-set-time
4233 { 'command': 'rtc-reset-reinjection' }
4235 # Rocker ethernet network switch
4236 { 'include': 'qapi/rocker.json' }
4241 # Mode of the replay subsystem.
4243 # @none: normal execution mode. Replay or record are not enabled.
4245 # @record: record mode. All non-deterministic data is written into the
4248 # @play: replay mode. Non-deterministic data required for system execution
4249 # is read from the log.
4253 { 'enum': 'ReplayMode',
4254 'data': [ 'none', 'record', 'play' ] }
4257 # @xen-load-devices-state:
4259 # Load the state of all devices from file. The RAM and the block devices
4260 # of the VM are not loaded by this command.
4262 # @filename: the file to load the state of the devices from as binary
4263 # data. See xen-save-devices-state.txt for a description of the binary
4268 { 'command': 'xen-load-devices-state', 'data': {'filename': 'str'} }
4273 # The struct describes capability for a specific GIC (Generic
4274 # Interrupt Controller) version. These bits are not only decided by
4275 # QEMU/KVM software version, but also decided by the hardware that
4276 # the program is running upon.
4278 # @version: version of GIC to be described. Currently, only 2 and 3
4281 # @emulated: whether current QEMU/hardware supports emulated GIC
4282 # device in user space.
4284 # @kernel: whether current QEMU/hardware supports hardware
4285 # accelerated GIC device in kernel.
4289 { 'struct': 'GICCapability',
4290 'data': { 'version': 'int',
4292 'kernel': 'bool' } }
4295 # @query-gic-capabilities:
4297 # This command is ARM-only. It will return a list of GICCapability
4298 # objects that describe its capability bits.
4300 # Returns: a list of GICCapability objects.
4304 { 'command': 'query-gic-capabilities', 'returns': ['GICCapability'] }
4307 # CpuInstanceProperties
4309 # List of properties to be used for hotplugging a CPU instance,
4310 # it should be passed by management with device_add command when
4311 # a CPU is being hotplugged.
4313 # Note: currently there are 4 properties that could be present
4314 # but management should be prepared to pass through other
4315 # properties with device_add command to allow for future
4316 # interface extension. This also requires the filed names to be kept in
4317 # sync with the properties passed to -device/device_add.
4319 # @node-id: #optional NUMA node ID the CPU belongs to
4320 # @socket-id: #optional socket number within node/board the CPU belongs to
4321 # @core-id: #optional core number within socket the CPU belongs to
4322 # @thread-id: #optional thread number within core the CPU belongs to
4326 { 'struct': 'CpuInstanceProperties',
4327 'data': { '*node-id': 'int',
4328 '*socket-id': 'int',
4337 # @type: CPU object type for usage with device_add command
4338 # @props: list of properties to be used for hotplugging CPU
4339 # @vcpus-count: number of logical VCPU threads @HotpluggableCPU provides
4340 # @qom-path: #optional link to existing CPU object if CPU is present or
4341 # omitted if CPU is not present.
4345 { 'struct': 'HotpluggableCPU',
4346 'data': { 'type': 'str',
4347 'vcpus-count': 'int',
4348 'props': 'CpuInstanceProperties',
4354 # @query-hotpluggable-cpus
4356 # Returns: a list of HotpluggableCPU objects.
4360 { 'command': 'query-hotpluggable-cpus', 'returns': ['HotpluggableCPU'] }