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 # @events: generate events for each migration state change
529 # @auto-converge: If enabled, QEMU will automatically throttle down the guest
530 # to speed up convergence of RAM migration. (since 1.6)
534 { 'enum': 'MigrationCapability',
535 'data': ['xbzrle', 'rdma-pin-all', 'auto-converge', 'zero-blocks',
536 'compress', 'events'] }
539 # @MigrationCapabilityStatus
541 # Migration capability information
543 # @capability: capability enum
545 # @state: capability state bool
549 { 'struct': 'MigrationCapabilityStatus',
550 'data': { 'capability' : 'MigrationCapability', 'state' : 'bool' } }
553 # @migrate-set-capabilities
555 # Enable/Disable the following migration capabilities (like xbzrle)
557 # @capabilities: json array of capability modifications to make
561 { 'command': 'migrate-set-capabilities',
562 'data': { 'capabilities': ['MigrationCapabilityStatus'] } }
565 # @query-migrate-capabilities
567 # Returns information about the current migration capabilities status
569 # Returns: @MigrationCapabilitiesStatus
573 { 'command': 'query-migrate-capabilities', 'returns': ['MigrationCapabilityStatus']}
575 # @MigrationParameter
577 # Migration parameters enumeration
579 # @compress-level: Set the compression level to be used in live migration,
580 # the compression level is an integer between 0 and 9, where 0 means
581 # no compression, 1 means the best compression speed, and 9 means best
582 # compression ratio which will consume more CPU.
584 # @compress-threads: Set compression thread count to be used in live migration,
585 # the compression thread count is an integer between 1 and 255.
587 # @decompress-threads: Set decompression thread count to be used in live
588 # migration, the decompression thread count is an integer between 1
589 # and 255. Usually, decompression is at least 4 times as fast as
590 # compression, so set the decompress-threads to the number about 1/4
591 # of compress-threads is adequate.
595 { 'enum': 'MigrationParameter',
596 'data': ['compress-level', 'compress-threads', 'decompress-threads'] }
599 # @migrate-set-parameters
601 # Set the following migration parameters
603 # @compress-level: compression level
605 # @compress-threads: compression thread count
607 # @decompress-threads: decompression thread count
611 { 'command': 'migrate-set-parameters',
612 'data': { '*compress-level': 'int',
613 '*compress-threads': 'int',
614 '*decompress-threads': 'int'} }
617 # @MigrationParameters
619 # @compress-level: compression level
621 # @compress-threads: compression thread count
623 # @decompress-threads: decompression thread count
627 { 'struct': 'MigrationParameters',
628 'data': { 'compress-level': 'int',
629 'compress-threads': 'int',
630 'decompress-threads': 'int'} }
632 # @query-migrate-parameters
634 # Returns information about the current migration parameters
636 # Returns: @MigrationParameters
640 { 'command': 'query-migrate-parameters',
641 'returns': 'MigrationParameters' }
644 # @client_migrate_info
646 # Set migration information for remote display. This makes the server
647 # ask the client to automatically reconnect using the new parameters
648 # once migration finished successfully. Only implemented for SPICE.
650 # @protocol: must be "spice"
651 # @hostname: migration target hostname
652 # @port: #optional spice tcp port for plaintext channels
653 # @tls-port: #optional spice tcp port for tls-secured channels
654 # @cert-subject: #optional server certificate subject
658 { 'command': 'client_migrate_info',
659 'data': { 'protocol': 'str', 'hostname': 'str', '*port': 'int',
660 '*tls-port': 'int', '*cert-subject': 'str' } }
665 # Information about a mouse device.
667 # @name: the name of the mouse device
669 # @index: the index of the mouse device
671 # @current: true if this device is currently receiving mouse events
673 # @absolute: true if this device supports absolute coordinates as input
677 { 'struct': 'MouseInfo',
678 'data': {'name': 'str', 'index': 'int', 'current': 'bool',
679 'absolute': 'bool'} }
684 # Returns information about each active mouse device
686 # Returns: a list of @MouseInfo for each device
690 { 'command': 'query-mice', 'returns': ['MouseInfo'] }
695 # Information about a virtual CPU
697 # @CPU: the index of the virtual CPU
699 # @current: this only exists for backwards compatible and should be ignored
701 # @halted: true if the virtual CPU is in the halt state. Halt usually refers
702 # to a processor specific low power mode.
704 # @qom_path: path to the CPU object in the QOM tree (since 2.4)
706 # @pc: #optional If the target is i386 or x86_64, this is the 64-bit instruction
708 # If the target is Sparc, this is the PC component of the
709 # instruction pointer.
711 # @nip: #optional If the target is PPC, the instruction pointer
713 # @npc: #optional If the target is Sparc, the NPC component of the instruction
716 # @PC: #optional If the target is MIPS, the instruction pointer
718 # @thread_id: ID of the underlying host thread
722 # Notes: @halted is a transient state that changes frequently. By the time the
723 # data is sent to the client, the guest may no longer be halted.
725 { 'struct': 'CpuInfo',
726 'data': {'CPU': 'int', 'current': 'bool', 'halted': 'bool',
728 '*pc': 'int', '*nip': 'int', '*npc': 'int', '*PC': 'int',
729 'thread_id': 'int'} }
734 # Returns a list of information about each virtual CPU.
736 # Returns: a list of @CpuInfo for each virtual CPU
740 { 'command': 'query-cpus', 'returns': ['CpuInfo'] }
745 # Information about an iothread
747 # @id: the identifier of the iothread
749 # @thread-id: ID of the underlying host thread
753 { 'struct': 'IOThreadInfo',
754 'data': {'id': 'str', 'thread-id': 'int'} }
759 # Returns a list of information about each iothread.
761 # Note this list excludes the QEMU main loop thread, which is not declared
762 # using the -object iothread command-line option. It is always the main thread
765 # Returns: a list of @IOThreadInfo for each iothread
769 { 'command': 'query-iothreads', 'returns': ['IOThreadInfo'] }
772 # @NetworkAddressFamily
774 # The network address family
782 # @unknown: otherwise
786 { 'enum': 'NetworkAddressFamily',
787 'data': [ 'ipv4', 'ipv6', 'unix', 'unknown' ] }
792 # The basic information for vnc network connection
796 # @service: The service name of the vnc port. This may depend on the host
797 # system's service database so symbolic names should not be relied
800 # @family: address family
802 # @websocket: true in case the socket is a websocket (since 2.3).
806 { 'struct': 'VncBasicInfo',
807 'data': { 'host': 'str',
809 'family': 'NetworkAddressFamily',
810 'websocket': 'bool' } }
815 # The network connection information for server
817 # @auth: #optional, authentication method
821 { 'struct': 'VncServerInfo',
822 'base': 'VncBasicInfo',
823 'data': { '*auth': 'str' } }
828 # Information about a connected VNC client.
830 # @x509_dname: #optional If x509 authentication is in use, the Distinguished
831 # Name of the client.
833 # @sasl_username: #optional If SASL authentication is in use, the SASL username
834 # used for authentication.
838 { 'struct': 'VncClientInfo',
839 'base': 'VncBasicInfo',
840 'data': { '*x509_dname': 'str', '*sasl_username': 'str' } }
845 # Information about the VNC session.
847 # @enabled: true if the VNC server is enabled, false otherwise
849 # @host: #optional The hostname the VNC server is bound to. This depends on
850 # the name resolution on the host and may be an IP address.
852 # @family: #optional 'ipv6' if the host is listening for IPv6 connections
853 # 'ipv4' if the host is listening for IPv4 connections
854 # 'unix' if the host is listening on a unix domain socket
855 # 'unknown' otherwise
857 # @service: #optional The service name of the server's port. This may depends
858 # on the host system's service database so symbolic names should not
861 # @auth: #optional the current authentication type used by the server
862 # 'none' if no authentication is being used
863 # 'vnc' if VNC authentication is being used
864 # 'vencrypt+plain' if VEncrypt is used with plain text authentication
865 # 'vencrypt+tls+none' if VEncrypt is used with TLS and no authentication
866 # 'vencrypt+tls+vnc' if VEncrypt is used with TLS and VNC authentication
867 # 'vencrypt+tls+plain' if VEncrypt is used with TLS and plain text auth
868 # 'vencrypt+x509+none' if VEncrypt is used with x509 and no auth
869 # 'vencrypt+x509+vnc' if VEncrypt is used with x509 and VNC auth
870 # 'vencrypt+x509+plain' if VEncrypt is used with x509 and plain text auth
871 # 'vencrypt+tls+sasl' if VEncrypt is used with TLS and SASL auth
872 # 'vencrypt+x509+sasl' if VEncrypt is used with x509 and SASL auth
874 # @clients: a list of @VncClientInfo of all currently connected clients
878 { 'struct': 'VncInfo',
879 'data': {'enabled': 'bool', '*host': 'str',
880 '*family': 'NetworkAddressFamily',
881 '*service': 'str', '*auth': 'str', '*clients': ['VncClientInfo']} }
886 # vnc primary authentication method.
890 { 'enum': 'VncPrimaryAuth',
891 'data': [ 'none', 'vnc', 'ra2', 'ra2ne', 'tight', 'ultra',
892 'tls', 'vencrypt', 'sasl' ] }
895 # @VncVencryptSubAuth:
897 # vnc sub authentication method with vencrypt.
901 { 'enum': 'VncVencryptSubAuth',
903 'tls-none', 'x509-none',
904 'tls-vnc', 'x509-vnc',
905 'tls-plain', 'x509-plain',
906 'tls-sasl', 'x509-sasl' ] }
911 # Information about a vnc server
913 # @id: vnc server name.
915 # @server: A list of @VncBasincInfo describing all listening sockets.
916 # The list can be empty (in case the vnc server is disabled).
917 # It also may have multiple entries: normal + websocket,
918 # possibly also ipv4 + ipv6 in the future.
920 # @clients: A list of @VncClientInfo of all currently connected clients.
921 # The list can be empty, for obvious reasons.
923 # @auth: The current authentication type used by the server
925 # @vencrypt: #optional The vencrypt sub authentication type used by the server,
926 # only specified in case auth == vencrypt.
928 # @display: #optional The display device the vnc server is linked to.
932 { 'struct': 'VncInfo2',
933 'data': { 'id' : 'str',
934 'server' : ['VncBasicInfo'],
935 'clients' : ['VncClientInfo'],
936 'auth' : 'VncPrimaryAuth',
937 '*vencrypt' : 'VncVencryptSubAuth',
938 '*display' : 'str' } }
943 # Returns information about the current VNC server
949 { 'command': 'query-vnc', 'returns': 'VncInfo' }
952 # @query-vnc-servers:
954 # Returns a list of vnc servers. The list can be empty.
956 # Returns: a list of @VncInfo2
960 { 'command': 'query-vnc-servers', 'returns': ['VncInfo2'] }
965 # The basic information for SPICE network connection
971 # @family: address family
975 { 'struct': 'SpiceBasicInfo',
976 'data': { 'host': 'str',
978 'family': 'NetworkAddressFamily' } }
983 # Information about a SPICE server
985 # @auth: #optional, authentication method
989 { 'struct': 'SpiceServerInfo',
990 'base': 'SpiceBasicInfo',
991 'data': { '*auth': 'str' } }
996 # Information about a SPICE client channel.
998 # @connection-id: SPICE connection id number. All channels with the same id
999 # belong to the same SPICE session.
1001 # @channel-type: SPICE channel type number. "1" is the main control
1002 # channel, filter for this one if you want to track spice
1005 # @channel-id: SPICE channel ID number. Usually "0", might be different when
1006 # multiple channels of the same type exist, such as multiple
1007 # display channels in a multihead setup
1009 # @tls: true if the channel is encrypted, false otherwise.
1013 { 'struct': 'SpiceChannel',
1014 'base': 'SpiceBasicInfo',
1015 'data': {'connection-id': 'int', 'channel-type': 'int', 'channel-id': 'int',
1019 # @SpiceQueryMouseMode
1021 # An enumeration of Spice mouse states.
1023 # @client: Mouse cursor position is determined by the client.
1025 # @server: Mouse cursor position is determined by the server.
1027 # @unknown: No information is available about mouse mode used by
1030 # Note: spice/enums.h has a SpiceMouseMode already, hence the name.
1034 { 'enum': 'SpiceQueryMouseMode',
1035 'data': [ 'client', 'server', 'unknown' ] }
1040 # Information about the SPICE session.
1042 # @enabled: true if the SPICE server is enabled, false otherwise
1044 # @migrated: true if the last guest migration completed and spice
1045 # migration had completed as well. false otherwise.
1047 # @host: #optional The hostname the SPICE server is bound to. This depends on
1048 # the name resolution on the host and may be an IP address.
1050 # @port: #optional The SPICE server's port number.
1052 # @compiled-version: #optional SPICE server version.
1054 # @tls-port: #optional The SPICE server's TLS port number.
1056 # @auth: #optional the current authentication type used by the server
1057 # 'none' if no authentication is being used
1058 # 'spice' uses SASL or direct TLS authentication, depending on command
1061 # @mouse-mode: The mode in which the mouse cursor is displayed currently. Can
1062 # be determined by the client or the server, or unknown if spice
1063 # server doesn't provide this information.
1067 # @channels: a list of @SpiceChannel for each active spice channel
1071 { 'struct': 'SpiceInfo',
1072 'data': {'enabled': 'bool', 'migrated': 'bool', '*host': 'str', '*port': 'int',
1073 '*tls-port': 'int', '*auth': 'str', '*compiled-version': 'str',
1074 'mouse-mode': 'SpiceQueryMouseMode', '*channels': ['SpiceChannel']} }
1079 # Returns information about the current SPICE server
1081 # Returns: @SpiceInfo
1085 { 'command': 'query-spice', 'returns': 'SpiceInfo' }
1090 # Information about the guest balloon device.
1092 # @actual: the number of bytes the balloon currently contains
1097 { 'struct': 'BalloonInfo', 'data': {'actual': 'int' } }
1102 # Return information about the balloon device.
1104 # Returns: @BalloonInfo on success
1105 # If the balloon driver is enabled but not functional because the KVM
1106 # kernel module cannot support it, KvmMissingCap
1107 # If no balloon device is present, DeviceNotActive
1111 { 'command': 'query-balloon', 'returns': 'BalloonInfo' }
1116 # A PCI device memory region
1118 # @base: the starting address (guest physical)
1120 # @limit: the ending address (guest physical)
1124 { 'struct': 'PciMemoryRange', 'data': {'base': 'int', 'limit': 'int'} }
1129 # Information about a PCI device I/O region.
1131 # @bar: the index of the Base Address Register for this region
1133 # @type: 'io' if the region is a PIO region
1134 # 'memory' if the region is a MMIO region
1136 # @prefetch: #optional if @type is 'memory', true if the memory is prefetchable
1138 # @mem_type_64: #optional if @type is 'memory', true if the BAR is 64-bit
1142 { 'struct': 'PciMemoryRegion',
1143 'data': {'bar': 'int', 'type': 'str', 'address': 'int', 'size': 'int',
1144 '*prefetch': 'bool', '*mem_type_64': 'bool' } }
1149 # Information about a bus of a PCI Bridge device
1151 # @number: primary bus interface number. This should be the number of the
1152 # bus the device resides on.
1154 # @secondary: secondary bus interface number. This is the number of the
1155 # main bus for the bridge
1157 # @subordinate: This is the highest number bus that resides below the
1160 # @io_range: The PIO range for all devices on this bridge
1162 # @memory_range: The MMIO range for all devices on this bridge
1164 # @prefetchable_range: The range of prefetchable MMIO for all devices on
1169 { 'struct': 'PciBusInfo',
1170 'data': {'number': 'int', 'secondary': 'int', 'subordinate': 'int',
1171 'io_range': 'PciMemoryRange',
1172 'memory_range': 'PciMemoryRange',
1173 'prefetchable_range': 'PciMemoryRange' } }
1178 # Information about a PCI Bridge device
1180 # @bus: information about the bus the device resides on
1182 # @devices: a list of @PciDeviceInfo for each device on this bridge
1186 { 'struct': 'PciBridgeInfo',
1187 'data': {'bus': 'PciBusInfo', '*devices': ['PciDeviceInfo']} }
1192 # Information about the Class of a PCI device
1194 # @desc: #optional a string description of the device's class
1196 # @class: the class code of the device
1200 { 'struct': 'PciDeviceClass',
1201 'data': {'*desc': 'str', 'class': 'int'} }
1206 # Information about the Id of a PCI device
1208 # @device: the PCI device id
1210 # @vendor: the PCI vendor id
1214 { 'struct': 'PciDeviceId',
1215 'data': {'device': 'int', 'vendor': 'int'} }
1220 # Information about a PCI device
1222 # @bus: the bus number of the device
1224 # @slot: the slot the device is located in
1226 # @function: the function of the slot used by the device
1228 # @class_info: the class of the device
1230 # @id: the PCI device id
1232 # @irq: #optional if an IRQ is assigned to the device, the IRQ number
1234 # @qdev_id: the device name of the PCI device
1236 # @pci_bridge: if the device is a PCI bridge, the bridge information
1238 # @regions: a list of the PCI I/O regions associated with the device
1240 # Notes: the contents of @class_info.desc are not stable and should only be
1241 # treated as informational.
1245 { 'struct': 'PciDeviceInfo',
1246 'data': {'bus': 'int', 'slot': 'int', 'function': 'int',
1247 'class_info': 'PciDeviceClass', 'id': 'PciDeviceId',
1248 '*irq': 'int', 'qdev_id': 'str', '*pci_bridge': 'PciBridgeInfo',
1249 'regions': ['PciMemoryRegion']} }
1254 # Information about a PCI bus
1256 # @bus: the bus index
1258 # @devices: a list of devices on this bus
1262 { 'struct': 'PciInfo', 'data': {'bus': 'int', 'devices': ['PciDeviceInfo']} }
1267 # Return information about the PCI bus topology of the guest.
1269 # Returns: a list of @PciInfo for each PCI bus
1273 { 'command': 'query-pci', 'returns': ['PciInfo'] }
1278 # This command will cause the QEMU process to exit gracefully. While every
1279 # attempt is made to send the QMP response before terminating, this is not
1280 # guaranteed. When using this interface, a premature EOF would not be
1285 { 'command': 'quit' }
1290 # Stop all guest VCPU execution.
1294 # Notes: This function will succeed even if the guest is already in the stopped
1295 # state. In "inmigrate" state, it will ensure that the guest
1296 # remains paused once migration finishes, as if the -S option was
1297 # passed on the command line.
1299 { 'command': 'stop' }
1304 # Performs a hard reset of a guest.
1308 { 'command': 'system_reset' }
1311 # @system_powerdown:
1313 # Requests that a guest perform a powerdown operation.
1317 # Notes: A guest may or may not respond to this command. This command
1318 # returning does not indicate that a guest has accepted the request or
1319 # that it has shut down. Many guests will respond to this command by
1320 # prompting the user in some way.
1322 { 'command': 'system_powerdown' }
1327 # This command is a nop that is only provided for the purposes of compatibility.
1331 # Notes: Do not use this command.
1333 { 'command': 'cpu', 'data': {'index': 'int'} }
1338 # Adds CPU with specified ID
1340 # @id: ID of CPU to be created, valid values [0..max_cpus)
1342 # Returns: Nothing on success
1346 { 'command': 'cpu-add', 'data': {'id': 'int'} }
1351 # Save a portion of guest memory to a file.
1353 # @val: the virtual address of the guest to start from
1355 # @size: the size of memory region to save
1357 # @filename: the file to save the memory to as binary data
1359 # @cpu-index: #optional the index of the virtual CPU to use for translating the
1360 # virtual address (defaults to CPU 0)
1362 # Returns: Nothing on success
1366 # Notes: Errors were not reliably returned until 1.1
1368 { 'command': 'memsave',
1369 'data': {'val': 'int', 'size': 'int', 'filename': 'str', '*cpu-index': 'int'} }
1374 # Save a portion of guest physical memory to a file.
1376 # @val: the physical address of the guest to start from
1378 # @size: the size of memory region to save
1380 # @filename: the file to save the memory to as binary data
1382 # Returns: Nothing on success
1386 # Notes: Errors were not reliably returned until 1.1
1388 { 'command': 'pmemsave',
1389 'data': {'val': 'int', 'size': 'int', 'filename': 'str'} }
1394 # Resume guest VCPU execution.
1398 # Returns: If successful, nothing
1399 # If QEMU was started with an encrypted block device and a key has
1400 # not yet been set, DeviceEncrypted.
1402 # Notes: This command will succeed if the guest is currently running. It
1403 # will also succeed if the guest is in the "inmigrate" state; in
1404 # this case, the effect of the command is to make sure the guest
1405 # starts once migration finishes, removing the effect of the -S
1406 # command line option if it was passed.
1408 { 'command': 'cont' }
1413 # Wakeup guest from suspend. Does nothing in case the guest isn't suspended.
1419 { 'command': 'system_wakeup' }
1424 # Injects a Non-Maskable Interrupt into the default CPU (x86/s390) or all CPUs (ppc64).
1426 # Returns: If successful, nothing
1430 # Note: prior to 2.1, this command was only supported for x86 and s390 VMs
1432 { 'command': 'inject-nmi' }
1437 # Sets the link status of a virtual network adapter.
1439 # @name: the device name of the virtual network adapter
1441 # @up: true to set the link status to be up
1443 # Returns: Nothing on success
1444 # If @name is not a valid network device, DeviceNotFound
1448 # Notes: Not all network adapters support setting link status. This command
1449 # will succeed even if the network adapter does not support link status
1452 { 'command': 'set_link', 'data': {'name': 'str', 'up': 'bool'} }
1457 # Request the balloon driver to change its balloon size.
1459 # @value: the target size of the balloon in bytes
1461 # Returns: Nothing on success
1462 # If the balloon driver is enabled but not functional because the KVM
1463 # kernel module cannot support it, KvmMissingCap
1464 # If no balloon device is present, DeviceNotActive
1466 # Notes: This command just issues a request to the guest. When it returns,
1467 # the balloon size may not have changed. A guest can change the balloon
1468 # size independent of this command.
1472 { 'command': 'balloon', 'data': {'value': 'int'} }
1477 # This action can be used to test transaction failure.
1481 { 'struct': 'Abort',
1485 # @TransactionAction
1487 # A discriminated record of operations that can be performed with
1492 # drive-backup since 1.6
1494 # blockdev-snapshot-internal-sync since 1.7
1495 # blockdev-backup since 2.3
1497 { 'union': 'TransactionAction',
1499 'blockdev-snapshot-sync': 'BlockdevSnapshot',
1500 'drive-backup': 'DriveBackup',
1501 'blockdev-backup': 'BlockdevBackup',
1503 'blockdev-snapshot-internal-sync': 'BlockdevSnapshotInternal'
1509 # Executes a number of transactionable QMP commands atomically. If any
1510 # operation fails, then the entire set of actions will be abandoned and the
1511 # appropriate error returned.
1514 # @TransactionAction: information needed for the respective operation
1516 # Returns: nothing on success
1517 # Errors depend on the operations of the transaction
1519 # Note: The transaction aborts on the first failure. Therefore, there will be
1520 # information on only one failed operation returned in an error condition, and
1521 # subsequent actions will not have been attempted.
1525 { 'command': 'transaction',
1526 'data': { 'actions': [ 'TransactionAction' ] } }
1529 # @human-monitor-command:
1531 # Execute a command on the human monitor and return the output.
1533 # @command-line: the command to execute in the human monitor
1535 # @cpu-index: #optional The CPU to use for commands that require an implicit CPU
1537 # Returns: the output of the command as a string
1541 # Notes: This command only exists as a stop-gap. Its use is highly
1542 # discouraged. The semantics of this command are not guaranteed.
1544 # Known limitations:
1546 # o This command is stateless, this means that commands that depend
1547 # on state information (such as getfd) might not work
1549 # o Commands that prompt the user for data (eg. 'cont' when the block
1550 # device is encrypted) don't currently work
1552 { 'command': 'human-monitor-command',
1553 'data': {'command-line': 'str', '*cpu-index': 'int'},
1559 # Cancel the current executing migration process.
1561 # Returns: nothing on success
1563 # Notes: This command succeeds even if there is no migration process running.
1567 { 'command': 'migrate_cancel' }
1570 # @migrate_set_downtime
1572 # Set maximum tolerated downtime for migration.
1574 # @value: maximum downtime in seconds
1576 # Returns: nothing on success
1580 { 'command': 'migrate_set_downtime', 'data': {'value': 'number'} }
1583 # @migrate_set_speed
1585 # Set maximum speed for migration.
1587 # @value: maximum speed in bytes.
1589 # Returns: nothing on success
1591 # Notes: A value lesser than zero will be automatically round up to zero.
1595 { 'command': 'migrate_set_speed', 'data': {'value': 'int'} }
1598 # @migrate-set-cache-size
1600 # Set XBZRLE cache size
1602 # @value: cache size in bytes
1604 # The size will be rounded down to the nearest power of 2.
1605 # The cache size can be modified before and during ongoing migration
1607 # Returns: nothing on success
1611 { 'command': 'migrate-set-cache-size', 'data': {'value': 'int'} }
1614 # @query-migrate-cache-size
1616 # query XBZRLE cache size
1618 # Returns: XBZRLE cache size in bytes
1622 { 'command': 'query-migrate-cache-size', 'returns': 'int' }
1625 # @ObjectPropertyInfo:
1627 # @name: the name of the property
1629 # @type: the type of the property. This will typically come in one of four
1632 # 1) A primitive type such as 'u8', 'u16', 'bool', 'str', or 'double'.
1633 # These types are mapped to the appropriate JSON type.
1635 # 2) A child type in the form 'child<subtype>' where subtype is a qdev
1636 # device type name. Child properties create the composition tree.
1638 # 3) 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
1690 # type. child<> and link<> properties are returned as #str
1691 # pathnames. All integer property types (u8, u16, etc) are
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 # Dump guest's storage keys
2062 # @filename: the path to the file to dump to
2064 # This command is only supported on s390 architecture.
2068 { 'command': 'dump-skeys',
2069 'data': { 'filename': 'str' } }
2074 # Add a network backend.
2076 # @type: the type of network backend. Current valid values are 'user', 'tap',
2077 # 'vde', 'socket', 'dump' and 'bridge'
2079 # @id: the name of the new network backend
2081 # @props: #optional a list of properties to be passed to the backend in
2082 # the format 'name=value', like 'ifname=tap0,script=no'
2084 # Notes: The semantics of @props is not well defined. Future commands will be
2085 # introduced that provide stronger typing for backend creation.
2089 # Returns: Nothing on success
2090 # If @type is not a valid network backend, DeviceNotFound
2092 { 'command': 'netdev_add',
2093 'data': {'type': 'str', 'id': 'str', '*props': '**'},
2099 # Remove a network backend.
2101 # @id: the name of the network backend to remove
2103 # Returns: Nothing on success
2104 # If @id is not a valid network backend, DeviceNotFound
2108 { 'command': 'netdev_del', 'data': {'id': 'str'} }
2113 # Create a QOM object.
2115 # @qom-type: the class name for the object to be created
2117 # @id: the name of the new object
2119 # @props: #optional a dictionary of properties to be passed to the backend
2121 # Returns: Nothing on success
2122 # Error if @qom-type is not a valid class name
2126 { 'command': 'object-add',
2127 'data': {'qom-type': 'str', 'id': 'str', '*props': '**'},
2133 # Remove a QOM object.
2135 # @id: the name of the QOM object to remove
2137 # Returns: Nothing on success
2138 # Error if @id is not a valid id for a QOM object
2142 { 'command': 'object-del', 'data': {'id': 'str'} }
2145 # @NetdevNoneOptions
2147 # Use it alone to have zero network devices.
2151 { 'struct': 'NetdevNoneOptions',
2155 # @NetLegacyNicOptions
2157 # Create a new Network Interface Card.
2159 # @netdev: #optional id of -netdev to connect to
2161 # @macaddr: #optional MAC address
2163 # @model: #optional device model (e1000, rtl8139, virtio etc.)
2165 # @addr: #optional PCI device address
2167 # @vectors: #optional number of MSI-x vectors, 0 to disable MSI-X
2171 { 'struct': 'NetLegacyNicOptions',
2177 '*vectors': 'uint32' } }
2182 # A fat type wrapping 'str', to be embedded in lists.
2186 { 'struct': 'String',
2191 # @NetdevUserOptions
2193 # Use the user mode network stack which requires no administrator privilege to
2196 # @hostname: #optional client hostname reported by the builtin DHCP server
2198 # @restrict: #optional isolate the guest from the host
2200 # @ip: #optional legacy parameter, use net= instead
2202 # @net: #optional IP address and optional netmask
2204 # @host: #optional guest-visible address of the host
2206 # @tftp: #optional root directory of the built-in TFTP server
2208 # @bootfile: #optional BOOTP filename, for use with tftp=
2210 # @dhcpstart: #optional the first of the 16 IPs the built-in DHCP server can
2213 # @dns: #optional guest-visible address of the virtual nameserver
2215 # @dnssearch: #optional list of DNS suffixes to search, passed as DHCP option
2218 # @smb: #optional root directory of the built-in SMB server
2220 # @smbserver: #optional IP address of the built-in SMB server
2222 # @hostfwd: #optional redirect incoming TCP or UDP host connections to guest
2225 # @guestfwd: #optional forward guest TCP connections
2229 { 'struct': 'NetdevUserOptions',
2232 '*restrict': 'bool',
2238 '*dhcpstart': 'str',
2240 '*dnssearch': ['String'],
2242 '*smbserver': 'str',
2243 '*hostfwd': ['String'],
2244 '*guestfwd': ['String'] } }
2249 # Connect the host TAP network interface name to the VLAN.
2251 # @ifname: #optional interface name
2253 # @fd: #optional file descriptor of an already opened tap
2255 # @fds: #optional multiple file descriptors of already opened multiqueue capable
2258 # @script: #optional script to initialize the interface
2260 # @downscript: #optional script to shut down the interface
2262 # @helper: #optional command to execute to configure bridge
2264 # @sndbuf: #optional send buffer limit. Understands [TGMKkb] suffixes.
2266 # @vnet_hdr: #optional enable the IFF_VNET_HDR flag on the tap interface
2268 # @vhost: #optional enable vhost-net network accelerator
2270 # @vhostfd: #optional file descriptor of an already opened vhost net device
2272 # @vhostfds: #optional file descriptors of multiple already opened vhost net
2275 # @vhostforce: #optional vhost on for non-MSIX virtio guests
2277 # @queues: #optional number of queues to be created for multiqueue capable tap
2281 { 'struct': 'NetdevTapOptions',
2287 '*downscript': 'str',
2290 '*vnet_hdr': 'bool',
2294 '*vhostforce': 'bool',
2295 '*queues': 'uint32'} }
2298 # @NetdevSocketOptions
2300 # Connect the VLAN to a remote VLAN in another QEMU virtual machine using a TCP
2301 # socket connection.
2303 # @fd: #optional file descriptor of an already opened socket
2305 # @listen: #optional port number, and optional hostname, to listen on
2307 # @connect: #optional port number, and optional hostname, to connect to
2309 # @mcast: #optional UDP multicast address and port number
2311 # @localaddr: #optional source address and port for multicast and udp packets
2313 # @udp: #optional UDP unicast address and port number
2317 { 'struct': 'NetdevSocketOptions',
2323 '*localaddr': 'str',
2327 # @NetdevL2TPv3Options
2329 # Connect the VLAN to Ethernet over L2TPv3 Static tunnel
2331 # @src: source address
2333 # @dst: destination address
2335 # @srcport: #optional source port - mandatory for udp, optional for ip
2337 # @dstport: #optional destination port - mandatory for udp, optional for ip
2339 # @ipv6: #optional - force the use of ipv6
2341 # @udp: #optional - use the udp version of l2tpv3 encapsulation
2343 # @cookie64: #optional - use 64 bit coookies
2345 # @counter: #optional have sequence counter
2347 # @pincounter: #optional pin sequence counter to zero -
2348 # workaround for buggy implementations or
2349 # networks with packet reorder
2351 # @txcookie: #optional 32 or 64 bit transmit cookie
2353 # @rxcookie: #optional 32 or 64 bit receive cookie
2355 # @txsession: 32 bit transmit session
2357 # @rxsession: #optional 32 bit receive session - if not specified
2358 # set to the same value as transmit
2360 # @offset: #optional additional offset - allows the insertion of
2361 # additional application-specific data before the packet payload
2365 { 'struct': 'NetdevL2TPv3Options',
2373 '*cookie64': 'bool',
2375 '*pincounter': 'bool',
2376 '*txcookie': 'uint64',
2377 '*rxcookie': 'uint64',
2378 'txsession': 'uint32',
2379 '*rxsession': 'uint32',
2380 '*offset': 'uint32' } }
2385 # Connect the VLAN to a vde switch running on the host.
2387 # @sock: #optional socket path
2389 # @port: #optional port number
2391 # @group: #optional group owner of socket
2393 # @mode: #optional permissions for socket
2397 { 'struct': 'NetdevVdeOptions',
2402 '*mode': 'uint16' } }
2405 # @NetdevDumpOptions
2407 # Dump VLAN network traffic to a file.
2409 # @len: #optional per-packet size limit (64k default). Understands [TGMKkb]
2412 # @file: #optional dump file path (default is qemu-vlan0.pcap)
2416 { 'struct': 'NetdevDumpOptions',
2422 # @NetdevBridgeOptions
2424 # Connect a host TAP network interface to a host bridge device.
2426 # @br: #optional bridge name
2428 # @helper: #optional command to execute to configure bridge
2432 { 'struct': 'NetdevBridgeOptions',
2435 '*helper': 'str' } }
2438 # @NetdevHubPortOptions
2440 # Connect two or more net clients through a software hub.
2442 # @hubid: hub identifier number
2446 { 'struct': 'NetdevHubPortOptions',
2448 'hubid': 'int32' } }
2451 # @NetdevNetmapOptions
2453 # Connect a client to a netmap-enabled NIC or to a VALE switch port
2455 # @ifname: Either the name of an existing network interface supported by
2456 # netmap, or the name of a VALE port (created on the fly).
2457 # A VALE port name is in the form 'valeXXX:YYY', where XXX and
2458 # YYY are non-negative integers. XXX identifies a switch and
2459 # YYY identifies a port of the switch. VALE ports having the
2460 # same XXX are therefore connected to the same switch.
2462 # @devname: #optional path of the netmap device (default: '/dev/netmap').
2466 { 'struct': 'NetdevNetmapOptions',
2469 '*devname': 'str' } }
2472 # @NetdevVhostUserOptions
2474 # Vhost-user network backend
2476 # @chardev: name of a unix socket chardev
2478 # @vhostforce: #optional vhost on for non-MSIX virtio guests (default: false).
2482 { 'struct': 'NetdevVhostUserOptions',
2485 '*vhostforce': 'bool' } }
2490 # A discriminated record of network device traits.
2494 # 'l2tpv3' - since 2.1
2497 { 'union': 'NetClientOptions',
2499 'none': 'NetdevNoneOptions',
2500 'nic': 'NetLegacyNicOptions',
2501 'user': 'NetdevUserOptions',
2502 'tap': 'NetdevTapOptions',
2503 'l2tpv3': 'NetdevL2TPv3Options',
2504 'socket': 'NetdevSocketOptions',
2505 'vde': 'NetdevVdeOptions',
2506 'dump': 'NetdevDumpOptions',
2507 'bridge': 'NetdevBridgeOptions',
2508 'hubport': 'NetdevHubPortOptions',
2509 'netmap': 'NetdevNetmapOptions',
2510 'vhost-user': 'NetdevVhostUserOptions' } }
2515 # Captures the configuration of a network device; legacy.
2517 # @vlan: #optional vlan number
2519 # @id: #optional identifier for monitor commands
2521 # @name: #optional identifier for monitor commands, ignored if @id is present
2523 # @opts: device type specific properties (legacy)
2527 { 'struct': 'NetLegacy',
2532 'opts': 'NetClientOptions' } }
2537 # Captures the configuration of a network device.
2539 # @id: identifier for monitor commands.
2541 # @opts: device type specific properties
2545 { 'struct': 'Netdev',
2548 'opts': 'NetClientOptions' } }
2551 # @InetSocketAddress
2553 # Captures a socket address or address range in the Internet namespace.
2555 # @host: host part of the address
2557 # @port: port part of the address, or lowest port if @to is present
2559 # @to: highest port to try
2561 # @ipv4: whether to accept IPv4 addresses, default try both IPv4 and IPv6
2564 # @ipv6: whether to accept IPv6 addresses, default try both IPv4 and IPv6
2569 { 'struct': 'InetSocketAddress',
2578 # @UnixSocketAddress
2580 # Captures a socket address in the local ("Unix socket") namespace.
2582 # @path: filesystem path to use
2586 { 'struct': 'UnixSocketAddress',
2593 # Captures the address of a socket, which could also be a named file descriptor
2597 { 'union': 'SocketAddress',
2599 'inet': 'InetSocketAddress',
2600 'unix': 'UnixSocketAddress',
2606 # Receive a file descriptor via SCM rights and assign it a name
2608 # @fdname: file descriptor name
2610 # Returns: Nothing on success
2614 # Notes: If @fdname already exists, the file descriptor assigned to
2615 # it will be closed and replaced by the received file
2617 # The 'closefd' command can be used to explicitly close the
2618 # file descriptor when it is no longer needed.
2620 { 'command': 'getfd', 'data': {'fdname': 'str'} }
2625 # Close a file descriptor previously passed via SCM rights
2627 # @fdname: file descriptor name
2629 # Returns: Nothing on success
2633 { 'command': 'closefd', 'data': {'fdname': 'str'} }
2638 # Information describing a machine.
2640 # @name: the name of the machine
2642 # @alias: #optional an alias for the machine name
2644 # @default: #optional whether the machine is default
2646 # @cpu-max: maximum number of CPUs supported by the machine type
2651 { 'struct': 'MachineInfo',
2652 'data': { 'name': 'str', '*alias': 'str',
2653 '*is-default': 'bool', 'cpu-max': 'int' } }
2658 # Return a list of supported machines
2660 # Returns: a list of MachineInfo
2664 { 'command': 'query-machines', 'returns': ['MachineInfo'] }
2667 # @CpuDefinitionInfo:
2669 # Virtual CPU definition.
2671 # @name: the name of the CPU definition
2675 { 'struct': 'CpuDefinitionInfo',
2676 'data': { 'name': 'str' } }
2679 # @query-cpu-definitions:
2681 # Return a list of supported virtual CPU definitions
2683 # Returns: a list of CpuDefInfo
2687 { 'command': 'query-cpu-definitions', 'returns': ['CpuDefinitionInfo'] }
2691 # Information about a file descriptor that was added to an fd set.
2693 # @fdset-id: The ID of the fd set that @fd was added to.
2695 # @fd: The file descriptor that was received via SCM rights and
2696 # added to the fd set.
2700 { 'struct': 'AddfdInfo', 'data': {'fdset-id': 'int', 'fd': 'int'} }
2705 # Add a file descriptor, that was passed via SCM rights, to an fd set.
2707 # @fdset-id: #optional The ID of the fd set to add the file descriptor to.
2709 # @opaque: #optional A free-form string that can be used to describe the fd.
2711 # Returns: @AddfdInfo on success
2712 # If file descriptor was not received, FdNotSupplied
2713 # If @fdset-id is a negative value, InvalidParameterValue
2715 # Notes: The list of fd sets is shared by all monitor connections.
2717 # If @fdset-id is not specified, a new fd set will be created.
2721 { 'command': 'add-fd', 'data': {'*fdset-id': 'int', '*opaque': 'str'},
2722 'returns': 'AddfdInfo' }
2727 # Remove a file descriptor from an fd set.
2729 # @fdset-id: The ID of the fd set that the file descriptor belongs to.
2731 # @fd: #optional The file descriptor that is to be removed.
2733 # Returns: Nothing on success
2734 # If @fdset-id or @fd is not found, FdNotFound
2738 # Notes: The list of fd sets is shared by all monitor connections.
2740 # If @fd is not specified, all file descriptors in @fdset-id
2743 { 'command': 'remove-fd', 'data': {'fdset-id': 'int', '*fd': 'int'} }
2748 # Information about a file descriptor that belongs to an fd set.
2750 # @fd: The file descriptor value.
2752 # @opaque: #optional A free-form string that can be used to describe the fd.
2756 { 'struct': 'FdsetFdInfo',
2757 'data': {'fd': 'int', '*opaque': 'str'} }
2762 # Information about an fd set.
2764 # @fdset-id: The ID of the fd set.
2766 # @fds: A list of file descriptors that belong to this fd set.
2770 { 'struct': 'FdsetInfo',
2771 'data': {'fdset-id': 'int', 'fds': ['FdsetFdInfo']} }
2776 # Return information describing all fd sets.
2778 # Returns: A list of @FdsetInfo
2782 # Note: The list of fd sets is shared by all monitor connections.
2785 { 'command': 'query-fdsets', 'returns': ['FdsetInfo'] }
2790 # Information describing the QEMU target.
2792 # @arch: the target architecture (eg "x86_64", "i386", etc)
2796 { 'struct': 'TargetInfo',
2797 'data': { 'arch': 'str' } }
2802 # Return information about the target for this QEMU
2804 # Returns: TargetInfo
2808 { 'command': 'query-target', 'returns': 'TargetInfo' }
2813 # An enumeration of key name.
2815 # This is used by the send-key command.
2819 # 'unmapped' and 'pause' since 2.0
2820 # 'ro' and 'kp_comma' since 2.4
2822 { 'enum': 'QKeyCode',
2823 'data': [ 'unmapped',
2824 'shift', 'shift_r', 'alt', 'alt_r', 'altgr', 'altgr_r', 'ctrl',
2825 'ctrl_r', 'menu', 'esc', '1', '2', '3', '4', '5', '6', '7', '8',
2826 '9', '0', 'minus', 'equal', 'backspace', 'tab', 'q', 'w', 'e',
2827 'r', 't', 'y', 'u', 'i', 'o', 'p', 'bracket_left', 'bracket_right',
2828 'ret', 'a', 's', 'd', 'f', 'g', 'h', 'j', 'k', 'l', 'semicolon',
2829 'apostrophe', 'grave_accent', 'backslash', 'z', 'x', 'c', 'v', 'b',
2830 'n', 'm', 'comma', 'dot', 'slash', 'asterisk', 'spc', 'caps_lock',
2831 'f1', 'f2', 'f3', 'f4', 'f5', 'f6', 'f7', 'f8', 'f9', 'f10',
2832 'num_lock', 'scroll_lock', 'kp_divide', 'kp_multiply',
2833 'kp_subtract', 'kp_add', 'kp_enter', 'kp_decimal', 'sysrq', 'kp_0',
2834 'kp_1', 'kp_2', 'kp_3', 'kp_4', 'kp_5', 'kp_6', 'kp_7', 'kp_8',
2835 'kp_9', 'less', 'f11', 'f12', 'print', 'home', 'pgup', 'pgdn', 'end',
2836 'left', 'up', 'down', 'right', 'insert', 'delete', 'stop', 'again',
2837 'props', 'undo', 'front', 'copy', 'open', 'paste', 'find', 'cut',
2838 'lf', 'help', 'meta_l', 'meta_r', 'compose', 'pause', 'ro',
2844 # Represents a keyboard key.
2848 { 'union': 'KeyValue',
2851 'qcode': 'QKeyCode' } }
2856 # Send keys to guest.
2858 # @keys: An array of @KeyValue elements. All @KeyValues in this array are
2859 # simultaneously sent to the guest. A @KeyValue.number value is sent
2860 # directly to the guest, while @KeyValue.qcode must be a valid
2863 # @hold-time: #optional time to delay key up events, milliseconds. Defaults
2866 # Returns: Nothing on success
2867 # If key is unknown or redundant, InvalidParameter
2872 { 'command': 'send-key',
2873 'data': { 'keys': ['KeyValue'], '*hold-time': 'int' } }
2878 # Write a PPM of the VGA screen to a file.
2880 # @filename: the path of a new PPM file to store the image
2882 # Returns: Nothing on success
2886 { 'command': 'screendump', 'data': {'filename': 'str'} }
2891 # Configuration info for file chardevs.
2893 # @in: #optional The name of the input file
2894 # @out: The name of the output file
2898 { 'struct': 'ChardevFile', 'data': { '*in' : 'str',
2904 # Configuration info for device and pipe chardevs.
2906 # @device: The name of the special file for the device,
2907 # i.e. /dev/ttyS0 on Unix or COM1: on Windows
2908 # @type: What kind of device this is.
2912 { 'struct': 'ChardevHostdev', 'data': { 'device' : 'str' } }
2917 # Configuration info for (stream) socket chardevs.
2919 # @addr: socket address to listen on (server=true)
2920 # or connect to (server=false)
2921 # @server: #optional create server socket (default: true)
2922 # @wait: #optional wait for incoming connection on server
2923 # sockets (default: false).
2924 # @nodelay: #optional set TCP_NODELAY socket option (default: false)
2925 # @telnet: #optional enable telnet protocol on server
2926 # sockets (default: false)
2927 # @reconnect: #optional For a client socket, if a socket is disconnected,
2928 # then attempt a reconnect after the given number of seconds.
2929 # Setting this to zero disables this function. (default: 0)
2934 { 'struct': 'ChardevSocket', 'data': { 'addr' : 'SocketAddress',
2937 '*nodelay' : 'bool',
2939 '*reconnect' : 'int' } }
2944 # Configuration info for datagram socket chardevs.
2946 # @remote: remote address
2947 # @local: #optional local address
2951 { 'struct': 'ChardevUdp', 'data': { 'remote' : 'SocketAddress',
2952 '*local' : 'SocketAddress' } }
2957 # Configuration info for mux chardevs.
2959 # @chardev: name of the base chardev.
2963 { 'struct': 'ChardevMux', 'data': { 'chardev' : 'str' } }
2968 # Configuration info for stdio chardevs.
2970 # @signal: #optional Allow signals (such as SIGINT triggered by ^C)
2971 # be delivered to qemu. Default: true in -nographic mode,
2976 { 'struct': 'ChardevStdio', 'data': { '*signal' : 'bool' } }
2979 # @ChardevSpiceChannel:
2981 # Configuration info for spice vm channel chardevs.
2983 # @type: kind of channel (for example vdagent).
2987 { 'struct': 'ChardevSpiceChannel', 'data': { 'type' : 'str' } }
2990 # @ChardevSpicePort:
2992 # Configuration info for spice port chardevs.
2994 # @fqdn: name of the channel (see docs/spice-port-fqdn.txt)
2998 { 'struct': 'ChardevSpicePort', 'data': { 'fqdn' : 'str' } }
3003 # Configuration info for virtual console chardevs.
3005 # @width: console width, in pixels
3006 # @height: console height, in pixels
3007 # @cols: console width, in chars
3008 # @rows: console height, in chars
3012 { 'struct': 'ChardevVC', 'data': { '*width' : 'int',
3020 # Configuration info for ring buffer chardevs.
3022 # @size: #optional ring buffer size, must be power of two, default is 65536
3026 { 'struct': 'ChardevRingbuf', 'data': { '*size' : 'int' } }
3031 # Configuration info for the new chardev backend.
3033 # Since: 1.4 (testdev since 2.2)
3035 { 'struct': 'ChardevDummy', 'data': { } }
3037 { 'union': 'ChardevBackend', 'data': { 'file' : 'ChardevFile',
3038 'serial' : 'ChardevHostdev',
3039 'parallel': 'ChardevHostdev',
3040 'pipe' : 'ChardevHostdev',
3041 'socket' : 'ChardevSocket',
3042 'udp' : 'ChardevUdp',
3043 'pty' : 'ChardevDummy',
3044 'null' : 'ChardevDummy',
3045 'mux' : 'ChardevMux',
3046 'msmouse': 'ChardevDummy',
3047 'braille': 'ChardevDummy',
3048 'testdev': 'ChardevDummy',
3049 'stdio' : 'ChardevStdio',
3050 'console': 'ChardevDummy',
3051 'spicevmc' : 'ChardevSpiceChannel',
3052 'spiceport' : 'ChardevSpicePort',
3054 'ringbuf': 'ChardevRingbuf',
3055 # next one is just for compatibility
3056 'memory' : 'ChardevRingbuf' } }
3061 # Return info about the chardev backend just created.
3063 # @pty: #optional name of the slave pseudoterminal device, present if
3064 # and only if a chardev of type 'pty' was created
3068 { 'struct' : 'ChardevReturn', 'data': { '*pty' : 'str' } }
3073 # Add a character device backend
3075 # @id: the chardev's ID, must be unique
3076 # @backend: backend type and parameters
3078 # Returns: ChardevReturn.
3082 { 'command': 'chardev-add', 'data': {'id' : 'str',
3083 'backend' : 'ChardevBackend' },
3084 'returns': 'ChardevReturn' }
3089 # Remove a character device backend
3091 # @id: the chardev's ID, must exist and not be in use
3093 # Returns: Nothing on success
3097 { 'command': 'chardev-remove', 'data': {'id': 'str'} }
3102 # An enumeration of TPM models
3104 # @tpm-tis: TPM TIS model
3108 { 'enum': 'TpmModel', 'data': [ 'tpm-tis' ] }
3111 # @query-tpm-models:
3113 # Return a list of supported TPM models
3115 # Returns: a list of TpmModel
3119 { 'command': 'query-tpm-models', 'returns': ['TpmModel'] }
3124 # An enumeration of TPM types
3126 # @passthrough: TPM passthrough type
3130 { 'enum': 'TpmType', 'data': [ 'passthrough' ] }
3135 # Return a list of supported TPM types
3137 # Returns: a list of TpmType
3141 { 'command': 'query-tpm-types', 'returns': ['TpmType'] }
3144 # @TPMPassthroughOptions:
3146 # Information about the TPM passthrough type
3148 # @path: #optional string describing the path used for accessing the TPM device
3150 # @cancel-path: #optional string showing the TPM's sysfs cancel file
3151 # for cancellation of TPM commands while they are executing
3155 { 'struct': 'TPMPassthroughOptions', 'data': { '*path' : 'str',
3156 '*cancel-path' : 'str'} }
3161 # A union referencing different TPM backend types' configuration options
3163 # @passthrough: The configuration options for the TPM passthrough type
3167 { 'union': 'TpmTypeOptions',
3168 'data': { 'passthrough' : 'TPMPassthroughOptions' } }
3173 # Information about the TPM
3175 # @id: The Id of the TPM
3177 # @model: The TPM frontend model
3179 # @options: The TPM (backend) type configuration options
3183 { 'struct': 'TPMInfo',
3184 'data': {'id': 'str',
3185 'model': 'TpmModel',
3186 'options': 'TpmTypeOptions' } }
3191 # Return information about the TPM device
3193 # Returns: @TPMInfo on success
3197 { 'command': 'query-tpm', 'returns': ['TPMInfo'] }
3202 # Specify an ACPI table on the command line to load.
3204 # At most one of @file and @data can be specified. The list of files specified
3205 # by any one of them is loaded and concatenated in order. If both are omitted,
3208 # Other fields / optargs can be used to override fields of the generic ACPI
3209 # table header; refer to the ACPI specification 5.0, section 5.2.6 System
3210 # Description Table Header. If a header field is not overridden, then the
3211 # corresponding value from the concatenated blob is used (in case of @file), or
3212 # it is filled in with a hard-coded value (in case of @data).
3214 # String fields are copied into the matching ACPI member from lowest address
3215 # upwards, and silently truncated / NUL-padded to length.
3217 # @sig: #optional table signature / identifier (4 bytes)
3219 # @rev: #optional table revision number (dependent on signature, 1 byte)
3221 # @oem_id: #optional OEM identifier (6 bytes)
3223 # @oem_table_id: #optional OEM table identifier (8 bytes)
3225 # @oem_rev: #optional OEM-supplied revision number (4 bytes)
3227 # @asl_compiler_id: #optional identifier of the utility that created the table
3230 # @asl_compiler_rev: #optional revision number of the utility that created the
3233 # @file: #optional colon (:) separated list of pathnames to load and
3234 # concatenate as table data. The resultant binary blob is expected to
3235 # have an ACPI table header. At least one file is required. This field
3238 # @data: #optional colon (:) separated list of pathnames to load and
3239 # concatenate as table data. The resultant binary blob must not have an
3240 # ACPI table header. At least one file is required. This field excludes
3245 { 'struct': 'AcpiTableOptions',
3250 '*oem_table_id': 'str',
3251 '*oem_rev': 'uint32',
3252 '*asl_compiler_id': 'str',
3253 '*asl_compiler_rev': 'uint32',
3258 # @CommandLineParameterType:
3260 # Possible types for an option parameter.
3262 # @string: accepts a character string
3264 # @boolean: accepts "on" or "off"
3266 # @number: accepts a number
3268 # @size: accepts a number followed by an optional suffix (K)ilo,
3269 # (M)ega, (G)iga, (T)era
3273 { 'enum': 'CommandLineParameterType',
3274 'data': ['string', 'boolean', 'number', 'size'] }
3277 # @CommandLineParameterInfo:
3279 # Details about a single parameter of a command line option.
3281 # @name: parameter name
3283 # @type: parameter @CommandLineParameterType
3285 # @help: #optional human readable text string, not suitable for parsing.
3287 # @default: #optional default value string (since 2.1)
3291 { 'struct': 'CommandLineParameterInfo',
3292 'data': { 'name': 'str',
3293 'type': 'CommandLineParameterType',
3295 '*default': 'str' } }
3298 # @CommandLineOptionInfo:
3300 # Details about a command line option, including its list of parameter details
3302 # @option: option name
3304 # @parameters: an array of @CommandLineParameterInfo
3308 { 'struct': 'CommandLineOptionInfo',
3309 'data': { 'option': 'str', 'parameters': ['CommandLineParameterInfo'] } }
3312 # @query-command-line-options:
3314 # Query command line option schema.
3316 # @option: #optional option name
3318 # Returns: list of @CommandLineOptionInfo for all options (or for the given
3319 # @option). Returns an error if the given @option doesn't exist.
3323 {'command': 'query-command-line-options', 'data': { '*option': 'str' },
3324 'returns': ['CommandLineOptionInfo'] }
3329 # A X86 32-bit register
3333 { 'enum': 'X86CPURegister32',
3334 'data': [ 'EAX', 'EBX', 'ECX', 'EDX', 'ESP', 'EBP', 'ESI', 'EDI' ] }
3337 # @X86CPUFeatureWordInfo
3339 # Information about a X86 CPU feature word
3341 # @cpuid-input-eax: Input EAX value for CPUID instruction for that feature word
3343 # @cpuid-input-ecx: #optional Input ECX value for CPUID instruction for that
3346 # @cpuid-register: Output register containing the feature bits
3348 # @features: value of output register, containing the feature bits
3352 { 'struct': 'X86CPUFeatureWordInfo',
3353 'data': { 'cpuid-input-eax': 'int',
3354 '*cpuid-input-ecx': 'int',
3355 'cpuid-register': 'X86CPURegister32',
3356 'features': 'int' } }
3361 # Packets receiving state
3363 # @normal: filter assigned packets according to the mac-table
3365 # @none: don't receive any assigned packet
3367 # @all: receive all assigned packets
3371 { 'enum': 'RxState', 'data': [ 'normal', 'none', 'all' ] }
3376 # Rx-filter information for a NIC.
3378 # @name: net client name
3380 # @promiscuous: whether promiscuous mode is enabled
3382 # @multicast: multicast receive state
3384 # @unicast: unicast receive state
3386 # @vlan: vlan receive state (Since 2.0)
3388 # @broadcast-allowed: whether to receive broadcast
3390 # @multicast-overflow: multicast table is overflowed or not
3392 # @unicast-overflow: unicast table is overflowed or not
3394 # @main-mac: the main macaddr string
3396 # @vlan-table: a list of active vlan id
3398 # @unicast-table: a list of unicast macaddr string
3400 # @multicast-table: a list of multicast macaddr string
3405 { 'struct': 'RxFilterInfo',
3408 'promiscuous': 'bool',
3409 'multicast': 'RxState',
3410 'unicast': 'RxState',
3412 'broadcast-allowed': 'bool',
3413 'multicast-overflow': 'bool',
3414 'unicast-overflow': 'bool',
3416 'vlan-table': ['int'],
3417 'unicast-table': ['str'],
3418 'multicast-table': ['str'] }}
3423 # Return rx-filter information for all NICs (or for the given NIC).
3425 # @name: #optional net client name
3427 # Returns: list of @RxFilterInfo for all NICs (or for the given NIC).
3428 # Returns an error if the given @name doesn't exist, or given
3429 # NIC doesn't support rx-filter querying, or given net client
3434 { 'command': 'query-rx-filter', 'data': { '*name': 'str' },
3435 'returns': ['RxFilterInfo'] }
3440 # Button of a pointer input device (mouse, tablet).
3444 { 'enum' : 'InputButton',
3445 'data' : [ 'Left', 'Middle', 'Right', 'WheelUp', 'WheelDown' ] }
3450 # Position axis of a pointer input device (mouse, tablet).
3454 { 'enum' : 'InputAxis',
3455 'data' : [ 'X', 'Y' ] }
3460 # Keyboard input event.
3462 # @key: Which key this event is for.
3463 # @down: True for key-down and false for key-up events.
3467 { 'struct' : 'InputKeyEvent',
3468 'data' : { 'key' : 'KeyValue',
3474 # Pointer button input event.
3476 # @button: Which button this event is for.
3477 # @down: True for key-down and false for key-up events.
3481 { 'struct' : 'InputBtnEvent',
3482 'data' : { 'button' : 'InputButton',
3488 # Pointer motion input event.
3490 # @axis: Which axis is referenced by @value.
3491 # @value: Pointer position. For absolute coordinates the
3492 # valid range is 0 -> 0x7ffff
3496 { 'struct' : 'InputMoveEvent',
3497 'data' : { 'axis' : 'InputAxis',
3503 # Input event union.
3505 # @key: Input event of Keyboard
3506 # @btn: Input event of pointer buttons
3507 # @rel: Input event of relative pointer motion
3508 # @abs: Input event of absolute pointer motion
3512 { 'union' : 'InputEvent',
3513 'data' : { 'key' : 'InputKeyEvent',
3514 'btn' : 'InputBtnEvent',
3515 'rel' : 'InputMoveEvent',
3516 'abs' : 'InputMoveEvent' } }
3519 # @x-input-send-event
3521 # Send input event(s) to guest.
3523 # @console: #optional console to send event(s) to.
3524 # This parameter can be used to send the input event to
3525 # specific input devices in case (a) multiple input devices
3526 # of the same kind are added to the virtual machine and (b)
3527 # you have configured input routing (see docs/multiseat.txt)
3528 # for those input devices. If input routing is not
3529 # configured this parameter has no effect.
3530 # If @console is missing, only devices that aren't associated
3531 # with a console are admissible.
3532 # If @console is specified, it must exist, and both devices
3533 # associated with that console and devices not associated with a
3534 # console are admissible, but the former take precedence.
3537 # @events: List of InputEvent union.
3539 # Returns: Nothing on success.
3543 # Note: this command is experimental, and not a stable API.
3546 { 'command': 'x-input-send-event',
3547 'data': { '*console':'int', 'events': [ 'InputEvent' ] } }
3552 # A discriminated record of NUMA options. (for OptsVisitor)
3556 { 'union': 'NumaOptions',
3558 'node': 'NumaNodeOptions' }}
3563 # Create a guest NUMA node. (for OptsVisitor)
3565 # @nodeid: #optional NUMA node ID (increase by 1 from 0 if omitted)
3567 # @cpus: #optional VCPUs belonging to this node (assign VCPUS round-robin
3570 # @mem: #optional memory size of this node; mutually exclusive with @memdev.
3571 # Equally divide total memory among nodes if both @mem and @memdev are
3574 # @memdev: #optional memory backend object. If specified for one node,
3575 # it must be specified for all nodes.
3579 { 'struct': 'NumaNodeOptions',
3581 '*nodeid': 'uint16',
3582 '*cpus': ['uint16'],
3589 # Host memory policy types
3591 # @default: restore default policy, remove any nondefault policy
3593 # @preferred: set the preferred host nodes for allocation
3595 # @bind: a strict policy that restricts memory allocation to the
3596 # host nodes specified
3598 # @interleave: memory allocations are interleaved across the set
3599 # of host nodes specified
3603 { 'enum': 'HostMemPolicy',
3604 'data': [ 'default', 'preferred', 'bind', 'interleave' ] }
3609 # Information about memory backend
3611 # @size: memory backend size
3613 # @merge: enables or disables memory merge support
3615 # @dump: includes memory backend's memory in a core dump or not
3617 # @prealloc: enables or disables memory preallocation
3619 # @host-nodes: host nodes for its memory policy
3621 # @policy: memory policy of memory backend
3626 { 'struct': 'Memdev',
3632 'host-nodes': ['uint16'],
3633 'policy': 'HostMemPolicy' }}
3638 # Returns information for all memory backends.
3640 # Returns: a list of @Memdev.
3644 { 'command': 'query-memdev', 'returns': ['Memdev'] }
3647 # @PCDIMMDeviceInfo:
3649 # PCDIMMDevice state information
3651 # @id: #optional device's ID
3653 # @addr: physical address, where device is mapped
3655 # @size: size of memory that the device provides
3657 # @slot: slot number at which device is plugged in
3659 # @node: NUMA node number where device is plugged in
3661 # @memdev: memory backend linked with device
3663 # @hotplugged: true if device was hotplugged
3665 # @hotpluggable: true if device if could be added/removed while machine is running
3669 { 'struct': 'PCDIMMDeviceInfo',
3670 'data': { '*id': 'str',
3676 'hotplugged': 'bool',
3677 'hotpluggable': 'bool'
3682 # @MemoryDeviceInfo:
3684 # Union containing information about a memory device
3688 { 'union': 'MemoryDeviceInfo', 'data': {'dimm': 'PCDIMMDeviceInfo'} }
3691 # @query-memory-devices
3693 # Lists available memory devices and their state
3697 { 'command': 'query-memory-devices', 'returns': ['MemoryDeviceInfo'] }
3701 # @DIMM: memory slot
3703 { 'enum': 'ACPISlotType', 'data': [ 'DIMM' ] }
3707 # OSPM Status Indication for a device
3708 # For description of possible values of @source and @status fields
3709 # see "_OST (OSPM Status Indication)" chapter of ACPI5.0 spec.
3711 # @device: #optional device ID associated with slot
3713 # @slot: slot ID, unique per slot of a given @slot-type
3715 # @slot-type: type of the slot
3717 # @source: an integer containing the source event
3719 # @status: an integer containing the status code
3723 { 'struct': 'ACPIOSTInfo',
3724 'data' : { '*device': 'str',
3726 'slot-type': 'ACPISlotType',
3731 # @query-acpi-ospm-status
3733 # Lists ACPI OSPM status of ACPI device objects,
3734 # which might be reported via _OST method
3738 { 'command': 'query-acpi-ospm-status', 'returns': ['ACPIOSTInfo'] }
3741 # @WatchdogExpirationAction
3743 # An enumeration of the actions taken when the watchdog device's timer is
3746 # @reset: system resets
3748 # @shutdown: system shutdown, note that it is similar to @powerdown, which
3749 # tries to set to system status and notify guest
3751 # @poweroff: system poweroff, the emulator program exits
3753 # @pause: system pauses, similar to @stop
3755 # @debug: system enters debug state
3757 # @none: nothing is done
3759 # @inject-nmi: a non-maskable interrupt is injected into the first VCPU (all
3760 # VCPUS on x86) (since 2.4)
3764 { 'enum': 'WatchdogExpirationAction',
3765 'data': [ 'reset', 'shutdown', 'poweroff', 'pause', 'debug', 'none',
3771 # An enumeration of the I/O operation types
3773 # @read: read operation
3775 # @write: write operation
3779 { 'enum': 'IoOperationType',
3780 'data': [ 'read', 'write' ] }
3785 # An enumeration of the actions taken when guest OS panic is detected
3787 # @pause: system pauses
3791 { 'enum': 'GuestPanicAction',
3792 'data': [ 'pause' ] }
3795 # @rtc-reset-reinjection
3797 # This command will reset the RTC interrupt reinjection backlog.
3798 # Can be used if another mechanism to synchronize guest time
3799 # is in effect, for example QEMU guest agent's guest-set-time
3804 { 'command': 'rtc-reset-reinjection' }
3806 # Rocker ethernet network switch
3807 { 'include': 'qapi/rocker.json' }