5 # QAPI common definitions
6 { 'include': 'qapi/common.json' }
8 # QAPI crypto definitions
9 { 'include': 'qapi/crypto.json' }
11 # QAPI block definitions
12 { 'include': 'qapi/block.json' }
14 # QAPI event definitions
15 { 'include': 'qapi/event.json' }
18 { 'include': 'qapi/trace.json' }
23 # Policy for handling lost ticks in timer devices.
25 # @discard: throw away the missed tick(s) and continue with future injection
26 # normally. Guest time may be delayed, unless the OS has explicit
27 # handling of lost ticks
29 # @delay: continue to deliver ticks at the normal rate. Guest time will be
30 # delayed due to the late tick
32 # @merge: merge the missed tick(s) into one tick and inject. Guest time
33 # may be delayed, depending on how the OS reacts to the merging
36 # @slew: deliver ticks at a higher rate to catch up with the missed tick. The
37 # guest time should not be delayed once catchup is complete.
41 { 'enum': 'LostTickPolicy',
42 'data': ['discard', 'delay', 'merge', 'slew' ] }
46 # Allow client connections for VNC, Spice and socket based
47 # character devices to be passed in to QEMU via SCM_RIGHTS.
49 # @protocol: protocol name. Valid names are "vnc", "spice" or the
50 # name of a character device (eg. from -chardev id=XXXX)
52 # @fdname: file descriptor name previously passed via 'getfd' command
54 # @skipauth: #optional whether to skip authentication. Only applies
55 # to "vnc" and "spice" protocols
57 # @tls: #optional whether to perform TLS. Only applies to the "spice"
60 # Returns: nothing on success.
64 { 'command': 'add_client',
65 'data': { 'protocol': 'str', 'fdname': 'str', '*skipauth': 'bool',
71 # Guest name information.
73 # @name: #optional The name of the guest
77 { 'struct': 'NameInfo', 'data': {'*name': 'str'} }
82 # Return the name information of a guest.
84 # Returns: @NameInfo of the guest
88 { 'command': 'query-name', 'returns': 'NameInfo' }
93 # Information about support for KVM acceleration
95 # @enabled: true if KVM acceleration is active
97 # @present: true if KVM acceleration is built into this executable
101 { 'struct': 'KvmInfo', 'data': {'enabled': 'bool', 'present': 'bool'} }
106 # Returns information about KVM acceleration
112 { 'command': 'query-kvm', 'returns': 'KvmInfo' }
117 # An enumeration of VM run states.
119 # @debug: QEMU is running on a debugger
121 # @finish-migrate: guest is paused to finish the migration process
123 # @inmigrate: guest is paused waiting for an incoming migration. Note
124 # that this state does not tell whether the machine will start at the
125 # end of the migration. This depends on the command-line -S option and
126 # any invocation of 'stop' or 'cont' that has happened since QEMU was
129 # @internal-error: An internal error that prevents further guest execution
132 # @io-error: the last IOP has failed and the device is configured to pause
135 # @paused: guest has been paused via the 'stop' command
137 # @postmigrate: guest is paused following a successful 'migrate'
139 # @prelaunch: QEMU was started with -S and guest has not started
141 # @restore-vm: guest is paused to restore VM state
143 # @running: guest is actively running
145 # @save-vm: guest is paused to save the VM state
147 # @shutdown: guest is shut down (and -no-shutdown is in use)
149 # @suspended: guest is suspended (ACPI S3)
151 # @watchdog: the watchdog action is configured to pause and has been triggered
153 # @guest-panicked: guest has been panicked as a result of guest OS panic
155 { 'enum': 'RunState',
156 'data': [ 'debug', 'inmigrate', 'internal-error', 'io-error', 'paused',
157 'postmigrate', 'prelaunch', 'finish-migrate', 'restore-vm',
158 'running', 'save-vm', 'shutdown', 'suspended', 'watchdog',
164 # Information about VCPU run state
166 # @running: true if all VCPUs are runnable, false if not runnable
168 # @singlestep: true if VCPUs are in single-step mode
170 # @status: the virtual machine @RunState
174 # Notes: @singlestep is enabled through the GDB stub
176 { 'struct': 'StatusInfo',
177 'data': {'running': 'bool', 'singlestep': 'bool', 'status': 'RunState'} }
182 # Query the run status of all VCPUs
184 # Returns: @StatusInfo reflecting all VCPUs
188 { 'command': 'query-status', 'returns': 'StatusInfo' }
193 # Guest UUID information.
195 # @UUID: the UUID of the guest
199 # Notes: If no UUID was specified for the guest, a null UUID is returned.
201 { 'struct': 'UuidInfo', 'data': {'UUID': 'str'} }
206 # Query the guest UUID information.
208 # Returns: The @UuidInfo for the guest
212 { 'command': 'query-uuid', 'returns': 'UuidInfo' }
217 # Information about a character device.
219 # @label: the label of the character device
221 # @filename: the filename of the character device
223 # @frontend-open: shows whether the frontend device attached to this backend
224 # (eg. with the chardev=... option) is in open or closed state
227 # Notes: @filename is encoded using the QEMU command line character device
228 # encoding. See the QEMU man page for details.
232 { 'struct': 'ChardevInfo', 'data': {'label': 'str',
234 'frontend-open': 'bool'} }
239 # Returns information about current character devices.
241 # Returns: a list of @ChardevInfo
245 { 'command': 'query-chardev', 'returns': ['ChardevInfo'] }
248 # @ChardevBackendInfo:
250 # Information about a character device backend
252 # @name: The backend name
256 { 'struct': 'ChardevBackendInfo', 'data': {'name': 'str'} }
259 # @query-chardev-backends:
261 # Returns information about character device backends.
263 # Returns: a list of @ChardevBackendInfo
267 { 'command': 'query-chardev-backends', 'returns': ['ChardevBackendInfo'] }
272 # An enumeration of data format.
274 # @utf8: Data is a UTF-8 string (RFC 3629)
276 # @base64: Data is Base64 encoded binary (RFC 3548)
280 { 'enum': 'DataFormat',
281 'data': [ 'utf8', 'base64' ] }
286 # Write to a ring buffer character device.
288 # @device: the ring buffer character device name
290 # @data: data to write
292 # @format: #optional data encoding (default 'utf8').
293 # - base64: data must be base64 encoded text. Its binary
294 # decoding gets written.
295 # Bug: invalid base64 is currently not rejected.
296 # Whitespace *is* invalid.
297 # - utf8: data's UTF-8 encoding is written
298 # - data itself is always Unicode regardless of format, like
301 # Returns: Nothing on success
305 { 'command': 'ringbuf-write',
306 'data': {'device': 'str', 'data': 'str',
307 '*format': 'DataFormat'} }
312 # Read from a ring buffer character device.
314 # @device: the ring buffer character device name
316 # @size: how many bytes to read at most
318 # @format: #optional data encoding (default 'utf8').
319 # - base64: the data read is returned in base64 encoding.
320 # - utf8: the data read is interpreted as UTF-8.
321 # Bug: can screw up when the buffer contains invalid UTF-8
322 # sequences, NUL characters, after the ring buffer lost
323 # data, and when reading stops because the size limit is
325 # - The return value is always Unicode regardless of format,
326 # like any other string.
328 # Returns: data read from the device
332 { 'command': 'ringbuf-read',
333 'data': {'device': 'str', 'size': 'int', '*format': 'DataFormat'},
339 # Information about a QMP event
341 # @name: The event name
345 { 'struct': 'EventInfo', 'data': {'name': 'str'} }
350 # Return a list of supported QMP events by this server
352 # Returns: A list of @EventInfo for all supported events
356 { 'command': 'query-events', 'returns': ['EventInfo'] }
361 # Detailed migration status.
363 # @transferred: amount of bytes already transferred to the target VM
365 # @remaining: amount of bytes remaining to be transferred to the target VM
367 # @total: total amount of bytes involved in the migration process
369 # @duplicate: number of duplicate (zero) pages (since 1.2)
371 # @skipped: number of skipped zero pages (since 1.5)
373 # @normal : number of normal pages (since 1.2)
375 # @normal-bytes: number of normal bytes sent (since 1.2)
377 # @dirty-pages-rate: number of pages dirtied by second by the
380 # @mbps: throughput in megabits/sec. (since 1.6)
382 # @dirty-sync-count: number of times that dirty ram was synchronized (since 2.1)
386 { 'struct': 'MigrationStats',
387 'data': {'transferred': 'int', 'remaining': 'int', 'total': 'int' ,
388 'duplicate': 'int', 'skipped': 'int', 'normal': 'int',
389 'normal-bytes': 'int', 'dirty-pages-rate' : 'int',
390 'mbps' : 'number', 'dirty-sync-count' : 'int' } }
395 # Detailed XBZRLE migration cache statistics
397 # @cache-size: XBZRLE cache size
399 # @bytes: amount of bytes already transferred to the target VM
401 # @pages: amount of pages transferred to the target VM
403 # @cache-miss: number of cache miss
405 # @cache-miss-rate: rate of cache miss (since 2.1)
407 # @overflow: number of overflows
411 { 'struct': 'XBZRLECacheStats',
412 'data': {'cache-size': 'int', 'bytes': 'int', 'pages': 'int',
413 'cache-miss': 'int', 'cache-miss-rate': 'number',
414 'overflow': 'int' } }
418 # An enumeration of migration status.
420 # @none: no migration has ever happened.
422 # @setup: migration process has been initiated.
424 # @cancelling: in the process of cancelling migration.
426 # @cancelled: cancelling migration is finished.
428 # @active: in the process of doing migration.
430 # @completed: migration is finished.
432 # @failed: some error occurred during migration process.
437 { 'enum': 'MigrationStatus',
438 'data': [ 'none', 'setup', 'cancelling', 'cancelled',
439 'active', 'completed', 'failed' ] }
444 # Information about current migration process.
446 # @status: #optional @MigrationStatus describing the current migration status.
447 # If this field is not returned, no migration process
450 # @ram: #optional @MigrationStats containing detailed migration
451 # status, only returned if status is 'active' or
452 # 'completed'(since 1.2)
454 # @disk: #optional @MigrationStats containing detailed disk migration
455 # status, only returned if status is 'active' and it is a block
458 # @xbzrle-cache: #optional @XBZRLECacheStats containing detailed XBZRLE
459 # migration statistics, only returned if XBZRLE feature is on and
460 # status is 'active' or 'completed' (since 1.2)
462 # @total-time: #optional total amount of milliseconds since migration started.
463 # If migration has ended, it returns the total migration
466 # @downtime: #optional only present when migration finishes correctly
467 # total downtime in milliseconds for the guest.
470 # @expected-downtime: #optional only present while migration is active
471 # expected downtime in milliseconds for the guest in last walk
472 # of the dirty bitmap. (since 1.3)
474 # @setup-time: #optional amount of setup time in milliseconds _before_ the
475 # iterations begin but _after_ the QMP command is issued. This is designed
476 # to provide an accounting of any activities (such as RDMA pinning) which
477 # may be expensive, but do not actually occur during the iterative
478 # migration rounds themselves. (since 1.6)
482 { 'struct': 'MigrationInfo',
483 'data': {'*status': 'MigrationStatus', '*ram': 'MigrationStats',
484 '*disk': 'MigrationStats',
485 '*xbzrle-cache': 'XBZRLECacheStats',
486 '*total-time': 'int',
487 '*expected-downtime': 'int',
489 '*setup-time': 'int'} }
494 # Returns information about current migration process.
496 # Returns: @MigrationInfo
500 { 'command': 'query-migrate', 'returns': 'MigrationInfo' }
503 # @MigrationCapability
505 # Migration capabilities enumeration
507 # @xbzrle: Migration supports xbzrle (Xor Based Zero Run Length Encoding).
508 # This feature allows us to minimize migration traffic for certain work
509 # loads, by sending compressed difference of the pages
511 # @rdma-pin-all: Controls whether or not the entire VM memory footprint is
512 # mlock()'d on demand or all at once. Refer to docs/rdma.txt for usage.
513 # Disabled by default. (since 2.0)
515 # @zero-blocks: During storage migration encode blocks of zeroes efficiently. This
516 # essentially saves 1MB of zeroes per block on the wire. Enabling requires
517 # source and target VM to support this feature. To enable it is sufficient
518 # to enable the capability on the source VM. The feature is disabled by
519 # default. (since 1.6)
521 # @compress: Use multiple compression threads to accelerate live migration.
522 # This feature can help to reduce the migration traffic, by sending
523 # compressed pages. Please note that if compress and xbzrle are both
524 # on, compress only takes effect in the ram bulk stage, after that,
525 # it will be disabled and only xbzrle takes effect, this can help to
526 # minimize migration traffic. The feature is disabled by default.
529 # @events: generate events for each migration state change
532 # @auto-converge: If enabled, QEMU will automatically throttle down the guest
533 # to speed up convergence of RAM migration. (since 1.6)
537 { 'enum': 'MigrationCapability',
538 'data': ['xbzrle', 'rdma-pin-all', 'auto-converge', 'zero-blocks',
539 'compress', 'events'] }
542 # @MigrationCapabilityStatus
544 # Migration capability information
546 # @capability: capability enum
548 # @state: capability state bool
552 { 'struct': 'MigrationCapabilityStatus',
553 'data': { 'capability' : 'MigrationCapability', 'state' : 'bool' } }
556 # @migrate-set-capabilities
558 # Enable/Disable the following migration capabilities (like xbzrle)
560 # @capabilities: json array of capability modifications to make
564 { 'command': 'migrate-set-capabilities',
565 'data': { 'capabilities': ['MigrationCapabilityStatus'] } }
568 # @query-migrate-capabilities
570 # Returns information about the current migration capabilities status
572 # Returns: @MigrationCapabilitiesStatus
576 { 'command': 'query-migrate-capabilities', 'returns': ['MigrationCapabilityStatus']}
578 # @MigrationParameter
580 # Migration parameters enumeration
582 # @compress-level: Set the compression level to be used in live migration,
583 # the compression level is an integer between 0 and 9, where 0 means
584 # no compression, 1 means the best compression speed, and 9 means best
585 # compression ratio which will consume more CPU.
587 # @compress-threads: Set compression thread count to be used in live migration,
588 # the compression thread count is an integer between 1 and 255.
590 # @decompress-threads: Set decompression thread count to be used in live
591 # migration, the decompression thread count is an integer between 1
592 # and 255. Usually, decompression is at least 4 times as fast as
593 # compression, so set the decompress-threads to the number about 1/4
594 # of compress-threads is adequate.
598 { 'enum': 'MigrationParameter',
599 'data': ['compress-level', 'compress-threads', 'decompress-threads'] }
602 # @migrate-set-parameters
604 # Set the following migration parameters
606 # @compress-level: compression level
608 # @compress-threads: compression thread count
610 # @decompress-threads: decompression thread count
614 { 'command': 'migrate-set-parameters',
615 'data': { '*compress-level': 'int',
616 '*compress-threads': 'int',
617 '*decompress-threads': 'int'} }
620 # @MigrationParameters
622 # @compress-level: compression level
624 # @compress-threads: compression thread count
626 # @decompress-threads: decompression thread count
630 { 'struct': 'MigrationParameters',
631 'data': { 'compress-level': 'int',
632 'compress-threads': 'int',
633 'decompress-threads': 'int'} }
635 # @query-migrate-parameters
637 # Returns information about the current migration parameters
639 # Returns: @MigrationParameters
643 { 'command': 'query-migrate-parameters',
644 'returns': 'MigrationParameters' }
647 # @client_migrate_info
649 # Set migration information for remote display. This makes the server
650 # ask the client to automatically reconnect using the new parameters
651 # once migration finished successfully. Only implemented for SPICE.
653 # @protocol: must be "spice"
654 # @hostname: migration target hostname
655 # @port: #optional spice tcp port for plaintext channels
656 # @tls-port: #optional spice tcp port for tls-secured channels
657 # @cert-subject: #optional server certificate subject
661 { 'command': 'client_migrate_info',
662 'data': { 'protocol': 'str', 'hostname': 'str', '*port': 'int',
663 '*tls-port': 'int', '*cert-subject': 'str' } }
668 # Information about a mouse device.
670 # @name: the name of the mouse device
672 # @index: the index of the mouse device
674 # @current: true if this device is currently receiving mouse events
676 # @absolute: true if this device supports absolute coordinates as input
680 { 'struct': 'MouseInfo',
681 'data': {'name': 'str', 'index': 'int', 'current': 'bool',
682 'absolute': 'bool'} }
687 # Returns information about each active mouse device
689 # Returns: a list of @MouseInfo for each device
693 { 'command': 'query-mice', 'returns': ['MouseInfo'] }
698 # Information about a virtual CPU
700 # @CPU: the index of the virtual CPU
702 # @current: this only exists for backwards compatible and should be ignored
704 # @halted: true if the virtual CPU is in the halt state. Halt usually refers
705 # to a processor specific low power mode.
707 # @qom_path: path to the CPU object in the QOM tree (since 2.4)
709 # @pc: #optional If the target is i386 or x86_64, this is the 64-bit instruction
711 # If the target is Sparc, this is the PC component of the
712 # instruction pointer.
714 # @nip: #optional If the target is PPC, the instruction pointer
716 # @npc: #optional If the target is Sparc, the NPC component of the instruction
719 # @PC: #optional If the target is MIPS, the instruction pointer
721 # @thread_id: ID of the underlying host thread
725 # Notes: @halted is a transient state that changes frequently. By the time the
726 # data is sent to the client, the guest may no longer be halted.
728 { 'struct': 'CpuInfo',
729 'data': {'CPU': 'int', 'current': 'bool', 'halted': 'bool',
731 '*pc': 'int', '*nip': 'int', '*npc': 'int', '*PC': 'int',
732 'thread_id': 'int'} }
737 # Returns a list of information about each virtual CPU.
739 # Returns: a list of @CpuInfo for each virtual CPU
743 { 'command': 'query-cpus', 'returns': ['CpuInfo'] }
748 # Information about an iothread
750 # @id: the identifier of the iothread
752 # @thread-id: ID of the underlying host thread
756 { 'struct': 'IOThreadInfo',
757 'data': {'id': 'str', 'thread-id': 'int'} }
762 # Returns a list of information about each iothread.
764 # Note this list excludes the QEMU main loop thread, which is not declared
765 # using the -object iothread command-line option. It is always the main thread
768 # Returns: a list of @IOThreadInfo for each iothread
772 { 'command': 'query-iothreads', 'returns': ['IOThreadInfo'] }
775 # @NetworkAddressFamily
777 # The network address family
785 # @unknown: otherwise
789 { 'enum': 'NetworkAddressFamily',
790 'data': [ 'ipv4', 'ipv6', 'unix', 'unknown' ] }
795 # The basic information for vnc network connection
799 # @service: The service name of the vnc port. This may depend on the host
800 # system's service database so symbolic names should not be relied
803 # @family: address family
805 # @websocket: true in case the socket is a websocket (since 2.3).
809 { 'struct': 'VncBasicInfo',
810 'data': { 'host': 'str',
812 'family': 'NetworkAddressFamily',
813 'websocket': 'bool' } }
818 # The network connection information for server
820 # @auth: #optional, authentication method
824 { 'struct': 'VncServerInfo',
825 'base': 'VncBasicInfo',
826 'data': { '*auth': 'str' } }
831 # Information about a connected VNC client.
833 # @x509_dname: #optional If x509 authentication is in use, the Distinguished
834 # Name of the client.
836 # @sasl_username: #optional If SASL authentication is in use, the SASL username
837 # used for authentication.
841 { 'struct': 'VncClientInfo',
842 'base': 'VncBasicInfo',
843 'data': { '*x509_dname': 'str', '*sasl_username': 'str' } }
848 # Information about the VNC session.
850 # @enabled: true if the VNC server is enabled, false otherwise
852 # @host: #optional The hostname the VNC server is bound to. This depends on
853 # the name resolution on the host and may be an IP address.
855 # @family: #optional 'ipv6' if the host is listening for IPv6 connections
856 # 'ipv4' if the host is listening for IPv4 connections
857 # 'unix' if the host is listening on a unix domain socket
858 # 'unknown' otherwise
860 # @service: #optional The service name of the server's port. This may depends
861 # on the host system's service database so symbolic names should not
864 # @auth: #optional the current authentication type used by the server
865 # 'none' if no authentication is being used
866 # 'vnc' if VNC authentication is being used
867 # 'vencrypt+plain' if VEncrypt is used with plain text authentication
868 # 'vencrypt+tls+none' if VEncrypt is used with TLS and no authentication
869 # 'vencrypt+tls+vnc' if VEncrypt is used with TLS and VNC authentication
870 # 'vencrypt+tls+plain' if VEncrypt is used with TLS and plain text auth
871 # 'vencrypt+x509+none' if VEncrypt is used with x509 and no auth
872 # 'vencrypt+x509+vnc' if VEncrypt is used with x509 and VNC auth
873 # 'vencrypt+x509+plain' if VEncrypt is used with x509 and plain text auth
874 # 'vencrypt+tls+sasl' if VEncrypt is used with TLS and SASL auth
875 # 'vencrypt+x509+sasl' if VEncrypt is used with x509 and SASL auth
877 # @clients: a list of @VncClientInfo of all currently connected clients
881 { 'struct': 'VncInfo',
882 'data': {'enabled': 'bool', '*host': 'str',
883 '*family': 'NetworkAddressFamily',
884 '*service': 'str', '*auth': 'str', '*clients': ['VncClientInfo']} }
889 # vnc primary authentication method.
893 { 'enum': 'VncPrimaryAuth',
894 'data': [ 'none', 'vnc', 'ra2', 'ra2ne', 'tight', 'ultra',
895 'tls', 'vencrypt', 'sasl' ] }
898 # @VncVencryptSubAuth:
900 # vnc sub authentication method with vencrypt.
904 { 'enum': 'VncVencryptSubAuth',
906 'tls-none', 'x509-none',
907 'tls-vnc', 'x509-vnc',
908 'tls-plain', 'x509-plain',
909 'tls-sasl', 'x509-sasl' ] }
914 # Information about a vnc server
916 # @id: vnc server name.
918 # @server: A list of @VncBasincInfo describing all listening sockets.
919 # The list can be empty (in case the vnc server is disabled).
920 # It also may have multiple entries: normal + websocket,
921 # possibly also ipv4 + ipv6 in the future.
923 # @clients: A list of @VncClientInfo of all currently connected clients.
924 # The list can be empty, for obvious reasons.
926 # @auth: The current authentication type used by the server
928 # @vencrypt: #optional The vencrypt sub authentication type used by the server,
929 # only specified in case auth == vencrypt.
931 # @display: #optional The display device the vnc server is linked to.
935 { 'struct': 'VncInfo2',
936 'data': { 'id' : 'str',
937 'server' : ['VncBasicInfo'],
938 'clients' : ['VncClientInfo'],
939 'auth' : 'VncPrimaryAuth',
940 '*vencrypt' : 'VncVencryptSubAuth',
941 '*display' : 'str' } }
946 # Returns information about the current VNC server
952 { 'command': 'query-vnc', 'returns': 'VncInfo' }
955 # @query-vnc-servers:
957 # Returns a list of vnc servers. The list can be empty.
959 # Returns: a list of @VncInfo2
963 { 'command': 'query-vnc-servers', 'returns': ['VncInfo2'] }
968 # The basic information for SPICE network connection
974 # @family: address family
978 { 'struct': 'SpiceBasicInfo',
979 'data': { 'host': 'str',
981 'family': 'NetworkAddressFamily' } }
986 # Information about a SPICE server
988 # @auth: #optional, authentication method
992 { 'struct': 'SpiceServerInfo',
993 'base': 'SpiceBasicInfo',
994 'data': { '*auth': 'str' } }
999 # Information about a SPICE client channel.
1001 # @connection-id: SPICE connection id number. All channels with the same id
1002 # belong to the same SPICE session.
1004 # @channel-type: SPICE channel type number. "1" is the main control
1005 # channel, filter for this one if you want to track spice
1008 # @channel-id: SPICE channel ID number. Usually "0", might be different when
1009 # multiple channels of the same type exist, such as multiple
1010 # display channels in a multihead setup
1012 # @tls: true if the channel is encrypted, false otherwise.
1016 { 'struct': 'SpiceChannel',
1017 'base': 'SpiceBasicInfo',
1018 'data': {'connection-id': 'int', 'channel-type': 'int', 'channel-id': 'int',
1022 # @SpiceQueryMouseMode
1024 # An enumeration of Spice mouse states.
1026 # @client: Mouse cursor position is determined by the client.
1028 # @server: Mouse cursor position is determined by the server.
1030 # @unknown: No information is available about mouse mode used by
1033 # Note: spice/enums.h has a SpiceMouseMode already, hence the name.
1037 { 'enum': 'SpiceQueryMouseMode',
1038 'data': [ 'client', 'server', 'unknown' ] }
1043 # Information about the SPICE session.
1045 # @enabled: true if the SPICE server is enabled, false otherwise
1047 # @migrated: true if the last guest migration completed and spice
1048 # migration had completed as well. false otherwise.
1050 # @host: #optional The hostname the SPICE server is bound to. This depends on
1051 # the name resolution on the host and may be an IP address.
1053 # @port: #optional The SPICE server's port number.
1055 # @compiled-version: #optional SPICE server version.
1057 # @tls-port: #optional The SPICE server's TLS port number.
1059 # @auth: #optional the current authentication type used by the server
1060 # 'none' if no authentication is being used
1061 # 'spice' uses SASL or direct TLS authentication, depending on command
1064 # @mouse-mode: The mode in which the mouse cursor is displayed currently. Can
1065 # be determined by the client or the server, or unknown if spice
1066 # server doesn't provide this information.
1070 # @channels: a list of @SpiceChannel for each active spice channel
1074 { 'struct': 'SpiceInfo',
1075 'data': {'enabled': 'bool', 'migrated': 'bool', '*host': 'str', '*port': 'int',
1076 '*tls-port': 'int', '*auth': 'str', '*compiled-version': 'str',
1077 'mouse-mode': 'SpiceQueryMouseMode', '*channels': ['SpiceChannel']} }
1082 # Returns information about the current SPICE server
1084 # Returns: @SpiceInfo
1088 { 'command': 'query-spice', 'returns': 'SpiceInfo' }
1093 # Information about the guest balloon device.
1095 # @actual: the number of bytes the balloon currently contains
1100 { 'struct': 'BalloonInfo', 'data': {'actual': 'int' } }
1105 # Return information about the balloon device.
1107 # Returns: @BalloonInfo on success
1108 # If the balloon driver is enabled but not functional because the KVM
1109 # kernel module cannot support it, KvmMissingCap
1110 # If no balloon device is present, DeviceNotActive
1114 { 'command': 'query-balloon', 'returns': 'BalloonInfo' }
1119 # A PCI device memory region
1121 # @base: the starting address (guest physical)
1123 # @limit: the ending address (guest physical)
1127 { 'struct': 'PciMemoryRange', 'data': {'base': 'int', 'limit': 'int'} }
1132 # Information about a PCI device I/O region.
1134 # @bar: the index of the Base Address Register for this region
1136 # @type: 'io' if the region is a PIO region
1137 # 'memory' if the region is a MMIO region
1139 # @prefetch: #optional if @type is 'memory', true if the memory is prefetchable
1141 # @mem_type_64: #optional if @type is 'memory', true if the BAR is 64-bit
1145 { 'struct': 'PciMemoryRegion',
1146 'data': {'bar': 'int', 'type': 'str', 'address': 'int', 'size': 'int',
1147 '*prefetch': 'bool', '*mem_type_64': 'bool' } }
1152 # Information about a bus of a PCI Bridge device
1154 # @number: primary bus interface number. This should be the number of the
1155 # bus the device resides on.
1157 # @secondary: secondary bus interface number. This is the number of the
1158 # main bus for the bridge
1160 # @subordinate: This is the highest number bus that resides below the
1163 # @io_range: The PIO range for all devices on this bridge
1165 # @memory_range: The MMIO range for all devices on this bridge
1167 # @prefetchable_range: The range of prefetchable MMIO for all devices on
1172 { 'struct': 'PciBusInfo',
1173 'data': {'number': 'int', 'secondary': 'int', 'subordinate': 'int',
1174 'io_range': 'PciMemoryRange',
1175 'memory_range': 'PciMemoryRange',
1176 'prefetchable_range': 'PciMemoryRange' } }
1181 # Information about a PCI Bridge device
1183 # @bus: information about the bus the device resides on
1185 # @devices: a list of @PciDeviceInfo for each device on this bridge
1189 { 'struct': 'PciBridgeInfo',
1190 'data': {'bus': 'PciBusInfo', '*devices': ['PciDeviceInfo']} }
1195 # Information about the Class of a PCI device
1197 # @desc: #optional a string description of the device's class
1199 # @class: the class code of the device
1203 { 'struct': 'PciDeviceClass',
1204 'data': {'*desc': 'str', 'class': 'int'} }
1209 # Information about the Id of a PCI device
1211 # @device: the PCI device id
1213 # @vendor: the PCI vendor id
1217 { 'struct': 'PciDeviceId',
1218 'data': {'device': 'int', 'vendor': 'int'} }
1223 # Information about a PCI device
1225 # @bus: the bus number of the device
1227 # @slot: the slot the device is located in
1229 # @function: the function of the slot used by the device
1231 # @class_info: the class of the device
1233 # @id: the PCI device id
1235 # @irq: #optional if an IRQ is assigned to the device, the IRQ number
1237 # @qdev_id: the device name of the PCI device
1239 # @pci_bridge: if the device is a PCI bridge, the bridge information
1241 # @regions: a list of the PCI I/O regions associated with the device
1243 # Notes: the contents of @class_info.desc are not stable and should only be
1244 # treated as informational.
1248 { 'struct': 'PciDeviceInfo',
1249 'data': {'bus': 'int', 'slot': 'int', 'function': 'int',
1250 'class_info': 'PciDeviceClass', 'id': 'PciDeviceId',
1251 '*irq': 'int', 'qdev_id': 'str', '*pci_bridge': 'PciBridgeInfo',
1252 'regions': ['PciMemoryRegion']} }
1257 # Information about a PCI bus
1259 # @bus: the bus index
1261 # @devices: a list of devices on this bus
1265 { 'struct': 'PciInfo', 'data': {'bus': 'int', 'devices': ['PciDeviceInfo']} }
1270 # Return information about the PCI bus topology of the guest.
1272 # Returns: a list of @PciInfo for each PCI bus
1276 { 'command': 'query-pci', 'returns': ['PciInfo'] }
1281 # This command will cause the QEMU process to exit gracefully. While every
1282 # attempt is made to send the QMP response before terminating, this is not
1283 # guaranteed. When using this interface, a premature EOF would not be
1288 { 'command': 'quit' }
1293 # Stop all guest VCPU execution.
1297 # Notes: This function will succeed even if the guest is already in the stopped
1298 # state. In "inmigrate" state, it will ensure that the guest
1299 # remains paused once migration finishes, as if the -S option was
1300 # passed on the command line.
1302 { 'command': 'stop' }
1307 # Performs a hard reset of a guest.
1311 { 'command': 'system_reset' }
1314 # @system_powerdown:
1316 # Requests that a guest perform a powerdown operation.
1320 # Notes: A guest may or may not respond to this command. This command
1321 # returning does not indicate that a guest has accepted the request or
1322 # that it has shut down. Many guests will respond to this command by
1323 # prompting the user in some way.
1325 { 'command': 'system_powerdown' }
1330 # This command is a nop that is only provided for the purposes of compatibility.
1334 # Notes: Do not use this command.
1336 { 'command': 'cpu', 'data': {'index': 'int'} }
1341 # Adds CPU with specified ID
1343 # @id: ID of CPU to be created, valid values [0..max_cpus)
1345 # Returns: Nothing on success
1349 { 'command': 'cpu-add', 'data': {'id': 'int'} }
1354 # Save a portion of guest memory to a file.
1356 # @val: the virtual address of the guest to start from
1358 # @size: the size of memory region to save
1360 # @filename: the file to save the memory to as binary data
1362 # @cpu-index: #optional the index of the virtual CPU to use for translating the
1363 # virtual address (defaults to CPU 0)
1365 # Returns: Nothing on success
1369 # Notes: Errors were not reliably returned until 1.1
1371 { 'command': 'memsave',
1372 'data': {'val': 'int', 'size': 'int', 'filename': 'str', '*cpu-index': 'int'} }
1377 # Save a portion of guest physical memory to a file.
1379 # @val: the physical address of the guest to start from
1381 # @size: the size of memory region to save
1383 # @filename: the file to save the memory to as binary data
1385 # Returns: Nothing on success
1389 # Notes: Errors were not reliably returned until 1.1
1391 { 'command': 'pmemsave',
1392 'data': {'val': 'int', 'size': 'int', 'filename': 'str'} }
1397 # Resume guest VCPU execution.
1401 # Returns: If successful, nothing
1402 # If QEMU was started with an encrypted block device and a key has
1403 # not yet been set, DeviceEncrypted.
1405 # Notes: This command will succeed if the guest is currently running. It
1406 # will also succeed if the guest is in the "inmigrate" state; in
1407 # this case, the effect of the command is to make sure the guest
1408 # starts once migration finishes, removing the effect of the -S
1409 # command line option if it was passed.
1411 { 'command': 'cont' }
1416 # Wakeup guest from suspend. Does nothing in case the guest isn't suspended.
1422 { 'command': 'system_wakeup' }
1427 # Injects a Non-Maskable Interrupt into the default CPU (x86/s390) or all CPUs (ppc64).
1429 # Returns: If successful, nothing
1433 # Note: prior to 2.1, this command was only supported for x86 and s390 VMs
1435 { 'command': 'inject-nmi' }
1440 # Sets the link status of a virtual network adapter.
1442 # @name: the device name of the virtual network adapter
1444 # @up: true to set the link status to be up
1446 # Returns: Nothing on success
1447 # If @name is not a valid network device, DeviceNotFound
1451 # Notes: Not all network adapters support setting link status. This command
1452 # will succeed even if the network adapter does not support link status
1455 { 'command': 'set_link', 'data': {'name': 'str', 'up': 'bool'} }
1460 # Request the balloon driver to change its balloon size.
1462 # @value: the target size of the balloon in bytes
1464 # Returns: Nothing on success
1465 # If the balloon driver is enabled but not functional because the KVM
1466 # kernel module cannot support it, KvmMissingCap
1467 # If no balloon device is present, DeviceNotActive
1469 # Notes: This command just issues a request to the guest. When it returns,
1470 # the balloon size may not have changed. A guest can change the balloon
1471 # size independent of this command.
1475 { 'command': 'balloon', 'data': {'value': 'int'} }
1480 # This action can be used to test transaction failure.
1484 { 'struct': 'Abort',
1488 # @TransactionAction
1490 # A discriminated record of operations that can be performed with
1495 # drive-backup since 1.6
1497 # blockdev-snapshot-internal-sync since 1.7
1498 # blockdev-backup since 2.3
1500 { 'union': 'TransactionAction',
1502 'blockdev-snapshot-sync': 'BlockdevSnapshot',
1503 'drive-backup': 'DriveBackup',
1504 'blockdev-backup': 'BlockdevBackup',
1506 'blockdev-snapshot-internal-sync': 'BlockdevSnapshotInternal'
1512 # Executes a number of transactionable QMP commands atomically. If any
1513 # operation fails, then the entire set of actions will be abandoned and the
1514 # appropriate error returned.
1517 # @TransactionAction: information needed for the respective operation
1519 # Returns: nothing on success
1520 # Errors depend on the operations of the transaction
1522 # Note: The transaction aborts on the first failure. Therefore, there will be
1523 # information on only one failed operation returned in an error condition, and
1524 # subsequent actions will not have been attempted.
1528 { 'command': 'transaction',
1529 'data': { 'actions': [ 'TransactionAction' ] } }
1532 # @human-monitor-command:
1534 # Execute a command on the human monitor and return the output.
1536 # @command-line: the command to execute in the human monitor
1538 # @cpu-index: #optional The CPU to use for commands that require an implicit CPU
1540 # Returns: the output of the command as a string
1544 # Notes: This command only exists as a stop-gap. Its use is highly
1545 # discouraged. The semantics of this command are not guaranteed.
1547 # Known limitations:
1549 # o This command is stateless, this means that commands that depend
1550 # on state information (such as getfd) might not work
1552 # o Commands that prompt the user for data (eg. 'cont' when the block
1553 # device is encrypted) don't currently work
1555 { 'command': 'human-monitor-command',
1556 'data': {'command-line': 'str', '*cpu-index': 'int'},
1562 # Cancel the current executing migration process.
1564 # Returns: nothing on success
1566 # Notes: This command succeeds even if there is no migration process running.
1570 { 'command': 'migrate_cancel' }
1573 # @migrate_set_downtime
1575 # Set maximum tolerated downtime for migration.
1577 # @value: maximum downtime in seconds
1579 # Returns: nothing on success
1583 { 'command': 'migrate_set_downtime', 'data': {'value': 'number'} }
1586 # @migrate_set_speed
1588 # Set maximum speed for migration.
1590 # @value: maximum speed in bytes.
1592 # Returns: nothing on success
1594 # Notes: A value lesser than zero will be automatically round up to zero.
1598 { 'command': 'migrate_set_speed', 'data': {'value': 'int'} }
1601 # @migrate-set-cache-size
1603 # Set XBZRLE cache size
1605 # @value: cache size in bytes
1607 # The size will be rounded down to the nearest power of 2.
1608 # The cache size can be modified before and during ongoing migration
1610 # Returns: nothing on success
1614 { 'command': 'migrate-set-cache-size', 'data': {'value': 'int'} }
1617 # @query-migrate-cache-size
1619 # query XBZRLE cache size
1621 # Returns: XBZRLE cache size in bytes
1625 { 'command': 'query-migrate-cache-size', 'returns': 'int' }
1628 # @ObjectPropertyInfo:
1630 # @name: the name of the property
1632 # @type: the type of the property. This will typically come in one of four
1635 # 1) A primitive type such as 'u8', 'u16', 'bool', 'str', or 'double'.
1636 # These types are mapped to the appropriate JSON type.
1638 # 2) A child type in the form 'child<subtype>' where subtype is a qdev
1639 # device type name. Child properties create the composition tree.
1641 # 3) A link type in the form 'link<subtype>' where subtype is a qdev
1642 # device type name. Link properties form the device model graph.
1646 { 'struct': 'ObjectPropertyInfo',
1647 'data': { 'name': 'str', 'type': 'str' } }
1652 # This command will list any properties of a object given a path in the object
1655 # @path: the path within the object model. See @qom-get for a description of
1658 # Returns: a list of @ObjectPropertyInfo that describe the properties of the
1663 { 'command': 'qom-list',
1664 'data': { 'path': 'str' },
1665 'returns': [ 'ObjectPropertyInfo' ] }
1670 # This command will get a property from a object model path and return the
1673 # @path: The path within the object model. There are two forms of supported
1674 # paths--absolute and partial paths.
1676 # Absolute paths are derived from the root object and can follow child<>
1677 # or link<> properties. Since they can follow link<> properties, they
1678 # can be arbitrarily long. Absolute paths look like absolute filenames
1679 # and are prefixed with a leading slash.
1681 # Partial paths look like relative filenames. They do not begin
1682 # with a prefix. The matching rules for partial paths are subtle but
1683 # designed to make specifying objects easy. At each level of the
1684 # composition tree, the partial path is matched as an absolute path.
1685 # The first match is not returned. At least two matches are searched
1686 # for. A successful result is only returned if only one match is
1687 # found. If more than one match is found, a flag is return to
1688 # indicate that the match was ambiguous.
1690 # @property: The property name to read
1692 # Returns: The property value. The type depends on the property
1693 # type. child<> and link<> properties are returned as #str
1694 # pathnames. All integer property types (u8, u16, etc) are
1699 { 'command': 'qom-get',
1700 'data': { 'path': 'str', 'property': 'str' },
1706 # This command will set a property from a object model path.
1708 # @path: see @qom-get for a description of this parameter
1710 # @property: the property name to set
1712 # @value: a value who's type is appropriate for the property type. See @qom-get
1713 # for a description of type mapping.
1717 { 'command': 'qom-set',
1718 'data': { 'path': 'str', 'property': 'str', 'value': 'any' } }
1723 # Sets the password of a remote display session.
1725 # @protocol: `vnc' to modify the VNC server password
1726 # `spice' to modify the Spice server password
1728 # @password: the new password
1730 # @connected: #optional how to handle existing clients when changing the
1731 # password. If nothing is specified, defaults to `keep'
1732 # `fail' to fail the command if clients are connected
1733 # `disconnect' to disconnect existing clients
1734 # `keep' to maintain existing clients
1736 # Returns: Nothing on success
1737 # If Spice is not enabled, DeviceNotFound
1741 { 'command': 'set_password',
1742 'data': {'protocol': 'str', 'password': 'str', '*connected': 'str'} }
1747 # Expire the password of a remote display server.
1749 # @protocol: the name of the remote display protocol `vnc' or `spice'
1751 # @time: when to expire the password.
1752 # `now' to expire the password immediately
1753 # `never' to cancel password expiration
1754 # `+INT' where INT is the number of seconds from now (integer)
1755 # `INT' where INT is the absolute time in seconds
1757 # Returns: Nothing on success
1758 # If @protocol is `spice' and Spice is not active, DeviceNotFound
1762 # Notes: Time is relative to the server and currently there is no way to
1763 # coordinate server time with client time. It is not recommended to
1764 # use the absolute time version of the @time parameter unless you're
1765 # sure you are on the same machine as the QEMU instance.
1767 { 'command': 'expire_password', 'data': {'protocol': 'str', 'time': 'str'} }
1770 # @change-vnc-password:
1772 # Change the VNC server password.
1774 # @password: the new password to use with VNC authentication
1778 # Notes: An empty password in this command will set the password to the empty
1779 # string. Existing clients are unaffected by executing this command.
1781 { 'command': 'change-vnc-password', 'data': {'password': 'str'} }
1786 # This command is multiple commands multiplexed together.
1788 # @device: This is normally the name of a block device but it may also be 'vnc'.
1789 # when it's 'vnc', then sub command depends on @target
1791 # @target: If @device is a block device, then this is the new filename.
1792 # If @device is 'vnc', then if the value 'password' selects the vnc
1793 # change password command. Otherwise, this specifies a new server URI
1794 # address to listen to for VNC connections.
1796 # @arg: If @device is a block device, then this is an optional format to open
1798 # If @device is 'vnc' and @target is 'password', this is the new VNC
1799 # password to set. If this argument is an empty string, then no future
1800 # logins will be allowed.
1802 # Returns: Nothing on success.
1803 # If @device is not a valid block device, DeviceNotFound
1804 # If the new block device is encrypted, DeviceEncrypted. Note that
1805 # if this error is returned, the device has been opened successfully
1806 # and an additional call to @block_passwd is required to set the
1807 # device's password. The behavior of reads and writes to the block
1808 # device between when these calls are executed is undefined.
1810 # Notes: It is strongly recommended that this interface is not used especially
1811 # for changing block devices.
1815 { 'command': 'change',
1816 'data': {'device': 'str', 'target': 'str', '*arg': 'str'} }
1821 # This structure describes a search result from @qom-list-types
1823 # @name: the type name found in the search
1827 # Notes: This command is experimental and may change syntax in future releases.
1829 { 'struct': 'ObjectTypeInfo',
1830 'data': { 'name': 'str' } }
1835 # This command will return a list of types given search parameters
1837 # @implements: if specified, only return types that implement this type name
1839 # @abstract: if true, include abstract types in the results
1841 # Returns: a list of @ObjectTypeInfo or an empty list if no results are found
1845 { 'command': 'qom-list-types',
1846 'data': { '*implements': 'str', '*abstract': 'bool' },
1847 'returns': [ 'ObjectTypeInfo' ] }
1850 # @DevicePropertyInfo:
1852 # Information about device properties.
1854 # @name: the name of the property
1855 # @type: the typename of the property
1856 # @description: #optional if specified, the description of the property.
1861 { 'struct': 'DevicePropertyInfo',
1862 'data': { 'name': 'str', 'type': 'str', '*description': 'str' } }
1865 # @device-list-properties:
1867 # List properties associated with a device.
1869 # @typename: the type name of a device
1871 # Returns: a list of DevicePropertyInfo describing a devices properties
1875 { 'command': 'device-list-properties',
1876 'data': { 'typename': 'str'},
1877 'returns': [ 'DevicePropertyInfo' ] }
1882 # Migrates the current running guest to another Virtual Machine.
1884 # @uri: the Uniform Resource Identifier of the destination VM
1886 # @blk: #optional do block migration (full disk copy)
1888 # @inc: #optional incremental disk copy migration
1890 # @detach: this argument exists only for compatibility reasons and
1891 # is ignored by QEMU
1893 # Returns: nothing on success
1897 { 'command': 'migrate',
1898 'data': {'uri': 'str', '*blk': 'bool', '*inc': 'bool', '*detach': 'bool' } }
1903 # Start an incoming migration, the qemu must have been started
1904 # with -incoming defer
1906 # @uri: The Uniform Resource Identifier identifying the source or
1907 # address to listen on
1909 # Returns: nothing on success
1912 # Note: It's a bad idea to use a string for the uri, but it needs to stay
1913 # compatible with -incoming and the format of the uri is already exposed
1916 { 'command': 'migrate-incoming', 'data': {'uri': 'str' } }
1918 # @xen-save-devices-state:
1920 # Save the state of all devices to file. The RAM and the block devices
1921 # of the VM are not saved by this command.
1923 # @filename: the file to save the state of the devices to as binary
1924 # data. See xen-save-devices-state.txt for a description of the binary
1927 # Returns: Nothing on success
1931 { 'command': 'xen-save-devices-state', 'data': {'filename': 'str'} }
1934 # @xen-set-global-dirty-log
1936 # Enable or disable the global dirty log mode.
1938 # @enable: true to enable, false to disable.
1944 { 'command': 'xen-set-global-dirty-log', 'data': { 'enable': 'bool' } }
1949 # Remove a device from a guest
1951 # @id: the name of the device
1953 # Returns: Nothing on success
1954 # If @id is not a valid device, DeviceNotFound
1956 # Notes: When this command completes, the device may not be removed from the
1957 # guest. Hot removal is an operation that requires guest cooperation.
1958 # This command merely requests that the guest begin the hot removal
1959 # process. Completion of the device removal process is signaled with a
1960 # DEVICE_DELETED event. Guest reset will automatically complete removal
1965 { 'command': 'device_del', 'data': {'id': 'str'} }
1968 # @DumpGuestMemoryFormat:
1970 # An enumeration of guest-memory-dump's format.
1974 # @kdump-zlib: kdump-compressed format with zlib-compressed
1976 # @kdump-lzo: kdump-compressed format with lzo-compressed
1978 # @kdump-snappy: kdump-compressed format with snappy-compressed
1982 { 'enum': 'DumpGuestMemoryFormat',
1983 'data': [ 'elf', 'kdump-zlib', 'kdump-lzo', 'kdump-snappy' ] }
1986 # @dump-guest-memory
1988 # Dump guest's memory to vmcore. It is a synchronous operation that can take
1989 # very long depending on the amount of guest memory. This command is only
1990 # supported on i386 and x86_64.
1992 # @paging: if true, do paging to get guest's memory mapping. This allows
1993 # using gdb to process the core file.
1995 # IMPORTANT: this option can make QEMU allocate several gigabytes
1996 # of RAM. This can happen for a large guest, or a
1997 # malicious guest pretending to be large.
1999 # Also, paging=true has the following limitations:
2001 # 1. The guest may be in a catastrophic state or can have corrupted
2002 # memory, which cannot be trusted
2003 # 2. The guest can be in real-mode even if paging is enabled. For
2004 # example, the guest uses ACPI to sleep, and ACPI sleep state
2007 # @protocol: the filename or file descriptor of the vmcore. The supported
2010 # 1. file: the protocol starts with "file:", and the following
2011 # string is the file's path.
2012 # 2. fd: the protocol starts with "fd:", and the following string
2015 # @begin: #optional if specified, the starting physical address.
2017 # @length: #optional if specified, the memory size, in bytes. If you don't
2018 # want to dump all guest's memory, please specify the start @begin
2021 # @format: #optional if specified, the format of guest memory dump. But non-elf
2022 # format is conflict with paging and filter, ie. @paging, @begin and
2023 # @length is not allowed to be specified with non-elf @format at the
2024 # same time (since 2.0)
2026 # Returns: nothing on success
2030 { 'command': 'dump-guest-memory',
2031 'data': { 'paging': 'bool', 'protocol': 'str', '*begin': 'int',
2032 '*length': 'int', '*format': 'DumpGuestMemoryFormat' } }
2035 # @DumpGuestMemoryCapability:
2037 # A list of the available formats for dump-guest-memory
2041 { 'struct': 'DumpGuestMemoryCapability',
2043 'formats': ['DumpGuestMemoryFormat'] } }
2046 # @query-dump-guest-memory-capability:
2048 # Returns the available formats for dump-guest-memory
2050 # Returns: A @DumpGuestMemoryCapability object listing available formats for
2055 { 'command': 'query-dump-guest-memory-capability',
2056 'returns': 'DumpGuestMemoryCapability' }
2061 # Dump guest's storage keys
2063 # @filename: the path to the file to dump to
2065 # This command is only supported on s390 architecture.
2069 { 'command': 'dump-skeys',
2070 'data': { 'filename': 'str' } }
2075 # Add a network backend.
2077 # @type: the type of network backend. Current valid values are 'user', 'tap',
2078 # 'vde', 'socket', 'dump' and 'bridge'
2080 # @id: the name of the new network backend
2082 # Additional arguments depend on the type.
2084 # TODO This command effectively bypasses QAPI completely due to its
2085 # "additional arguments" business. It shouldn't have been added to
2086 # the schema in this form. It should be qapified properly, or
2087 # replaced by a properly qapified command.
2091 # Returns: Nothing on success
2092 # If @type is not a valid network backend, DeviceNotFound
2094 { 'command': 'netdev_add',
2095 'data': {'type': 'str', 'id': 'str'},
2096 'gen': false } # so we can get the additional arguments
2101 # Remove a network backend.
2103 # @id: the name of the network backend to remove
2105 # Returns: Nothing on success
2106 # If @id is not a valid network backend, DeviceNotFound
2110 { 'command': 'netdev_del', 'data': {'id': 'str'} }
2115 # Create a QOM object.
2117 # @qom-type: the class name for the object to be created
2119 # @id: the name of the new object
2121 # @props: #optional a dictionary of properties to be passed to the backend
2123 # Returns: Nothing on success
2124 # Error if @qom-type is not a valid class name
2128 { 'command': 'object-add',
2129 'data': {'qom-type': 'str', 'id': 'str', '*props': 'any'} }
2134 # Remove a QOM object.
2136 # @id: the name of the QOM object to remove
2138 # Returns: Nothing on success
2139 # Error if @id is not a valid id for a QOM object
2143 { 'command': 'object-del', 'data': {'id': 'str'} }
2146 # @NetdevNoneOptions
2148 # Use it alone to have zero network devices.
2152 { 'struct': 'NetdevNoneOptions',
2156 # @NetLegacyNicOptions
2158 # Create a new Network Interface Card.
2160 # @netdev: #optional id of -netdev to connect to
2162 # @macaddr: #optional MAC address
2164 # @model: #optional device model (e1000, rtl8139, virtio etc.)
2166 # @addr: #optional PCI device address
2168 # @vectors: #optional number of MSI-x vectors, 0 to disable MSI-X
2172 { 'struct': 'NetLegacyNicOptions',
2178 '*vectors': 'uint32' } }
2183 # A fat type wrapping 'str', to be embedded in lists.
2187 { 'struct': 'String',
2192 # @NetdevUserOptions
2194 # Use the user mode network stack which requires no administrator privilege to
2197 # @hostname: #optional client hostname reported by the builtin DHCP server
2199 # @restrict: #optional isolate the guest from the host
2201 # @ip: #optional legacy parameter, use net= instead
2203 # @net: #optional IP address and optional netmask
2205 # @host: #optional guest-visible address of the host
2207 # @tftp: #optional root directory of the built-in TFTP server
2209 # @bootfile: #optional BOOTP filename, for use with tftp=
2211 # @dhcpstart: #optional the first of the 16 IPs the built-in DHCP server can
2214 # @dns: #optional guest-visible address of the virtual nameserver
2216 # @dnssearch: #optional list of DNS suffixes to search, passed as DHCP option
2219 # @smb: #optional root directory of the built-in SMB server
2221 # @smbserver: #optional IP address of the built-in SMB server
2223 # @hostfwd: #optional redirect incoming TCP or UDP host connections to guest
2226 # @guestfwd: #optional forward guest TCP connections
2230 { 'struct': 'NetdevUserOptions',
2233 '*restrict': 'bool',
2239 '*dhcpstart': 'str',
2241 '*dnssearch': ['String'],
2243 '*smbserver': 'str',
2244 '*hostfwd': ['String'],
2245 '*guestfwd': ['String'] } }
2250 # Connect the host TAP network interface name to the VLAN.
2252 # @ifname: #optional interface name
2254 # @fd: #optional file descriptor of an already opened tap
2256 # @fds: #optional multiple file descriptors of already opened multiqueue capable
2259 # @script: #optional script to initialize the interface
2261 # @downscript: #optional script to shut down the interface
2263 # @helper: #optional command to execute to configure bridge
2265 # @sndbuf: #optional send buffer limit. Understands [TGMKkb] suffixes.
2267 # @vnet_hdr: #optional enable the IFF_VNET_HDR flag on the tap interface
2269 # @vhost: #optional enable vhost-net network accelerator
2271 # @vhostfd: #optional file descriptor of an already opened vhost net device
2273 # @vhostfds: #optional file descriptors of multiple already opened vhost net
2276 # @vhostforce: #optional vhost on for non-MSIX virtio guests
2278 # @queues: #optional number of queues to be created for multiqueue capable tap
2282 { 'struct': 'NetdevTapOptions',
2288 '*downscript': 'str',
2291 '*vnet_hdr': 'bool',
2295 '*vhostforce': 'bool',
2296 '*queues': 'uint32'} }
2299 # @NetdevSocketOptions
2301 # Connect the VLAN to a remote VLAN in another QEMU virtual machine using a TCP
2302 # socket connection.
2304 # @fd: #optional file descriptor of an already opened socket
2306 # @listen: #optional port number, and optional hostname, to listen on
2308 # @connect: #optional port number, and optional hostname, to connect to
2310 # @mcast: #optional UDP multicast address and port number
2312 # @localaddr: #optional source address and port for multicast and udp packets
2314 # @udp: #optional UDP unicast address and port number
2318 { 'struct': 'NetdevSocketOptions',
2324 '*localaddr': 'str',
2328 # @NetdevL2TPv3Options
2330 # Connect the VLAN to Ethernet over L2TPv3 Static tunnel
2332 # @src: source address
2334 # @dst: destination address
2336 # @srcport: #optional source port - mandatory for udp, optional for ip
2338 # @dstport: #optional destination port - mandatory for udp, optional for ip
2340 # @ipv6: #optional - force the use of ipv6
2342 # @udp: #optional - use the udp version of l2tpv3 encapsulation
2344 # @cookie64: #optional - use 64 bit coookies
2346 # @counter: #optional have sequence counter
2348 # @pincounter: #optional pin sequence counter to zero -
2349 # workaround for buggy implementations or
2350 # networks with packet reorder
2352 # @txcookie: #optional 32 or 64 bit transmit cookie
2354 # @rxcookie: #optional 32 or 64 bit receive cookie
2356 # @txsession: 32 bit transmit session
2358 # @rxsession: #optional 32 bit receive session - if not specified
2359 # set to the same value as transmit
2361 # @offset: #optional additional offset - allows the insertion of
2362 # additional application-specific data before the packet payload
2366 { 'struct': 'NetdevL2TPv3Options',
2374 '*cookie64': 'bool',
2376 '*pincounter': 'bool',
2377 '*txcookie': 'uint64',
2378 '*rxcookie': 'uint64',
2379 'txsession': 'uint32',
2380 '*rxsession': 'uint32',
2381 '*offset': 'uint32' } }
2386 # Connect the VLAN to a vde switch running on the host.
2388 # @sock: #optional socket path
2390 # @port: #optional port number
2392 # @group: #optional group owner of socket
2394 # @mode: #optional permissions for socket
2398 { 'struct': 'NetdevVdeOptions',
2403 '*mode': 'uint16' } }
2406 # @NetdevDumpOptions
2408 # Dump VLAN network traffic to a file.
2410 # @len: #optional per-packet size limit (64k default). Understands [TGMKkb]
2413 # @file: #optional dump file path (default is qemu-vlan0.pcap)
2417 { 'struct': 'NetdevDumpOptions',
2423 # @NetdevBridgeOptions
2425 # Connect a host TAP network interface to a host bridge device.
2427 # @br: #optional bridge name
2429 # @helper: #optional command to execute to configure bridge
2433 { 'struct': 'NetdevBridgeOptions',
2436 '*helper': 'str' } }
2439 # @NetdevHubPortOptions
2441 # Connect two or more net clients through a software hub.
2443 # @hubid: hub identifier number
2447 { 'struct': 'NetdevHubPortOptions',
2449 'hubid': 'int32' } }
2452 # @NetdevNetmapOptions
2454 # Connect a client to a netmap-enabled NIC or to a VALE switch port
2456 # @ifname: Either the name of an existing network interface supported by
2457 # netmap, or the name of a VALE port (created on the fly).
2458 # A VALE port name is in the form 'valeXXX:YYY', where XXX and
2459 # YYY are non-negative integers. XXX identifies a switch and
2460 # YYY identifies a port of the switch. VALE ports having the
2461 # same XXX are therefore connected to the same switch.
2463 # @devname: #optional path of the netmap device (default: '/dev/netmap').
2467 { 'struct': 'NetdevNetmapOptions',
2470 '*devname': 'str' } }
2473 # @NetdevVhostUserOptions
2475 # Vhost-user network backend
2477 # @chardev: name of a unix socket chardev
2479 # @vhostforce: #optional vhost on for non-MSIX virtio guests (default: false).
2483 { 'struct': 'NetdevVhostUserOptions',
2486 '*vhostforce': 'bool' } }
2491 # A discriminated record of network device traits.
2495 # 'l2tpv3' - since 2.1
2498 { 'union': 'NetClientOptions',
2500 'none': 'NetdevNoneOptions',
2501 'nic': 'NetLegacyNicOptions',
2502 'user': 'NetdevUserOptions',
2503 'tap': 'NetdevTapOptions',
2504 'l2tpv3': 'NetdevL2TPv3Options',
2505 'socket': 'NetdevSocketOptions',
2506 'vde': 'NetdevVdeOptions',
2507 'dump': 'NetdevDumpOptions',
2508 'bridge': 'NetdevBridgeOptions',
2509 'hubport': 'NetdevHubPortOptions',
2510 'netmap': 'NetdevNetmapOptions',
2511 'vhost-user': 'NetdevVhostUserOptions' } }
2516 # Captures the configuration of a network device; legacy.
2518 # @vlan: #optional vlan number
2520 # @id: #optional identifier for monitor commands
2522 # @name: #optional identifier for monitor commands, ignored if @id is present
2524 # @opts: device type specific properties (legacy)
2528 { 'struct': 'NetLegacy',
2533 'opts': 'NetClientOptions' } }
2538 # Captures the configuration of a network device.
2540 # @id: identifier for monitor commands.
2542 # @opts: device type specific properties
2546 { 'struct': 'Netdev',
2549 'opts': 'NetClientOptions' } }
2552 # @InetSocketAddress
2554 # Captures a socket address or address range in the Internet namespace.
2556 # @host: host part of the address
2558 # @port: port part of the address, or lowest port if @to is present
2560 # @to: highest port to try
2562 # @ipv4: whether to accept IPv4 addresses, default try both IPv4 and IPv6
2565 # @ipv6: whether to accept IPv6 addresses, default try both IPv4 and IPv6
2570 { 'struct': 'InetSocketAddress',
2579 # @UnixSocketAddress
2581 # Captures a socket address in the local ("Unix socket") namespace.
2583 # @path: filesystem path to use
2587 { 'struct': 'UnixSocketAddress',
2594 # Captures the address of a socket, which could also be a named file descriptor
2598 { 'union': 'SocketAddress',
2600 'inet': 'InetSocketAddress',
2601 'unix': 'UnixSocketAddress',
2607 # Receive a file descriptor via SCM rights and assign it a name
2609 # @fdname: file descriptor name
2611 # Returns: Nothing on success
2615 # Notes: If @fdname already exists, the file descriptor assigned to
2616 # it will be closed and replaced by the received file
2618 # The 'closefd' command can be used to explicitly close the
2619 # file descriptor when it is no longer needed.
2621 { 'command': 'getfd', 'data': {'fdname': 'str'} }
2626 # Close a file descriptor previously passed via SCM rights
2628 # @fdname: file descriptor name
2630 # Returns: Nothing on success
2634 { 'command': 'closefd', 'data': {'fdname': 'str'} }
2639 # Information describing a machine.
2641 # @name: the name of the machine
2643 # @alias: #optional an alias for the machine name
2645 # @default: #optional whether the machine is default
2647 # @cpu-max: maximum number of CPUs supported by the machine type
2652 { 'struct': 'MachineInfo',
2653 'data': { 'name': 'str', '*alias': 'str',
2654 '*is-default': 'bool', 'cpu-max': 'int' } }
2659 # Return a list of supported machines
2661 # Returns: a list of MachineInfo
2665 { 'command': 'query-machines', 'returns': ['MachineInfo'] }
2668 # @CpuDefinitionInfo:
2670 # Virtual CPU definition.
2672 # @name: the name of the CPU definition
2676 { 'struct': 'CpuDefinitionInfo',
2677 'data': { 'name': 'str' } }
2680 # @query-cpu-definitions:
2682 # Return a list of supported virtual CPU definitions
2684 # Returns: a list of CpuDefInfo
2688 { 'command': 'query-cpu-definitions', 'returns': ['CpuDefinitionInfo'] }
2692 # Information about a file descriptor that was added to an fd set.
2694 # @fdset-id: The ID of the fd set that @fd was added to.
2696 # @fd: The file descriptor that was received via SCM rights and
2697 # added to the fd set.
2701 { 'struct': 'AddfdInfo', 'data': {'fdset-id': 'int', 'fd': 'int'} }
2706 # Add a file descriptor, that was passed via SCM rights, to an fd set.
2708 # @fdset-id: #optional The ID of the fd set to add the file descriptor to.
2710 # @opaque: #optional A free-form string that can be used to describe the fd.
2712 # Returns: @AddfdInfo on success
2713 # If file descriptor was not received, FdNotSupplied
2714 # If @fdset-id is a negative value, InvalidParameterValue
2716 # Notes: The list of fd sets is shared by all monitor connections.
2718 # If @fdset-id is not specified, a new fd set will be created.
2722 { 'command': 'add-fd', 'data': {'*fdset-id': 'int', '*opaque': 'str'},
2723 'returns': 'AddfdInfo' }
2728 # Remove a file descriptor from an fd set.
2730 # @fdset-id: The ID of the fd set that the file descriptor belongs to.
2732 # @fd: #optional The file descriptor that is to be removed.
2734 # Returns: Nothing on success
2735 # If @fdset-id or @fd is not found, FdNotFound
2739 # Notes: The list of fd sets is shared by all monitor connections.
2741 # If @fd is not specified, all file descriptors in @fdset-id
2744 { 'command': 'remove-fd', 'data': {'fdset-id': 'int', '*fd': 'int'} }
2749 # Information about a file descriptor that belongs to an fd set.
2751 # @fd: The file descriptor value.
2753 # @opaque: #optional A free-form string that can be used to describe the fd.
2757 { 'struct': 'FdsetFdInfo',
2758 'data': {'fd': 'int', '*opaque': 'str'} }
2763 # Information about an fd set.
2765 # @fdset-id: The ID of the fd set.
2767 # @fds: A list of file descriptors that belong to this fd set.
2771 { 'struct': 'FdsetInfo',
2772 'data': {'fdset-id': 'int', 'fds': ['FdsetFdInfo']} }
2777 # Return information describing all fd sets.
2779 # Returns: A list of @FdsetInfo
2783 # Note: The list of fd sets is shared by all monitor connections.
2786 { 'command': 'query-fdsets', 'returns': ['FdsetInfo'] }
2791 # Information describing the QEMU target.
2793 # @arch: the target architecture (eg "x86_64", "i386", etc)
2797 { 'struct': 'TargetInfo',
2798 'data': { 'arch': 'str' } }
2803 # Return information about the target for this QEMU
2805 # Returns: TargetInfo
2809 { 'command': 'query-target', 'returns': 'TargetInfo' }
2814 # An enumeration of key name.
2816 # This is used by the send-key command.
2820 # 'unmapped' and 'pause' since 2.0
2821 # 'ro' and 'kp_comma' since 2.4
2823 { 'enum': 'QKeyCode',
2824 'data': [ 'unmapped',
2825 'shift', 'shift_r', 'alt', 'alt_r', 'altgr', 'altgr_r', 'ctrl',
2826 'ctrl_r', 'menu', 'esc', '1', '2', '3', '4', '5', '6', '7', '8',
2827 '9', '0', 'minus', 'equal', 'backspace', 'tab', 'q', 'w', 'e',
2828 'r', 't', 'y', 'u', 'i', 'o', 'p', 'bracket_left', 'bracket_right',
2829 'ret', 'a', 's', 'd', 'f', 'g', 'h', 'j', 'k', 'l', 'semicolon',
2830 'apostrophe', 'grave_accent', 'backslash', 'z', 'x', 'c', 'v', 'b',
2831 'n', 'm', 'comma', 'dot', 'slash', 'asterisk', 'spc', 'caps_lock',
2832 'f1', 'f2', 'f3', 'f4', 'f5', 'f6', 'f7', 'f8', 'f9', 'f10',
2833 'num_lock', 'scroll_lock', 'kp_divide', 'kp_multiply',
2834 'kp_subtract', 'kp_add', 'kp_enter', 'kp_decimal', 'sysrq', 'kp_0',
2835 'kp_1', 'kp_2', 'kp_3', 'kp_4', 'kp_5', 'kp_6', 'kp_7', 'kp_8',
2836 'kp_9', 'less', 'f11', 'f12', 'print', 'home', 'pgup', 'pgdn', 'end',
2837 'left', 'up', 'down', 'right', 'insert', 'delete', 'stop', 'again',
2838 'props', 'undo', 'front', 'copy', 'open', 'paste', 'find', 'cut',
2839 'lf', 'help', 'meta_l', 'meta_r', 'compose', 'pause', 'ro',
2845 # Represents a keyboard key.
2849 { 'union': 'KeyValue',
2852 'qcode': 'QKeyCode' } }
2857 # Send keys to guest.
2859 # @keys: An array of @KeyValue elements. All @KeyValues in this array are
2860 # simultaneously sent to the guest. A @KeyValue.number value is sent
2861 # directly to the guest, while @KeyValue.qcode must be a valid
2864 # @hold-time: #optional time to delay key up events, milliseconds. Defaults
2867 # Returns: Nothing on success
2868 # If key is unknown or redundant, InvalidParameter
2873 { 'command': 'send-key',
2874 'data': { 'keys': ['KeyValue'], '*hold-time': 'int' } }
2879 # Write a PPM of the VGA screen to a file.
2881 # @filename: the path of a new PPM file to store the image
2883 # Returns: Nothing on success
2887 { 'command': 'screendump', 'data': {'filename': 'str'} }
2892 # Configuration info for file chardevs.
2894 # @in: #optional The name of the input file
2895 # @out: The name of the output file
2899 { 'struct': 'ChardevFile', 'data': { '*in' : 'str',
2905 # Configuration info for device and pipe chardevs.
2907 # @device: The name of the special file for the device,
2908 # i.e. /dev/ttyS0 on Unix or COM1: on Windows
2909 # @type: What kind of device this is.
2913 { 'struct': 'ChardevHostdev', 'data': { 'device' : 'str' } }
2918 # Configuration info for (stream) socket chardevs.
2920 # @addr: socket address to listen on (server=true)
2921 # or connect to (server=false)
2922 # @server: #optional create server socket (default: true)
2923 # @wait: #optional wait for incoming connection on server
2924 # sockets (default: false).
2925 # @nodelay: #optional set TCP_NODELAY socket option (default: false)
2926 # @telnet: #optional enable telnet protocol on server
2927 # sockets (default: false)
2928 # @reconnect: #optional For a client socket, if a socket is disconnected,
2929 # then attempt a reconnect after the given number of seconds.
2930 # Setting this to zero disables this function. (default: 0)
2935 { 'struct': 'ChardevSocket', 'data': { 'addr' : 'SocketAddress',
2938 '*nodelay' : 'bool',
2940 '*reconnect' : 'int' } }
2945 # Configuration info for datagram socket chardevs.
2947 # @remote: remote address
2948 # @local: #optional local address
2952 { 'struct': 'ChardevUdp', 'data': { 'remote' : 'SocketAddress',
2953 '*local' : 'SocketAddress' } }
2958 # Configuration info for mux chardevs.
2960 # @chardev: name of the base chardev.
2964 { 'struct': 'ChardevMux', 'data': { 'chardev' : 'str' } }
2969 # Configuration info for stdio chardevs.
2971 # @signal: #optional Allow signals (such as SIGINT triggered by ^C)
2972 # be delivered to qemu. Default: true in -nographic mode,
2977 { 'struct': 'ChardevStdio', 'data': { '*signal' : 'bool' } }
2980 # @ChardevSpiceChannel:
2982 # Configuration info for spice vm channel chardevs.
2984 # @type: kind of channel (for example vdagent).
2988 { 'struct': 'ChardevSpiceChannel', 'data': { 'type' : 'str' } }
2991 # @ChardevSpicePort:
2993 # Configuration info for spice port chardevs.
2995 # @fqdn: name of the channel (see docs/spice-port-fqdn.txt)
2999 { 'struct': 'ChardevSpicePort', 'data': { 'fqdn' : 'str' } }
3004 # Configuration info for virtual console chardevs.
3006 # @width: console width, in pixels
3007 # @height: console height, in pixels
3008 # @cols: console width, in chars
3009 # @rows: console height, in chars
3013 { 'struct': 'ChardevVC', 'data': { '*width' : 'int',
3021 # Configuration info for ring buffer chardevs.
3023 # @size: #optional ring buffer size, must be power of two, default is 65536
3027 { 'struct': 'ChardevRingbuf', 'data': { '*size' : 'int' } }
3032 # Configuration info for the new chardev backend.
3034 # Since: 1.4 (testdev since 2.2)
3036 { 'struct': 'ChardevDummy', 'data': { } }
3038 { 'union': 'ChardevBackend', 'data': { 'file' : 'ChardevFile',
3039 'serial' : 'ChardevHostdev',
3040 'parallel': 'ChardevHostdev',
3041 'pipe' : 'ChardevHostdev',
3042 'socket' : 'ChardevSocket',
3043 'udp' : 'ChardevUdp',
3044 'pty' : 'ChardevDummy',
3045 'null' : 'ChardevDummy',
3046 'mux' : 'ChardevMux',
3047 'msmouse': 'ChardevDummy',
3048 'braille': 'ChardevDummy',
3049 'testdev': 'ChardevDummy',
3050 'stdio' : 'ChardevStdio',
3051 'console': 'ChardevDummy',
3052 'spicevmc' : 'ChardevSpiceChannel',
3053 'spiceport' : 'ChardevSpicePort',
3055 'ringbuf': 'ChardevRingbuf',
3056 # next one is just for compatibility
3057 'memory' : 'ChardevRingbuf' } }
3062 # Return info about the chardev backend just created.
3064 # @pty: #optional name of the slave pseudoterminal device, present if
3065 # and only if a chardev of type 'pty' was created
3069 { 'struct' : 'ChardevReturn', 'data': { '*pty' : 'str' } }
3074 # Add a character device backend
3076 # @id: the chardev's ID, must be unique
3077 # @backend: backend type and parameters
3079 # Returns: ChardevReturn.
3083 { 'command': 'chardev-add', 'data': {'id' : 'str',
3084 'backend' : 'ChardevBackend' },
3085 'returns': 'ChardevReturn' }
3090 # Remove a character device backend
3092 # @id: the chardev's ID, must exist and not be in use
3094 # Returns: Nothing on success
3098 { 'command': 'chardev-remove', 'data': {'id': 'str'} }
3103 # An enumeration of TPM models
3105 # @tpm-tis: TPM TIS model
3109 { 'enum': 'TpmModel', 'data': [ 'tpm-tis' ] }
3112 # @query-tpm-models:
3114 # Return a list of supported TPM models
3116 # Returns: a list of TpmModel
3120 { 'command': 'query-tpm-models', 'returns': ['TpmModel'] }
3125 # An enumeration of TPM types
3127 # @passthrough: TPM passthrough type
3131 { 'enum': 'TpmType', 'data': [ 'passthrough' ] }
3136 # Return a list of supported TPM types
3138 # Returns: a list of TpmType
3142 { 'command': 'query-tpm-types', 'returns': ['TpmType'] }
3145 # @TPMPassthroughOptions:
3147 # Information about the TPM passthrough type
3149 # @path: #optional string describing the path used for accessing the TPM device
3151 # @cancel-path: #optional string showing the TPM's sysfs cancel file
3152 # for cancellation of TPM commands while they are executing
3156 { 'struct': 'TPMPassthroughOptions', 'data': { '*path' : 'str',
3157 '*cancel-path' : 'str'} }
3162 # A union referencing different TPM backend types' configuration options
3164 # @passthrough: The configuration options for the TPM passthrough type
3168 { 'union': 'TpmTypeOptions',
3169 'data': { 'passthrough' : 'TPMPassthroughOptions' } }
3174 # Information about the TPM
3176 # @id: The Id of the TPM
3178 # @model: The TPM frontend model
3180 # @options: The TPM (backend) type configuration options
3184 { 'struct': 'TPMInfo',
3185 'data': {'id': 'str',
3186 'model': 'TpmModel',
3187 'options': 'TpmTypeOptions' } }
3192 # Return information about the TPM device
3194 # Returns: @TPMInfo on success
3198 { 'command': 'query-tpm', 'returns': ['TPMInfo'] }
3203 # Specify an ACPI table on the command line to load.
3205 # At most one of @file and @data can be specified. The list of files specified
3206 # by any one of them is loaded and concatenated in order. If both are omitted,
3209 # Other fields / optargs can be used to override fields of the generic ACPI
3210 # table header; refer to the ACPI specification 5.0, section 5.2.6 System
3211 # Description Table Header. If a header field is not overridden, then the
3212 # corresponding value from the concatenated blob is used (in case of @file), or
3213 # it is filled in with a hard-coded value (in case of @data).
3215 # String fields are copied into the matching ACPI member from lowest address
3216 # upwards, and silently truncated / NUL-padded to length.
3218 # @sig: #optional table signature / identifier (4 bytes)
3220 # @rev: #optional table revision number (dependent on signature, 1 byte)
3222 # @oem_id: #optional OEM identifier (6 bytes)
3224 # @oem_table_id: #optional OEM table identifier (8 bytes)
3226 # @oem_rev: #optional OEM-supplied revision number (4 bytes)
3228 # @asl_compiler_id: #optional identifier of the utility that created the table
3231 # @asl_compiler_rev: #optional revision number of the utility that created the
3234 # @file: #optional colon (:) separated list of pathnames to load and
3235 # concatenate as table data. The resultant binary blob is expected to
3236 # have an ACPI table header. At least one file is required. This field
3239 # @data: #optional colon (:) separated list of pathnames to load and
3240 # concatenate as table data. The resultant binary blob must not have an
3241 # ACPI table header. At least one file is required. This field excludes
3246 { 'struct': 'AcpiTableOptions',
3251 '*oem_table_id': 'str',
3252 '*oem_rev': 'uint32',
3253 '*asl_compiler_id': 'str',
3254 '*asl_compiler_rev': 'uint32',
3259 # @CommandLineParameterType:
3261 # Possible types for an option parameter.
3263 # @string: accepts a character string
3265 # @boolean: accepts "on" or "off"
3267 # @number: accepts a number
3269 # @size: accepts a number followed by an optional suffix (K)ilo,
3270 # (M)ega, (G)iga, (T)era
3274 { 'enum': 'CommandLineParameterType',
3275 'data': ['string', 'boolean', 'number', 'size'] }
3278 # @CommandLineParameterInfo:
3280 # Details about a single parameter of a command line option.
3282 # @name: parameter name
3284 # @type: parameter @CommandLineParameterType
3286 # @help: #optional human readable text string, not suitable for parsing.
3288 # @default: #optional default value string (since 2.1)
3292 { 'struct': 'CommandLineParameterInfo',
3293 'data': { 'name': 'str',
3294 'type': 'CommandLineParameterType',
3296 '*default': 'str' } }
3299 # @CommandLineOptionInfo:
3301 # Details about a command line option, including its list of parameter details
3303 # @option: option name
3305 # @parameters: an array of @CommandLineParameterInfo
3309 { 'struct': 'CommandLineOptionInfo',
3310 'data': { 'option': 'str', 'parameters': ['CommandLineParameterInfo'] } }
3313 # @query-command-line-options:
3315 # Query command line option schema.
3317 # @option: #optional option name
3319 # Returns: list of @CommandLineOptionInfo for all options (or for the given
3320 # @option). Returns an error if the given @option doesn't exist.
3324 {'command': 'query-command-line-options', 'data': { '*option': 'str' },
3325 'returns': ['CommandLineOptionInfo'] }
3330 # A X86 32-bit register
3334 { 'enum': 'X86CPURegister32',
3335 'data': [ 'EAX', 'EBX', 'ECX', 'EDX', 'ESP', 'EBP', 'ESI', 'EDI' ] }
3338 # @X86CPUFeatureWordInfo
3340 # Information about a X86 CPU feature word
3342 # @cpuid-input-eax: Input EAX value for CPUID instruction for that feature word
3344 # @cpuid-input-ecx: #optional Input ECX value for CPUID instruction for that
3347 # @cpuid-register: Output register containing the feature bits
3349 # @features: value of output register, containing the feature bits
3353 { 'struct': 'X86CPUFeatureWordInfo',
3354 'data': { 'cpuid-input-eax': 'int',
3355 '*cpuid-input-ecx': 'int',
3356 'cpuid-register': 'X86CPURegister32',
3357 'features': 'int' } }
3362 # Packets receiving state
3364 # @normal: filter assigned packets according to the mac-table
3366 # @none: don't receive any assigned packet
3368 # @all: receive all assigned packets
3372 { 'enum': 'RxState', 'data': [ 'normal', 'none', 'all' ] }
3377 # Rx-filter information for a NIC.
3379 # @name: net client name
3381 # @promiscuous: whether promiscuous mode is enabled
3383 # @multicast: multicast receive state
3385 # @unicast: unicast receive state
3387 # @vlan: vlan receive state (Since 2.0)
3389 # @broadcast-allowed: whether to receive broadcast
3391 # @multicast-overflow: multicast table is overflowed or not
3393 # @unicast-overflow: unicast table is overflowed or not
3395 # @main-mac: the main macaddr string
3397 # @vlan-table: a list of active vlan id
3399 # @unicast-table: a list of unicast macaddr string
3401 # @multicast-table: a list of multicast macaddr string
3406 { 'struct': 'RxFilterInfo',
3409 'promiscuous': 'bool',
3410 'multicast': 'RxState',
3411 'unicast': 'RxState',
3413 'broadcast-allowed': 'bool',
3414 'multicast-overflow': 'bool',
3415 'unicast-overflow': 'bool',
3417 'vlan-table': ['int'],
3418 'unicast-table': ['str'],
3419 'multicast-table': ['str'] }}
3424 # Return rx-filter information for all NICs (or for the given NIC).
3426 # @name: #optional net client name
3428 # Returns: list of @RxFilterInfo for all NICs (or for the given NIC).
3429 # Returns an error if the given @name doesn't exist, or given
3430 # NIC doesn't support rx-filter querying, or given net client
3435 { 'command': 'query-rx-filter', 'data': { '*name': 'str' },
3436 'returns': ['RxFilterInfo'] }
3441 # Button of a pointer input device (mouse, tablet).
3445 { 'enum' : 'InputButton',
3446 'data' : [ 'Left', 'Middle', 'Right', 'WheelUp', 'WheelDown' ] }
3451 # Position axis of a pointer input device (mouse, tablet).
3455 { 'enum' : 'InputAxis',
3456 'data' : [ 'X', 'Y' ] }
3461 # Keyboard input event.
3463 # @key: Which key this event is for.
3464 # @down: True for key-down and false for key-up events.
3468 { 'struct' : 'InputKeyEvent',
3469 'data' : { 'key' : 'KeyValue',
3475 # Pointer button input event.
3477 # @button: Which button this event is for.
3478 # @down: True for key-down and false for key-up events.
3482 { 'struct' : 'InputBtnEvent',
3483 'data' : { 'button' : 'InputButton',
3489 # Pointer motion input event.
3491 # @axis: Which axis is referenced by @value.
3492 # @value: Pointer position. For absolute coordinates the
3493 # valid range is 0 -> 0x7ffff
3497 { 'struct' : 'InputMoveEvent',
3498 'data' : { 'axis' : 'InputAxis',
3504 # Input event union.
3506 # @key: Input event of Keyboard
3507 # @btn: Input event of pointer buttons
3508 # @rel: Input event of relative pointer motion
3509 # @abs: Input event of absolute pointer motion
3513 { 'union' : 'InputEvent',
3514 'data' : { 'key' : 'InputKeyEvent',
3515 'btn' : 'InputBtnEvent',
3516 'rel' : 'InputMoveEvent',
3517 'abs' : 'InputMoveEvent' } }
3520 # @x-input-send-event
3522 # Send input event(s) to guest.
3524 # @console: #optional console to send event(s) to.
3525 # This parameter can be used to send the input event to
3526 # specific input devices in case (a) multiple input devices
3527 # of the same kind are added to the virtual machine and (b)
3528 # you have configured input routing (see docs/multiseat.txt)
3529 # for those input devices. If input routing is not
3530 # configured this parameter has no effect.
3531 # If @console is missing, only devices that aren't associated
3532 # with a console are admissible.
3533 # If @console is specified, it must exist, and both devices
3534 # associated with that console and devices not associated with a
3535 # console are admissible, but the former take precedence.
3538 # @events: List of InputEvent union.
3540 # Returns: Nothing on success.
3544 # Note: this command is experimental, and not a stable API.
3547 { 'command': 'x-input-send-event',
3548 'data': { '*console':'int', 'events': [ 'InputEvent' ] } }
3553 # A discriminated record of NUMA options. (for OptsVisitor)
3557 { 'union': 'NumaOptions',
3559 'node': 'NumaNodeOptions' }}
3564 # Create a guest NUMA node. (for OptsVisitor)
3566 # @nodeid: #optional NUMA node ID (increase by 1 from 0 if omitted)
3568 # @cpus: #optional VCPUs belonging to this node (assign VCPUS round-robin
3571 # @mem: #optional memory size of this node; mutually exclusive with @memdev.
3572 # Equally divide total memory among nodes if both @mem and @memdev are
3575 # @memdev: #optional memory backend object. If specified for one node,
3576 # it must be specified for all nodes.
3580 { 'struct': 'NumaNodeOptions',
3582 '*nodeid': 'uint16',
3583 '*cpus': ['uint16'],
3590 # Host memory policy types
3592 # @default: restore default policy, remove any nondefault policy
3594 # @preferred: set the preferred host nodes for allocation
3596 # @bind: a strict policy that restricts memory allocation to the
3597 # host nodes specified
3599 # @interleave: memory allocations are interleaved across the set
3600 # of host nodes specified
3604 { 'enum': 'HostMemPolicy',
3605 'data': [ 'default', 'preferred', 'bind', 'interleave' ] }
3610 # Information about memory backend
3612 # @size: memory backend size
3614 # @merge: enables or disables memory merge support
3616 # @dump: includes memory backend's memory in a core dump or not
3618 # @prealloc: enables or disables memory preallocation
3620 # @host-nodes: host nodes for its memory policy
3622 # @policy: memory policy of memory backend
3627 { 'struct': 'Memdev',
3633 'host-nodes': ['uint16'],
3634 'policy': 'HostMemPolicy' }}
3639 # Returns information for all memory backends.
3641 # Returns: a list of @Memdev.
3645 { 'command': 'query-memdev', 'returns': ['Memdev'] }
3648 # @PCDIMMDeviceInfo:
3650 # PCDIMMDevice state information
3652 # @id: #optional device's ID
3654 # @addr: physical address, where device is mapped
3656 # @size: size of memory that the device provides
3658 # @slot: slot number at which device is plugged in
3660 # @node: NUMA node number where device is plugged in
3662 # @memdev: memory backend linked with device
3664 # @hotplugged: true if device was hotplugged
3666 # @hotpluggable: true if device if could be added/removed while machine is running
3670 { 'struct': 'PCDIMMDeviceInfo',
3671 'data': { '*id': 'str',
3677 'hotplugged': 'bool',
3678 'hotpluggable': 'bool'
3683 # @MemoryDeviceInfo:
3685 # Union containing information about a memory device
3689 { 'union': 'MemoryDeviceInfo', 'data': {'dimm': 'PCDIMMDeviceInfo'} }
3692 # @query-memory-devices
3694 # Lists available memory devices and their state
3698 { 'command': 'query-memory-devices', 'returns': ['MemoryDeviceInfo'] }
3702 # @DIMM: memory slot
3704 { 'enum': 'ACPISlotType', 'data': [ 'DIMM' ] }
3708 # OSPM Status Indication for a device
3709 # For description of possible values of @source and @status fields
3710 # see "_OST (OSPM Status Indication)" chapter of ACPI5.0 spec.
3712 # @device: #optional device ID associated with slot
3714 # @slot: slot ID, unique per slot of a given @slot-type
3716 # @slot-type: type of the slot
3718 # @source: an integer containing the source event
3720 # @status: an integer containing the status code
3724 { 'struct': 'ACPIOSTInfo',
3725 'data' : { '*device': 'str',
3727 'slot-type': 'ACPISlotType',
3732 # @query-acpi-ospm-status
3734 # Lists ACPI OSPM status of ACPI device objects,
3735 # which might be reported via _OST method
3739 { 'command': 'query-acpi-ospm-status', 'returns': ['ACPIOSTInfo'] }
3742 # @WatchdogExpirationAction
3744 # An enumeration of the actions taken when the watchdog device's timer is
3747 # @reset: system resets
3749 # @shutdown: system shutdown, note that it is similar to @powerdown, which
3750 # tries to set to system status and notify guest
3752 # @poweroff: system poweroff, the emulator program exits
3754 # @pause: system pauses, similar to @stop
3756 # @debug: system enters debug state
3758 # @none: nothing is done
3760 # @inject-nmi: a non-maskable interrupt is injected into the first VCPU (all
3761 # VCPUS on x86) (since 2.4)
3765 { 'enum': 'WatchdogExpirationAction',
3766 'data': [ 'reset', 'shutdown', 'poweroff', 'pause', 'debug', 'none',
3772 # An enumeration of the I/O operation types
3774 # @read: read operation
3776 # @write: write operation
3780 { 'enum': 'IoOperationType',
3781 'data': [ 'read', 'write' ] }
3786 # An enumeration of the actions taken when guest OS panic is detected
3788 # @pause: system pauses
3792 { 'enum': 'GuestPanicAction',
3793 'data': [ 'pause' ] }
3796 # @rtc-reset-reinjection
3798 # This command will reset the RTC interrupt reinjection backlog.
3799 # Can be used if another mechanism to synchronize guest time
3800 # is in effect, for example QEMU guest agent's guest-set-time
3805 { 'command': 'rtc-reset-reinjection' }
3807 # Rocker ethernet network switch
3808 { 'include': 'qapi/rocker.json' }