5 # QAPI common definitions
6 { 'include': 'qapi/common.json' }
8 # QAPI block definitions
9 { 'include': 'qapi/block.json' }
11 # QAPI event definitions
12 { 'include': 'qapi/event.json' }
15 { 'include': 'qapi/trace.json' }
20 # Policy for handling lost ticks in timer devices.
22 # @discard: throw away the missed tick(s) and continue with future injection
23 # normally. Guest time may be delayed, unless the OS has explicit
24 # handling of lost ticks
26 # @delay: continue to deliver ticks at the normal rate. Guest time will be
27 # delayed due to the late tick
29 # @merge: merge the missed tick(s) into one tick and inject. Guest time
30 # may be delayed, depending on how the OS reacts to the merging
33 # @slew: deliver ticks at a higher rate to catch up with the missed tick. The
34 # guest time should not be delayed once catchup is complete.
38 { 'enum': 'LostTickPolicy',
39 'data': ['discard', 'delay', 'merge', 'slew' ] }
43 # Allow client connections for VNC, Spice and socket based
44 # character devices to be passed in to QEMU via SCM_RIGHTS.
46 # @protocol: protocol name. Valid names are "vnc", "spice" or the
47 # name of a character device (eg. from -chardev id=XXXX)
49 # @fdname: file descriptor name previously passed via 'getfd' command
51 # @skipauth: #optional whether to skip authentication. Only applies
52 # to "vnc" and "spice" protocols
54 # @tls: #optional whether to perform TLS. Only applies to the "spice"
57 # Returns: nothing on success.
61 { 'command': 'add_client',
62 'data': { 'protocol': 'str', 'fdname': 'str', '*skipauth': 'bool',
68 # Guest name information.
70 # @name: #optional The name of the guest
74 { 'struct': 'NameInfo', 'data': {'*name': 'str'} }
79 # Return the name information of a guest.
81 # Returns: @NameInfo of the guest
85 { 'command': 'query-name', 'returns': 'NameInfo' }
90 # Information about support for KVM acceleration
92 # @enabled: true if KVM acceleration is active
94 # @present: true if KVM acceleration is built into this executable
98 { 'struct': 'KvmInfo', 'data': {'enabled': 'bool', 'present': 'bool'} }
103 # Returns information about KVM acceleration
109 { 'command': 'query-kvm', 'returns': 'KvmInfo' }
114 # An enumeration of VM run states.
116 # @debug: QEMU is running on a debugger
118 # @finish-migrate: guest is paused to finish the migration process
120 # @inmigrate: guest is paused waiting for an incoming migration. Note
121 # that this state does not tell whether the machine will start at the
122 # end of the migration. This depends on the command-line -S option and
123 # any invocation of 'stop' or 'cont' that has happened since QEMU was
126 # @internal-error: An internal error that prevents further guest execution
129 # @io-error: the last IOP has failed and the device is configured to pause
132 # @paused: guest has been paused via the 'stop' command
134 # @postmigrate: guest is paused following a successful 'migrate'
136 # @prelaunch: QEMU was started with -S and guest has not started
138 # @restore-vm: guest is paused to restore VM state
140 # @running: guest is actively running
142 # @save-vm: guest is paused to save the VM state
144 # @shutdown: guest is shut down (and -no-shutdown is in use)
146 # @suspended: guest is suspended (ACPI S3)
148 # @watchdog: the watchdog action is configured to pause and has been triggered
150 # @guest-panicked: guest has been panicked as a result of guest OS panic
152 { 'enum': 'RunState',
153 'data': [ 'debug', 'inmigrate', 'internal-error', 'io-error', 'paused',
154 'postmigrate', 'prelaunch', 'finish-migrate', 'restore-vm',
155 'running', 'save-vm', 'shutdown', 'suspended', 'watchdog',
161 # Information about VCPU run state
163 # @running: true if all VCPUs are runnable, false if not runnable
165 # @singlestep: true if VCPUs are in single-step mode
167 # @status: the virtual machine @RunState
171 # Notes: @singlestep is enabled through the GDB stub
173 { 'struct': 'StatusInfo',
174 'data': {'running': 'bool', 'singlestep': 'bool', 'status': 'RunState'} }
179 # Query the run status of all VCPUs
181 # Returns: @StatusInfo reflecting all VCPUs
185 { 'command': 'query-status', 'returns': 'StatusInfo' }
190 # Guest UUID information.
192 # @UUID: the UUID of the guest
196 # Notes: If no UUID was specified for the guest, a null UUID is returned.
198 { 'struct': 'UuidInfo', 'data': {'UUID': 'str'} }
203 # Query the guest UUID information.
205 # Returns: The @UuidInfo for the guest
209 { 'command': 'query-uuid', 'returns': 'UuidInfo' }
214 # Information about a character device.
216 # @label: the label of the character device
218 # @filename: the filename of the character device
220 # @frontend-open: shows whether the frontend device attached to this backend
221 # (eg. with the chardev=... option) is in open or closed state
224 # Notes: @filename is encoded using the QEMU command line character device
225 # encoding. See the QEMU man page for details.
229 { 'struct': 'ChardevInfo', 'data': {'label': 'str',
231 'frontend-open': 'bool'} }
236 # Returns information about current character devices.
238 # Returns: a list of @ChardevInfo
242 { 'command': 'query-chardev', 'returns': ['ChardevInfo'] }
245 # @ChardevBackendInfo:
247 # Information about a character device backend
249 # @name: The backend name
253 { 'struct': 'ChardevBackendInfo', 'data': {'name': 'str'} }
256 # @query-chardev-backends:
258 # Returns information about character device backends.
260 # Returns: a list of @ChardevBackendInfo
264 { 'command': 'query-chardev-backends', 'returns': ['ChardevBackendInfo'] }
269 # An enumeration of data format.
271 # @utf8: Data is a UTF-8 string (RFC 3629)
273 # @base64: Data is Base64 encoded binary (RFC 3548)
277 { 'enum': 'DataFormat',
278 'data': [ 'utf8', 'base64' ] }
283 # Write to a ring buffer character device.
285 # @device: the ring buffer character device name
287 # @data: data to write
289 # @format: #optional data encoding (default 'utf8').
290 # - base64: data must be base64 encoded text. Its binary
291 # decoding gets written.
292 # Bug: invalid base64 is currently not rejected.
293 # Whitespace *is* invalid.
294 # - utf8: data's UTF-8 encoding is written
295 # - data itself is always Unicode regardless of format, like
298 # Returns: Nothing on success
302 { 'command': 'ringbuf-write',
303 'data': {'device': 'str', 'data': 'str',
304 '*format': 'DataFormat'} }
309 # Read from a ring buffer character device.
311 # @device: the ring buffer character device name
313 # @size: how many bytes to read at most
315 # @format: #optional data encoding (default 'utf8').
316 # - base64: the data read is returned in base64 encoding.
317 # - utf8: the data read is interpreted as UTF-8.
318 # Bug: can screw up when the buffer contains invalid UTF-8
319 # sequences, NUL characters, after the ring buffer lost
320 # data, and when reading stops because the size limit is
322 # - The return value is always Unicode regardless of format,
323 # like any other string.
325 # Returns: data read from the device
329 { 'command': 'ringbuf-read',
330 'data': {'device': 'str', 'size': 'int', '*format': 'DataFormat'},
336 # Information about a QMP event
338 # @name: The event name
342 { 'struct': 'EventInfo', 'data': {'name': 'str'} }
347 # Return a list of supported QMP events by this server
349 # Returns: A list of @EventInfo for all supported events
353 { 'command': 'query-events', 'returns': ['EventInfo'] }
358 # Detailed migration status.
360 # @transferred: amount of bytes already transferred to the target VM
362 # @remaining: amount of bytes remaining to be transferred to the target VM
364 # @total: total amount of bytes involved in the migration process
366 # @duplicate: number of duplicate (zero) pages (since 1.2)
368 # @skipped: number of skipped zero pages (since 1.5)
370 # @normal : number of normal pages (since 1.2)
372 # @normal-bytes: number of normal bytes sent (since 1.2)
374 # @dirty-pages-rate: number of pages dirtied by second by the
377 # @mbps: throughput in megabits/sec. (since 1.6)
379 # @dirty-sync-count: number of times that dirty ram was synchronized (since 2.1)
383 { 'struct': 'MigrationStats',
384 'data': {'transferred': 'int', 'remaining': 'int', 'total': 'int' ,
385 'duplicate': 'int', 'skipped': 'int', 'normal': 'int',
386 'normal-bytes': 'int', 'dirty-pages-rate' : 'int',
387 'mbps' : 'number', 'dirty-sync-count' : 'int' } }
392 # Detailed XBZRLE migration cache statistics
394 # @cache-size: XBZRLE cache size
396 # @bytes: amount of bytes already transferred to the target VM
398 # @pages: amount of pages transferred to the target VM
400 # @cache-miss: number of cache miss
402 # @cache-miss-rate: rate of cache miss (since 2.1)
404 # @overflow: number of overflows
408 { 'struct': 'XBZRLECacheStats',
409 'data': {'cache-size': 'int', 'bytes': 'int', 'pages': 'int',
410 'cache-miss': 'int', 'cache-miss-rate': 'number',
411 'overflow': 'int' } }
415 # An enumeration of migration status.
417 # @none: no migration has ever happened.
419 # @setup: migration process has been initiated.
421 # @cancelling: in the process of cancelling migration.
423 # @cancelled: cancelling migration is finished.
425 # @active: in the process of doing migration.
427 # @completed: migration is finished.
429 # @failed: some error occurred during migration process.
434 { 'enum': 'MigrationStatus',
435 'data': [ 'none', 'setup', 'cancelling', 'cancelled',
436 'active', 'completed', 'failed' ] }
441 # Information about current migration process.
443 # @status: #optional @MigrationStatus describing the current migration status.
444 # If this field is not returned, no migration process
447 # @ram: #optional @MigrationStats containing detailed migration
448 # status, only returned if status is 'active' or
449 # 'completed'(since 1.2)
451 # @disk: #optional @MigrationStats containing detailed disk migration
452 # status, only returned if status is 'active' and it is a block
455 # @xbzrle-cache: #optional @XBZRLECacheStats containing detailed XBZRLE
456 # migration statistics, only returned if XBZRLE feature is on and
457 # status is 'active' or 'completed' (since 1.2)
459 # @total-time: #optional total amount of milliseconds since migration started.
460 # If migration has ended, it returns the total migration
463 # @downtime: #optional only present when migration finishes correctly
464 # total downtime in milliseconds for the guest.
467 # @expected-downtime: #optional only present while migration is active
468 # expected downtime in milliseconds for the guest in last walk
469 # of the dirty bitmap. (since 1.3)
471 # @setup-time: #optional amount of setup time in milliseconds _before_ the
472 # iterations begin but _after_ the QMP command is issued. This is designed
473 # to provide an accounting of any activities (such as RDMA pinning) which
474 # may be expensive, but do not actually occur during the iterative
475 # migration rounds themselves. (since 1.6)
479 { 'struct': 'MigrationInfo',
480 'data': {'*status': 'MigrationStatus', '*ram': 'MigrationStats',
481 '*disk': 'MigrationStats',
482 '*xbzrle-cache': 'XBZRLECacheStats',
483 '*total-time': 'int',
484 '*expected-downtime': 'int',
486 '*setup-time': 'int'} }
491 # Returns information about current migration process.
493 # Returns: @MigrationInfo
497 { 'command': 'query-migrate', 'returns': 'MigrationInfo' }
500 # @MigrationCapability
502 # Migration capabilities enumeration
504 # @xbzrle: Migration supports xbzrle (Xor Based Zero Run Length Encoding).
505 # This feature allows us to minimize migration traffic for certain work
506 # loads, by sending compressed difference of the pages
508 # @rdma-pin-all: Controls whether or not the entire VM memory footprint is
509 # mlock()'d on demand or all at once. Refer to docs/rdma.txt for usage.
510 # Disabled by default. (since 2.0)
512 # @zero-blocks: During storage migration encode blocks of zeroes efficiently. This
513 # essentially saves 1MB of zeroes per block on the wire. Enabling requires
514 # source and target VM to support this feature. To enable it is sufficient
515 # to enable the capability on the source VM. The feature is disabled by
516 # default. (since 1.6)
518 # @compress: Use multiple compression threads to accelerate live migration.
519 # This feature can help to reduce the migration traffic, by sending
520 # compressed pages. Please note that if compress and xbzrle are both
521 # on, compress only takes effect in the ram bulk stage, after that,
522 # it will be disabled and only xbzrle takes effect, this can help to
523 # minimize migration traffic. The feature is disabled by default.
526 # @auto-converge: If enabled, QEMU will automatically throttle down the guest
527 # to speed up convergence of RAM migration. (since 1.6)
531 { 'enum': 'MigrationCapability',
532 'data': ['xbzrle', 'rdma-pin-all', 'auto-converge', 'zero-blocks',
536 # @MigrationCapabilityStatus
538 # Migration capability information
540 # @capability: capability enum
542 # @state: capability state bool
546 { 'struct': 'MigrationCapabilityStatus',
547 'data': { 'capability' : 'MigrationCapability', 'state' : 'bool' } }
550 # @migrate-set-capabilities
552 # Enable/Disable the following migration capabilities (like xbzrle)
554 # @capabilities: json array of capability modifications to make
558 { 'command': 'migrate-set-capabilities',
559 'data': { 'capabilities': ['MigrationCapabilityStatus'] } }
562 # @query-migrate-capabilities
564 # Returns information about the current migration capabilities status
566 # Returns: @MigrationCapabilitiesStatus
570 { 'command': 'query-migrate-capabilities', 'returns': ['MigrationCapabilityStatus']}
572 # @MigrationParameter
574 # Migration parameters enumeration
576 # @compress-level: Set the compression level to be used in live migration,
577 # the compression level is an integer between 0 and 9, where 0 means
578 # no compression, 1 means the best compression speed, and 9 means best
579 # compression ratio which will consume more CPU.
581 # @compress-threads: Set compression thread count to be used in live migration,
582 # the compression thread count is an integer between 1 and 255.
584 # @decompress-threads: Set decompression thread count to be used in live
585 # migration, the decompression thread count is an integer between 1
586 # and 255. Usually, decompression is at least 4 times as fast as
587 # compression, so set the decompress-threads to the number about 1/4
588 # of compress-threads is adequate.
592 { 'enum': 'MigrationParameter',
593 'data': ['compress-level', 'compress-threads', 'decompress-threads'] }
596 # @migrate-set-parameters
598 # Set the following migration parameters
600 # @compress-level: compression level
602 # @compress-threads: compression thread count
604 # @decompress-threads: decompression thread count
608 { 'command': 'migrate-set-parameters',
609 'data': { '*compress-level': 'int',
610 '*compress-threads': 'int',
611 '*decompress-threads': 'int'} }
614 # @MigrationParameters
616 # @compress-level: compression level
618 # @compress-threads: compression thread count
620 # @decompress-threads: decompression thread count
624 { 'struct': 'MigrationParameters',
625 'data': { 'compress-level': 'int',
626 'compress-threads': 'int',
627 'decompress-threads': 'int'} }
629 # @query-migrate-parameters
631 # Returns information about the current migration parameters
633 # Returns: @MigrationParameters
637 { 'command': 'query-migrate-parameters',
638 'returns': 'MigrationParameters' }
641 # @client_migrate_info
643 # Set migration information for remote display. This makes the server
644 # ask the client to automatically reconnect using the new parameters
645 # once migration finished successfully. Only implemented for SPICE.
647 # @protocol: must be "spice"
648 # @hostname: migration target hostname
649 # @port: #optional spice tcp port for plaintext channels
650 # @tls-port: #optional spice tcp port for tls-secured channels
651 # @cert-subject: #optional server certificate subject
655 { 'command': 'client_migrate_info',
656 'data': { 'protocol': 'str', 'hostname': 'str', '*port': 'int',
657 '*tls-port': 'int', '*cert-subject': 'str' } }
662 # Information about a mouse device.
664 # @name: the name of the mouse device
666 # @index: the index of the mouse device
668 # @current: true if this device is currently receiving mouse events
670 # @absolute: true if this device supports absolute coordinates as input
674 { 'struct': 'MouseInfo',
675 'data': {'name': 'str', 'index': 'int', 'current': 'bool',
676 'absolute': 'bool'} }
681 # Returns information about each active mouse device
683 # Returns: a list of @MouseInfo for each device
687 { 'command': 'query-mice', 'returns': ['MouseInfo'] }
692 # Information about a virtual CPU
694 # @CPU: the index of the virtual CPU
696 # @current: this only exists for backwards compatible and should be ignored
698 # @halted: true if the virtual CPU is in the halt state. Halt usually refers
699 # to a processor specific low power mode.
701 # @qom_path: path to the CPU object in the QOM tree (since 2.4)
703 # @pc: #optional If the target is i386 or x86_64, this is the 64-bit instruction
705 # If the target is Sparc, this is the PC component of the
706 # instruction pointer.
708 # @nip: #optional If the target is PPC, the instruction pointer
710 # @npc: #optional If the target is Sparc, the NPC component of the instruction
713 # @PC: #optional If the target is MIPS, the instruction pointer
715 # @thread_id: ID of the underlying host thread
719 # Notes: @halted is a transient state that changes frequently. By the time the
720 # data is sent to the client, the guest may no longer be halted.
722 { 'struct': 'CpuInfo',
723 'data': {'CPU': 'int', 'current': 'bool', 'halted': 'bool',
725 '*pc': 'int', '*nip': 'int', '*npc': 'int', '*PC': 'int',
726 'thread_id': 'int'} }
731 # Returns a list of information about each virtual CPU.
733 # Returns: a list of @CpuInfo for each virtual CPU
737 { 'command': 'query-cpus', 'returns': ['CpuInfo'] }
742 # Information about an iothread
744 # @id: the identifier of the iothread
746 # @thread-id: ID of the underlying host thread
750 { 'struct': 'IOThreadInfo',
751 'data': {'id': 'str', 'thread-id': 'int'} }
756 # Returns a list of information about each iothread.
758 # Note this list excludes the QEMU main loop thread, which is not declared
759 # using the -object iothread command-line option. It is always the main thread
762 # Returns: a list of @IOThreadInfo for each iothread
766 { 'command': 'query-iothreads', 'returns': ['IOThreadInfo'] }
769 # @NetworkAddressFamily
771 # The network address family
779 # @unknown: otherwise
783 { 'enum': 'NetworkAddressFamily',
784 'data': [ 'ipv4', 'ipv6', 'unix', 'unknown' ] }
789 # The basic information for vnc network connection
793 # @service: The service name of the vnc port. This may depend on the host
794 # system's service database so symbolic names should not be relied
797 # @family: address family
799 # @websocket: true in case the socket is a websocket (since 2.3).
803 { 'struct': 'VncBasicInfo',
804 'data': { 'host': 'str',
806 'family': 'NetworkAddressFamily',
807 'websocket': 'bool' } }
812 # The network connection information for server
814 # @auth: #optional, authentication method
818 { 'struct': 'VncServerInfo',
819 'base': 'VncBasicInfo',
820 'data': { '*auth': 'str' } }
825 # Information about a connected VNC client.
827 # @x509_dname: #optional If x509 authentication is in use, the Distinguished
828 # Name of the client.
830 # @sasl_username: #optional If SASL authentication is in use, the SASL username
831 # used for authentication.
835 { 'struct': 'VncClientInfo',
836 'base': 'VncBasicInfo',
837 'data': { '*x509_dname': 'str', '*sasl_username': 'str' } }
842 # Information about the VNC session.
844 # @enabled: true if the VNC server is enabled, false otherwise
846 # @host: #optional The hostname the VNC server is bound to. This depends on
847 # the name resolution on the host and may be an IP address.
849 # @family: #optional 'ipv6' if the host is listening for IPv6 connections
850 # 'ipv4' if the host is listening for IPv4 connections
851 # 'unix' if the host is listening on a unix domain socket
852 # 'unknown' otherwise
854 # @service: #optional The service name of the server's port. This may depends
855 # on the host system's service database so symbolic names should not
858 # @auth: #optional the current authentication type used by the server
859 # 'none' if no authentication is being used
860 # 'vnc' if VNC authentication is being used
861 # 'vencrypt+plain' if VEncrypt is used with plain text authentication
862 # 'vencrypt+tls+none' if VEncrypt is used with TLS and no authentication
863 # 'vencrypt+tls+vnc' if VEncrypt is used with TLS and VNC authentication
864 # 'vencrypt+tls+plain' if VEncrypt is used with TLS and plain text auth
865 # 'vencrypt+x509+none' if VEncrypt is used with x509 and no auth
866 # 'vencrypt+x509+vnc' if VEncrypt is used with x509 and VNC auth
867 # 'vencrypt+x509+plain' if VEncrypt is used with x509 and plain text auth
868 # 'vencrypt+tls+sasl' if VEncrypt is used with TLS and SASL auth
869 # 'vencrypt+x509+sasl' if VEncrypt is used with x509 and SASL auth
871 # @clients: a list of @VncClientInfo of all currently connected clients
875 { 'struct': 'VncInfo',
876 'data': {'enabled': 'bool', '*host': 'str',
877 '*family': 'NetworkAddressFamily',
878 '*service': 'str', '*auth': 'str', '*clients': ['VncClientInfo']} }
883 # vnc primary authentication method.
887 { 'enum': 'VncPrimaryAuth',
888 'data': [ 'none', 'vnc', 'ra2', 'ra2ne', 'tight', 'ultra',
889 'tls', 'vencrypt', 'sasl' ] }
892 # @VncVencryptSubAuth:
894 # vnc sub authentication method with vencrypt.
898 { 'enum': 'VncVencryptSubAuth',
900 'tls-none', 'x509-none',
901 'tls-vnc', 'x509-vnc',
902 'tls-plain', 'x509-plain',
903 'tls-sasl', 'x509-sasl' ] }
908 # Information about a vnc server
910 # @id: vnc server name.
912 # @server: A list of @VncBasincInfo describing all listening sockets.
913 # The list can be empty (in case the vnc server is disabled).
914 # It also may have multiple entries: normal + websocket,
915 # possibly also ipv4 + ipv6 in the future.
917 # @clients: A list of @VncClientInfo of all currently connected clients.
918 # The list can be empty, for obvious reasons.
920 # @auth: The current authentication type used by the server
922 # @vencrypt: #optional The vencrypt sub authentication type used by the server,
923 # only specified in case auth == vencrypt.
925 # @display: #optional The display device the vnc server is linked to.
929 { 'struct': 'VncInfo2',
930 'data': { 'id' : 'str',
931 'server' : ['VncBasicInfo'],
932 'clients' : ['VncClientInfo'],
933 'auth' : 'VncPrimaryAuth',
934 '*vencrypt' : 'VncVencryptSubAuth',
935 '*display' : 'str' } }
940 # Returns information about the current VNC server
946 { 'command': 'query-vnc', 'returns': 'VncInfo' }
949 # @query-vnc-servers:
951 # Returns a list of vnc servers. The list can be empty.
953 # Returns: a list of @VncInfo2
957 { 'command': 'query-vnc-servers', 'returns': ['VncInfo2'] }
962 # The basic information for SPICE network connection
968 # @family: address family
972 { 'struct': 'SpiceBasicInfo',
973 'data': { 'host': 'str',
975 'family': 'NetworkAddressFamily' } }
980 # Information about a SPICE server
982 # @auth: #optional, authentication method
986 { 'struct': 'SpiceServerInfo',
987 'base': 'SpiceBasicInfo',
988 'data': { '*auth': 'str' } }
993 # Information about a SPICE client channel.
995 # @connection-id: SPICE connection id number. All channels with the same id
996 # belong to the same SPICE session.
998 # @channel-type: SPICE channel type number. "1" is the main control
999 # channel, filter for this one if you want to track spice
1002 # @channel-id: SPICE channel ID number. Usually "0", might be different when
1003 # multiple channels of the same type exist, such as multiple
1004 # display channels in a multihead setup
1006 # @tls: true if the channel is encrypted, false otherwise.
1010 { 'struct': 'SpiceChannel',
1011 'base': 'SpiceBasicInfo',
1012 'data': {'connection-id': 'int', 'channel-type': 'int', 'channel-id': 'int',
1016 # @SpiceQueryMouseMode
1018 # An enumeration of Spice mouse states.
1020 # @client: Mouse cursor position is determined by the client.
1022 # @server: Mouse cursor position is determined by the server.
1024 # @unknown: No information is available about mouse mode used by
1027 # Note: spice/enums.h has a SpiceMouseMode already, hence the name.
1031 { 'enum': 'SpiceQueryMouseMode',
1032 'data': [ 'client', 'server', 'unknown' ] }
1037 # Information about the SPICE session.
1039 # @enabled: true if the SPICE server is enabled, false otherwise
1041 # @migrated: true if the last guest migration completed and spice
1042 # migration had completed as well. false otherwise.
1044 # @host: #optional The hostname the SPICE server is bound to. This depends on
1045 # the name resolution on the host and may be an IP address.
1047 # @port: #optional The SPICE server's port number.
1049 # @compiled-version: #optional SPICE server version.
1051 # @tls-port: #optional The SPICE server's TLS port number.
1053 # @auth: #optional the current authentication type used by the server
1054 # 'none' if no authentication is being used
1055 # 'spice' uses SASL or direct TLS authentication, depending on command
1058 # @mouse-mode: The mode in which the mouse cursor is displayed currently. Can
1059 # be determined by the client or the server, or unknown if spice
1060 # server doesn't provide this information.
1064 # @channels: a list of @SpiceChannel for each active spice channel
1068 { 'struct': 'SpiceInfo',
1069 'data': {'enabled': 'bool', 'migrated': 'bool', '*host': 'str', '*port': 'int',
1070 '*tls-port': 'int', '*auth': 'str', '*compiled-version': 'str',
1071 'mouse-mode': 'SpiceQueryMouseMode', '*channels': ['SpiceChannel']} }
1076 # Returns information about the current SPICE server
1078 # Returns: @SpiceInfo
1082 { 'command': 'query-spice', 'returns': 'SpiceInfo' }
1087 # Information about the guest balloon device.
1089 # @actual: the number of bytes the balloon currently contains
1094 { 'struct': 'BalloonInfo', 'data': {'actual': 'int' } }
1099 # Return information about the balloon device.
1101 # Returns: @BalloonInfo on success
1102 # If the balloon driver is enabled but not functional because the KVM
1103 # kernel module cannot support it, KvmMissingCap
1104 # If no balloon device is present, DeviceNotActive
1108 { 'command': 'query-balloon', 'returns': 'BalloonInfo' }
1113 # A PCI device memory region
1115 # @base: the starting address (guest physical)
1117 # @limit: the ending address (guest physical)
1121 { 'struct': 'PciMemoryRange', 'data': {'base': 'int', 'limit': 'int'} }
1126 # Information about a PCI device I/O region.
1128 # @bar: the index of the Base Address Register for this region
1130 # @type: 'io' if the region is a PIO region
1131 # 'memory' if the region is a MMIO region
1133 # @prefetch: #optional if @type is 'memory', true if the memory is prefetchable
1135 # @mem_type_64: #optional if @type is 'memory', true if the BAR is 64-bit
1139 { 'struct': 'PciMemoryRegion',
1140 'data': {'bar': 'int', 'type': 'str', 'address': 'int', 'size': 'int',
1141 '*prefetch': 'bool', '*mem_type_64': 'bool' } }
1146 # Information about a bus of a PCI Bridge device
1148 # @number: primary bus interface number. This should be the number of the
1149 # bus the device resides on.
1151 # @secondary: secondary bus interface number. This is the number of the
1152 # main bus for the bridge
1154 # @subordinate: This is the highest number bus that resides below the
1157 # @io_range: The PIO range for all devices on this bridge
1159 # @memory_range: The MMIO range for all devices on this bridge
1161 # @prefetchable_range: The range of prefetchable MMIO for all devices on
1166 { 'struct': 'PciBusInfo',
1167 'data': {'number': 'int', 'secondary': 'int', 'subordinate': 'int',
1168 'io_range': 'PciMemoryRange',
1169 'memory_range': 'PciMemoryRange',
1170 'prefetchable_range': 'PciMemoryRange' } }
1175 # Information about a PCI Bridge device
1177 # @bus: information about the bus the device resides on
1179 # @devices: a list of @PciDeviceInfo for each device on this bridge
1183 { 'struct': 'PciBridgeInfo',
1184 'data': {'bus': 'PciBusInfo', '*devices': ['PciDeviceInfo']} }
1189 # Information about the Class of a PCI device
1191 # @desc: #optional a string description of the device's class
1193 # @class: the class code of the device
1197 { 'struct': 'PciDeviceClass',
1198 'data': {'*desc': 'str', 'class': 'int'} }
1203 # Information about the Id of a PCI device
1205 # @device: the PCI device id
1207 # @vendor: the PCI vendor id
1211 { 'struct': 'PciDeviceId',
1212 'data': {'device': 'int', 'vendor': 'int'} }
1217 # Information about a PCI device
1219 # @bus: the bus number of the device
1221 # @slot: the slot the device is located in
1223 # @function: the function of the slot used by the device
1225 # @class_info: the class of the device
1227 # @id: the PCI device id
1229 # @irq: #optional if an IRQ is assigned to the device, the IRQ number
1231 # @qdev_id: the device name of the PCI device
1233 # @pci_bridge: if the device is a PCI bridge, the bridge information
1235 # @regions: a list of the PCI I/O regions associated with the device
1237 # Notes: the contents of @class_info.desc are not stable and should only be
1238 # treated as informational.
1242 { 'struct': 'PciDeviceInfo',
1243 'data': {'bus': 'int', 'slot': 'int', 'function': 'int',
1244 'class_info': 'PciDeviceClass', 'id': 'PciDeviceId',
1245 '*irq': 'int', 'qdev_id': 'str', '*pci_bridge': 'PciBridgeInfo',
1246 'regions': ['PciMemoryRegion']} }
1251 # Information about a PCI bus
1253 # @bus: the bus index
1255 # @devices: a list of devices on this bus
1259 { 'struct': 'PciInfo', 'data': {'bus': 'int', 'devices': ['PciDeviceInfo']} }
1264 # Return information about the PCI bus topology of the guest.
1266 # Returns: a list of @PciInfo for each PCI bus
1270 { 'command': 'query-pci', 'returns': ['PciInfo'] }
1275 # This command will cause the QEMU process to exit gracefully. While every
1276 # attempt is made to send the QMP response before terminating, this is not
1277 # guaranteed. When using this interface, a premature EOF would not be
1282 { 'command': 'quit' }
1287 # Stop all guest VCPU execution.
1291 # Notes: This function will succeed even if the guest is already in the stopped
1292 # state. In "inmigrate" state, it will ensure that the guest
1293 # remains paused once migration finishes, as if the -S option was
1294 # passed on the command line.
1296 { 'command': 'stop' }
1301 # Performs a hard reset of a guest.
1305 { 'command': 'system_reset' }
1308 # @system_powerdown:
1310 # Requests that a guest perform a powerdown operation.
1314 # Notes: A guest may or may not respond to this command. This command
1315 # returning does not indicate that a guest has accepted the request or
1316 # that it has shut down. Many guests will respond to this command by
1317 # prompting the user in some way.
1319 { 'command': 'system_powerdown' }
1324 # This command is a nop that is only provided for the purposes of compatibility.
1328 # Notes: Do not use this command.
1330 { 'command': 'cpu', 'data': {'index': 'int'} }
1335 # Adds CPU with specified ID
1337 # @id: ID of CPU to be created, valid values [0..max_cpus)
1339 # Returns: Nothing on success
1343 { 'command': 'cpu-add', 'data': {'id': 'int'} }
1348 # Save a portion of guest memory to a file.
1350 # @val: the virtual address of the guest to start from
1352 # @size: the size of memory region to save
1354 # @filename: the file to save the memory to as binary data
1356 # @cpu-index: #optional the index of the virtual CPU to use for translating the
1357 # virtual address (defaults to CPU 0)
1359 # Returns: Nothing on success
1363 # Notes: Errors were not reliably returned until 1.1
1365 { 'command': 'memsave',
1366 'data': {'val': 'int', 'size': 'int', 'filename': 'str', '*cpu-index': 'int'} }
1371 # Save a portion of guest physical memory to a file.
1373 # @val: the physical address of the guest to start from
1375 # @size: the size of memory region to save
1377 # @filename: the file to save the memory to as binary data
1379 # Returns: Nothing on success
1383 # Notes: Errors were not reliably returned until 1.1
1385 { 'command': 'pmemsave',
1386 'data': {'val': 'int', 'size': 'int', 'filename': 'str'} }
1391 # Resume guest VCPU execution.
1395 # Returns: If successful, nothing
1396 # If QEMU was started with an encrypted block device and a key has
1397 # not yet been set, DeviceEncrypted.
1399 # Notes: This command will succeed if the guest is currently running. It
1400 # will also succeed if the guest is in the "inmigrate" state; in
1401 # this case, the effect of the command is to make sure the guest
1402 # starts once migration finishes, removing the effect of the -S
1403 # command line option if it was passed.
1405 { 'command': 'cont' }
1410 # Wakeup guest from suspend. Does nothing in case the guest isn't suspended.
1416 { 'command': 'system_wakeup' }
1421 # Injects a Non-Maskable Interrupt into the default CPU (x86/s390) or all CPUs (ppc64).
1423 # Returns: If successful, nothing
1427 # Note: prior to 2.1, this command was only supported for x86 and s390 VMs
1429 { 'command': 'inject-nmi' }
1434 # Sets the link status of a virtual network adapter.
1436 # @name: the device name of the virtual network adapter
1438 # @up: true to set the link status to be up
1440 # Returns: Nothing on success
1441 # If @name is not a valid network device, DeviceNotFound
1445 # Notes: Not all network adapters support setting link status. This command
1446 # will succeed even if the network adapter does not support link status
1449 { 'command': 'set_link', 'data': {'name': 'str', 'up': 'bool'} }
1454 # Request the balloon driver to change its balloon size.
1456 # @value: the target size of the balloon in bytes
1458 # Returns: Nothing on success
1459 # If the balloon driver is enabled but not functional because the KVM
1460 # kernel module cannot support it, KvmMissingCap
1461 # If no balloon device is present, DeviceNotActive
1463 # Notes: This command just issues a request to the guest. When it returns,
1464 # the balloon size may not have changed. A guest can change the balloon
1465 # size independent of this command.
1469 { 'command': 'balloon', 'data': {'value': 'int'} }
1474 # This action can be used to test transaction failure.
1478 { 'struct': 'Abort',
1482 # @TransactionAction
1484 # A discriminated record of operations that can be performed with
1489 # drive-backup since 1.6
1491 # blockdev-snapshot-internal-sync since 1.7
1492 # blockdev-backup since 2.3
1494 { 'union': 'TransactionAction',
1496 'blockdev-snapshot-sync': 'BlockdevSnapshot',
1497 'drive-backup': 'DriveBackup',
1498 'blockdev-backup': 'BlockdevBackup',
1500 'blockdev-snapshot-internal-sync': 'BlockdevSnapshotInternal'
1506 # Executes a number of transactionable QMP commands atomically. If any
1507 # operation fails, then the entire set of actions will be abandoned and the
1508 # appropriate error returned.
1511 # @TransactionAction: information needed for the respective operation
1513 # Returns: nothing on success
1514 # Errors depend on the operations of the transaction
1516 # Note: The transaction aborts on the first failure. Therefore, there will be
1517 # information on only one failed operation returned in an error condition, and
1518 # subsequent actions will not have been attempted.
1522 { 'command': 'transaction',
1523 'data': { 'actions': [ 'TransactionAction' ] } }
1526 # @human-monitor-command:
1528 # Execute a command on the human monitor and return the output.
1530 # @command-line: the command to execute in the human monitor
1532 # @cpu-index: #optional The CPU to use for commands that require an implicit CPU
1534 # Returns: the output of the command as a string
1538 # Notes: This command only exists as a stop-gap. Its use is highly
1539 # discouraged. The semantics of this command are not guaranteed.
1541 # Known limitations:
1543 # o This command is stateless, this means that commands that depend
1544 # on state information (such as getfd) might not work
1546 # o Commands that prompt the user for data (eg. 'cont' when the block
1547 # device is encrypted) don't currently work
1549 { 'command': 'human-monitor-command',
1550 'data': {'command-line': 'str', '*cpu-index': 'int'},
1556 # Cancel the current executing migration process.
1558 # Returns: nothing on success
1560 # Notes: This command succeeds even if there is no migration process running.
1564 { 'command': 'migrate_cancel' }
1567 # @migrate_set_downtime
1569 # Set maximum tolerated downtime for migration.
1571 # @value: maximum downtime in seconds
1573 # Returns: nothing on success
1577 { 'command': 'migrate_set_downtime', 'data': {'value': 'number'} }
1580 # @migrate_set_speed
1582 # Set maximum speed for migration.
1584 # @value: maximum speed in bytes.
1586 # Returns: nothing on success
1588 # Notes: A value lesser than zero will be automatically round up to zero.
1592 { 'command': 'migrate_set_speed', 'data': {'value': 'int'} }
1595 # @migrate-set-cache-size
1597 # Set XBZRLE cache size
1599 # @value: cache size in bytes
1601 # The size will be rounded down to the nearest power of 2.
1602 # The cache size can be modified before and during ongoing migration
1604 # Returns: nothing on success
1608 { 'command': 'migrate-set-cache-size', 'data': {'value': 'int'} }
1611 # @query-migrate-cache-size
1613 # query XBZRLE cache size
1615 # Returns: XBZRLE cache size in bytes
1619 { 'command': 'query-migrate-cache-size', 'returns': 'int' }
1622 # @ObjectPropertyInfo:
1624 # @name: the name of the property
1626 # @type: the type of the property. This will typically come in one of four
1629 # 1) A primitive type such as 'u8', 'u16', 'bool', 'str', or 'double'.
1630 # These types are mapped to the appropriate JSON type.
1632 # 2) A legacy type in the form 'legacy<subtype>' where subtype is the
1633 # legacy qdev typename. These types are always treated as strings.
1635 # 3) A child type in the form 'child<subtype>' where subtype is a qdev
1636 # device type name. Child properties create the composition tree.
1638 # 4) A link type in the form 'link<subtype>' where subtype is a qdev
1639 # device type name. Link properties form the device model graph.
1643 { 'struct': 'ObjectPropertyInfo',
1644 'data': { 'name': 'str', 'type': 'str' } }
1649 # This command will list any properties of a object given a path in the object
1652 # @path: the path within the object model. See @qom-get for a description of
1655 # Returns: a list of @ObjectPropertyInfo that describe the properties of the
1660 { 'command': 'qom-list',
1661 'data': { 'path': 'str' },
1662 'returns': [ 'ObjectPropertyInfo' ] }
1667 # This command will get a property from a object model path and return the
1670 # @path: The path within the object model. There are two forms of supported
1671 # paths--absolute and partial paths.
1673 # Absolute paths are derived from the root object and can follow child<>
1674 # or link<> properties. Since they can follow link<> properties, they
1675 # can be arbitrarily long. Absolute paths look like absolute filenames
1676 # and are prefixed with a leading slash.
1678 # Partial paths look like relative filenames. They do not begin
1679 # with a prefix. The matching rules for partial paths are subtle but
1680 # designed to make specifying objects easy. At each level of the
1681 # composition tree, the partial path is matched as an absolute path.
1682 # The first match is not returned. At least two matches are searched
1683 # for. A successful result is only returned if only one match is
1684 # found. If more than one match is found, a flag is return to
1685 # indicate that the match was ambiguous.
1687 # @property: The property name to read
1689 # Returns: The property value. The type depends on the property type. legacy<>
1690 # properties are returned as #str. child<> and link<> properties are
1691 # returns as #str pathnames. All integer property types (u8, u16, etc)
1692 # are returned as #int.
1696 { 'command': 'qom-get',
1697 'data': { 'path': 'str', 'property': 'str' },
1704 # This command will set a property from a object model path.
1706 # @path: see @qom-get for a description of this parameter
1708 # @property: the property name to set
1710 # @value: a value who's type is appropriate for the property type. See @qom-get
1711 # for a description of type mapping.
1715 { 'command': 'qom-set',
1716 'data': { 'path': 'str', 'property': 'str', 'value': '**' },
1722 # Sets the password of a remote display session.
1724 # @protocol: `vnc' to modify the VNC server password
1725 # `spice' to modify the Spice server password
1727 # @password: the new password
1729 # @connected: #optional how to handle existing clients when changing the
1730 # password. If nothing is specified, defaults to `keep'
1731 # `fail' to fail the command if clients are connected
1732 # `disconnect' to disconnect existing clients
1733 # `keep' to maintain existing clients
1735 # Returns: Nothing on success
1736 # If Spice is not enabled, DeviceNotFound
1740 { 'command': 'set_password',
1741 'data': {'protocol': 'str', 'password': 'str', '*connected': 'str'} }
1746 # Expire the password of a remote display server.
1748 # @protocol: the name of the remote display protocol `vnc' or `spice'
1750 # @time: when to expire the password.
1751 # `now' to expire the password immediately
1752 # `never' to cancel password expiration
1753 # `+INT' where INT is the number of seconds from now (integer)
1754 # `INT' where INT is the absolute time in seconds
1756 # Returns: Nothing on success
1757 # If @protocol is `spice' and Spice is not active, DeviceNotFound
1761 # Notes: Time is relative to the server and currently there is no way to
1762 # coordinate server time with client time. It is not recommended to
1763 # use the absolute time version of the @time parameter unless you're
1764 # sure you are on the same machine as the QEMU instance.
1766 { 'command': 'expire_password', 'data': {'protocol': 'str', 'time': 'str'} }
1769 # @change-vnc-password:
1771 # Change the VNC server password.
1773 # @password: the new password to use with VNC authentication
1777 # Notes: An empty password in this command will set the password to the empty
1778 # string. Existing clients are unaffected by executing this command.
1780 { 'command': 'change-vnc-password', 'data': {'password': 'str'} }
1785 # This command is multiple commands multiplexed together.
1787 # @device: This is normally the name of a block device but it may also be 'vnc'.
1788 # when it's 'vnc', then sub command depends on @target
1790 # @target: If @device is a block device, then this is the new filename.
1791 # If @device is 'vnc', then if the value 'password' selects the vnc
1792 # change password command. Otherwise, this specifies a new server URI
1793 # address to listen to for VNC connections.
1795 # @arg: If @device is a block device, then this is an optional format to open
1797 # If @device is 'vnc' and @target is 'password', this is the new VNC
1798 # password to set. If this argument is an empty string, then no future
1799 # logins will be allowed.
1801 # Returns: Nothing on success.
1802 # If @device is not a valid block device, DeviceNotFound
1803 # If the new block device is encrypted, DeviceEncrypted. Note that
1804 # if this error is returned, the device has been opened successfully
1805 # and an additional call to @block_passwd is required to set the
1806 # device's password. The behavior of reads and writes to the block
1807 # device between when these calls are executed is undefined.
1809 # Notes: It is strongly recommended that this interface is not used especially
1810 # for changing block devices.
1814 { 'command': 'change',
1815 'data': {'device': 'str', 'target': 'str', '*arg': 'str'} }
1820 # This structure describes a search result from @qom-list-types
1822 # @name: the type name found in the search
1826 # Notes: This command is experimental and may change syntax in future releases.
1828 { 'struct': 'ObjectTypeInfo',
1829 'data': { 'name': 'str' } }
1834 # This command will return a list of types given search parameters
1836 # @implements: if specified, only return types that implement this type name
1838 # @abstract: if true, include abstract types in the results
1840 # Returns: a list of @ObjectTypeInfo or an empty list if no results are found
1844 { 'command': 'qom-list-types',
1845 'data': { '*implements': 'str', '*abstract': 'bool' },
1846 'returns': [ 'ObjectTypeInfo' ] }
1849 # @DevicePropertyInfo:
1851 # Information about device properties.
1853 # @name: the name of the property
1854 # @type: the typename of the property
1855 # @description: #optional if specified, the description of the property.
1860 { 'struct': 'DevicePropertyInfo',
1861 'data': { 'name': 'str', 'type': 'str', '*description': 'str' } }
1864 # @device-list-properties:
1866 # List properties associated with a device.
1868 # @typename: the type name of a device
1870 # Returns: a list of DevicePropertyInfo describing a devices properties
1874 { 'command': 'device-list-properties',
1875 'data': { 'typename': 'str'},
1876 'returns': [ 'DevicePropertyInfo' ] }
1881 # Migrates the current running guest to another Virtual Machine.
1883 # @uri: the Uniform Resource Identifier of the destination VM
1885 # @blk: #optional do block migration (full disk copy)
1887 # @inc: #optional incremental disk copy migration
1889 # @detach: this argument exists only for compatibility reasons and
1890 # is ignored by QEMU
1892 # Returns: nothing on success
1896 { 'command': 'migrate',
1897 'data': {'uri': 'str', '*blk': 'bool', '*inc': 'bool', '*detach': 'bool' } }
1902 # Start an incoming migration, the qemu must have been started
1903 # with -incoming defer
1905 # @uri: The Uniform Resource Identifier identifying the source or
1906 # address to listen on
1908 # Returns: nothing on success
1911 # Note: It's a bad idea to use a string for the uri, but it needs to stay
1912 # compatible with -incoming and the format of the uri is already exposed
1915 { 'command': 'migrate-incoming', 'data': {'uri': 'str' } }
1917 # @xen-save-devices-state:
1919 # Save the state of all devices to file. The RAM and the block devices
1920 # of the VM are not saved by this command.
1922 # @filename: the file to save the state of the devices to as binary
1923 # data. See xen-save-devices-state.txt for a description of the binary
1926 # Returns: Nothing on success
1930 { 'command': 'xen-save-devices-state', 'data': {'filename': 'str'} }
1933 # @xen-set-global-dirty-log
1935 # Enable or disable the global dirty log mode.
1937 # @enable: true to enable, false to disable.
1943 { 'command': 'xen-set-global-dirty-log', 'data': { 'enable': 'bool' } }
1948 # Remove a device from a guest
1950 # @id: the name of the device
1952 # Returns: Nothing on success
1953 # If @id is not a valid device, DeviceNotFound
1955 # Notes: When this command completes, the device may not be removed from the
1956 # guest. Hot removal is an operation that requires guest cooperation.
1957 # This command merely requests that the guest begin the hot removal
1958 # process. Completion of the device removal process is signaled with a
1959 # DEVICE_DELETED event. Guest reset will automatically complete removal
1964 { 'command': 'device_del', 'data': {'id': 'str'} }
1967 # @DumpGuestMemoryFormat:
1969 # An enumeration of guest-memory-dump's format.
1973 # @kdump-zlib: kdump-compressed format with zlib-compressed
1975 # @kdump-lzo: kdump-compressed format with lzo-compressed
1977 # @kdump-snappy: kdump-compressed format with snappy-compressed
1981 { 'enum': 'DumpGuestMemoryFormat',
1982 'data': [ 'elf', 'kdump-zlib', 'kdump-lzo', 'kdump-snappy' ] }
1985 # @dump-guest-memory
1987 # Dump guest's memory to vmcore. It is a synchronous operation that can take
1988 # very long depending on the amount of guest memory. This command is only
1989 # supported on i386 and x86_64.
1991 # @paging: if true, do paging to get guest's memory mapping. This allows
1992 # using gdb to process the core file.
1994 # IMPORTANT: this option can make QEMU allocate several gigabytes
1995 # of RAM. This can happen for a large guest, or a
1996 # malicious guest pretending to be large.
1998 # Also, paging=true has the following limitations:
2000 # 1. The guest may be in a catastrophic state or can have corrupted
2001 # memory, which cannot be trusted
2002 # 2. The guest can be in real-mode even if paging is enabled. For
2003 # example, the guest uses ACPI to sleep, and ACPI sleep state
2006 # @protocol: the filename or file descriptor of the vmcore. The supported
2009 # 1. file: the protocol starts with "file:", and the following
2010 # string is the file's path.
2011 # 2. fd: the protocol starts with "fd:", and the following string
2014 # @begin: #optional if specified, the starting physical address.
2016 # @length: #optional if specified, the memory size, in bytes. If you don't
2017 # want to dump all guest's memory, please specify the start @begin
2020 # @format: #optional if specified, the format of guest memory dump. But non-elf
2021 # format is conflict with paging and filter, ie. @paging, @begin and
2022 # @length is not allowed to be specified with non-elf @format at the
2023 # same time (since 2.0)
2025 # Returns: nothing on success
2029 { 'command': 'dump-guest-memory',
2030 'data': { 'paging': 'bool', 'protocol': 'str', '*begin': 'int',
2031 '*length': 'int', '*format': 'DumpGuestMemoryFormat' } }
2034 # @DumpGuestMemoryCapability:
2036 # A list of the available formats for dump-guest-memory
2040 { 'struct': 'DumpGuestMemoryCapability',
2042 'formats': ['DumpGuestMemoryFormat'] } }
2045 # @query-dump-guest-memory-capability:
2047 # Returns the available formats for dump-guest-memory
2049 # Returns: A @DumpGuestMemoryCapability object listing available formats for
2054 { 'command': 'query-dump-guest-memory-capability',
2055 'returns': 'DumpGuestMemoryCapability' }
2060 # Add a network backend.
2062 # @type: the type of network backend. Current valid values are 'user', 'tap',
2063 # 'vde', 'socket', 'dump' and 'bridge'
2065 # @id: the name of the new network backend
2067 # @props: #optional a list of properties to be passed to the backend in
2068 # the format 'name=value', like 'ifname=tap0,script=no'
2070 # Notes: The semantics of @props is not well defined. Future commands will be
2071 # introduced that provide stronger typing for backend creation.
2075 # Returns: Nothing on success
2076 # If @type is not a valid network backend, DeviceNotFound
2078 { 'command': 'netdev_add',
2079 'data': {'type': 'str', 'id': 'str', '*props': '**'},
2085 # Remove a network backend.
2087 # @id: the name of the network backend to remove
2089 # Returns: Nothing on success
2090 # If @id is not a valid network backend, DeviceNotFound
2094 { 'command': 'netdev_del', 'data': {'id': 'str'} }
2099 # Create a QOM object.
2101 # @qom-type: the class name for the object to be created
2103 # @id: the name of the new object
2105 # @props: #optional a dictionary of properties to be passed to the backend
2107 # Returns: Nothing on success
2108 # Error if @qom-type is not a valid class name
2112 { 'command': 'object-add',
2113 'data': {'qom-type': 'str', 'id': 'str', '*props': '**'},
2119 # Remove a QOM object.
2121 # @id: the name of the QOM object to remove
2123 # Returns: Nothing on success
2124 # Error if @id is not a valid id for a QOM object
2128 { 'command': 'object-del', 'data': {'id': 'str'} }
2131 # @NetdevNoneOptions
2133 # Use it alone to have zero network devices.
2137 { 'struct': 'NetdevNoneOptions',
2141 # @NetLegacyNicOptions
2143 # Create a new Network Interface Card.
2145 # @netdev: #optional id of -netdev to connect to
2147 # @macaddr: #optional MAC address
2149 # @model: #optional device model (e1000, rtl8139, virtio etc.)
2151 # @addr: #optional PCI device address
2153 # @vectors: #optional number of MSI-x vectors, 0 to disable MSI-X
2157 { 'struct': 'NetLegacyNicOptions',
2163 '*vectors': 'uint32' } }
2168 # A fat type wrapping 'str', to be embedded in lists.
2172 { 'struct': 'String',
2177 # @NetdevUserOptions
2179 # Use the user mode network stack which requires no administrator privilege to
2182 # @hostname: #optional client hostname reported by the builtin DHCP server
2184 # @restrict: #optional isolate the guest from the host
2186 # @ip: #optional legacy parameter, use net= instead
2188 # @net: #optional IP address and optional netmask
2190 # @host: #optional guest-visible address of the host
2192 # @tftp: #optional root directory of the built-in TFTP server
2194 # @bootfile: #optional BOOTP filename, for use with tftp=
2196 # @dhcpstart: #optional the first of the 16 IPs the built-in DHCP server can
2199 # @dns: #optional guest-visible address of the virtual nameserver
2201 # @dnssearch: #optional list of DNS suffixes to search, passed as DHCP option
2204 # @smb: #optional root directory of the built-in SMB server
2206 # @smbserver: #optional IP address of the built-in SMB server
2208 # @hostfwd: #optional redirect incoming TCP or UDP host connections to guest
2211 # @guestfwd: #optional forward guest TCP connections
2215 { 'struct': 'NetdevUserOptions',
2218 '*restrict': 'bool',
2224 '*dhcpstart': 'str',
2226 '*dnssearch': ['String'],
2228 '*smbserver': 'str',
2229 '*hostfwd': ['String'],
2230 '*guestfwd': ['String'] } }
2235 # Connect the host TAP network interface name to the VLAN.
2237 # @ifname: #optional interface name
2239 # @fd: #optional file descriptor of an already opened tap
2241 # @fds: #optional multiple file descriptors of already opened multiqueue capable
2244 # @script: #optional script to initialize the interface
2246 # @downscript: #optional script to shut down the interface
2248 # @helper: #optional command to execute to configure bridge
2250 # @sndbuf: #optional send buffer limit. Understands [TGMKkb] suffixes.
2252 # @vnet_hdr: #optional enable the IFF_VNET_HDR flag on the tap interface
2254 # @vhost: #optional enable vhost-net network accelerator
2256 # @vhostfd: #optional file descriptor of an already opened vhost net device
2258 # @vhostfds: #optional file descriptors of multiple already opened vhost net
2261 # @vhostforce: #optional vhost on for non-MSIX virtio guests
2263 # @queues: #optional number of queues to be created for multiqueue capable tap
2267 { 'struct': 'NetdevTapOptions',
2273 '*downscript': 'str',
2276 '*vnet_hdr': 'bool',
2280 '*vhostforce': 'bool',
2281 '*queues': 'uint32'} }
2284 # @NetdevSocketOptions
2286 # Connect the VLAN to a remote VLAN in another QEMU virtual machine using a TCP
2287 # socket connection.
2289 # @fd: #optional file descriptor of an already opened socket
2291 # @listen: #optional port number, and optional hostname, to listen on
2293 # @connect: #optional port number, and optional hostname, to connect to
2295 # @mcast: #optional UDP multicast address and port number
2297 # @localaddr: #optional source address and port for multicast and udp packets
2299 # @udp: #optional UDP unicast address and port number
2303 { 'struct': 'NetdevSocketOptions',
2309 '*localaddr': 'str',
2313 # @NetdevL2TPv3Options
2315 # Connect the VLAN to Ethernet over L2TPv3 Static tunnel
2317 # @src: source address
2319 # @dst: destination address
2321 # @srcport: #optional source port - mandatory for udp, optional for ip
2323 # @dstport: #optional destination port - mandatory for udp, optional for ip
2325 # @ipv6: #optional - force the use of ipv6
2327 # @udp: #optional - use the udp version of l2tpv3 encapsulation
2329 # @cookie64: #optional - use 64 bit coookies
2331 # @counter: #optional have sequence counter
2333 # @pincounter: #optional pin sequence counter to zero -
2334 # workaround for buggy implementations or
2335 # networks with packet reorder
2337 # @txcookie: #optional 32 or 64 bit transmit cookie
2339 # @rxcookie: #optional 32 or 64 bit receive cookie
2341 # @txsession: 32 bit transmit session
2343 # @rxsession: #optional 32 bit receive session - if not specified
2344 # set to the same value as transmit
2346 # @offset: #optional additional offset - allows the insertion of
2347 # additional application-specific data before the packet payload
2351 { 'struct': 'NetdevL2TPv3Options',
2359 '*cookie64': 'bool',
2361 '*pincounter': 'bool',
2362 '*txcookie': 'uint64',
2363 '*rxcookie': 'uint64',
2364 'txsession': 'uint32',
2365 '*rxsession': 'uint32',
2366 '*offset': 'uint32' } }
2371 # Connect the VLAN to a vde switch running on the host.
2373 # @sock: #optional socket path
2375 # @port: #optional port number
2377 # @group: #optional group owner of socket
2379 # @mode: #optional permissions for socket
2383 { 'struct': 'NetdevVdeOptions',
2388 '*mode': 'uint16' } }
2391 # @NetdevDumpOptions
2393 # Dump VLAN network traffic to a file.
2395 # @len: #optional per-packet size limit (64k default). Understands [TGMKkb]
2398 # @file: #optional dump file path (default is qemu-vlan0.pcap)
2402 { 'struct': 'NetdevDumpOptions',
2408 # @NetdevBridgeOptions
2410 # Connect a host TAP network interface to a host bridge device.
2412 # @br: #optional bridge name
2414 # @helper: #optional command to execute to configure bridge
2418 { 'struct': 'NetdevBridgeOptions',
2421 '*helper': 'str' } }
2424 # @NetdevHubPortOptions
2426 # Connect two or more net clients through a software hub.
2428 # @hubid: hub identifier number
2432 { 'struct': 'NetdevHubPortOptions',
2434 'hubid': 'int32' } }
2437 # @NetdevNetmapOptions
2439 # Connect a client to a netmap-enabled NIC or to a VALE switch port
2441 # @ifname: Either the name of an existing network interface supported by
2442 # netmap, or the name of a VALE port (created on the fly).
2443 # A VALE port name is in the form 'valeXXX:YYY', where XXX and
2444 # YYY are non-negative integers. XXX identifies a switch and
2445 # YYY identifies a port of the switch. VALE ports having the
2446 # same XXX are therefore connected to the same switch.
2448 # @devname: #optional path of the netmap device (default: '/dev/netmap').
2452 { 'struct': 'NetdevNetmapOptions',
2455 '*devname': 'str' } }
2458 # @NetdevVhostUserOptions
2460 # Vhost-user network backend
2462 # @chardev: name of a unix socket chardev
2464 # @vhostforce: #optional vhost on for non-MSIX virtio guests (default: false).
2466 # @queues: #optional number of queues to be created for multiqueue vhost-user
2467 # (default: 1) (Since 2.4)
2471 { 'struct': 'NetdevVhostUserOptions',
2474 '*vhostforce': 'bool',
2475 '*queues': 'uint32' } }
2480 # A discriminated record of network device traits.
2484 # 'l2tpv3' - since 2.1
2487 { 'union': 'NetClientOptions',
2489 'none': 'NetdevNoneOptions',
2490 'nic': 'NetLegacyNicOptions',
2491 'user': 'NetdevUserOptions',
2492 'tap': 'NetdevTapOptions',
2493 'l2tpv3': 'NetdevL2TPv3Options',
2494 'socket': 'NetdevSocketOptions',
2495 'vde': 'NetdevVdeOptions',
2496 'dump': 'NetdevDumpOptions',
2497 'bridge': 'NetdevBridgeOptions',
2498 'hubport': 'NetdevHubPortOptions',
2499 'netmap': 'NetdevNetmapOptions',
2500 'vhost-user': 'NetdevVhostUserOptions' } }
2505 # Captures the configuration of a network device; legacy.
2507 # @vlan: #optional vlan number
2509 # @id: #optional identifier for monitor commands
2511 # @name: #optional identifier for monitor commands, ignored if @id is present
2513 # @opts: device type specific properties (legacy)
2517 { 'struct': 'NetLegacy',
2522 'opts': 'NetClientOptions' } }
2527 # Captures the configuration of a network device.
2529 # @id: identifier for monitor commands.
2531 # @opts: device type specific properties
2535 { 'struct': 'Netdev',
2538 'opts': 'NetClientOptions' } }
2541 # @InetSocketAddress
2543 # Captures a socket address or address range in the Internet namespace.
2545 # @host: host part of the address
2547 # @port: port part of the address, or lowest port if @to is present
2549 # @to: highest port to try
2551 # @ipv4: whether to accept IPv4 addresses, default try both IPv4 and IPv6
2554 # @ipv6: whether to accept IPv6 addresses, default try both IPv4 and IPv6
2559 { 'struct': 'InetSocketAddress',
2568 # @UnixSocketAddress
2570 # Captures a socket address in the local ("Unix socket") namespace.
2572 # @path: filesystem path to use
2576 { 'struct': 'UnixSocketAddress',
2583 # Captures the address of a socket, which could also be a named file descriptor
2587 { 'union': 'SocketAddress',
2589 'inet': 'InetSocketAddress',
2590 'unix': 'UnixSocketAddress',
2596 # Receive a file descriptor via SCM rights and assign it a name
2598 # @fdname: file descriptor name
2600 # Returns: Nothing on success
2604 # Notes: If @fdname already exists, the file descriptor assigned to
2605 # it will be closed and replaced by the received file
2607 # The 'closefd' command can be used to explicitly close the
2608 # file descriptor when it is no longer needed.
2610 { 'command': 'getfd', 'data': {'fdname': 'str'} }
2615 # Close a file descriptor previously passed via SCM rights
2617 # @fdname: file descriptor name
2619 # Returns: Nothing on success
2623 { 'command': 'closefd', 'data': {'fdname': 'str'} }
2628 # Information describing a machine.
2630 # @name: the name of the machine
2632 # @alias: #optional an alias for the machine name
2634 # @default: #optional whether the machine is default
2636 # @cpu-max: maximum number of CPUs supported by the machine type
2641 { 'struct': 'MachineInfo',
2642 'data': { 'name': 'str', '*alias': 'str',
2643 '*is-default': 'bool', 'cpu-max': 'int' } }
2648 # Return a list of supported machines
2650 # Returns: a list of MachineInfo
2654 { 'command': 'query-machines', 'returns': ['MachineInfo'] }
2657 # @CpuDefinitionInfo:
2659 # Virtual CPU definition.
2661 # @name: the name of the CPU definition
2665 { 'struct': 'CpuDefinitionInfo',
2666 'data': { 'name': 'str' } }
2669 # @query-cpu-definitions:
2671 # Return a list of supported virtual CPU definitions
2673 # Returns: a list of CpuDefInfo
2677 { 'command': 'query-cpu-definitions', 'returns': ['CpuDefinitionInfo'] }
2681 # Information about a file descriptor that was added to an fd set.
2683 # @fdset-id: The ID of the fd set that @fd was added to.
2685 # @fd: The file descriptor that was received via SCM rights and
2686 # added to the fd set.
2690 { 'struct': 'AddfdInfo', 'data': {'fdset-id': 'int', 'fd': 'int'} }
2695 # Add a file descriptor, that was passed via SCM rights, to an fd set.
2697 # @fdset-id: #optional The ID of the fd set to add the file descriptor to.
2699 # @opaque: #optional A free-form string that can be used to describe the fd.
2701 # Returns: @AddfdInfo on success
2702 # If file descriptor was not received, FdNotSupplied
2703 # If @fdset-id is a negative value, InvalidParameterValue
2705 # Notes: The list of fd sets is shared by all monitor connections.
2707 # If @fdset-id is not specified, a new fd set will be created.
2711 { 'command': 'add-fd', 'data': {'*fdset-id': 'int', '*opaque': 'str'},
2712 'returns': 'AddfdInfo' }
2717 # Remove a file descriptor from an fd set.
2719 # @fdset-id: The ID of the fd set that the file descriptor belongs to.
2721 # @fd: #optional The file descriptor that is to be removed.
2723 # Returns: Nothing on success
2724 # If @fdset-id or @fd is not found, FdNotFound
2728 # Notes: The list of fd sets is shared by all monitor connections.
2730 # If @fd is not specified, all file descriptors in @fdset-id
2733 { 'command': 'remove-fd', 'data': {'fdset-id': 'int', '*fd': 'int'} }
2738 # Information about a file descriptor that belongs to an fd set.
2740 # @fd: The file descriptor value.
2742 # @opaque: #optional A free-form string that can be used to describe the fd.
2746 { 'struct': 'FdsetFdInfo',
2747 'data': {'fd': 'int', '*opaque': 'str'} }
2752 # Information about an fd set.
2754 # @fdset-id: The ID of the fd set.
2756 # @fds: A list of file descriptors that belong to this fd set.
2760 { 'struct': 'FdsetInfo',
2761 'data': {'fdset-id': 'int', 'fds': ['FdsetFdInfo']} }
2766 # Return information describing all fd sets.
2768 # Returns: A list of @FdsetInfo
2772 # Note: The list of fd sets is shared by all monitor connections.
2775 { 'command': 'query-fdsets', 'returns': ['FdsetInfo'] }
2780 # Information describing the QEMU target.
2782 # @arch: the target architecture (eg "x86_64", "i386", etc)
2786 { 'struct': 'TargetInfo',
2787 'data': { 'arch': 'str' } }
2792 # Return information about the target for this QEMU
2794 # Returns: TargetInfo
2798 { 'command': 'query-target', 'returns': 'TargetInfo' }
2803 # An enumeration of key name.
2805 # This is used by the send-key command.
2809 # 'unmapped' and 'pause' since 2.0
2810 # 'ro' and 'kp_comma' since 2.4
2812 { 'enum': 'QKeyCode',
2813 'data': [ 'unmapped',
2814 'shift', 'shift_r', 'alt', 'alt_r', 'altgr', 'altgr_r', 'ctrl',
2815 'ctrl_r', 'menu', 'esc', '1', '2', '3', '4', '5', '6', '7', '8',
2816 '9', '0', 'minus', 'equal', 'backspace', 'tab', 'q', 'w', 'e',
2817 'r', 't', 'y', 'u', 'i', 'o', 'p', 'bracket_left', 'bracket_right',
2818 'ret', 'a', 's', 'd', 'f', 'g', 'h', 'j', 'k', 'l', 'semicolon',
2819 'apostrophe', 'grave_accent', 'backslash', 'z', 'x', 'c', 'v', 'b',
2820 'n', 'm', 'comma', 'dot', 'slash', 'asterisk', 'spc', 'caps_lock',
2821 'f1', 'f2', 'f3', 'f4', 'f5', 'f6', 'f7', 'f8', 'f9', 'f10',
2822 'num_lock', 'scroll_lock', 'kp_divide', 'kp_multiply',
2823 'kp_subtract', 'kp_add', 'kp_enter', 'kp_decimal', 'sysrq', 'kp_0',
2824 'kp_1', 'kp_2', 'kp_3', 'kp_4', 'kp_5', 'kp_6', 'kp_7', 'kp_8',
2825 'kp_9', 'less', 'f11', 'f12', 'print', 'home', 'pgup', 'pgdn', 'end',
2826 'left', 'up', 'down', 'right', 'insert', 'delete', 'stop', 'again',
2827 'props', 'undo', 'front', 'copy', 'open', 'paste', 'find', 'cut',
2828 'lf', 'help', 'meta_l', 'meta_r', 'compose', 'pause', 'ro',
2834 # Represents a keyboard key.
2838 { 'union': 'KeyValue',
2841 'qcode': 'QKeyCode' } }
2846 # Send keys to guest.
2848 # @keys: An array of @KeyValue elements. All @KeyValues in this array are
2849 # simultaneously sent to the guest. A @KeyValue.number value is sent
2850 # directly to the guest, while @KeyValue.qcode must be a valid
2853 # @hold-time: #optional time to delay key up events, milliseconds. Defaults
2856 # Returns: Nothing on success
2857 # If key is unknown or redundant, InvalidParameter
2862 { 'command': 'send-key',
2863 'data': { 'keys': ['KeyValue'], '*hold-time': 'int' } }
2868 # Write a PPM of the VGA screen to a file.
2870 # @filename: the path of a new PPM file to store the image
2872 # Returns: Nothing on success
2876 { 'command': 'screendump', 'data': {'filename': 'str'} }
2881 # Configuration info for file chardevs.
2883 # @in: #optional The name of the input file
2884 # @out: The name of the output file
2888 { 'struct': 'ChardevFile', 'data': { '*in' : 'str',
2894 # Configuration info for device and pipe chardevs.
2896 # @device: The name of the special file for the device,
2897 # i.e. /dev/ttyS0 on Unix or COM1: on Windows
2898 # @type: What kind of device this is.
2902 { 'struct': 'ChardevHostdev', 'data': { 'device' : 'str' } }
2907 # Configuration info for (stream) socket chardevs.
2909 # @addr: socket address to listen on (server=true)
2910 # or connect to (server=false)
2911 # @server: #optional create server socket (default: true)
2912 # @wait: #optional wait for incoming connection on server
2913 # sockets (default: false).
2914 # @nodelay: #optional set TCP_NODELAY socket option (default: false)
2915 # @telnet: #optional enable telnet protocol on server
2916 # sockets (default: false)
2917 # @reconnect: #optional For a client socket, if a socket is disconnected,
2918 # then attempt a reconnect after the given number of seconds.
2919 # Setting this to zero disables this function. (default: 0)
2924 { 'struct': 'ChardevSocket', 'data': { 'addr' : 'SocketAddress',
2927 '*nodelay' : 'bool',
2929 '*reconnect' : 'int' } }
2934 # Configuration info for datagram socket chardevs.
2936 # @remote: remote address
2937 # @local: #optional local address
2941 { 'struct': 'ChardevUdp', 'data': { 'remote' : 'SocketAddress',
2942 '*local' : 'SocketAddress' } }
2947 # Configuration info for mux chardevs.
2949 # @chardev: name of the base chardev.
2953 { 'struct': 'ChardevMux', 'data': { 'chardev' : 'str' } }
2958 # Configuration info for stdio chardevs.
2960 # @signal: #optional Allow signals (such as SIGINT triggered by ^C)
2961 # be delivered to qemu. Default: true in -nographic mode,
2966 { 'struct': 'ChardevStdio', 'data': { '*signal' : 'bool' } }
2969 # @ChardevSpiceChannel:
2971 # Configuration info for spice vm channel chardevs.
2973 # @type: kind of channel (for example vdagent).
2977 { 'struct': 'ChardevSpiceChannel', 'data': { 'type' : 'str' } }
2980 # @ChardevSpicePort:
2982 # Configuration info for spice port chardevs.
2984 # @fqdn: name of the channel (see docs/spice-port-fqdn.txt)
2988 { 'struct': 'ChardevSpicePort', 'data': { 'fqdn' : 'str' } }
2993 # Configuration info for virtual console chardevs.
2995 # @width: console width, in pixels
2996 # @height: console height, in pixels
2997 # @cols: console width, in chars
2998 # @rows: console height, in chars
3002 { 'struct': 'ChardevVC', 'data': { '*width' : 'int',
3010 # Configuration info for ring buffer chardevs.
3012 # @size: #optional ring buffer size, must be power of two, default is 65536
3016 { 'struct': 'ChardevRingbuf', 'data': { '*size' : 'int' } }
3021 # Configuration info for the new chardev backend.
3023 # Since: 1.4 (testdev since 2.2)
3025 { 'struct': 'ChardevDummy', 'data': { } }
3027 { 'union': 'ChardevBackend', 'data': { 'file' : 'ChardevFile',
3028 'serial' : 'ChardevHostdev',
3029 'parallel': 'ChardevHostdev',
3030 'pipe' : 'ChardevHostdev',
3031 'socket' : 'ChardevSocket',
3032 'udp' : 'ChardevUdp',
3033 'pty' : 'ChardevDummy',
3034 'null' : 'ChardevDummy',
3035 'mux' : 'ChardevMux',
3036 'msmouse': 'ChardevDummy',
3037 'braille': 'ChardevDummy',
3038 'testdev': 'ChardevDummy',
3039 'stdio' : 'ChardevStdio',
3040 'console': 'ChardevDummy',
3041 'spicevmc' : 'ChardevSpiceChannel',
3042 'spiceport' : 'ChardevSpicePort',
3044 'ringbuf': 'ChardevRingbuf',
3045 # next one is just for compatibility
3046 'memory' : 'ChardevRingbuf' } }
3051 # Return info about the chardev backend just created.
3053 # @pty: #optional name of the slave pseudoterminal device, present if
3054 # and only if a chardev of type 'pty' was created
3058 { 'struct' : 'ChardevReturn', 'data': { '*pty' : 'str' } }
3063 # Add a character device backend
3065 # @id: the chardev's ID, must be unique
3066 # @backend: backend type and parameters
3068 # Returns: ChardevReturn.
3072 { 'command': 'chardev-add', 'data': {'id' : 'str',
3073 'backend' : 'ChardevBackend' },
3074 'returns': 'ChardevReturn' }
3079 # Remove a character device backend
3081 # @id: the chardev's ID, must exist and not be in use
3083 # Returns: Nothing on success
3087 { 'command': 'chardev-remove', 'data': {'id': 'str'} }
3092 # An enumeration of TPM models
3094 # @tpm-tis: TPM TIS model
3098 { 'enum': 'TpmModel', 'data': [ 'tpm-tis' ] }
3101 # @query-tpm-models:
3103 # Return a list of supported TPM models
3105 # Returns: a list of TpmModel
3109 { 'command': 'query-tpm-models', 'returns': ['TpmModel'] }
3114 # An enumeration of TPM types
3116 # @passthrough: TPM passthrough type
3120 { 'enum': 'TpmType', 'data': [ 'passthrough' ] }
3125 # Return a list of supported TPM types
3127 # Returns: a list of TpmType
3131 { 'command': 'query-tpm-types', 'returns': ['TpmType'] }
3134 # @TPMPassthroughOptions:
3136 # Information about the TPM passthrough type
3138 # @path: #optional string describing the path used for accessing the TPM device
3140 # @cancel-path: #optional string showing the TPM's sysfs cancel file
3141 # for cancellation of TPM commands while they are executing
3145 { 'struct': 'TPMPassthroughOptions', 'data': { '*path' : 'str',
3146 '*cancel-path' : 'str'} }
3151 # A union referencing different TPM backend types' configuration options
3153 # @passthrough: The configuration options for the TPM passthrough type
3157 { 'union': 'TpmTypeOptions',
3158 'data': { 'passthrough' : 'TPMPassthroughOptions' } }
3163 # Information about the TPM
3165 # @id: The Id of the TPM
3167 # @model: The TPM frontend model
3169 # @options: The TPM (backend) type configuration options
3173 { 'struct': 'TPMInfo',
3174 'data': {'id': 'str',
3175 'model': 'TpmModel',
3176 'options': 'TpmTypeOptions' } }
3181 # Return information about the TPM device
3183 # Returns: @TPMInfo on success
3187 { 'command': 'query-tpm', 'returns': ['TPMInfo'] }
3192 # Specify an ACPI table on the command line to load.
3194 # At most one of @file and @data can be specified. The list of files specified
3195 # by any one of them is loaded and concatenated in order. If both are omitted,
3198 # Other fields / optargs can be used to override fields of the generic ACPI
3199 # table header; refer to the ACPI specification 5.0, section 5.2.6 System
3200 # Description Table Header. If a header field is not overridden, then the
3201 # corresponding value from the concatenated blob is used (in case of @file), or
3202 # it is filled in with a hard-coded value (in case of @data).
3204 # String fields are copied into the matching ACPI member from lowest address
3205 # upwards, and silently truncated / NUL-padded to length.
3207 # @sig: #optional table signature / identifier (4 bytes)
3209 # @rev: #optional table revision number (dependent on signature, 1 byte)
3211 # @oem_id: #optional OEM identifier (6 bytes)
3213 # @oem_table_id: #optional OEM table identifier (8 bytes)
3215 # @oem_rev: #optional OEM-supplied revision number (4 bytes)
3217 # @asl_compiler_id: #optional identifier of the utility that created the table
3220 # @asl_compiler_rev: #optional revision number of the utility that created the
3223 # @file: #optional colon (:) separated list of pathnames to load and
3224 # concatenate as table data. The resultant binary blob is expected to
3225 # have an ACPI table header. At least one file is required. This field
3228 # @data: #optional colon (:) separated list of pathnames to load and
3229 # concatenate as table data. The resultant binary blob must not have an
3230 # ACPI table header. At least one file is required. This field excludes
3235 { 'struct': 'AcpiTableOptions',
3240 '*oem_table_id': 'str',
3241 '*oem_rev': 'uint32',
3242 '*asl_compiler_id': 'str',
3243 '*asl_compiler_rev': 'uint32',
3248 # @CommandLineParameterType:
3250 # Possible types for an option parameter.
3252 # @string: accepts a character string
3254 # @boolean: accepts "on" or "off"
3256 # @number: accepts a number
3258 # @size: accepts a number followed by an optional suffix (K)ilo,
3259 # (M)ega, (G)iga, (T)era
3263 { 'enum': 'CommandLineParameterType',
3264 'data': ['string', 'boolean', 'number', 'size'] }
3267 # @CommandLineParameterInfo:
3269 # Details about a single parameter of a command line option.
3271 # @name: parameter name
3273 # @type: parameter @CommandLineParameterType
3275 # @help: #optional human readable text string, not suitable for parsing.
3277 # @default: #optional default value string (since 2.1)
3281 { 'struct': 'CommandLineParameterInfo',
3282 'data': { 'name': 'str',
3283 'type': 'CommandLineParameterType',
3285 '*default': 'str' } }
3288 # @CommandLineOptionInfo:
3290 # Details about a command line option, including its list of parameter details
3292 # @option: option name
3294 # @parameters: an array of @CommandLineParameterInfo
3298 { 'struct': 'CommandLineOptionInfo',
3299 'data': { 'option': 'str', 'parameters': ['CommandLineParameterInfo'] } }
3302 # @query-command-line-options:
3304 # Query command line option schema.
3306 # @option: #optional option name
3308 # Returns: list of @CommandLineOptionInfo for all options (or for the given
3309 # @option). Returns an error if the given @option doesn't exist.
3313 {'command': 'query-command-line-options', 'data': { '*option': 'str' },
3314 'returns': ['CommandLineOptionInfo'] }
3319 # A X86 32-bit register
3323 { 'enum': 'X86CPURegister32',
3324 'data': [ 'EAX', 'EBX', 'ECX', 'EDX', 'ESP', 'EBP', 'ESI', 'EDI' ] }
3327 # @X86CPUFeatureWordInfo
3329 # Information about a X86 CPU feature word
3331 # @cpuid-input-eax: Input EAX value for CPUID instruction for that feature word
3333 # @cpuid-input-ecx: #optional Input ECX value for CPUID instruction for that
3336 # @cpuid-register: Output register containing the feature bits
3338 # @features: value of output register, containing the feature bits
3342 { 'struct': 'X86CPUFeatureWordInfo',
3343 'data': { 'cpuid-input-eax': 'int',
3344 '*cpuid-input-ecx': 'int',
3345 'cpuid-register': 'X86CPURegister32',
3346 'features': 'int' } }
3351 # Packets receiving state
3353 # @normal: filter assigned packets according to the mac-table
3355 # @none: don't receive any assigned packet
3357 # @all: receive all assigned packets
3361 { 'enum': 'RxState', 'data': [ 'normal', 'none', 'all' ] }
3366 # Rx-filter information for a NIC.
3368 # @name: net client name
3370 # @promiscuous: whether promiscuous mode is enabled
3372 # @multicast: multicast receive state
3374 # @unicast: unicast receive state
3376 # @vlan: vlan receive state (Since 2.0)
3378 # @broadcast-allowed: whether to receive broadcast
3380 # @multicast-overflow: multicast table is overflowed or not
3382 # @unicast-overflow: unicast table is overflowed or not
3384 # @main-mac: the main macaddr string
3386 # @vlan-table: a list of active vlan id
3388 # @unicast-table: a list of unicast macaddr string
3390 # @multicast-table: a list of multicast macaddr string
3395 { 'struct': 'RxFilterInfo',
3398 'promiscuous': 'bool',
3399 'multicast': 'RxState',
3400 'unicast': 'RxState',
3402 'broadcast-allowed': 'bool',
3403 'multicast-overflow': 'bool',
3404 'unicast-overflow': 'bool',
3406 'vlan-table': ['int'],
3407 'unicast-table': ['str'],
3408 'multicast-table': ['str'] }}
3413 # Return rx-filter information for all NICs (or for the given NIC).
3415 # @name: #optional net client name
3417 # Returns: list of @RxFilterInfo for all NICs (or for the given NIC).
3418 # Returns an error if the given @name doesn't exist, or given
3419 # NIC doesn't support rx-filter querying, or given net client
3424 { 'command': 'query-rx-filter', 'data': { '*name': 'str' },
3425 'returns': ['RxFilterInfo'] }
3430 # Button of a pointer input device (mouse, tablet).
3434 { 'enum' : 'InputButton',
3435 'data' : [ 'Left', 'Middle', 'Right', 'WheelUp', 'WheelDown' ] }
3440 # Position axis of a pointer input device (mouse, tablet).
3444 { 'enum' : 'InputAxis',
3445 'data' : [ 'X', 'Y' ] }
3450 # Keyboard input event.
3452 # @key: Which key this event is for.
3453 # @down: True for key-down and false for key-up events.
3457 { 'struct' : 'InputKeyEvent',
3458 'data' : { 'key' : 'KeyValue',
3464 # Pointer button input event.
3466 # @button: Which button this event is for.
3467 # @down: True for key-down and false for key-up events.
3471 { 'struct' : 'InputBtnEvent',
3472 'data' : { 'button' : 'InputButton',
3478 # Pointer motion input event.
3480 # @axis: Which axis is referenced by @value.
3481 # @value: Pointer position. For absolute coordinates the
3482 # valid range is 0 -> 0x7ffff
3486 { 'struct' : 'InputMoveEvent',
3487 'data' : { 'axis' : 'InputAxis',
3493 # Input event union.
3495 # @key: Input event of Keyboard
3496 # @btn: Input event of pointer buttons
3497 # @rel: Input event of relative pointer motion
3498 # @abs: Input event of absolute pointer motion
3502 { 'union' : 'InputEvent',
3503 'data' : { 'key' : 'InputKeyEvent',
3504 'btn' : 'InputBtnEvent',
3505 'rel' : 'InputMoveEvent',
3506 'abs' : 'InputMoveEvent' } }
3509 # @x-input-send-event
3511 # Send input event(s) to guest.
3513 # @console: #optional console to send event(s) to.
3514 # This parameter can be used to send the input event to
3515 # specific input devices in case (a) multiple input devices
3516 # of the same kind are added to the virtual machine and (b)
3517 # you have configured input routing (see docs/multiseat.txt)
3518 # for those input devices. If input routing is not
3519 # configured this parameter has no effect.
3520 # If @console is missing, only devices that aren't associated
3521 # with a console are admissible.
3522 # If @console is specified, it must exist, and both devices
3523 # associated with that console and devices not associated with a
3524 # console are admissible, but the former take precedence.
3527 # @events: List of InputEvent union.
3529 # Returns: Nothing on success.
3533 # Note: this command is experimental, and not a stable API.
3536 { 'command': 'x-input-send-event',
3537 'data': { '*console':'int', 'events': [ 'InputEvent' ] } }
3542 # A discriminated record of NUMA options. (for OptsVisitor)
3546 { 'union': 'NumaOptions',
3548 'node': 'NumaNodeOptions' }}
3553 # Create a guest NUMA node. (for OptsVisitor)
3555 # @nodeid: #optional NUMA node ID (increase by 1 from 0 if omitted)
3557 # @cpus: #optional VCPUs belonging to this node (assign VCPUS round-robin
3560 # @mem: #optional memory size of this node; mutually exclusive with @memdev.
3561 # Equally divide total memory among nodes if both @mem and @memdev are
3564 # @memdev: #optional memory backend object. If specified for one node,
3565 # it must be specified for all nodes.
3569 { 'struct': 'NumaNodeOptions',
3571 '*nodeid': 'uint16',
3572 '*cpus': ['uint16'],
3579 # Host memory policy types
3581 # @default: restore default policy, remove any nondefault policy
3583 # @preferred: set the preferred host nodes for allocation
3585 # @bind: a strict policy that restricts memory allocation to the
3586 # host nodes specified
3588 # @interleave: memory allocations are interleaved across the set
3589 # of host nodes specified
3593 { 'enum': 'HostMemPolicy',
3594 'data': [ 'default', 'preferred', 'bind', 'interleave' ] }
3599 # Information about memory backend
3601 # @size: memory backend size
3603 # @merge: enables or disables memory merge support
3605 # @dump: includes memory backend's memory in a core dump or not
3607 # @prealloc: enables or disables memory preallocation
3609 # @host-nodes: host nodes for its memory policy
3611 # @policy: memory policy of memory backend
3616 { 'struct': 'Memdev',
3622 'host-nodes': ['uint16'],
3623 'policy': 'HostMemPolicy' }}
3628 # Returns information for all memory backends.
3630 # Returns: a list of @Memdev.
3634 { 'command': 'query-memdev', 'returns': ['Memdev'] }
3637 # @PCDIMMDeviceInfo:
3639 # PCDIMMDevice state information
3641 # @id: #optional device's ID
3643 # @addr: physical address, where device is mapped
3645 # @size: size of memory that the device provides
3647 # @slot: slot number at which device is plugged in
3649 # @node: NUMA node number where device is plugged in
3651 # @memdev: memory backend linked with device
3653 # @hotplugged: true if device was hotplugged
3655 # @hotpluggable: true if device if could be added/removed while machine is running
3659 { 'struct': 'PCDIMMDeviceInfo',
3660 'data': { '*id': 'str',
3666 'hotplugged': 'bool',
3667 'hotpluggable': 'bool'
3672 # @MemoryDeviceInfo:
3674 # Union containing information about a memory device
3678 { 'union': 'MemoryDeviceInfo', 'data': {'dimm': 'PCDIMMDeviceInfo'} }
3681 # @query-memory-devices
3683 # Lists available memory devices and their state
3687 { 'command': 'query-memory-devices', 'returns': ['MemoryDeviceInfo'] }
3691 # @DIMM: memory slot
3693 { 'enum': 'ACPISlotType', 'data': [ 'DIMM' ] }
3697 # OSPM Status Indication for a device
3698 # For description of possible values of @source and @status fields
3699 # see "_OST (OSPM Status Indication)" chapter of ACPI5.0 spec.
3701 # @device: #optional device ID associated with slot
3703 # @slot: slot ID, unique per slot of a given @slot-type
3705 # @slot-type: type of the slot
3707 # @source: an integer containing the source event
3709 # @status: an integer containing the status code
3713 { 'struct': 'ACPIOSTInfo',
3714 'data' : { '*device': 'str',
3716 'slot-type': 'ACPISlotType',
3721 # @query-acpi-ospm-status
3723 # Lists ACPI OSPM status of ACPI device objects,
3724 # which might be reported via _OST method
3728 { 'command': 'query-acpi-ospm-status', 'returns': ['ACPIOSTInfo'] }
3731 # @WatchdogExpirationAction
3733 # An enumeration of the actions taken when the watchdog device's timer is
3736 # @reset: system resets
3738 # @shutdown: system shutdown, note that it is similar to @powerdown, which
3739 # tries to set to system status and notify guest
3741 # @poweroff: system poweroff, the emulator program exits
3743 # @pause: system pauses, similar to @stop
3745 # @debug: system enters debug state
3747 # @none: nothing is done
3749 # @inject-nmi: a non-maskable interrupt is injected into the first VCPU (all
3750 # VCPUS on x86) (since 2.4)
3754 { 'enum': 'WatchdogExpirationAction',
3755 'data': [ 'reset', 'shutdown', 'poweroff', 'pause', 'debug', 'none',
3761 # An enumeration of the I/O operation types
3763 # @read: read operation
3765 # @write: write operation
3769 { 'enum': 'IoOperationType',
3770 'data': [ 'read', 'write' ] }
3775 # An enumeration of the actions taken when guest OS panic is detected
3777 # @pause: system pauses
3781 { 'enum': 'GuestPanicAction',
3782 'data': [ 'pause' ] }
3785 # @rtc-reset-reinjection
3787 # This command will reset the RTC interrupt reinjection backlog.
3788 # Can be used if another mechanism to synchronize guest time
3789 # is in effect, for example QEMU guest agent's guest-set-time
3794 { 'command': 'rtc-reset-reinjection' }
3796 # Rocker ethernet network switch
3797 { 'include': 'qapi/rocker.json' }