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 # Bug: invalid base64 is currently not rejected.
299 # Whitespace *is* invalid.
300 # - utf8: data's UTF-8 encoding is written
301 # - data itself is always Unicode regardless of format, like
304 # Returns: Nothing on success
308 { 'command': 'ringbuf-write',
309 'data': {'device': 'str', 'data': 'str',
310 '*format': 'DataFormat'} }
315 # Read from a ring buffer character device.
317 # @device: the ring buffer character device name
319 # @size: how many bytes to read at most
321 # @format: #optional data encoding (default 'utf8').
322 # - base64: the data read is returned in base64 encoding.
323 # - utf8: the data read is interpreted as UTF-8.
324 # Bug: can screw up when the buffer contains invalid UTF-8
325 # sequences, NUL characters, after the ring buffer lost
326 # data, and when reading stops because the size limit is
328 # - The return value is always Unicode regardless of format,
329 # like any other string.
331 # Returns: data read from the device
335 { 'command': 'ringbuf-read',
336 'data': {'device': 'str', 'size': 'int', '*format': 'DataFormat'},
342 # Information about a QMP event
344 # @name: The event name
348 { 'struct': 'EventInfo', 'data': {'name': 'str'} }
353 # Return a list of supported QMP events by this server
355 # Returns: A list of @EventInfo for all supported events
359 { 'command': 'query-events', 'returns': ['EventInfo'] }
364 # Detailed migration status.
366 # @transferred: amount of bytes already transferred to the target VM
368 # @remaining: amount of bytes remaining to be transferred to the target VM
370 # @total: total amount of bytes involved in the migration process
372 # @duplicate: number of duplicate (zero) pages (since 1.2)
374 # @skipped: number of skipped zero pages (since 1.5)
376 # @normal : number of normal pages (since 1.2)
378 # @normal-bytes: number of normal bytes sent (since 1.2)
380 # @dirty-pages-rate: number of pages dirtied by second by the
383 # @mbps: throughput in megabits/sec. (since 1.6)
385 # @dirty-sync-count: number of times that dirty ram was synchronized (since 2.1)
389 { 'struct': 'MigrationStats',
390 'data': {'transferred': 'int', 'remaining': 'int', 'total': 'int' ,
391 'duplicate': 'int', 'skipped': 'int', 'normal': 'int',
392 'normal-bytes': 'int', 'dirty-pages-rate' : 'int',
393 'mbps' : 'number', 'dirty-sync-count' : 'int' } }
398 # Detailed XBZRLE migration cache statistics
400 # @cache-size: XBZRLE cache size
402 # @bytes: amount of bytes already transferred to the target VM
404 # @pages: amount of pages transferred to the target VM
406 # @cache-miss: number of cache miss
408 # @cache-miss-rate: rate of cache miss (since 2.1)
410 # @overflow: number of overflows
414 { 'struct': 'XBZRLECacheStats',
415 'data': {'cache-size': 'int', 'bytes': 'int', 'pages': 'int',
416 'cache-miss': 'int', 'cache-miss-rate': 'number',
417 'overflow': 'int' } }
421 # An enumeration of migration status.
423 # @none: no migration has ever happened.
425 # @setup: migration process has been initiated.
427 # @cancelling: in the process of cancelling migration.
429 # @cancelled: cancelling migration is finished.
431 # @active: in the process of doing migration.
433 # @postcopy-active: like active, but now in postcopy mode. (since 2.5)
435 # @completed: migration is finished.
437 # @failed: some error occurred during migration process.
442 { 'enum': 'MigrationStatus',
443 'data': [ 'none', 'setup', 'cancelling', 'cancelled',
444 'active', 'postcopy-active', 'completed', 'failed' ] }
449 # Information about current migration process.
451 # @status: #optional @MigrationStatus describing the current migration status.
452 # If this field is not returned, no migration process
455 # @ram: #optional @MigrationStats containing detailed migration
456 # status, only returned if status is 'active' or
457 # 'completed'(since 1.2)
459 # @disk: #optional @MigrationStats containing detailed disk migration
460 # status, only returned if status is 'active' and it is a block
463 # @xbzrle-cache: #optional @XBZRLECacheStats containing detailed XBZRLE
464 # migration statistics, only returned if XBZRLE feature is on and
465 # status is 'active' or 'completed' (since 1.2)
467 # @total-time: #optional total amount of milliseconds since migration started.
468 # If migration has ended, it returns the total migration
471 # @downtime: #optional only present when migration finishes correctly
472 # total downtime in milliseconds for the guest.
475 # @expected-downtime: #optional only present while migration is active
476 # expected downtime in milliseconds for the guest in last walk
477 # of the dirty bitmap. (since 1.3)
479 # @setup-time: #optional amount of setup time in milliseconds _before_ the
480 # iterations begin but _after_ the QMP command is issued. This is designed
481 # to provide an accounting of any activities (such as RDMA pinning) which
482 # may be expensive, but do not actually occur during the iterative
483 # migration rounds themselves. (since 1.6)
485 # @x-cpu-throttle-percentage: #optional percentage of time guest cpus are being
486 # throttled during auto-converge. This is only present when auto-converge
487 # has started throttling guest cpus. (Since 2.5)
491 { 'struct': 'MigrationInfo',
492 'data': {'*status': 'MigrationStatus', '*ram': 'MigrationStats',
493 '*disk': 'MigrationStats',
494 '*xbzrle-cache': 'XBZRLECacheStats',
495 '*total-time': 'int',
496 '*expected-downtime': 'int',
498 '*setup-time': 'int',
499 '*x-cpu-throttle-percentage': 'int'} }
504 # Returns information about current migration process.
506 # Returns: @MigrationInfo
510 { 'command': 'query-migrate', 'returns': 'MigrationInfo' }
513 # @MigrationCapability
515 # Migration capabilities enumeration
517 # @xbzrle: Migration supports xbzrle (Xor Based Zero Run Length Encoding).
518 # This feature allows us to minimize migration traffic for certain work
519 # loads, by sending compressed difference of the pages
521 # @rdma-pin-all: Controls whether or not the entire VM memory footprint is
522 # mlock()'d on demand or all at once. Refer to docs/rdma.txt for usage.
523 # Disabled by default. (since 2.0)
525 # @zero-blocks: During storage migration encode blocks of zeroes efficiently. This
526 # essentially saves 1MB of zeroes per block on the wire. Enabling requires
527 # source and target VM to support this feature. To enable it is sufficient
528 # to enable the capability on the source VM. The feature is disabled by
529 # default. (since 1.6)
531 # @compress: Use multiple compression threads to accelerate live migration.
532 # This feature can help to reduce the migration traffic, by sending
533 # compressed pages. Please note that if compress and xbzrle are both
534 # on, compress only takes effect in the ram bulk stage, after that,
535 # it will be disabled and only xbzrle takes effect, this can help to
536 # minimize migration traffic. The feature is disabled by default.
539 # @events: generate events for each migration state change
542 # @auto-converge: If enabled, QEMU will automatically throttle down the guest
543 # to speed up convergence of RAM migration. (since 1.6)
545 # @x-postcopy-ram: Start executing on the migration target before all of RAM has
546 # been migrated, pulling the remaining pages along as needed. NOTE: If
547 # the migration fails during postcopy the VM will fail. (since 2.5)
551 { 'enum': 'MigrationCapability',
552 'data': ['xbzrle', 'rdma-pin-all', 'auto-converge', 'zero-blocks',
553 'compress', 'events', 'x-postcopy-ram'] }
556 # @MigrationCapabilityStatus
558 # Migration capability information
560 # @capability: capability enum
562 # @state: capability state bool
566 { 'struct': 'MigrationCapabilityStatus',
567 'data': { 'capability' : 'MigrationCapability', 'state' : 'bool' } }
570 # @migrate-set-capabilities
572 # Enable/Disable the following migration capabilities (like xbzrle)
574 # @capabilities: json array of capability modifications to make
578 { 'command': 'migrate-set-capabilities',
579 'data': { 'capabilities': ['MigrationCapabilityStatus'] } }
582 # @query-migrate-capabilities
584 # Returns information about the current migration capabilities status
586 # Returns: @MigrationCapabilitiesStatus
590 { 'command': 'query-migrate-capabilities', 'returns': ['MigrationCapabilityStatus']}
592 # @MigrationParameter
594 # Migration parameters enumeration
596 # @compress-level: Set the compression level to be used in live migration,
597 # the compression level is an integer between 0 and 9, where 0 means
598 # no compression, 1 means the best compression speed, and 9 means best
599 # compression ratio which will consume more CPU.
601 # @compress-threads: Set compression thread count to be used in live migration,
602 # the compression thread count is an integer between 1 and 255.
604 # @decompress-threads: Set decompression thread count to be used in live
605 # migration, the decompression thread count is an integer between 1
606 # and 255. Usually, decompression is at least 4 times as fast as
607 # compression, so set the decompress-threads to the number about 1/4
608 # of compress-threads is adequate.
610 # @x-cpu-throttle-initial: Initial percentage of time guest cpus are throttled
611 # when migration auto-converge is activated. The
612 # default value is 20. (Since 2.5)
614 # @x-cpu-throttle-increment: throttle percentage increase each time
615 # auto-converge detects that migration is not making
616 # progress. The default value is 10. (Since 2.5)
619 { 'enum': 'MigrationParameter',
620 'data': ['compress-level', 'compress-threads', 'decompress-threads',
621 'x-cpu-throttle-initial', 'x-cpu-throttle-increment'] }
624 # @migrate-set-parameters
626 # Set the following migration parameters
628 # @compress-level: compression level
630 # @compress-threads: compression thread count
632 # @decompress-threads: decompression thread count
634 # @x-cpu-throttle-initial: Initial percentage of time guest cpus are throttled
635 # when migration auto-converge is activated. The
636 # default value is 20. (Since 2.5)
638 # @x-cpu-throttle-increment: throttle percentage increase each time
639 # auto-converge detects that migration is not making
640 # progress. The default value is 10. (Since 2.5)
643 { 'command': 'migrate-set-parameters',
644 'data': { '*compress-level': 'int',
645 '*compress-threads': 'int',
646 '*decompress-threads': 'int',
647 '*x-cpu-throttle-initial': 'int',
648 '*x-cpu-throttle-increment': 'int'} }
651 # @MigrationParameters
653 # @compress-level: compression level
655 # @compress-threads: compression thread count
657 # @decompress-threads: decompression thread count
659 # @x-cpu-throttle-initial: Initial percentage of time guest cpus are throttled
660 # when migration auto-converge is activated. The
661 # default value is 20. (Since 2.5)
663 # @x-cpu-throttle-increment: throttle percentage increase each time
664 # auto-converge detects that migration is not making
665 # progress. The default value is 10. (Since 2.5)
669 { 'struct': 'MigrationParameters',
670 'data': { 'compress-level': 'int',
671 'compress-threads': 'int',
672 'decompress-threads': 'int',
673 'x-cpu-throttle-initial': 'int',
674 'x-cpu-throttle-increment': 'int'} }
676 # @query-migrate-parameters
678 # Returns information about the current migration parameters
680 # Returns: @MigrationParameters
684 { 'command': 'query-migrate-parameters',
685 'returns': 'MigrationParameters' }
688 # @client_migrate_info
690 # Set migration information for remote display. This makes the server
691 # ask the client to automatically reconnect using the new parameters
692 # once migration finished successfully. Only implemented for SPICE.
694 # @protocol: must be "spice"
695 # @hostname: migration target hostname
696 # @port: #optional spice tcp port for plaintext channels
697 # @tls-port: #optional spice tcp port for tls-secured channels
698 # @cert-subject: #optional server certificate subject
702 { 'command': 'client_migrate_info',
703 'data': { 'protocol': 'str', 'hostname': 'str', '*port': 'int',
704 '*tls-port': 'int', '*cert-subject': 'str' } }
707 # @migrate-start-postcopy
709 # Followup to a migration command to switch the migration to postcopy mode.
710 # The x-postcopy-ram capability must be set before the original migration
714 { 'command': 'migrate-start-postcopy' }
719 # Information about a mouse device.
721 # @name: the name of the mouse device
723 # @index: the index of the mouse device
725 # @current: true if this device is currently receiving mouse events
727 # @absolute: true if this device supports absolute coordinates as input
731 { 'struct': 'MouseInfo',
732 'data': {'name': 'str', 'index': 'int', 'current': 'bool',
733 'absolute': 'bool'} }
738 # Returns information about each active mouse device
740 # Returns: a list of @MouseInfo for each device
744 { 'command': 'query-mice', 'returns': ['MouseInfo'] }
749 # Information about a virtual CPU
751 # @CPU: the index of the virtual CPU
753 # @current: this only exists for backwards compatible and should be ignored
755 # @halted: true if the virtual CPU is in the halt state. Halt usually refers
756 # to a processor specific low power mode.
758 # @qom_path: path to the CPU object in the QOM tree (since 2.4)
760 # @pc: #optional If the target is i386 or x86_64, this is the 64-bit instruction
762 # If the target is Sparc, this is the PC component of the
763 # instruction pointer.
765 # @nip: #optional If the target is PPC, the instruction pointer
767 # @npc: #optional If the target is Sparc, the NPC component of the instruction
770 # @PC: #optional If the target is MIPS, the instruction pointer
772 # @thread_id: ID of the underlying host thread
776 # Notes: @halted is a transient state that changes frequently. By the time the
777 # data is sent to the client, the guest may no longer be halted.
779 { 'struct': 'CpuInfo',
780 'data': {'CPU': 'int', 'current': 'bool', 'halted': 'bool',
782 '*pc': 'int', '*nip': 'int', '*npc': 'int', '*PC': 'int',
783 'thread_id': 'int'} }
788 # Returns a list of information about each virtual CPU.
790 # Returns: a list of @CpuInfo for each virtual CPU
794 { 'command': 'query-cpus', 'returns': ['CpuInfo'] }
799 # Information about an iothread
801 # @id: the identifier of the iothread
803 # @thread-id: ID of the underlying host thread
807 { 'struct': 'IOThreadInfo',
808 'data': {'id': 'str', 'thread-id': 'int'} }
813 # Returns a list of information about each iothread.
815 # Note this list excludes the QEMU main loop thread, which is not declared
816 # using the -object iothread command-line option. It is always the main thread
819 # Returns: a list of @IOThreadInfo for each iothread
823 { 'command': 'query-iothreads', 'returns': ['IOThreadInfo'] }
826 # @NetworkAddressFamily
828 # The network address family
836 # @unknown: otherwise
840 { 'enum': 'NetworkAddressFamily',
841 'data': [ 'ipv4', 'ipv6', 'unix', 'unknown' ] }
846 # The basic information for vnc network connection
850 # @service: The service name of the vnc port. This may depend on the host
851 # system's service database so symbolic names should not be relied
854 # @family: address family
856 # @websocket: true in case the socket is a websocket (since 2.3).
860 { 'struct': 'VncBasicInfo',
861 'data': { 'host': 'str',
863 'family': 'NetworkAddressFamily',
864 'websocket': 'bool' } }
869 # The network connection information for server
871 # @auth: #optional, authentication method
875 { 'struct': 'VncServerInfo',
876 'base': 'VncBasicInfo',
877 'data': { '*auth': 'str' } }
882 # Information about a connected VNC client.
884 # @x509_dname: #optional If x509 authentication is in use, the Distinguished
885 # Name of the client.
887 # @sasl_username: #optional If SASL authentication is in use, the SASL username
888 # used for authentication.
892 { 'struct': 'VncClientInfo',
893 'base': 'VncBasicInfo',
894 'data': { '*x509_dname': 'str', '*sasl_username': 'str' } }
899 # Information about the VNC session.
901 # @enabled: true if the VNC server is enabled, false otherwise
903 # @host: #optional The hostname the VNC server is bound to. This depends on
904 # the name resolution on the host and may be an IP address.
906 # @family: #optional 'ipv6' if the host is listening for IPv6 connections
907 # 'ipv4' if the host is listening for IPv4 connections
908 # 'unix' if the host is listening on a unix domain socket
909 # 'unknown' otherwise
911 # @service: #optional The service name of the server's port. This may depends
912 # on the host system's service database so symbolic names should not
915 # @auth: #optional the current authentication type used by the server
916 # 'none' if no authentication is being used
917 # 'vnc' if VNC authentication is being used
918 # 'vencrypt+plain' if VEncrypt is used with plain text authentication
919 # 'vencrypt+tls+none' if VEncrypt is used with TLS and no authentication
920 # 'vencrypt+tls+vnc' if VEncrypt is used with TLS and VNC authentication
921 # 'vencrypt+tls+plain' if VEncrypt is used with TLS and plain text auth
922 # 'vencrypt+x509+none' if VEncrypt is used with x509 and no auth
923 # 'vencrypt+x509+vnc' if VEncrypt is used with x509 and VNC auth
924 # 'vencrypt+x509+plain' if VEncrypt is used with x509 and plain text auth
925 # 'vencrypt+tls+sasl' if VEncrypt is used with TLS and SASL auth
926 # 'vencrypt+x509+sasl' if VEncrypt is used with x509 and SASL auth
928 # @clients: a list of @VncClientInfo of all currently connected clients
932 { 'struct': 'VncInfo',
933 'data': {'enabled': 'bool', '*host': 'str',
934 '*family': 'NetworkAddressFamily',
935 '*service': 'str', '*auth': 'str', '*clients': ['VncClientInfo']} }
940 # vnc primary authentication method.
944 { 'enum': 'VncPrimaryAuth',
945 'data': [ 'none', 'vnc', 'ra2', 'ra2ne', 'tight', 'ultra',
946 'tls', 'vencrypt', 'sasl' ] }
949 # @VncVencryptSubAuth:
951 # vnc sub authentication method with vencrypt.
955 { 'enum': 'VncVencryptSubAuth',
957 'tls-none', 'x509-none',
958 'tls-vnc', 'x509-vnc',
959 'tls-plain', 'x509-plain',
960 'tls-sasl', 'x509-sasl' ] }
965 # Information about a vnc server
967 # @id: vnc server name.
969 # @server: A list of @VncBasincInfo describing all listening sockets.
970 # The list can be empty (in case the vnc server is disabled).
971 # It also may have multiple entries: normal + websocket,
972 # possibly also ipv4 + ipv6 in the future.
974 # @clients: A list of @VncClientInfo of all currently connected clients.
975 # The list can be empty, for obvious reasons.
977 # @auth: The current authentication type used by the server
979 # @vencrypt: #optional The vencrypt sub authentication type used by the server,
980 # only specified in case auth == vencrypt.
982 # @display: #optional The display device the vnc server is linked to.
986 { 'struct': 'VncInfo2',
987 'data': { 'id' : 'str',
988 'server' : ['VncBasicInfo'],
989 'clients' : ['VncClientInfo'],
990 'auth' : 'VncPrimaryAuth',
991 '*vencrypt' : 'VncVencryptSubAuth',
992 '*display' : 'str' } }
997 # Returns information about the current VNC server
1003 { 'command': 'query-vnc', 'returns': 'VncInfo' }
1006 # @query-vnc-servers:
1008 # Returns a list of vnc servers. The list can be empty.
1010 # Returns: a list of @VncInfo2
1014 { 'command': 'query-vnc-servers', 'returns': ['VncInfo2'] }
1019 # The basic information for SPICE network connection
1023 # @port: port number
1025 # @family: address family
1029 { 'struct': 'SpiceBasicInfo',
1030 'data': { 'host': 'str',
1032 'family': 'NetworkAddressFamily' } }
1037 # Information about a SPICE server
1039 # @auth: #optional, authentication method
1043 { 'struct': 'SpiceServerInfo',
1044 'base': 'SpiceBasicInfo',
1045 'data': { '*auth': 'str' } }
1050 # Information about a SPICE client channel.
1052 # @connection-id: SPICE connection id number. All channels with the same id
1053 # belong to the same SPICE session.
1055 # @channel-type: SPICE channel type number. "1" is the main control
1056 # channel, filter for this one if you want to track spice
1059 # @channel-id: SPICE channel ID number. Usually "0", might be different when
1060 # multiple channels of the same type exist, such as multiple
1061 # display channels in a multihead setup
1063 # @tls: true if the channel is encrypted, false otherwise.
1067 { 'struct': 'SpiceChannel',
1068 'base': 'SpiceBasicInfo',
1069 'data': {'connection-id': 'int', 'channel-type': 'int', 'channel-id': 'int',
1073 # @SpiceQueryMouseMode
1075 # An enumeration of Spice mouse states.
1077 # @client: Mouse cursor position is determined by the client.
1079 # @server: Mouse cursor position is determined by the server.
1081 # @unknown: No information is available about mouse mode used by
1084 # Note: spice/enums.h has a SpiceMouseMode already, hence the name.
1088 { 'enum': 'SpiceQueryMouseMode',
1089 'data': [ 'client', 'server', 'unknown' ] }
1094 # Information about the SPICE session.
1096 # @enabled: true if the SPICE server is enabled, false otherwise
1098 # @migrated: true if the last guest migration completed and spice
1099 # migration had completed as well. false otherwise.
1101 # @host: #optional The hostname the SPICE server is bound to. This depends on
1102 # the name resolution on the host and may be an IP address.
1104 # @port: #optional The SPICE server's port number.
1106 # @compiled-version: #optional SPICE server version.
1108 # @tls-port: #optional The SPICE server's TLS port number.
1110 # @auth: #optional the current authentication type used by the server
1111 # 'none' if no authentication is being used
1112 # 'spice' uses SASL or direct TLS authentication, depending on command
1115 # @mouse-mode: The mode in which the mouse cursor is displayed currently. Can
1116 # be determined by the client or the server, or unknown if spice
1117 # server doesn't provide this information.
1121 # @channels: a list of @SpiceChannel for each active spice channel
1125 { 'struct': 'SpiceInfo',
1126 'data': {'enabled': 'bool', 'migrated': 'bool', '*host': 'str', '*port': 'int',
1127 '*tls-port': 'int', '*auth': 'str', '*compiled-version': 'str',
1128 'mouse-mode': 'SpiceQueryMouseMode', '*channels': ['SpiceChannel']} }
1133 # Returns information about the current SPICE server
1135 # Returns: @SpiceInfo
1139 { 'command': 'query-spice', 'returns': 'SpiceInfo' }
1144 # Information about the guest balloon device.
1146 # @actual: the number of bytes the balloon currently contains
1151 { 'struct': 'BalloonInfo', 'data': {'actual': 'int' } }
1156 # Return information about the balloon device.
1158 # Returns: @BalloonInfo on success
1159 # If the balloon driver is enabled but not functional because the KVM
1160 # kernel module cannot support it, KvmMissingCap
1161 # If no balloon device is present, DeviceNotActive
1165 { 'command': 'query-balloon', 'returns': 'BalloonInfo' }
1170 # A PCI device memory region
1172 # @base: the starting address (guest physical)
1174 # @limit: the ending address (guest physical)
1178 { 'struct': 'PciMemoryRange', 'data': {'base': 'int', 'limit': 'int'} }
1183 # Information about a PCI device I/O region.
1185 # @bar: the index of the Base Address Register for this region
1187 # @type: 'io' if the region is a PIO region
1188 # 'memory' if the region is a MMIO region
1190 # @prefetch: #optional if @type is 'memory', true if the memory is prefetchable
1192 # @mem_type_64: #optional if @type is 'memory', true if the BAR is 64-bit
1196 { 'struct': 'PciMemoryRegion',
1197 'data': {'bar': 'int', 'type': 'str', 'address': 'int', 'size': 'int',
1198 '*prefetch': 'bool', '*mem_type_64': 'bool' } }
1203 # Information about a bus of a PCI Bridge device
1205 # @number: primary bus interface number. This should be the number of the
1206 # bus the device resides on.
1208 # @secondary: secondary bus interface number. This is the number of the
1209 # main bus for the bridge
1211 # @subordinate: This is the highest number bus that resides below the
1214 # @io_range: The PIO range for all devices on this bridge
1216 # @memory_range: The MMIO range for all devices on this bridge
1218 # @prefetchable_range: The range of prefetchable MMIO for all devices on
1223 { 'struct': 'PciBusInfo',
1224 'data': {'number': 'int', 'secondary': 'int', 'subordinate': 'int',
1225 'io_range': 'PciMemoryRange',
1226 'memory_range': 'PciMemoryRange',
1227 'prefetchable_range': 'PciMemoryRange' } }
1232 # Information about a PCI Bridge device
1234 # @bus: information about the bus the device resides on
1236 # @devices: a list of @PciDeviceInfo for each device on this bridge
1240 { 'struct': 'PciBridgeInfo',
1241 'data': {'bus': 'PciBusInfo', '*devices': ['PciDeviceInfo']} }
1246 # Information about the Class of a PCI device
1248 # @desc: #optional a string description of the device's class
1250 # @class: the class code of the device
1254 { 'struct': 'PciDeviceClass',
1255 'data': {'*desc': 'str', 'class': 'int'} }
1260 # Information about the Id of a PCI device
1262 # @device: the PCI device id
1264 # @vendor: the PCI vendor id
1268 { 'struct': 'PciDeviceId',
1269 'data': {'device': 'int', 'vendor': 'int'} }
1274 # Information about a PCI device
1276 # @bus: the bus number of the device
1278 # @slot: the slot the device is located in
1280 # @function: the function of the slot used by the device
1282 # @class_info: the class of the device
1284 # @id: the PCI device id
1286 # @irq: #optional if an IRQ is assigned to the device, the IRQ number
1288 # @qdev_id: the device name of the PCI device
1290 # @pci_bridge: if the device is a PCI bridge, the bridge information
1292 # @regions: a list of the PCI I/O regions associated with the device
1294 # Notes: the contents of @class_info.desc are not stable and should only be
1295 # treated as informational.
1299 { 'struct': 'PciDeviceInfo',
1300 'data': {'bus': 'int', 'slot': 'int', 'function': 'int',
1301 'class_info': 'PciDeviceClass', 'id': 'PciDeviceId',
1302 '*irq': 'int', 'qdev_id': 'str', '*pci_bridge': 'PciBridgeInfo',
1303 'regions': ['PciMemoryRegion']} }
1308 # Information about a PCI bus
1310 # @bus: the bus index
1312 # @devices: a list of devices on this bus
1316 { 'struct': 'PciInfo', 'data': {'bus': 'int', 'devices': ['PciDeviceInfo']} }
1321 # Return information about the PCI bus topology of the guest.
1323 # Returns: a list of @PciInfo for each PCI bus
1327 { 'command': 'query-pci', 'returns': ['PciInfo'] }
1332 # This command will cause the QEMU process to exit gracefully. While every
1333 # attempt is made to send the QMP response before terminating, this is not
1334 # guaranteed. When using this interface, a premature EOF would not be
1339 { 'command': 'quit' }
1344 # Stop all guest VCPU execution.
1348 # Notes: This function will succeed even if the guest is already in the stopped
1349 # state. In "inmigrate" state, it will ensure that the guest
1350 # remains paused once migration finishes, as if the -S option was
1351 # passed on the command line.
1353 { 'command': 'stop' }
1358 # Performs a hard reset of a guest.
1362 { 'command': 'system_reset' }
1365 # @system_powerdown:
1367 # Requests that a guest perform a powerdown operation.
1371 # Notes: A guest may or may not respond to this command. This command
1372 # returning does not indicate that a guest has accepted the request or
1373 # that it has shut down. Many guests will respond to this command by
1374 # prompting the user in some way.
1376 { 'command': 'system_powerdown' }
1381 # This command is a nop that is only provided for the purposes of compatibility.
1385 # Notes: Do not use this command.
1387 { 'command': 'cpu', 'data': {'index': 'int'} }
1392 # Adds CPU with specified ID
1394 # @id: ID of CPU to be created, valid values [0..max_cpus)
1396 # Returns: Nothing on success
1400 { 'command': 'cpu-add', 'data': {'id': 'int'} }
1405 # Save a portion of guest memory to a file.
1407 # @val: the virtual address of the guest to start from
1409 # @size: the size of memory region to save
1411 # @filename: the file to save the memory to as binary data
1413 # @cpu-index: #optional the index of the virtual CPU to use for translating the
1414 # virtual address (defaults to CPU 0)
1416 # Returns: Nothing on success
1420 # Notes: Errors were not reliably returned until 1.1
1422 { 'command': 'memsave',
1423 'data': {'val': 'int', 'size': 'int', 'filename': 'str', '*cpu-index': 'int'} }
1428 # Save a portion of guest physical memory to a file.
1430 # @val: the physical address of the guest to start from
1432 # @size: the size of memory region to save
1434 # @filename: the file to save the memory to as binary data
1436 # Returns: Nothing on success
1440 # Notes: Errors were not reliably returned until 1.1
1442 { 'command': 'pmemsave',
1443 'data': {'val': 'int', 'size': 'int', 'filename': 'str'} }
1448 # Resume guest VCPU execution.
1452 # Returns: If successful, nothing
1453 # If QEMU was started with an encrypted block device and a key has
1454 # not yet been set, DeviceEncrypted.
1456 # Notes: This command will succeed if the guest is currently running. It
1457 # will also succeed if the guest is in the "inmigrate" state; in
1458 # this case, the effect of the command is to make sure the guest
1459 # starts once migration finishes, removing the effect of the -S
1460 # command line option if it was passed.
1462 { 'command': 'cont' }
1467 # Wakeup guest from suspend. Does nothing in case the guest isn't suspended.
1473 { 'command': 'system_wakeup' }
1478 # Injects a Non-Maskable Interrupt into the default CPU (x86/s390) or all CPUs (ppc64).
1480 # Returns: If successful, nothing
1484 # Note: prior to 2.1, this command was only supported for x86 and s390 VMs
1486 { 'command': 'inject-nmi' }
1491 # Sets the link status of a virtual network adapter.
1493 # @name: the device name of the virtual network adapter
1495 # @up: true to set the link status to be up
1497 # Returns: Nothing on success
1498 # If @name is not a valid network device, DeviceNotFound
1502 # Notes: Not all network adapters support setting link status. This command
1503 # will succeed even if the network adapter does not support link status
1506 { 'command': 'set_link', 'data': {'name': 'str', 'up': 'bool'} }
1511 # Gets the link status of a virtual network adapter.
1513 # @name: the device name of the virtual network adapter
1515 # Returns: on|off on success
1516 # If @name is not a valid network device, DeviceNotFound
1520 # Notes: Not all network adapters support setting link status. This command
1521 # will succeed even if the network adapter does not support link status
1525 { 'struct': 'LinkInfo', 'data': {'is_up': 'bool'} }
1526 { 'command': 'get_link', 'data': {'name': 'str'}, 'returns': 'LinkInfo' }
1531 # Request the balloon driver to change its balloon size.
1533 # @value: the target size of the balloon in bytes
1535 # Returns: Nothing on success
1536 # If the balloon driver is enabled but not functional because the KVM
1537 # kernel module cannot support it, KvmMissingCap
1538 # If no balloon device is present, DeviceNotActive
1540 # Notes: This command just issues a request to the guest. When it returns,
1541 # the balloon size may not have changed. A guest can change the balloon
1542 # size independent of this command.
1546 { 'command': 'balloon', 'data': {'value': 'int'} }
1551 # This action can be used to test transaction failure.
1555 { 'struct': 'Abort',
1559 # @ActionCompletionMode
1561 # An enumeration of Transactional completion modes.
1563 # @individual: Do not attempt to cancel any other Actions if any Actions fail
1564 # after the Transaction request succeeds. All Actions that
1565 # can complete successfully will do so without waiting on others.
1566 # This is the default.
1568 # @grouped: If any Action fails after the Transaction succeeds, cancel all
1569 # Actions. Actions do not complete until all Actions are ready to
1570 # complete. May be rejected by Actions that do not support this
1575 { 'enum': 'ActionCompletionMode',
1576 'data': [ 'individual', 'grouped' ] }
1579 # @TransactionAction
1581 # A discriminated record of operations that can be performed with
1586 # drive-backup since 1.6
1588 # blockdev-snapshot-internal-sync since 1.7
1589 # blockdev-backup since 2.3
1590 # blockdev-snapshot since 2.5
1591 # block-dirty-bitmap-add since 2.5
1592 # block-dirty-bitmap-clear since 2.5
1594 { 'union': 'TransactionAction',
1596 'blockdev-snapshot': 'BlockdevSnapshot',
1597 'blockdev-snapshot-sync': 'BlockdevSnapshotSync',
1598 'drive-backup': 'DriveBackup',
1599 'blockdev-backup': 'BlockdevBackup',
1601 'blockdev-snapshot-internal-sync': 'BlockdevSnapshotInternal',
1602 'block-dirty-bitmap-add': 'BlockDirtyBitmapAdd',
1603 'block-dirty-bitmap-clear': 'BlockDirtyBitmap'
1607 # @TransactionProperties
1609 # Optional arguments to modify the behavior of a Transaction.
1611 # @completion-mode: #optional Controls how jobs launched asynchronously by
1612 # Actions will complete or fail as a group.
1613 # See @ActionCompletionMode for details.
1617 { 'struct': 'TransactionProperties',
1619 '*completion-mode': 'ActionCompletionMode'
1626 # Executes a number of transactionable QMP commands atomically. If any
1627 # operation fails, then the entire set of actions will be abandoned and the
1628 # appropriate error returned.
1630 # @actions: List of @TransactionAction;
1631 # information needed for the respective operations.
1633 # @properties: #optional structure of additional options to control the
1634 # execution of the transaction. See @TransactionProperties
1635 # for additional detail.
1637 # Returns: nothing on success
1638 # Errors depend on the operations of the transaction
1640 # Note: The transaction aborts on the first failure. Therefore, there will be
1641 # information on only one failed operation returned in an error condition, and
1642 # subsequent actions will not have been attempted.
1646 { 'command': 'transaction',
1647 'data': { 'actions': [ 'TransactionAction' ],
1648 '*properties': 'TransactionProperties'
1653 # @human-monitor-command:
1655 # Execute a command on the human monitor and return the output.
1657 # @command-line: the command to execute in the human monitor
1659 # @cpu-index: #optional The CPU to use for commands that require an implicit CPU
1661 # Returns: the output of the command as a string
1665 # Notes: This command only exists as a stop-gap. Its use is highly
1666 # discouraged. The semantics of this command are not guaranteed.
1668 # Known limitations:
1670 # o This command is stateless, this means that commands that depend
1671 # on state information (such as getfd) might not work
1673 # o Commands that prompt the user for data (eg. 'cont' when the block
1674 # device is encrypted) don't currently work
1676 { 'command': 'human-monitor-command',
1677 'data': {'command-line': 'str', '*cpu-index': 'int'},
1683 # Cancel the current executing migration process.
1685 # Returns: nothing on success
1687 # Notes: This command succeeds even if there is no migration process running.
1691 { 'command': 'migrate_cancel' }
1694 # @migrate_set_downtime
1696 # Set maximum tolerated downtime for migration.
1698 # @value: maximum downtime in seconds
1700 # Returns: nothing on success
1704 { 'command': 'migrate_set_downtime', 'data': {'value': 'number'} }
1707 # @migrate_set_speed
1709 # Set maximum speed for migration.
1711 # @value: maximum speed in bytes.
1713 # Returns: nothing on success
1715 # Notes: A value lesser than zero will be automatically round up to zero.
1719 { 'command': 'migrate_set_speed', 'data': {'value': 'int'} }
1722 # @migrate-set-cache-size
1724 # Set XBZRLE cache size
1726 # @value: cache size in bytes
1728 # The size will be rounded down to the nearest power of 2.
1729 # The cache size can be modified before and during ongoing migration
1731 # Returns: nothing on success
1735 { 'command': 'migrate-set-cache-size', 'data': {'value': 'int'} }
1738 # @query-migrate-cache-size
1740 # query XBZRLE cache size
1742 # Returns: XBZRLE cache size in bytes
1746 { 'command': 'query-migrate-cache-size', 'returns': 'int' }
1749 # @ObjectPropertyInfo:
1751 # @name: the name of the property
1753 # @type: the type of the property. This will typically come in one of four
1756 # 1) A primitive type such as 'u8', 'u16', 'bool', 'str', or 'double'.
1757 # These types are mapped to the appropriate JSON type.
1759 # 2) A child type in the form 'child<subtype>' where subtype is a qdev
1760 # device type name. Child properties create the composition tree.
1762 # 3) A link type in the form 'link<subtype>' where subtype is a qdev
1763 # device type name. Link properties form the device model graph.
1767 { 'struct': 'ObjectPropertyInfo',
1768 'data': { 'name': 'str', 'type': 'str' } }
1773 # This command will list any properties of a object given a path in the object
1776 # @path: the path within the object model. See @qom-get for a description of
1779 # Returns: a list of @ObjectPropertyInfo that describe the properties of the
1784 { 'command': 'qom-list',
1785 'data': { 'path': 'str' },
1786 'returns': [ 'ObjectPropertyInfo' ] }
1791 # This command will get a property from a object model path and return the
1794 # @path: The path within the object model. There are two forms of supported
1795 # paths--absolute and partial paths.
1797 # Absolute paths are derived from the root object and can follow child<>
1798 # or link<> properties. Since they can follow link<> properties, they
1799 # can be arbitrarily long. Absolute paths look like absolute filenames
1800 # and are prefixed with a leading slash.
1802 # Partial paths look like relative filenames. They do not begin
1803 # with a prefix. The matching rules for partial paths are subtle but
1804 # designed to make specifying objects easy. At each level of the
1805 # composition tree, the partial path is matched as an absolute path.
1806 # The first match is not returned. At least two matches are searched
1807 # for. A successful result is only returned if only one match is
1808 # found. If more than one match is found, a flag is return to
1809 # indicate that the match was ambiguous.
1811 # @property: The property name to read
1813 # Returns: The property value. The type depends on the property
1814 # type. child<> and link<> properties are returned as #str
1815 # pathnames. All integer property types (u8, u16, etc) are
1820 { 'command': 'qom-get',
1821 'data': { 'path': 'str', 'property': 'str' },
1827 # This command will set a property from a object model path.
1829 # @path: see @qom-get for a description of this parameter
1831 # @property: the property name to set
1833 # @value: a value who's type is appropriate for the property type. See @qom-get
1834 # for a description of type mapping.
1838 { 'command': 'qom-set',
1839 'data': { 'path': 'str', 'property': 'str', 'value': 'any' } }
1844 # Sets the password of a remote display session.
1846 # @protocol: `vnc' to modify the VNC server password
1847 # `spice' to modify the Spice server password
1849 # @password: the new password
1851 # @connected: #optional how to handle existing clients when changing the
1852 # password. If nothing is specified, defaults to `keep'
1853 # `fail' to fail the command if clients are connected
1854 # `disconnect' to disconnect existing clients
1855 # `keep' to maintain existing clients
1857 # Returns: Nothing on success
1858 # If Spice is not enabled, DeviceNotFound
1862 { 'command': 'set_password',
1863 'data': {'protocol': 'str', 'password': 'str', '*connected': 'str'} }
1868 # Expire the password of a remote display server.
1870 # @protocol: the name of the remote display protocol `vnc' or `spice'
1872 # @time: when to expire the password.
1873 # `now' to expire the password immediately
1874 # `never' to cancel password expiration
1875 # `+INT' where INT is the number of seconds from now (integer)
1876 # `INT' where INT is the absolute time in seconds
1878 # Returns: Nothing on success
1879 # If @protocol is `spice' and Spice is not active, DeviceNotFound
1883 # Notes: Time is relative to the server and currently there is no way to
1884 # coordinate server time with client time. It is not recommended to
1885 # use the absolute time version of the @time parameter unless you're
1886 # sure you are on the same machine as the QEMU instance.
1888 { 'command': 'expire_password', 'data': {'protocol': 'str', 'time': 'str'} }
1891 # @change-vnc-password:
1893 # Change the VNC server password.
1895 # @password: the new password to use with VNC authentication
1899 # Notes: An empty password in this command will set the password to the empty
1900 # string. Existing clients are unaffected by executing this command.
1902 { 'command': 'change-vnc-password', 'data': {'password': 'str'} }
1907 # This command is multiple commands multiplexed together.
1909 # @device: This is normally the name of a block device but it may also be 'vnc'.
1910 # when it's 'vnc', then sub command depends on @target
1912 # @target: If @device is a block device, then this is the new filename.
1913 # If @device is 'vnc', then if the value 'password' selects the vnc
1914 # change password command. Otherwise, this specifies a new server URI
1915 # address to listen to for VNC connections.
1917 # @arg: If @device is a block device, then this is an optional format to open
1919 # If @device is 'vnc' and @target is 'password', this is the new VNC
1920 # password to set. If this argument is an empty string, then no future
1921 # logins will be allowed.
1923 # Returns: Nothing on success.
1924 # If @device is not a valid block device, DeviceNotFound
1925 # If the new block device is encrypted, DeviceEncrypted. Note that
1926 # if this error is returned, the device has been opened successfully
1927 # and an additional call to @block_passwd is required to set the
1928 # device's password. The behavior of reads and writes to the block
1929 # device between when these calls are executed is undefined.
1931 # Notes: This interface is deprecated, and it is strongly recommended that you
1932 # avoid using it. For changing block devices, use
1933 # blockdev-change-medium; for changing VNC parameters, use
1934 # change-vnc-password.
1938 { 'command': 'change',
1939 'data': {'device': 'str', 'target': 'str', '*arg': 'str'} }
1944 # This structure describes a search result from @qom-list-types
1946 # @name: the type name found in the search
1950 # Notes: This command is experimental and may change syntax in future releases.
1952 { 'struct': 'ObjectTypeInfo',
1953 'data': { 'name': 'str' } }
1958 # This command will return a list of types given search parameters
1960 # @implements: if specified, only return types that implement this type name
1962 # @abstract: if true, include abstract types in the results
1964 # Returns: a list of @ObjectTypeInfo or an empty list if no results are found
1968 { 'command': 'qom-list-types',
1969 'data': { '*implements': 'str', '*abstract': 'bool' },
1970 'returns': [ 'ObjectTypeInfo' ] }
1973 # @DevicePropertyInfo:
1975 # Information about device properties.
1977 # @name: the name of the property
1978 # @type: the typename of the property
1979 # @description: #optional if specified, the description of the property.
1984 { 'struct': 'DevicePropertyInfo',
1985 'data': { 'name': 'str', 'type': 'str', '*description': 'str' } }
1988 # @device-list-properties:
1990 # List properties associated with a device.
1992 # @typename: the type name of a device
1994 # Returns: a list of DevicePropertyInfo describing a devices properties
1998 { 'command': 'device-list-properties',
1999 'data': { 'typename': 'str'},
2000 'returns': [ 'DevicePropertyInfo' ] }
2005 # Migrates the current running guest to another Virtual Machine.
2007 # @uri: the Uniform Resource Identifier of the destination VM
2009 # @blk: #optional do block migration (full disk copy)
2011 # @inc: #optional incremental disk copy migration
2013 # @detach: this argument exists only for compatibility reasons and
2014 # is ignored by QEMU
2016 # Returns: nothing on success
2020 { 'command': 'migrate',
2021 'data': {'uri': 'str', '*blk': 'bool', '*inc': 'bool', '*detach': 'bool' } }
2026 # Start an incoming migration, the qemu must have been started
2027 # with -incoming defer
2029 # @uri: The Uniform Resource Identifier identifying the source or
2030 # address to listen on
2032 # Returns: nothing on success
2035 # Note: It's a bad idea to use a string for the uri, but it needs to stay
2036 # compatible with -incoming and the format of the uri is already exposed
2039 { 'command': 'migrate-incoming', 'data': {'uri': 'str' } }
2041 # @xen-save-devices-state:
2043 # Save the state of all devices to file. The RAM and the block devices
2044 # of the VM are not saved by this command.
2046 # @filename: the file to save the state of the devices to as binary
2047 # data. See xen-save-devices-state.txt for a description of the binary
2050 # Returns: Nothing on success
2054 { 'command': 'xen-save-devices-state', 'data': {'filename': 'str'} }
2057 # @xen-set-global-dirty-log
2059 # Enable or disable the global dirty log mode.
2061 # @enable: true to enable, false to disable.
2067 { 'command': 'xen-set-global-dirty-log', 'data': { 'enable': 'bool' } }
2072 # Remove a device from a guest
2074 # @id: the name or QOM path of the device
2076 # Returns: Nothing on success
2077 # If @id is not a valid device, DeviceNotFound
2079 # Notes: When this command completes, the device may not be removed from the
2080 # guest. Hot removal is an operation that requires guest cooperation.
2081 # This command merely requests that the guest begin the hot removal
2082 # process. Completion of the device removal process is signaled with a
2083 # DEVICE_DELETED event. Guest reset will automatically complete removal
2088 { 'command': 'device_del', 'data': {'id': 'str'} }
2091 # @DumpGuestMemoryFormat:
2093 # An enumeration of guest-memory-dump's format.
2097 # @kdump-zlib: kdump-compressed format with zlib-compressed
2099 # @kdump-lzo: kdump-compressed format with lzo-compressed
2101 # @kdump-snappy: kdump-compressed format with snappy-compressed
2105 { 'enum': 'DumpGuestMemoryFormat',
2106 'data': [ 'elf', 'kdump-zlib', 'kdump-lzo', 'kdump-snappy' ] }
2109 # @dump-guest-memory
2111 # Dump guest's memory to vmcore. It is a synchronous operation that can take
2112 # very long depending on the amount of guest memory. This command is only
2113 # supported on i386 and x86_64.
2115 # @paging: if true, do paging to get guest's memory mapping. This allows
2116 # using gdb to process the core file.
2118 # IMPORTANT: this option can make QEMU allocate several gigabytes
2119 # of RAM. This can happen for a large guest, or a
2120 # malicious guest pretending to be large.
2122 # Also, paging=true has the following limitations:
2124 # 1. The guest may be in a catastrophic state or can have corrupted
2125 # memory, which cannot be trusted
2126 # 2. The guest can be in real-mode even if paging is enabled. For
2127 # example, the guest uses ACPI to sleep, and ACPI sleep state
2130 # @protocol: the filename or file descriptor of the vmcore. The supported
2133 # 1. file: the protocol starts with "file:", and the following
2134 # string is the file's path.
2135 # 2. fd: the protocol starts with "fd:", and the following string
2138 # @begin: #optional if specified, the starting physical address.
2140 # @length: #optional if specified, the memory size, in bytes. If you don't
2141 # want to dump all guest's memory, please specify the start @begin
2144 # @format: #optional if specified, the format of guest memory dump. But non-elf
2145 # format is conflict with paging and filter, ie. @paging, @begin and
2146 # @length is not allowed to be specified with non-elf @format at the
2147 # same time (since 2.0)
2149 # Returns: nothing on success
2153 { 'command': 'dump-guest-memory',
2154 'data': { 'paging': 'bool', 'protocol': 'str', '*begin': 'int',
2155 '*length': 'int', '*format': 'DumpGuestMemoryFormat' } }
2158 # @DumpGuestMemoryCapability:
2160 # A list of the available formats for dump-guest-memory
2164 { 'struct': 'DumpGuestMemoryCapability',
2166 'formats': ['DumpGuestMemoryFormat'] } }
2169 # @query-dump-guest-memory-capability:
2171 # Returns the available formats for dump-guest-memory
2173 # Returns: A @DumpGuestMemoryCapability object listing available formats for
2178 { 'command': 'query-dump-guest-memory-capability',
2179 'returns': 'DumpGuestMemoryCapability' }
2184 # Dump guest's storage keys
2186 # @filename: the path to the file to dump to
2188 # This command is only supported on s390 architecture.
2192 { 'command': 'dump-skeys',
2193 'data': { 'filename': 'str' } }
2198 # Add a network backend.
2200 # @type: the type of network backend. Current valid values are 'user', 'tap',
2201 # 'vde', 'socket', 'dump' and 'bridge'
2203 # @id: the name of the new network backend
2205 # Additional arguments depend on the type.
2207 # TODO This command effectively bypasses QAPI completely due to its
2208 # "additional arguments" business. It shouldn't have been added to
2209 # the schema in this form. It should be qapified properly, or
2210 # replaced by a properly qapified command.
2214 # Returns: Nothing on success
2215 # If @type is not a valid network backend, DeviceNotFound
2217 { 'command': 'netdev_add',
2218 'data': {'type': 'str', 'id': 'str'},
2219 'gen': false } # so we can get the additional arguments
2224 # Remove a network backend.
2226 # @id: the name of the network backend to remove
2228 # Returns: Nothing on success
2229 # If @id is not a valid network backend, DeviceNotFound
2233 { 'command': 'netdev_del', 'data': {'id': 'str'} }
2238 # Create a QOM object.
2240 # @qom-type: the class name for the object to be created
2242 # @id: the name of the new object
2244 # @props: #optional a dictionary of properties to be passed to the backend
2246 # Returns: Nothing on success
2247 # Error if @qom-type is not a valid class name
2251 { 'command': 'object-add',
2252 'data': {'qom-type': 'str', 'id': 'str', '*props': 'any'} }
2257 # Remove a QOM object.
2259 # @id: the name of the QOM object to remove
2261 # Returns: Nothing on success
2262 # Error if @id is not a valid id for a QOM object
2266 { 'command': 'object-del', 'data': {'id': 'str'} }
2269 # @NetdevNoneOptions
2271 # Use it alone to have zero network devices.
2275 { 'struct': 'NetdevNoneOptions',
2279 # @NetLegacyNicOptions
2281 # Create a new Network Interface Card.
2283 # @netdev: #optional id of -netdev to connect to
2285 # @macaddr: #optional MAC address
2287 # @model: #optional device model (e1000, rtl8139, virtio etc.)
2289 # @addr: #optional PCI device address
2291 # @vectors: #optional number of MSI-x vectors, 0 to disable MSI-X
2295 { 'struct': 'NetLegacyNicOptions',
2301 '*vectors': 'uint32' } }
2306 # A fat type wrapping 'str', to be embedded in lists.
2310 { 'struct': 'String',
2315 # @NetdevUserOptions
2317 # Use the user mode network stack which requires no administrator privilege to
2320 # @hostname: #optional client hostname reported by the builtin DHCP server
2322 # @restrict: #optional isolate the guest from the host
2324 # @ip: #optional legacy parameter, use net= instead
2326 # @net: #optional IP address and optional netmask
2328 # @host: #optional guest-visible address of the host
2330 # @tftp: #optional root directory of the built-in TFTP server
2332 # @bootfile: #optional BOOTP filename, for use with tftp=
2334 # @dhcpstart: #optional the first of the 16 IPs the built-in DHCP server can
2337 # @dns: #optional guest-visible address of the virtual nameserver
2339 # @dnssearch: #optional list of DNS suffixes to search, passed as DHCP option
2342 # @smb: #optional root directory of the built-in SMB server
2344 # @smbserver: #optional IP address of the built-in SMB server
2346 # @hostfwd: #optional redirect incoming TCP or UDP host connections to guest
2349 # @guestfwd: #optional forward guest TCP connections
2353 { 'struct': 'NetdevUserOptions',
2356 '*restrict': 'bool',
2362 '*dhcpstart': 'str',
2364 '*dnssearch': ['String'],
2366 '*smbserver': 'str',
2367 '*hostfwd': ['String'],
2368 '*guestfwd': ['String'] } }
2373 # Connect the host TAP network interface name to the VLAN.
2375 # @ifname: #optional interface name
2377 # @fd: #optional file descriptor of an already opened tap
2379 # @fds: #optional multiple file descriptors of already opened multiqueue capable
2382 # @script: #optional script to initialize the interface
2384 # @downscript: #optional script to shut down the interface
2386 # @helper: #optional command to execute to configure bridge
2388 # @sndbuf: #optional send buffer limit. Understands [TGMKkb] suffixes.
2390 # @vnet_hdr: #optional enable the IFF_VNET_HDR flag on the tap interface
2392 # @vhost: #optional enable vhost-net network accelerator
2394 # @vhostfd: #optional file descriptor of an already opened vhost net device
2396 # @vhostfds: #optional file descriptors of multiple already opened vhost net
2399 # @vhostforce: #optional vhost on for non-MSIX virtio guests
2401 # @queues: #optional number of queues to be created for multiqueue capable tap
2405 { 'struct': 'NetdevTapOptions',
2411 '*downscript': 'str',
2414 '*vnet_hdr': 'bool',
2418 '*vhostforce': 'bool',
2419 '*queues': 'uint32'} }
2422 # @NetdevSocketOptions
2424 # Connect the VLAN to a remote VLAN in another QEMU virtual machine using a TCP
2425 # socket connection.
2427 # @fd: #optional file descriptor of an already opened socket
2429 # @listen: #optional port number, and optional hostname, to listen on
2431 # @connect: #optional port number, and optional hostname, to connect to
2433 # @mcast: #optional UDP multicast address and port number
2435 # @localaddr: #optional source address and port for multicast and udp packets
2437 # @udp: #optional UDP unicast address and port number
2441 { 'struct': 'NetdevSocketOptions',
2447 '*localaddr': 'str',
2451 # @NetdevL2TPv3Options
2453 # Connect the VLAN to Ethernet over L2TPv3 Static tunnel
2455 # @src: source address
2457 # @dst: destination address
2459 # @srcport: #optional source port - mandatory for udp, optional for ip
2461 # @dstport: #optional destination port - mandatory for udp, optional for ip
2463 # @ipv6: #optional - force the use of ipv6
2465 # @udp: #optional - use the udp version of l2tpv3 encapsulation
2467 # @cookie64: #optional - use 64 bit coookies
2469 # @counter: #optional have sequence counter
2471 # @pincounter: #optional pin sequence counter to zero -
2472 # workaround for buggy implementations or
2473 # networks with packet reorder
2475 # @txcookie: #optional 32 or 64 bit transmit cookie
2477 # @rxcookie: #optional 32 or 64 bit receive cookie
2479 # @txsession: 32 bit transmit session
2481 # @rxsession: #optional 32 bit receive session - if not specified
2482 # set to the same value as transmit
2484 # @offset: #optional additional offset - allows the insertion of
2485 # additional application-specific data before the packet payload
2489 { 'struct': 'NetdevL2TPv3Options',
2497 '*cookie64': 'bool',
2499 '*pincounter': 'bool',
2500 '*txcookie': 'uint64',
2501 '*rxcookie': 'uint64',
2502 'txsession': 'uint32',
2503 '*rxsession': 'uint32',
2504 '*offset': 'uint32' } }
2509 # Connect the VLAN to a vde switch running on the host.
2511 # @sock: #optional socket path
2513 # @port: #optional port number
2515 # @group: #optional group owner of socket
2517 # @mode: #optional permissions for socket
2521 { 'struct': 'NetdevVdeOptions',
2526 '*mode': 'uint16' } }
2529 # @NetdevDumpOptions
2531 # Dump VLAN network traffic to a file.
2533 # @len: #optional per-packet size limit (64k default). Understands [TGMKkb]
2536 # @file: #optional dump file path (default is qemu-vlan0.pcap)
2540 { 'struct': 'NetdevDumpOptions',
2546 # @NetdevBridgeOptions
2548 # Connect a host TAP network interface to a host bridge device.
2550 # @br: #optional bridge name
2552 # @helper: #optional command to execute to configure bridge
2556 { 'struct': 'NetdevBridgeOptions',
2559 '*helper': 'str' } }
2562 # @NetdevHubPortOptions
2564 # Connect two or more net clients through a software hub.
2566 # @hubid: hub identifier number
2570 { 'struct': 'NetdevHubPortOptions',
2572 'hubid': 'int32' } }
2575 # @NetdevNetmapOptions
2577 # Connect a client to a netmap-enabled NIC or to a VALE switch port
2579 # @ifname: Either the name of an existing network interface supported by
2580 # netmap, or the name of a VALE port (created on the fly).
2581 # A VALE port name is in the form 'valeXXX:YYY', where XXX and
2582 # YYY are non-negative integers. XXX identifies a switch and
2583 # YYY identifies a port of the switch. VALE ports having the
2584 # same XXX are therefore connected to the same switch.
2586 # @devname: #optional path of the netmap device (default: '/dev/netmap').
2590 { 'struct': 'NetdevNetmapOptions',
2593 '*devname': 'str' } }
2596 # @NetdevVhostUserOptions
2598 # Vhost-user network backend
2600 # @chardev: name of a unix socket chardev
2602 # @vhostforce: #optional vhost on for non-MSIX virtio guests (default: false).
2604 # @queues: #optional number of queues to be created for multiqueue vhost-user
2605 # (default: 1) (Since 2.5)
2609 { 'struct': 'NetdevVhostUserOptions',
2612 '*vhostforce': 'bool',
2613 '*queues': 'int' } }
2618 # A discriminated record of network device traits.
2622 # 'l2tpv3' - since 2.1
2625 { 'union': 'NetClientOptions',
2627 'none': 'NetdevNoneOptions',
2628 'nic': 'NetLegacyNicOptions',
2629 'user': 'NetdevUserOptions',
2630 'tap': 'NetdevTapOptions',
2631 'l2tpv3': 'NetdevL2TPv3Options',
2632 'socket': 'NetdevSocketOptions',
2633 'vde': 'NetdevVdeOptions',
2634 'dump': 'NetdevDumpOptions',
2635 'bridge': 'NetdevBridgeOptions',
2636 'hubport': 'NetdevHubPortOptions',
2637 'netmap': 'NetdevNetmapOptions',
2638 'vhost-user': 'NetdevVhostUserOptions' } }
2643 # Captures the configuration of a network device; legacy.
2645 # @vlan: #optional vlan number
2647 # @id: #optional identifier for monitor commands
2649 # @name: #optional identifier for monitor commands, ignored if @id is present
2651 # @opts: device type specific properties (legacy)
2655 { 'struct': 'NetLegacy',
2660 'opts': 'NetClientOptions' } }
2665 # Captures the configuration of a network device.
2667 # @id: identifier for monitor commands.
2669 # @opts: device type specific properties
2673 { 'struct': 'Netdev',
2676 'opts': 'NetClientOptions' } }
2679 # @NetFilterDirection
2681 # Indicates whether a netfilter is attached to a netdev's transmit queue or
2682 # receive queue or both.
2684 # @all: the filter is attached both to the receive and the transmit
2685 # queue of the netdev (default).
2687 # @rx: the filter is attached to the receive queue of the netdev,
2688 # where it will receive packets sent to the netdev.
2690 # @tx: the filter is attached to the transmit queue of the netdev,
2691 # where it will receive packets sent by the netdev.
2695 { 'enum': 'NetFilterDirection',
2696 'data': [ 'all', 'rx', 'tx' ] }
2699 # @InetSocketAddress
2701 # Captures a socket address or address range in the Internet namespace.
2703 # @host: host part of the address
2705 # @port: port part of the address, or lowest port if @to is present
2707 # @to: highest port to try
2709 # @ipv4: whether to accept IPv4 addresses, default try both IPv4 and IPv6
2712 # @ipv6: whether to accept IPv6 addresses, default try both IPv4 and IPv6
2717 { 'struct': 'InetSocketAddress',
2726 # @UnixSocketAddress
2728 # Captures a socket address in the local ("Unix socket") namespace.
2730 # @path: filesystem path to use
2734 { 'struct': 'UnixSocketAddress',
2741 # Captures the address of a socket, which could also be a named file descriptor
2745 { 'union': 'SocketAddress',
2747 'inet': 'InetSocketAddress',
2748 'unix': 'UnixSocketAddress',
2754 # Receive a file descriptor via SCM rights and assign it a name
2756 # @fdname: file descriptor name
2758 # Returns: Nothing on success
2762 # Notes: If @fdname already exists, the file descriptor assigned to
2763 # it will be closed and replaced by the received file
2765 # The 'closefd' command can be used to explicitly close the
2766 # file descriptor when it is no longer needed.
2768 { 'command': 'getfd', 'data': {'fdname': 'str'} }
2773 # Close a file descriptor previously passed via SCM rights
2775 # @fdname: file descriptor name
2777 # Returns: Nothing on success
2781 { 'command': 'closefd', 'data': {'fdname': 'str'} }
2786 # Information describing a machine.
2788 # @name: the name of the machine
2790 # @alias: #optional an alias for the machine name
2792 # @default: #optional whether the machine is default
2794 # @cpu-max: maximum number of CPUs supported by the machine type
2799 { 'struct': 'MachineInfo',
2800 'data': { 'name': 'str', '*alias': 'str',
2801 '*is-default': 'bool', 'cpu-max': 'int' } }
2806 # Return a list of supported machines
2808 # Returns: a list of MachineInfo
2812 { 'command': 'query-machines', 'returns': ['MachineInfo'] }
2815 # @CpuDefinitionInfo:
2817 # Virtual CPU definition.
2819 # @name: the name of the CPU definition
2823 { 'struct': 'CpuDefinitionInfo',
2824 'data': { 'name': 'str' } }
2827 # @query-cpu-definitions:
2829 # Return a list of supported virtual CPU definitions
2831 # Returns: a list of CpuDefInfo
2835 { 'command': 'query-cpu-definitions', 'returns': ['CpuDefinitionInfo'] }
2839 # Information about a file descriptor that was added to an fd set.
2841 # @fdset-id: The ID of the fd set that @fd was added to.
2843 # @fd: The file descriptor that was received via SCM rights and
2844 # added to the fd set.
2848 { 'struct': 'AddfdInfo', 'data': {'fdset-id': 'int', 'fd': 'int'} }
2853 # Add a file descriptor, that was passed via SCM rights, to an fd set.
2855 # @fdset-id: #optional The ID of the fd set to add the file descriptor to.
2857 # @opaque: #optional A free-form string that can be used to describe the fd.
2859 # Returns: @AddfdInfo on success
2860 # If file descriptor was not received, FdNotSupplied
2861 # If @fdset-id is a negative value, InvalidParameterValue
2863 # Notes: The list of fd sets is shared by all monitor connections.
2865 # If @fdset-id is not specified, a new fd set will be created.
2869 { 'command': 'add-fd', 'data': {'*fdset-id': 'int', '*opaque': 'str'},
2870 'returns': 'AddfdInfo' }
2875 # Remove a file descriptor from an fd set.
2877 # @fdset-id: The ID of the fd set that the file descriptor belongs to.
2879 # @fd: #optional The file descriptor that is to be removed.
2881 # Returns: Nothing on success
2882 # If @fdset-id or @fd is not found, FdNotFound
2886 # Notes: The list of fd sets is shared by all monitor connections.
2888 # If @fd is not specified, all file descriptors in @fdset-id
2891 { 'command': 'remove-fd', 'data': {'fdset-id': 'int', '*fd': 'int'} }
2896 # Information about a file descriptor that belongs to an fd set.
2898 # @fd: The file descriptor value.
2900 # @opaque: #optional A free-form string that can be used to describe the fd.
2904 { 'struct': 'FdsetFdInfo',
2905 'data': {'fd': 'int', '*opaque': 'str'} }
2910 # Information about an fd set.
2912 # @fdset-id: The ID of the fd set.
2914 # @fds: A list of file descriptors that belong to this fd set.
2918 { 'struct': 'FdsetInfo',
2919 'data': {'fdset-id': 'int', 'fds': ['FdsetFdInfo']} }
2924 # Return information describing all fd sets.
2926 # Returns: A list of @FdsetInfo
2930 # Note: The list of fd sets is shared by all monitor connections.
2933 { 'command': 'query-fdsets', 'returns': ['FdsetInfo'] }
2938 # Information describing the QEMU target.
2940 # @arch: the target architecture (eg "x86_64", "i386", etc)
2944 { 'struct': 'TargetInfo',
2945 'data': { 'arch': 'str' } }
2950 # Return information about the target for this QEMU
2952 # Returns: TargetInfo
2956 { 'command': 'query-target', 'returns': 'TargetInfo' }
2961 # An enumeration of key name.
2963 # This is used by the send-key command.
2967 # 'unmapped' and 'pause' since 2.0
2968 # 'ro' and 'kp_comma' since 2.4
2970 { 'enum': 'QKeyCode',
2971 'data': [ 'unmapped',
2972 'shift', 'shift_r', 'alt', 'alt_r', 'altgr', 'altgr_r', 'ctrl',
2973 'ctrl_r', 'menu', 'esc', '1', '2', '3', '4', '5', '6', '7', '8',
2974 '9', '0', 'minus', 'equal', 'backspace', 'tab', 'q', 'w', 'e',
2975 'r', 't', 'y', 'u', 'i', 'o', 'p', 'bracket_left', 'bracket_right',
2976 'ret', 'a', 's', 'd', 'f', 'g', 'h', 'j', 'k', 'l', 'semicolon',
2977 'apostrophe', 'grave_accent', 'backslash', 'z', 'x', 'c', 'v', 'b',
2978 'n', 'm', 'comma', 'dot', 'slash', 'asterisk', 'spc', 'caps_lock',
2979 'f1', 'f2', 'f3', 'f4', 'f5', 'f6', 'f7', 'f8', 'f9', 'f10',
2980 'num_lock', 'scroll_lock', 'kp_divide', 'kp_multiply',
2981 'kp_subtract', 'kp_add', 'kp_enter', 'kp_decimal', 'sysrq', 'kp_0',
2982 'kp_1', 'kp_2', 'kp_3', 'kp_4', 'kp_5', 'kp_6', 'kp_7', 'kp_8',
2983 'kp_9', 'less', 'f11', 'f12', 'print', 'home', 'pgup', 'pgdn', 'end',
2984 'left', 'up', 'down', 'right', 'insert', 'delete', 'stop', 'again',
2985 'props', 'undo', 'front', 'copy', 'open', 'paste', 'find', 'cut',
2986 'lf', 'help', 'meta_l', 'meta_r', 'compose', 'pause', 'ro',
2992 # Represents a keyboard key.
2996 { 'union': 'KeyValue',
2999 'qcode': 'QKeyCode' } }
3004 # Send keys to guest.
3006 # @keys: An array of @KeyValue elements. All @KeyValues in this array are
3007 # simultaneously sent to the guest. A @KeyValue.number value is sent
3008 # directly to the guest, while @KeyValue.qcode must be a valid
3011 # @hold-time: #optional time to delay key up events, milliseconds. Defaults
3014 # Returns: Nothing on success
3015 # If key is unknown or redundant, InvalidParameter
3020 { 'command': 'send-key',
3021 'data': { 'keys': ['KeyValue'], '*hold-time': 'int' } }
3026 # Write a PPM of the VGA screen to a file.
3028 # @filename: the path of a new PPM file to store the image
3030 # Returns: Nothing on success
3034 { 'command': 'screendump', 'data': {'filename': 'str'} }
3039 # Configuration info for file chardevs.
3041 # @in: #optional The name of the input file
3042 # @out: The name of the output file
3046 { 'struct': 'ChardevFile', 'data': { '*in' : 'str',
3052 # Configuration info for device and pipe chardevs.
3054 # @device: The name of the special file for the device,
3055 # i.e. /dev/ttyS0 on Unix or COM1: on Windows
3056 # @type: What kind of device this is.
3060 { 'struct': 'ChardevHostdev', 'data': { 'device' : 'str' } }
3065 # Configuration info for (stream) socket chardevs.
3067 # @addr: socket address to listen on (server=true)
3068 # or connect to (server=false)
3069 # @server: #optional create server socket (default: true)
3070 # @wait: #optional wait for incoming connection on server
3071 # sockets (default: false).
3072 # @nodelay: #optional set TCP_NODELAY socket option (default: false)
3073 # @telnet: #optional enable telnet protocol on server
3074 # sockets (default: false)
3075 # @reconnect: #optional For a client socket, if a socket is disconnected,
3076 # then attempt a reconnect after the given number of seconds.
3077 # Setting this to zero disables this function. (default: 0)
3082 { 'struct': 'ChardevSocket', 'data': { 'addr' : 'SocketAddress',
3085 '*nodelay' : 'bool',
3087 '*reconnect' : 'int' } }
3092 # Configuration info for datagram socket chardevs.
3094 # @remote: remote address
3095 # @local: #optional local address
3099 { 'struct': 'ChardevUdp', 'data': { 'remote' : 'SocketAddress',
3100 '*local' : 'SocketAddress' } }
3105 # Configuration info for mux chardevs.
3107 # @chardev: name of the base chardev.
3111 { 'struct': 'ChardevMux', 'data': { 'chardev' : 'str' } }
3116 # Configuration info for stdio chardevs.
3118 # @signal: #optional Allow signals (such as SIGINT triggered by ^C)
3119 # be delivered to qemu. Default: true in -nographic mode,
3124 { 'struct': 'ChardevStdio', 'data': { '*signal' : 'bool' } }
3127 # @ChardevSpiceChannel:
3129 # Configuration info for spice vm channel chardevs.
3131 # @type: kind of channel (for example vdagent).
3135 { 'struct': 'ChardevSpiceChannel', 'data': { 'type' : 'str' } }
3138 # @ChardevSpicePort:
3140 # Configuration info for spice port chardevs.
3142 # @fqdn: name of the channel (see docs/spice-port-fqdn.txt)
3146 { 'struct': 'ChardevSpicePort', 'data': { 'fqdn' : 'str' } }
3151 # Configuration info for virtual console chardevs.
3153 # @width: console width, in pixels
3154 # @height: console height, in pixels
3155 # @cols: console width, in chars
3156 # @rows: console height, in chars
3160 { 'struct': 'ChardevVC', 'data': { '*width' : 'int',
3168 # Configuration info for ring buffer chardevs.
3170 # @size: #optional ring buffer size, must be power of two, default is 65536
3174 { 'struct': 'ChardevRingbuf', 'data': { '*size' : 'int' } }
3179 # Configuration info for the new chardev backend.
3181 # Since: 1.4 (testdev since 2.2)
3183 { 'struct': 'ChardevDummy', 'data': { } }
3185 { 'union': 'ChardevBackend', 'data': { 'file' : 'ChardevFile',
3186 'serial' : 'ChardevHostdev',
3187 'parallel': 'ChardevHostdev',
3188 'pipe' : 'ChardevHostdev',
3189 'socket' : 'ChardevSocket',
3190 'udp' : 'ChardevUdp',
3191 'pty' : 'ChardevDummy',
3192 'null' : 'ChardevDummy',
3193 'mux' : 'ChardevMux',
3194 'msmouse': 'ChardevDummy',
3195 'braille': 'ChardevDummy',
3196 'testdev': 'ChardevDummy',
3197 'stdio' : 'ChardevStdio',
3198 'console': 'ChardevDummy',
3199 'spicevmc' : 'ChardevSpiceChannel',
3200 'spiceport' : 'ChardevSpicePort',
3202 'ringbuf': 'ChardevRingbuf',
3203 # next one is just for compatibility
3204 'memory' : 'ChardevRingbuf' } }
3209 # Return info about the chardev backend just created.
3211 # @pty: #optional name of the slave pseudoterminal device, present if
3212 # and only if a chardev of type 'pty' was created
3216 { 'struct' : 'ChardevReturn', 'data': { '*pty' : 'str' } }
3221 # Add a character device backend
3223 # @id: the chardev's ID, must be unique
3224 # @backend: backend type and parameters
3226 # Returns: ChardevReturn.
3230 { 'command': 'chardev-add', 'data': {'id' : 'str',
3231 'backend' : 'ChardevBackend' },
3232 'returns': 'ChardevReturn' }
3237 # Remove a character device backend
3239 # @id: the chardev's ID, must exist and not be in use
3241 # Returns: Nothing on success
3245 { 'command': 'chardev-remove', 'data': {'id': 'str'} }
3250 # An enumeration of TPM models
3252 # @tpm-tis: TPM TIS model
3256 { 'enum': 'TpmModel', 'data': [ 'tpm-tis' ] }
3259 # @query-tpm-models:
3261 # Return a list of supported TPM models
3263 # Returns: a list of TpmModel
3267 { 'command': 'query-tpm-models', 'returns': ['TpmModel'] }
3272 # An enumeration of TPM types
3274 # @passthrough: TPM passthrough type
3278 { 'enum': 'TpmType', 'data': [ 'passthrough' ] }
3283 # Return a list of supported TPM types
3285 # Returns: a list of TpmType
3289 { 'command': 'query-tpm-types', 'returns': ['TpmType'] }
3292 # @TPMPassthroughOptions:
3294 # Information about the TPM passthrough type
3296 # @path: #optional string describing the path used for accessing the TPM device
3298 # @cancel-path: #optional string showing the TPM's sysfs cancel file
3299 # for cancellation of TPM commands while they are executing
3303 { 'struct': 'TPMPassthroughOptions', 'data': { '*path' : 'str',
3304 '*cancel-path' : 'str'} }
3309 # A union referencing different TPM backend types' configuration options
3311 # @passthrough: The configuration options for the TPM passthrough type
3315 { 'union': 'TpmTypeOptions',
3316 'data': { 'passthrough' : 'TPMPassthroughOptions' } }
3321 # Information about the TPM
3323 # @id: The Id of the TPM
3325 # @model: The TPM frontend model
3327 # @options: The TPM (backend) type configuration options
3331 { 'struct': 'TPMInfo',
3332 'data': {'id': 'str',
3333 'model': 'TpmModel',
3334 'options': 'TpmTypeOptions' } }
3339 # Return information about the TPM device
3341 # Returns: @TPMInfo on success
3345 { 'command': 'query-tpm', 'returns': ['TPMInfo'] }
3350 # Specify an ACPI table on the command line to load.
3352 # At most one of @file and @data can be specified. The list of files specified
3353 # by any one of them is loaded and concatenated in order. If both are omitted,
3356 # Other fields / optargs can be used to override fields of the generic ACPI
3357 # table header; refer to the ACPI specification 5.0, section 5.2.6 System
3358 # Description Table Header. If a header field is not overridden, then the
3359 # corresponding value from the concatenated blob is used (in case of @file), or
3360 # it is filled in with a hard-coded value (in case of @data).
3362 # String fields are copied into the matching ACPI member from lowest address
3363 # upwards, and silently truncated / NUL-padded to length.
3365 # @sig: #optional table signature / identifier (4 bytes)
3367 # @rev: #optional table revision number (dependent on signature, 1 byte)
3369 # @oem_id: #optional OEM identifier (6 bytes)
3371 # @oem_table_id: #optional OEM table identifier (8 bytes)
3373 # @oem_rev: #optional OEM-supplied revision number (4 bytes)
3375 # @asl_compiler_id: #optional identifier of the utility that created the table
3378 # @asl_compiler_rev: #optional revision number of the utility that created the
3381 # @file: #optional colon (:) separated list of pathnames to load and
3382 # concatenate as table data. The resultant binary blob is expected to
3383 # have an ACPI table header. At least one file is required. This field
3386 # @data: #optional colon (:) separated list of pathnames to load and
3387 # concatenate as table data. The resultant binary blob must not have an
3388 # ACPI table header. At least one file is required. This field excludes
3393 { 'struct': 'AcpiTableOptions',
3398 '*oem_table_id': 'str',
3399 '*oem_rev': 'uint32',
3400 '*asl_compiler_id': 'str',
3401 '*asl_compiler_rev': 'uint32',
3406 # @CommandLineParameterType:
3408 # Possible types for an option parameter.
3410 # @string: accepts a character string
3412 # @boolean: accepts "on" or "off"
3414 # @number: accepts a number
3416 # @size: accepts a number followed by an optional suffix (K)ilo,
3417 # (M)ega, (G)iga, (T)era
3421 { 'enum': 'CommandLineParameterType',
3422 'data': ['string', 'boolean', 'number', 'size'] }
3425 # @CommandLineParameterInfo:
3427 # Details about a single parameter of a command line option.
3429 # @name: parameter name
3431 # @type: parameter @CommandLineParameterType
3433 # @help: #optional human readable text string, not suitable for parsing.
3435 # @default: #optional default value string (since 2.1)
3439 { 'struct': 'CommandLineParameterInfo',
3440 'data': { 'name': 'str',
3441 'type': 'CommandLineParameterType',
3443 '*default': 'str' } }
3446 # @CommandLineOptionInfo:
3448 # Details about a command line option, including its list of parameter details
3450 # @option: option name
3452 # @parameters: an array of @CommandLineParameterInfo
3456 { 'struct': 'CommandLineOptionInfo',
3457 'data': { 'option': 'str', 'parameters': ['CommandLineParameterInfo'] } }
3460 # @query-command-line-options:
3462 # Query command line option schema.
3464 # @option: #optional option name
3466 # Returns: list of @CommandLineOptionInfo for all options (or for the given
3467 # @option). Returns an error if the given @option doesn't exist.
3471 {'command': 'query-command-line-options', 'data': { '*option': 'str' },
3472 'returns': ['CommandLineOptionInfo'] }
3477 # A X86 32-bit register
3481 { 'enum': 'X86CPURegister32',
3482 'data': [ 'EAX', 'EBX', 'ECX', 'EDX', 'ESP', 'EBP', 'ESI', 'EDI' ] }
3485 # @X86CPUFeatureWordInfo
3487 # Information about a X86 CPU feature word
3489 # @cpuid-input-eax: Input EAX value for CPUID instruction for that feature word
3491 # @cpuid-input-ecx: #optional Input ECX value for CPUID instruction for that
3494 # @cpuid-register: Output register containing the feature bits
3496 # @features: value of output register, containing the feature bits
3500 { 'struct': 'X86CPUFeatureWordInfo',
3501 'data': { 'cpuid-input-eax': 'int',
3502 '*cpuid-input-ecx': 'int',
3503 'cpuid-register': 'X86CPURegister32',
3504 'features': 'int' } }
3509 # Not used by QMP; hack to let us use X86CPUFeatureWordInfoList internally
3513 { 'struct': 'DummyForceArrays',
3514 'data': { 'unused': ['X86CPUFeatureWordInfo'] } }
3520 # Packets receiving state
3522 # @normal: filter assigned packets according to the mac-table
3524 # @none: don't receive any assigned packet
3526 # @all: receive all assigned packets
3530 { 'enum': 'RxState', 'data': [ 'normal', 'none', 'all' ] }
3535 # Rx-filter information for a NIC.
3537 # @name: net client name
3539 # @promiscuous: whether promiscuous mode is enabled
3541 # @multicast: multicast receive state
3543 # @unicast: unicast receive state
3545 # @vlan: vlan receive state (Since 2.0)
3547 # @broadcast-allowed: whether to receive broadcast
3549 # @multicast-overflow: multicast table is overflowed or not
3551 # @unicast-overflow: unicast table is overflowed or not
3553 # @main-mac: the main macaddr string
3555 # @vlan-table: a list of active vlan id
3557 # @unicast-table: a list of unicast macaddr string
3559 # @multicast-table: a list of multicast macaddr string
3564 { 'struct': 'RxFilterInfo',
3567 'promiscuous': 'bool',
3568 'multicast': 'RxState',
3569 'unicast': 'RxState',
3571 'broadcast-allowed': 'bool',
3572 'multicast-overflow': 'bool',
3573 'unicast-overflow': 'bool',
3575 'vlan-table': ['int'],
3576 'unicast-table': ['str'],
3577 'multicast-table': ['str'] }}
3582 # Return rx-filter information for all NICs (or for the given NIC).
3584 # @name: #optional net client name
3586 # Returns: list of @RxFilterInfo for all NICs (or for the given NIC).
3587 # Returns an error if the given @name doesn't exist, or given
3588 # NIC doesn't support rx-filter querying, or given net client
3593 { 'command': 'query-rx-filter', 'data': { '*name': 'str' },
3594 'returns': ['RxFilterInfo'] }
3599 # Button of a pointer input device (mouse, tablet).
3603 # Note that the spelling of these values may change when the
3604 # x-input-send-event is promoted out of experimental status.
3606 { 'enum' : 'InputButton',
3607 'data' : [ 'Left', 'Middle', 'Right', 'WheelUp', 'WheelDown' ] }
3612 # Position axis of a pointer input device (mouse, tablet).
3616 # Note that the spelling of these values may change when the
3617 # x-input-send-event is promoted out of experimental status.
3619 { 'enum' : 'InputAxis',
3620 'data' : [ 'X', 'Y' ] }
3625 # Keyboard input event.
3627 # @key: Which key this event is for.
3628 # @down: True for key-down and false for key-up events.
3632 { 'struct' : 'InputKeyEvent',
3633 'data' : { 'key' : 'KeyValue',
3639 # Pointer button input event.
3641 # @button: Which button this event is for.
3642 # @down: True for key-down and false for key-up events.
3646 { 'struct' : 'InputBtnEvent',
3647 'data' : { 'button' : 'InputButton',
3653 # Pointer motion input event.
3655 # @axis: Which axis is referenced by @value.
3656 # @value: Pointer position. For absolute coordinates the
3657 # valid range is 0 -> 0x7ffff
3661 { 'struct' : 'InputMoveEvent',
3662 'data' : { 'axis' : 'InputAxis',
3668 # Input event union.
3670 # @key: Input event of Keyboard
3671 # @btn: Input event of pointer buttons
3672 # @rel: Input event of relative pointer motion
3673 # @abs: Input event of absolute pointer motion
3677 { 'union' : 'InputEvent',
3678 'data' : { 'key' : 'InputKeyEvent',
3679 'btn' : 'InputBtnEvent',
3680 'rel' : 'InputMoveEvent',
3681 'abs' : 'InputMoveEvent' } }
3684 # @x-input-send-event
3686 # Send input event(s) to guest.
3688 # @console: #optional console to send event(s) to.
3689 # This parameter can be used to send the input event to
3690 # specific input devices in case (a) multiple input devices
3691 # of the same kind are added to the virtual machine and (b)
3692 # you have configured input routing (see docs/multiseat.txt)
3693 # for those input devices. If input routing is not
3694 # configured this parameter has no effect.
3695 # If @console is missing, only devices that aren't associated
3696 # with a console are admissible.
3697 # If @console is specified, it must exist, and both devices
3698 # associated with that console and devices not associated with a
3699 # console are admissible, but the former take precedence.
3702 # @events: List of InputEvent union.
3704 # Returns: Nothing on success.
3708 # Note: this command is experimental, and not a stable API. Things that
3709 # might change before it becomes stable include the spelling of enum
3710 # values for InputButton and InputAxis, and the notion of how to designate
3711 # which console will receive the event.
3714 { 'command': 'x-input-send-event',
3715 'data': { '*console':'int', 'events': [ 'InputEvent' ] } }
3720 # A discriminated record of NUMA options. (for OptsVisitor)
3724 { 'union': 'NumaOptions',
3726 'node': 'NumaNodeOptions' }}
3731 # Create a guest NUMA node. (for OptsVisitor)
3733 # @nodeid: #optional NUMA node ID (increase by 1 from 0 if omitted)
3735 # @cpus: #optional VCPUs belonging to this node (assign VCPUS round-robin
3738 # @mem: #optional memory size of this node; mutually exclusive with @memdev.
3739 # Equally divide total memory among nodes if both @mem and @memdev are
3742 # @memdev: #optional memory backend object. If specified for one node,
3743 # it must be specified for all nodes.
3747 { 'struct': 'NumaNodeOptions',
3749 '*nodeid': 'uint16',
3750 '*cpus': ['uint16'],
3757 # Host memory policy types
3759 # @default: restore default policy, remove any nondefault policy
3761 # @preferred: set the preferred host nodes for allocation
3763 # @bind: a strict policy that restricts memory allocation to the
3764 # host nodes specified
3766 # @interleave: memory allocations are interleaved across the set
3767 # of host nodes specified
3771 { 'enum': 'HostMemPolicy',
3772 'data': [ 'default', 'preferred', 'bind', 'interleave' ] }
3777 # Information about memory backend
3779 # @size: memory backend size
3781 # @merge: enables or disables memory merge support
3783 # @dump: includes memory backend's memory in a core dump or not
3785 # @prealloc: enables or disables memory preallocation
3787 # @host-nodes: host nodes for its memory policy
3789 # @policy: memory policy of memory backend
3794 { 'struct': 'Memdev',
3800 'host-nodes': ['uint16'],
3801 'policy': 'HostMemPolicy' }}
3806 # Returns information for all memory backends.
3808 # Returns: a list of @Memdev.
3812 { 'command': 'query-memdev', 'returns': ['Memdev'] }
3815 # @PCDIMMDeviceInfo:
3817 # PCDIMMDevice state information
3819 # @id: #optional device's ID
3821 # @addr: physical address, where device is mapped
3823 # @size: size of memory that the device provides
3825 # @slot: slot number at which device is plugged in
3827 # @node: NUMA node number where device is plugged in
3829 # @memdev: memory backend linked with device
3831 # @hotplugged: true if device was hotplugged
3833 # @hotpluggable: true if device if could be added/removed while machine is running
3837 { 'struct': 'PCDIMMDeviceInfo',
3838 'data': { '*id': 'str',
3844 'hotplugged': 'bool',
3845 'hotpluggable': 'bool'
3850 # @MemoryDeviceInfo:
3852 # Union containing information about a memory device
3856 { 'union': 'MemoryDeviceInfo', 'data': {'dimm': 'PCDIMMDeviceInfo'} }
3859 # @query-memory-devices
3861 # Lists available memory devices and their state
3865 { 'command': 'query-memory-devices', 'returns': ['MemoryDeviceInfo'] }
3869 # @DIMM: memory slot
3871 { 'enum': 'ACPISlotType', 'data': [ 'DIMM' ] }
3875 # OSPM Status Indication for a device
3876 # For description of possible values of @source and @status fields
3877 # see "_OST (OSPM Status Indication)" chapter of ACPI5.0 spec.
3879 # @device: #optional device ID associated with slot
3881 # @slot: slot ID, unique per slot of a given @slot-type
3883 # @slot-type: type of the slot
3885 # @source: an integer containing the source event
3887 # @status: an integer containing the status code
3891 { 'struct': 'ACPIOSTInfo',
3892 'data' : { '*device': 'str',
3894 'slot-type': 'ACPISlotType',
3899 # @query-acpi-ospm-status
3901 # Lists ACPI OSPM status of ACPI device objects,
3902 # which might be reported via _OST method
3906 { 'command': 'query-acpi-ospm-status', 'returns': ['ACPIOSTInfo'] }
3909 # @WatchdogExpirationAction
3911 # An enumeration of the actions taken when the watchdog device's timer is
3914 # @reset: system resets
3916 # @shutdown: system shutdown, note that it is similar to @powerdown, which
3917 # tries to set to system status and notify guest
3919 # @poweroff: system poweroff, the emulator program exits
3921 # @pause: system pauses, similar to @stop
3923 # @debug: system enters debug state
3925 # @none: nothing is done
3927 # @inject-nmi: a non-maskable interrupt is injected into the first VCPU (all
3928 # VCPUS on x86) (since 2.4)
3932 { 'enum': 'WatchdogExpirationAction',
3933 'data': [ 'reset', 'shutdown', 'poweroff', 'pause', 'debug', 'none',
3939 # An enumeration of the I/O operation types
3941 # @read: read operation
3943 # @write: write operation
3947 { 'enum': 'IoOperationType',
3948 'data': [ 'read', 'write' ] }
3953 # An enumeration of the actions taken when guest OS panic is detected
3955 # @pause: system pauses
3959 { 'enum': 'GuestPanicAction',
3960 'data': [ 'pause' ] }
3963 # @rtc-reset-reinjection
3965 # This command will reset the RTC interrupt reinjection backlog.
3966 # Can be used if another mechanism to synchronize guest time
3967 # is in effect, for example QEMU guest agent's guest-set-time
3972 { 'command': 'rtc-reset-reinjection' }
3974 # Rocker ethernet network switch
3975 { 'include': 'qapi/rocker.json' }
3980 # Mode of the replay subsystem.
3982 # @none: normal execution mode. Replay or record are not enabled.
3984 # @record: record mode. All non-deterministic data is written into the
3987 # @play: replay mode. Non-deterministic data required for system execution
3988 # is read from the log.
3992 { 'enum': 'ReplayMode',
3993 'data': [ 'none', 'record', 'play' ] }