5 # QAPI common definitions
6 { 'include': 'qapi/common.json' }
8 # QAPI crypto definitions
9 { 'include': 'qapi/crypto.json' }
11 # QAPI block definitions
12 { 'include': 'qapi/block.json' }
14 # QAPI event definitions
15 { 'include': 'qapi/event.json' }
18 { 'include': 'qapi/trace.json' }
21 { 'include': 'qapi/introspect.json' }
26 # Policy for handling lost ticks in timer devices.
28 # @discard: throw away the missed tick(s) and continue with future injection
29 # normally. Guest time may be delayed, unless the OS has explicit
30 # handling of lost ticks
32 # @delay: continue to deliver ticks at the normal rate. Guest time will be
33 # delayed due to the late tick
35 # @merge: merge the missed tick(s) into one tick and inject. Guest time
36 # may be delayed, depending on how the OS reacts to the merging
39 # @slew: deliver ticks at a higher rate to catch up with the missed tick. The
40 # guest time should not be delayed once catchup is complete.
44 { 'enum': 'LostTickPolicy',
45 'data': ['discard', 'delay', 'merge', 'slew' ] }
49 # Allow client connections for VNC, Spice and socket based
50 # character devices to be passed in to QEMU via SCM_RIGHTS.
52 # @protocol: protocol name. Valid names are "vnc", "spice" or the
53 # name of a character device (eg. from -chardev id=XXXX)
55 # @fdname: file descriptor name previously passed via 'getfd' command
57 # @skipauth: #optional whether to skip authentication. Only applies
58 # to "vnc" and "spice" protocols
60 # @tls: #optional whether to perform TLS. Only applies to the "spice"
63 # Returns: nothing on success.
67 { 'command': 'add_client',
68 'data': { 'protocol': 'str', 'fdname': 'str', '*skipauth': 'bool',
74 # Guest name information.
76 # @name: #optional The name of the guest
80 { 'struct': 'NameInfo', 'data': {'*name': 'str'} }
85 # Return the name information of a guest.
87 # Returns: @NameInfo of the guest
91 { 'command': 'query-name', 'returns': 'NameInfo' }
96 # Information about support for KVM acceleration
98 # @enabled: true if KVM acceleration is active
100 # @present: true if KVM acceleration is built into this executable
104 { 'struct': 'KvmInfo', 'data': {'enabled': 'bool', 'present': 'bool'} }
109 # Returns information about KVM acceleration
115 { 'command': 'query-kvm', 'returns': 'KvmInfo' }
120 # An enumeration of VM run states.
122 # @debug: QEMU is running on a debugger
124 # @finish-migrate: guest is paused to finish the migration process
126 # @inmigrate: guest is paused waiting for an incoming migration. Note
127 # that this state does not tell whether the machine will start at the
128 # end of the migration. This depends on the command-line -S option and
129 # any invocation of 'stop' or 'cont' that has happened since QEMU was
132 # @internal-error: An internal error that prevents further guest execution
135 # @io-error: the last IOP has failed and the device is configured to pause
138 # @paused: guest has been paused via the 'stop' command
140 # @postmigrate: guest is paused following a successful 'migrate'
142 # @prelaunch: QEMU was started with -S and guest has not started
144 # @restore-vm: guest is paused to restore VM state
146 # @running: guest is actively running
148 # @save-vm: guest is paused to save the VM state
150 # @shutdown: guest is shut down (and -no-shutdown is in use)
152 # @suspended: guest is suspended (ACPI S3)
154 # @watchdog: the watchdog action is configured to pause and has been triggered
156 # @guest-panicked: guest has been panicked as a result of guest OS panic
158 { 'enum': 'RunState',
159 'data': [ 'debug', 'inmigrate', 'internal-error', 'io-error', 'paused',
160 'postmigrate', 'prelaunch', 'finish-migrate', 'restore-vm',
161 'running', 'save-vm', 'shutdown', 'suspended', 'watchdog',
167 # Information about VCPU run state
169 # @running: true if all VCPUs are runnable, false if not runnable
171 # @singlestep: true if VCPUs are in single-step mode
173 # @status: the virtual machine @RunState
177 # Notes: @singlestep is enabled through the GDB stub
179 { 'struct': 'StatusInfo',
180 'data': {'running': 'bool', 'singlestep': 'bool', 'status': 'RunState'} }
185 # Query the run status of all VCPUs
187 # Returns: @StatusInfo reflecting all VCPUs
191 { 'command': 'query-status', 'returns': 'StatusInfo' }
196 # Guest UUID information.
198 # @UUID: the UUID of the guest
202 # Notes: If no UUID was specified for the guest, a null UUID is returned.
204 { 'struct': 'UuidInfo', 'data': {'UUID': 'str'} }
209 # Query the guest UUID information.
211 # Returns: The @UuidInfo for the guest
215 { 'command': 'query-uuid', 'returns': 'UuidInfo' }
220 # Information about a character device.
222 # @label: the label of the character device
224 # @filename: the filename of the character device
226 # @frontend-open: shows whether the frontend device attached to this backend
227 # (eg. with the chardev=... option) is in open or closed state
230 # Notes: @filename is encoded using the QEMU command line character device
231 # encoding. See the QEMU man page for details.
235 { 'struct': 'ChardevInfo', 'data': {'label': 'str',
237 'frontend-open': 'bool'} }
242 # Returns information about current character devices.
244 # Returns: a list of @ChardevInfo
248 { 'command': 'query-chardev', 'returns': ['ChardevInfo'] }
251 # @ChardevBackendInfo:
253 # Information about a character device backend
255 # @name: The backend name
259 { 'struct': 'ChardevBackendInfo', 'data': {'name': 'str'} }
262 # @query-chardev-backends:
264 # Returns information about character device backends.
266 # Returns: a list of @ChardevBackendInfo
270 { 'command': 'query-chardev-backends', 'returns': ['ChardevBackendInfo'] }
275 # An enumeration of data format.
277 # @utf8: Data is a UTF-8 string (RFC 3629)
279 # @base64: Data is Base64 encoded binary (RFC 3548)
283 { 'enum': 'DataFormat',
284 'data': [ 'utf8', 'base64' ] }
289 # Write to a ring buffer character device.
291 # @device: the ring buffer character device name
293 # @data: data to write
295 # @format: #optional data encoding (default 'utf8').
296 # - base64: data must be base64 encoded text. Its binary
297 # decoding gets written.
298 # Bug: invalid base64 is currently not rejected.
299 # Whitespace *is* invalid.
300 # - utf8: data's UTF-8 encoding is written
301 # - data itself is always Unicode regardless of format, like
304 # Returns: Nothing on success
308 { 'command': 'ringbuf-write',
309 'data': {'device': 'str', 'data': 'str',
310 '*format': 'DataFormat'} }
315 # Read from a ring buffer character device.
317 # @device: the ring buffer character device name
319 # @size: how many bytes to read at most
321 # @format: #optional data encoding (default 'utf8').
322 # - base64: the data read is returned in base64 encoding.
323 # - utf8: the data read is interpreted as UTF-8.
324 # Bug: can screw up when the buffer contains invalid UTF-8
325 # sequences, NUL characters, after the ring buffer lost
326 # data, and when reading stops because the size limit is
328 # - The return value is always Unicode regardless of format,
329 # like any other string.
331 # Returns: data read from the device
335 { 'command': 'ringbuf-read',
336 'data': {'device': 'str', 'size': 'int', '*format': 'DataFormat'},
342 # Information about a QMP event
344 # @name: The event name
348 { 'struct': 'EventInfo', 'data': {'name': 'str'} }
353 # Return a list of supported QMP events by this server
355 # Returns: A list of @EventInfo for all supported events
359 { 'command': 'query-events', 'returns': ['EventInfo'] }
364 # Detailed migration status.
366 # @transferred: amount of bytes already transferred to the target VM
368 # @remaining: amount of bytes remaining to be transferred to the target VM
370 # @total: total amount of bytes involved in the migration process
372 # @duplicate: number of duplicate (zero) pages (since 1.2)
374 # @skipped: number of skipped zero pages (since 1.5)
376 # @normal : number of normal pages (since 1.2)
378 # @normal-bytes: number of normal bytes sent (since 1.2)
380 # @dirty-pages-rate: number of pages dirtied by second by the
383 # @mbps: throughput in megabits/sec. (since 1.6)
385 # @dirty-sync-count: number of times that dirty ram was synchronized (since 2.1)
389 { 'struct': 'MigrationStats',
390 'data': {'transferred': 'int', 'remaining': 'int', 'total': 'int' ,
391 'duplicate': 'int', 'skipped': 'int', 'normal': 'int',
392 'normal-bytes': 'int', 'dirty-pages-rate' : 'int',
393 'mbps' : 'number', 'dirty-sync-count' : 'int' } }
398 # Detailed XBZRLE migration cache statistics
400 # @cache-size: XBZRLE cache size
402 # @bytes: amount of bytes already transferred to the target VM
404 # @pages: amount of pages transferred to the target VM
406 # @cache-miss: number of cache miss
408 # @cache-miss-rate: rate of cache miss (since 2.1)
410 # @overflow: number of overflows
414 { 'struct': 'XBZRLECacheStats',
415 'data': {'cache-size': 'int', 'bytes': 'int', 'pages': 'int',
416 'cache-miss': 'int', 'cache-miss-rate': 'number',
417 'overflow': 'int' } }
421 # An enumeration of migration status.
423 # @none: no migration has ever happened.
425 # @setup: migration process has been initiated.
427 # @cancelling: in the process of cancelling migration.
429 # @cancelled: cancelling migration is finished.
431 # @active: in the process of doing migration.
433 # @completed: migration is finished.
435 # @failed: some error occurred during migration process.
440 { 'enum': 'MigrationStatus',
441 'data': [ 'none', 'setup', 'cancelling', 'cancelled',
442 'active', 'completed', 'failed' ] }
447 # Information about current migration process.
449 # @status: #optional @MigrationStatus describing the current migration status.
450 # If this field is not returned, no migration process
453 # @ram: #optional @MigrationStats containing detailed migration
454 # status, only returned if status is 'active' or
455 # 'completed'(since 1.2)
457 # @disk: #optional @MigrationStats containing detailed disk migration
458 # status, only returned if status is 'active' and it is a block
461 # @xbzrle-cache: #optional @XBZRLECacheStats containing detailed XBZRLE
462 # migration statistics, only returned if XBZRLE feature is on and
463 # status is 'active' or 'completed' (since 1.2)
465 # @total-time: #optional total amount of milliseconds since migration started.
466 # If migration has ended, it returns the total migration
469 # @downtime: #optional only present when migration finishes correctly
470 # total downtime in milliseconds for the guest.
473 # @expected-downtime: #optional only present while migration is active
474 # expected downtime in milliseconds for the guest in last walk
475 # of the dirty bitmap. (since 1.3)
477 # @setup-time: #optional amount of setup time in milliseconds _before_ the
478 # iterations begin but _after_ the QMP command is issued. This is designed
479 # to provide an accounting of any activities (such as RDMA pinning) which
480 # may be expensive, but do not actually occur during the iterative
481 # migration rounds themselves. (since 1.6)
485 { 'struct': 'MigrationInfo',
486 'data': {'*status': 'MigrationStatus', '*ram': 'MigrationStats',
487 '*disk': 'MigrationStats',
488 '*xbzrle-cache': 'XBZRLECacheStats',
489 '*total-time': 'int',
490 '*expected-downtime': 'int',
492 '*setup-time': 'int'} }
497 # Returns information about current migration process.
499 # Returns: @MigrationInfo
503 { 'command': 'query-migrate', 'returns': 'MigrationInfo' }
506 # @MigrationCapability
508 # Migration capabilities enumeration
510 # @xbzrle: Migration supports xbzrle (Xor Based Zero Run Length Encoding).
511 # This feature allows us to minimize migration traffic for certain work
512 # loads, by sending compressed difference of the pages
514 # @rdma-pin-all: Controls whether or not the entire VM memory footprint is
515 # mlock()'d on demand or all at once. Refer to docs/rdma.txt for usage.
516 # Disabled by default. (since 2.0)
518 # @zero-blocks: During storage migration encode blocks of zeroes efficiently. This
519 # essentially saves 1MB of zeroes per block on the wire. Enabling requires
520 # source and target VM to support this feature. To enable it is sufficient
521 # to enable the capability on the source VM. The feature is disabled by
522 # default. (since 1.6)
524 # @compress: Use multiple compression threads to accelerate live migration.
525 # This feature can help to reduce the migration traffic, by sending
526 # compressed pages. Please note that if compress and xbzrle are both
527 # on, compress only takes effect in the ram bulk stage, after that,
528 # it will be disabled and only xbzrle takes effect, this can help to
529 # minimize migration traffic. The feature is disabled by default.
532 # @events: generate events for each migration state change
535 # @auto-converge: If enabled, QEMU will automatically throttle down the guest
536 # to speed up convergence of RAM migration. (since 1.6)
540 { 'enum': 'MigrationCapability',
541 'data': ['xbzrle', 'rdma-pin-all', 'auto-converge', 'zero-blocks',
542 'compress', 'events'] }
545 # @MigrationCapabilityStatus
547 # Migration capability information
549 # @capability: capability enum
551 # @state: capability state bool
555 { 'struct': 'MigrationCapabilityStatus',
556 'data': { 'capability' : 'MigrationCapability', 'state' : 'bool' } }
559 # @migrate-set-capabilities
561 # Enable/Disable the following migration capabilities (like xbzrle)
563 # @capabilities: json array of capability modifications to make
567 { 'command': 'migrate-set-capabilities',
568 'data': { 'capabilities': ['MigrationCapabilityStatus'] } }
571 # @query-migrate-capabilities
573 # Returns information about the current migration capabilities status
575 # Returns: @MigrationCapabilitiesStatus
579 { 'command': 'query-migrate-capabilities', 'returns': ['MigrationCapabilityStatus']}
581 # @MigrationParameter
583 # Migration parameters enumeration
585 # @compress-level: Set the compression level to be used in live migration,
586 # the compression level is an integer between 0 and 9, where 0 means
587 # no compression, 1 means the best compression speed, and 9 means best
588 # compression ratio which will consume more CPU.
590 # @compress-threads: Set compression thread count to be used in live migration,
591 # the compression thread count is an integer between 1 and 255.
593 # @decompress-threads: Set decompression thread count to be used in live
594 # migration, the decompression thread count is an integer between 1
595 # and 255. Usually, decompression is at least 4 times as fast as
596 # compression, so set the decompress-threads to the number about 1/4
597 # of compress-threads is adequate.
601 { 'enum': 'MigrationParameter',
602 'data': ['compress-level', 'compress-threads', 'decompress-threads'] }
605 # @migrate-set-parameters
607 # Set the following migration parameters
609 # @compress-level: compression level
611 # @compress-threads: compression thread count
613 # @decompress-threads: decompression thread count
617 { 'command': 'migrate-set-parameters',
618 'data': { '*compress-level': 'int',
619 '*compress-threads': 'int',
620 '*decompress-threads': 'int'} }
623 # @MigrationParameters
625 # @compress-level: compression level
627 # @compress-threads: compression thread count
629 # @decompress-threads: decompression thread count
633 { 'struct': 'MigrationParameters',
634 'data': { 'compress-level': 'int',
635 'compress-threads': 'int',
636 'decompress-threads': 'int'} }
638 # @query-migrate-parameters
640 # Returns information about the current migration parameters
642 # Returns: @MigrationParameters
646 { 'command': 'query-migrate-parameters',
647 'returns': 'MigrationParameters' }
650 # @client_migrate_info
652 # Set migration information for remote display. This makes the server
653 # ask the client to automatically reconnect using the new parameters
654 # once migration finished successfully. Only implemented for SPICE.
656 # @protocol: must be "spice"
657 # @hostname: migration target hostname
658 # @port: #optional spice tcp port for plaintext channels
659 # @tls-port: #optional spice tcp port for tls-secured channels
660 # @cert-subject: #optional server certificate subject
664 { 'command': 'client_migrate_info',
665 'data': { 'protocol': 'str', 'hostname': 'str', '*port': 'int',
666 '*tls-port': 'int', '*cert-subject': 'str' } }
671 # Information about a mouse device.
673 # @name: the name of the mouse device
675 # @index: the index of the mouse device
677 # @current: true if this device is currently receiving mouse events
679 # @absolute: true if this device supports absolute coordinates as input
683 { 'struct': 'MouseInfo',
684 'data': {'name': 'str', 'index': 'int', 'current': 'bool',
685 'absolute': 'bool'} }
690 # Returns information about each active mouse device
692 # Returns: a list of @MouseInfo for each device
696 { 'command': 'query-mice', 'returns': ['MouseInfo'] }
701 # Information about a virtual CPU
703 # @CPU: the index of the virtual CPU
705 # @current: this only exists for backwards compatible and should be ignored
707 # @halted: true if the virtual CPU is in the halt state. Halt usually refers
708 # to a processor specific low power mode.
710 # @qom_path: path to the CPU object in the QOM tree (since 2.4)
712 # @pc: #optional If the target is i386 or x86_64, this is the 64-bit instruction
714 # If the target is Sparc, this is the PC component of the
715 # instruction pointer.
717 # @nip: #optional If the target is PPC, the instruction pointer
719 # @npc: #optional If the target is Sparc, the NPC component of the instruction
722 # @PC: #optional If the target is MIPS, the instruction pointer
724 # @thread_id: ID of the underlying host thread
728 # Notes: @halted is a transient state that changes frequently. By the time the
729 # data is sent to the client, the guest may no longer be halted.
731 { 'struct': 'CpuInfo',
732 'data': {'CPU': 'int', 'current': 'bool', 'halted': 'bool',
734 '*pc': 'int', '*nip': 'int', '*npc': 'int', '*PC': 'int',
735 'thread_id': 'int'} }
740 # Returns a list of information about each virtual CPU.
742 # Returns: a list of @CpuInfo for each virtual CPU
746 { 'command': 'query-cpus', 'returns': ['CpuInfo'] }
751 # Information about an iothread
753 # @id: the identifier of the iothread
755 # @thread-id: ID of the underlying host thread
759 { 'struct': 'IOThreadInfo',
760 'data': {'id': 'str', 'thread-id': 'int'} }
765 # Returns a list of information about each iothread.
767 # Note this list excludes the QEMU main loop thread, which is not declared
768 # using the -object iothread command-line option. It is always the main thread
771 # Returns: a list of @IOThreadInfo for each iothread
775 { 'command': 'query-iothreads', 'returns': ['IOThreadInfo'] }
778 # @NetworkAddressFamily
780 # The network address family
788 # @unknown: otherwise
792 { 'enum': 'NetworkAddressFamily',
793 'data': [ 'ipv4', 'ipv6', 'unix', 'unknown' ] }
798 # The basic information for vnc network connection
802 # @service: The service name of the vnc port. This may depend on the host
803 # system's service database so symbolic names should not be relied
806 # @family: address family
808 # @websocket: true in case the socket is a websocket (since 2.3).
812 { 'struct': 'VncBasicInfo',
813 'data': { 'host': 'str',
815 'family': 'NetworkAddressFamily',
816 'websocket': 'bool' } }
821 # The network connection information for server
823 # @auth: #optional, authentication method
827 { 'struct': 'VncServerInfo',
828 'base': 'VncBasicInfo',
829 'data': { '*auth': 'str' } }
834 # Information about a connected VNC client.
836 # @x509_dname: #optional If x509 authentication is in use, the Distinguished
837 # Name of the client.
839 # @sasl_username: #optional If SASL authentication is in use, the SASL username
840 # used for authentication.
844 { 'struct': 'VncClientInfo',
845 'base': 'VncBasicInfo',
846 'data': { '*x509_dname': 'str', '*sasl_username': 'str' } }
851 # Information about the VNC session.
853 # @enabled: true if the VNC server is enabled, false otherwise
855 # @host: #optional The hostname the VNC server is bound to. This depends on
856 # the name resolution on the host and may be an IP address.
858 # @family: #optional 'ipv6' if the host is listening for IPv6 connections
859 # 'ipv4' if the host is listening for IPv4 connections
860 # 'unix' if the host is listening on a unix domain socket
861 # 'unknown' otherwise
863 # @service: #optional The service name of the server's port. This may depends
864 # on the host system's service database so symbolic names should not
867 # @auth: #optional the current authentication type used by the server
868 # 'none' if no authentication is being used
869 # 'vnc' if VNC authentication is being used
870 # 'vencrypt+plain' if VEncrypt is used with plain text authentication
871 # 'vencrypt+tls+none' if VEncrypt is used with TLS and no authentication
872 # 'vencrypt+tls+vnc' if VEncrypt is used with TLS and VNC authentication
873 # 'vencrypt+tls+plain' if VEncrypt is used with TLS and plain text auth
874 # 'vencrypt+x509+none' if VEncrypt is used with x509 and no auth
875 # 'vencrypt+x509+vnc' if VEncrypt is used with x509 and VNC auth
876 # 'vencrypt+x509+plain' if VEncrypt is used with x509 and plain text auth
877 # 'vencrypt+tls+sasl' if VEncrypt is used with TLS and SASL auth
878 # 'vencrypt+x509+sasl' if VEncrypt is used with x509 and SASL auth
880 # @clients: a list of @VncClientInfo of all currently connected clients
884 { 'struct': 'VncInfo',
885 'data': {'enabled': 'bool', '*host': 'str',
886 '*family': 'NetworkAddressFamily',
887 '*service': 'str', '*auth': 'str', '*clients': ['VncClientInfo']} }
892 # vnc primary authentication method.
896 { 'enum': 'VncPrimaryAuth',
897 'data': [ 'none', 'vnc', 'ra2', 'ra2ne', 'tight', 'ultra',
898 'tls', 'vencrypt', 'sasl' ] }
901 # @VncVencryptSubAuth:
903 # vnc sub authentication method with vencrypt.
907 { 'enum': 'VncVencryptSubAuth',
909 'tls-none', 'x509-none',
910 'tls-vnc', 'x509-vnc',
911 'tls-plain', 'x509-plain',
912 'tls-sasl', 'x509-sasl' ] }
917 # Information about a vnc server
919 # @id: vnc server name.
921 # @server: A list of @VncBasincInfo describing all listening sockets.
922 # The list can be empty (in case the vnc server is disabled).
923 # It also may have multiple entries: normal + websocket,
924 # possibly also ipv4 + ipv6 in the future.
926 # @clients: A list of @VncClientInfo of all currently connected clients.
927 # The list can be empty, for obvious reasons.
929 # @auth: The current authentication type used by the server
931 # @vencrypt: #optional The vencrypt sub authentication type used by the server,
932 # only specified in case auth == vencrypt.
934 # @display: #optional The display device the vnc server is linked to.
938 { 'struct': 'VncInfo2',
939 'data': { 'id' : 'str',
940 'server' : ['VncBasicInfo'],
941 'clients' : ['VncClientInfo'],
942 'auth' : 'VncPrimaryAuth',
943 '*vencrypt' : 'VncVencryptSubAuth',
944 '*display' : 'str' } }
949 # Returns information about the current VNC server
955 { 'command': 'query-vnc', 'returns': 'VncInfo' }
958 # @query-vnc-servers:
960 # Returns a list of vnc servers. The list can be empty.
962 # Returns: a list of @VncInfo2
966 { 'command': 'query-vnc-servers', 'returns': ['VncInfo2'] }
971 # The basic information for SPICE network connection
977 # @family: address family
981 { 'struct': 'SpiceBasicInfo',
982 'data': { 'host': 'str',
984 'family': 'NetworkAddressFamily' } }
989 # Information about a SPICE server
991 # @auth: #optional, authentication method
995 { 'struct': 'SpiceServerInfo',
996 'base': 'SpiceBasicInfo',
997 'data': { '*auth': 'str' } }
1002 # Information about a SPICE client channel.
1004 # @connection-id: SPICE connection id number. All channels with the same id
1005 # belong to the same SPICE session.
1007 # @channel-type: SPICE channel type number. "1" is the main control
1008 # channel, filter for this one if you want to track spice
1011 # @channel-id: SPICE channel ID number. Usually "0", might be different when
1012 # multiple channels of the same type exist, such as multiple
1013 # display channels in a multihead setup
1015 # @tls: true if the channel is encrypted, false otherwise.
1019 { 'struct': 'SpiceChannel',
1020 'base': 'SpiceBasicInfo',
1021 'data': {'connection-id': 'int', 'channel-type': 'int', 'channel-id': 'int',
1025 # @SpiceQueryMouseMode
1027 # An enumeration of Spice mouse states.
1029 # @client: Mouse cursor position is determined by the client.
1031 # @server: Mouse cursor position is determined by the server.
1033 # @unknown: No information is available about mouse mode used by
1036 # Note: spice/enums.h has a SpiceMouseMode already, hence the name.
1040 { 'enum': 'SpiceQueryMouseMode',
1041 'data': [ 'client', 'server', 'unknown' ] }
1046 # Information about the SPICE session.
1048 # @enabled: true if the SPICE server is enabled, false otherwise
1050 # @migrated: true if the last guest migration completed and spice
1051 # migration had completed as well. false otherwise.
1053 # @host: #optional The hostname the SPICE server is bound to. This depends on
1054 # the name resolution on the host and may be an IP address.
1056 # @port: #optional The SPICE server's port number.
1058 # @compiled-version: #optional SPICE server version.
1060 # @tls-port: #optional The SPICE server's TLS port number.
1062 # @auth: #optional the current authentication type used by the server
1063 # 'none' if no authentication is being used
1064 # 'spice' uses SASL or direct TLS authentication, depending on command
1067 # @mouse-mode: The mode in which the mouse cursor is displayed currently. Can
1068 # be determined by the client or the server, or unknown if spice
1069 # server doesn't provide this information.
1073 # @channels: a list of @SpiceChannel for each active spice channel
1077 { 'struct': 'SpiceInfo',
1078 'data': {'enabled': 'bool', 'migrated': 'bool', '*host': 'str', '*port': 'int',
1079 '*tls-port': 'int', '*auth': 'str', '*compiled-version': 'str',
1080 'mouse-mode': 'SpiceQueryMouseMode', '*channels': ['SpiceChannel']} }
1085 # Returns information about the current SPICE server
1087 # Returns: @SpiceInfo
1091 { 'command': 'query-spice', 'returns': 'SpiceInfo' }
1096 # Information about the guest balloon device.
1098 # @actual: the number of bytes the balloon currently contains
1103 { 'struct': 'BalloonInfo', 'data': {'actual': 'int' } }
1108 # Return information about the balloon device.
1110 # Returns: @BalloonInfo on success
1111 # If the balloon driver is enabled but not functional because the KVM
1112 # kernel module cannot support it, KvmMissingCap
1113 # If no balloon device is present, DeviceNotActive
1117 { 'command': 'query-balloon', 'returns': 'BalloonInfo' }
1122 # A PCI device memory region
1124 # @base: the starting address (guest physical)
1126 # @limit: the ending address (guest physical)
1130 { 'struct': 'PciMemoryRange', 'data': {'base': 'int', 'limit': 'int'} }
1135 # Information about a PCI device I/O region.
1137 # @bar: the index of the Base Address Register for this region
1139 # @type: 'io' if the region is a PIO region
1140 # 'memory' if the region is a MMIO region
1142 # @prefetch: #optional if @type is 'memory', true if the memory is prefetchable
1144 # @mem_type_64: #optional if @type is 'memory', true if the BAR is 64-bit
1148 { 'struct': 'PciMemoryRegion',
1149 'data': {'bar': 'int', 'type': 'str', 'address': 'int', 'size': 'int',
1150 '*prefetch': 'bool', '*mem_type_64': 'bool' } }
1155 # Information about a bus of a PCI Bridge device
1157 # @number: primary bus interface number. This should be the number of the
1158 # bus the device resides on.
1160 # @secondary: secondary bus interface number. This is the number of the
1161 # main bus for the bridge
1163 # @subordinate: This is the highest number bus that resides below the
1166 # @io_range: The PIO range for all devices on this bridge
1168 # @memory_range: The MMIO range for all devices on this bridge
1170 # @prefetchable_range: The range of prefetchable MMIO for all devices on
1175 { 'struct': 'PciBusInfo',
1176 'data': {'number': 'int', 'secondary': 'int', 'subordinate': 'int',
1177 'io_range': 'PciMemoryRange',
1178 'memory_range': 'PciMemoryRange',
1179 'prefetchable_range': 'PciMemoryRange' } }
1184 # Information about a PCI Bridge device
1186 # @bus: information about the bus the device resides on
1188 # @devices: a list of @PciDeviceInfo for each device on this bridge
1192 { 'struct': 'PciBridgeInfo',
1193 'data': {'bus': 'PciBusInfo', '*devices': ['PciDeviceInfo']} }
1198 # Information about the Class of a PCI device
1200 # @desc: #optional a string description of the device's class
1202 # @class: the class code of the device
1206 { 'struct': 'PciDeviceClass',
1207 'data': {'*desc': 'str', 'class': 'int'} }
1212 # Information about the Id of a PCI device
1214 # @device: the PCI device id
1216 # @vendor: the PCI vendor id
1220 { 'struct': 'PciDeviceId',
1221 'data': {'device': 'int', 'vendor': 'int'} }
1226 # Information about a PCI device
1228 # @bus: the bus number of the device
1230 # @slot: the slot the device is located in
1232 # @function: the function of the slot used by the device
1234 # @class_info: the class of the device
1236 # @id: the PCI device id
1238 # @irq: #optional if an IRQ is assigned to the device, the IRQ number
1240 # @qdev_id: the device name of the PCI device
1242 # @pci_bridge: if the device is a PCI bridge, the bridge information
1244 # @regions: a list of the PCI I/O regions associated with the device
1246 # Notes: the contents of @class_info.desc are not stable and should only be
1247 # treated as informational.
1251 { 'struct': 'PciDeviceInfo',
1252 'data': {'bus': 'int', 'slot': 'int', 'function': 'int',
1253 'class_info': 'PciDeviceClass', 'id': 'PciDeviceId',
1254 '*irq': 'int', 'qdev_id': 'str', '*pci_bridge': 'PciBridgeInfo',
1255 'regions': ['PciMemoryRegion']} }
1260 # Information about a PCI bus
1262 # @bus: the bus index
1264 # @devices: a list of devices on this bus
1268 { 'struct': 'PciInfo', 'data': {'bus': 'int', 'devices': ['PciDeviceInfo']} }
1273 # Return information about the PCI bus topology of the guest.
1275 # Returns: a list of @PciInfo for each PCI bus
1279 { 'command': 'query-pci', 'returns': ['PciInfo'] }
1284 # This command will cause the QEMU process to exit gracefully. While every
1285 # attempt is made to send the QMP response before terminating, this is not
1286 # guaranteed. When using this interface, a premature EOF would not be
1291 { 'command': 'quit' }
1296 # Stop all guest VCPU execution.
1300 # Notes: This function will succeed even if the guest is already in the stopped
1301 # state. In "inmigrate" state, it will ensure that the guest
1302 # remains paused once migration finishes, as if the -S option was
1303 # passed on the command line.
1305 { 'command': 'stop' }
1310 # Performs a hard reset of a guest.
1314 { 'command': 'system_reset' }
1317 # @system_powerdown:
1319 # Requests that a guest perform a powerdown operation.
1323 # Notes: A guest may or may not respond to this command. This command
1324 # returning does not indicate that a guest has accepted the request or
1325 # that it has shut down. Many guests will respond to this command by
1326 # prompting the user in some way.
1328 { 'command': 'system_powerdown' }
1333 # This command is a nop that is only provided for the purposes of compatibility.
1337 # Notes: Do not use this command.
1339 { 'command': 'cpu', 'data': {'index': 'int'} }
1344 # Adds CPU with specified ID
1346 # @id: ID of CPU to be created, valid values [0..max_cpus)
1348 # Returns: Nothing on success
1352 { 'command': 'cpu-add', 'data': {'id': 'int'} }
1357 # Save a portion of guest memory to a file.
1359 # @val: the virtual address of the guest to start from
1361 # @size: the size of memory region to save
1363 # @filename: the file to save the memory to as binary data
1365 # @cpu-index: #optional the index of the virtual CPU to use for translating the
1366 # virtual address (defaults to CPU 0)
1368 # Returns: Nothing on success
1372 # Notes: Errors were not reliably returned until 1.1
1374 { 'command': 'memsave',
1375 'data': {'val': 'int', 'size': 'int', 'filename': 'str', '*cpu-index': 'int'} }
1380 # Save a portion of guest physical memory to a file.
1382 # @val: the physical address of the guest to start from
1384 # @size: the size of memory region to save
1386 # @filename: the file to save the memory to as binary data
1388 # Returns: Nothing on success
1392 # Notes: Errors were not reliably returned until 1.1
1394 { 'command': 'pmemsave',
1395 'data': {'val': 'int', 'size': 'int', 'filename': 'str'} }
1400 # Resume guest VCPU execution.
1404 # Returns: If successful, nothing
1405 # If QEMU was started with an encrypted block device and a key has
1406 # not yet been set, DeviceEncrypted.
1408 # Notes: This command will succeed if the guest is currently running. It
1409 # will also succeed if the guest is in the "inmigrate" state; in
1410 # this case, the effect of the command is to make sure the guest
1411 # starts once migration finishes, removing the effect of the -S
1412 # command line option if it was passed.
1414 { 'command': 'cont' }
1419 # Wakeup guest from suspend. Does nothing in case the guest isn't suspended.
1425 { 'command': 'system_wakeup' }
1430 # Injects a Non-Maskable Interrupt into the default CPU (x86/s390) or all CPUs (ppc64).
1432 # Returns: If successful, nothing
1436 # Note: prior to 2.1, this command was only supported for x86 and s390 VMs
1438 { 'command': 'inject-nmi' }
1443 # Sets the link status of a virtual network adapter.
1445 # @name: the device name of the virtual network adapter
1447 # @up: true to set the link status to be up
1449 # Returns: Nothing on success
1450 # If @name is not a valid network device, DeviceNotFound
1454 # Notes: Not all network adapters support setting link status. This command
1455 # will succeed even if the network adapter does not support link status
1458 { 'command': 'set_link', 'data': {'name': 'str', 'up': 'bool'} }
1463 # Request the balloon driver to change its balloon size.
1465 # @value: the target size of the balloon in bytes
1467 # Returns: Nothing on success
1468 # If the balloon driver is enabled but not functional because the KVM
1469 # kernel module cannot support it, KvmMissingCap
1470 # If no balloon device is present, DeviceNotActive
1472 # Notes: This command just issues a request to the guest. When it returns,
1473 # the balloon size may not have changed. A guest can change the balloon
1474 # size independent of this command.
1478 { 'command': 'balloon', 'data': {'value': 'int'} }
1483 # This action can be used to test transaction failure.
1487 { 'struct': 'Abort',
1491 # @TransactionAction
1493 # A discriminated record of operations that can be performed with
1498 # drive-backup since 1.6
1500 # blockdev-snapshot-internal-sync since 1.7
1501 # blockdev-backup since 2.3
1503 { 'union': 'TransactionAction',
1505 'blockdev-snapshot-sync': 'BlockdevSnapshot',
1506 'drive-backup': 'DriveBackup',
1507 'blockdev-backup': 'BlockdevBackup',
1509 'blockdev-snapshot-internal-sync': 'BlockdevSnapshotInternal'
1515 # Executes a number of transactionable QMP commands atomically. If any
1516 # operation fails, then the entire set of actions will be abandoned and the
1517 # appropriate error returned.
1520 # @TransactionAction: information needed for the respective operation
1522 # Returns: nothing on success
1523 # Errors depend on the operations of the transaction
1525 # Note: The transaction aborts on the first failure. Therefore, there will be
1526 # information on only one failed operation returned in an error condition, and
1527 # subsequent actions will not have been attempted.
1531 { 'command': 'transaction',
1532 'data': { 'actions': [ 'TransactionAction' ] } }
1535 # @human-monitor-command:
1537 # Execute a command on the human monitor and return the output.
1539 # @command-line: the command to execute in the human monitor
1541 # @cpu-index: #optional The CPU to use for commands that require an implicit CPU
1543 # Returns: the output of the command as a string
1547 # Notes: This command only exists as a stop-gap. Its use is highly
1548 # discouraged. The semantics of this command are not guaranteed.
1550 # Known limitations:
1552 # o This command is stateless, this means that commands that depend
1553 # on state information (such as getfd) might not work
1555 # o Commands that prompt the user for data (eg. 'cont' when the block
1556 # device is encrypted) don't currently work
1558 { 'command': 'human-monitor-command',
1559 'data': {'command-line': 'str', '*cpu-index': 'int'},
1565 # Cancel the current executing migration process.
1567 # Returns: nothing on success
1569 # Notes: This command succeeds even if there is no migration process running.
1573 { 'command': 'migrate_cancel' }
1576 # @migrate_set_downtime
1578 # Set maximum tolerated downtime for migration.
1580 # @value: maximum downtime in seconds
1582 # Returns: nothing on success
1586 { 'command': 'migrate_set_downtime', 'data': {'value': 'number'} }
1589 # @migrate_set_speed
1591 # Set maximum speed for migration.
1593 # @value: maximum speed in bytes.
1595 # Returns: nothing on success
1597 # Notes: A value lesser than zero will be automatically round up to zero.
1601 { 'command': 'migrate_set_speed', 'data': {'value': 'int'} }
1604 # @migrate-set-cache-size
1606 # Set XBZRLE cache size
1608 # @value: cache size in bytes
1610 # The size will be rounded down to the nearest power of 2.
1611 # The cache size can be modified before and during ongoing migration
1613 # Returns: nothing on success
1617 { 'command': 'migrate-set-cache-size', 'data': {'value': 'int'} }
1620 # @query-migrate-cache-size
1622 # query XBZRLE cache size
1624 # Returns: XBZRLE cache size in bytes
1628 { 'command': 'query-migrate-cache-size', 'returns': 'int' }
1631 # @ObjectPropertyInfo:
1633 # @name: the name of the property
1635 # @type: the type of the property. This will typically come in one of four
1638 # 1) A primitive type such as 'u8', 'u16', 'bool', 'str', or 'double'.
1639 # These types are mapped to the appropriate JSON type.
1641 # 2) A child type in the form 'child<subtype>' where subtype is a qdev
1642 # device type name. Child properties create the composition tree.
1644 # 3) A link type in the form 'link<subtype>' where subtype is a qdev
1645 # device type name. Link properties form the device model graph.
1649 { 'struct': 'ObjectPropertyInfo',
1650 'data': { 'name': 'str', 'type': 'str' } }
1655 # This command will list any properties of a object given a path in the object
1658 # @path: the path within the object model. See @qom-get for a description of
1661 # Returns: a list of @ObjectPropertyInfo that describe the properties of the
1666 { 'command': 'qom-list',
1667 'data': { 'path': 'str' },
1668 'returns': [ 'ObjectPropertyInfo' ] }
1673 # This command will get a property from a object model path and return the
1676 # @path: The path within the object model. There are two forms of supported
1677 # paths--absolute and partial paths.
1679 # Absolute paths are derived from the root object and can follow child<>
1680 # or link<> properties. Since they can follow link<> properties, they
1681 # can be arbitrarily long. Absolute paths look like absolute filenames
1682 # and are prefixed with a leading slash.
1684 # Partial paths look like relative filenames. They do not begin
1685 # with a prefix. The matching rules for partial paths are subtle but
1686 # designed to make specifying objects easy. At each level of the
1687 # composition tree, the partial path is matched as an absolute path.
1688 # The first match is not returned. At least two matches are searched
1689 # for. A successful result is only returned if only one match is
1690 # found. If more than one match is found, a flag is return to
1691 # indicate that the match was ambiguous.
1693 # @property: The property name to read
1695 # Returns: The property value. The type depends on the property
1696 # type. child<> and link<> properties are returned as #str
1697 # pathnames. All integer property types (u8, u16, etc) are
1702 { 'command': 'qom-get',
1703 'data': { 'path': 'str', 'property': 'str' },
1709 # This command will set a property from a object model path.
1711 # @path: see @qom-get for a description of this parameter
1713 # @property: the property name to set
1715 # @value: a value who's type is appropriate for the property type. See @qom-get
1716 # for a description of type mapping.
1720 { 'command': 'qom-set',
1721 'data': { 'path': 'str', 'property': 'str', 'value': 'any' } }
1726 # Sets the password of a remote display session.
1728 # @protocol: `vnc' to modify the VNC server password
1729 # `spice' to modify the Spice server password
1731 # @password: the new password
1733 # @connected: #optional how to handle existing clients when changing the
1734 # password. If nothing is specified, defaults to `keep'
1735 # `fail' to fail the command if clients are connected
1736 # `disconnect' to disconnect existing clients
1737 # `keep' to maintain existing clients
1739 # Returns: Nothing on success
1740 # If Spice is not enabled, DeviceNotFound
1744 { 'command': 'set_password',
1745 'data': {'protocol': 'str', 'password': 'str', '*connected': 'str'} }
1750 # Expire the password of a remote display server.
1752 # @protocol: the name of the remote display protocol `vnc' or `spice'
1754 # @time: when to expire the password.
1755 # `now' to expire the password immediately
1756 # `never' to cancel password expiration
1757 # `+INT' where INT is the number of seconds from now (integer)
1758 # `INT' where INT is the absolute time in seconds
1760 # Returns: Nothing on success
1761 # If @protocol is `spice' and Spice is not active, DeviceNotFound
1765 # Notes: Time is relative to the server and currently there is no way to
1766 # coordinate server time with client time. It is not recommended to
1767 # use the absolute time version of the @time parameter unless you're
1768 # sure you are on the same machine as the QEMU instance.
1770 { 'command': 'expire_password', 'data': {'protocol': 'str', 'time': 'str'} }
1773 # @change-vnc-password:
1775 # Change the VNC server password.
1777 # @password: the new password to use with VNC authentication
1781 # Notes: An empty password in this command will set the password to the empty
1782 # string. Existing clients are unaffected by executing this command.
1784 { 'command': 'change-vnc-password', 'data': {'password': 'str'} }
1789 # This command is multiple commands multiplexed together.
1791 # @device: This is normally the name of a block device but it may also be 'vnc'.
1792 # when it's 'vnc', then sub command depends on @target
1794 # @target: If @device is a block device, then this is the new filename.
1795 # If @device is 'vnc', then if the value 'password' selects the vnc
1796 # change password command. Otherwise, this specifies a new server URI
1797 # address to listen to for VNC connections.
1799 # @arg: If @device is a block device, then this is an optional format to open
1801 # If @device is 'vnc' and @target is 'password', this is the new VNC
1802 # password to set. If this argument is an empty string, then no future
1803 # logins will be allowed.
1805 # Returns: Nothing on success.
1806 # If @device is not a valid block device, DeviceNotFound
1807 # If the new block device is encrypted, DeviceEncrypted. Note that
1808 # if this error is returned, the device has been opened successfully
1809 # and an additional call to @block_passwd is required to set the
1810 # device's password. The behavior of reads and writes to the block
1811 # device between when these calls are executed is undefined.
1813 # Notes: It is strongly recommended that this interface is not used especially
1814 # for changing block devices.
1818 { 'command': 'change',
1819 'data': {'device': 'str', 'target': 'str', '*arg': 'str'} }
1824 # This structure describes a search result from @qom-list-types
1826 # @name: the type name found in the search
1830 # Notes: This command is experimental and may change syntax in future releases.
1832 { 'struct': 'ObjectTypeInfo',
1833 'data': { 'name': 'str' } }
1838 # This command will return a list of types given search parameters
1840 # @implements: if specified, only return types that implement this type name
1842 # @abstract: if true, include abstract types in the results
1844 # Returns: a list of @ObjectTypeInfo or an empty list if no results are found
1848 { 'command': 'qom-list-types',
1849 'data': { '*implements': 'str', '*abstract': 'bool' },
1850 'returns': [ 'ObjectTypeInfo' ] }
1853 # @DevicePropertyInfo:
1855 # Information about device properties.
1857 # @name: the name of the property
1858 # @type: the typename of the property
1859 # @description: #optional if specified, the description of the property.
1864 { 'struct': 'DevicePropertyInfo',
1865 'data': { 'name': 'str', 'type': 'str', '*description': 'str' } }
1868 # @device-list-properties:
1870 # List properties associated with a device.
1872 # @typename: the type name of a device
1874 # Returns: a list of DevicePropertyInfo describing a devices properties
1878 { 'command': 'device-list-properties',
1879 'data': { 'typename': 'str'},
1880 'returns': [ 'DevicePropertyInfo' ] }
1885 # Migrates the current running guest to another Virtual Machine.
1887 # @uri: the Uniform Resource Identifier of the destination VM
1889 # @blk: #optional do block migration (full disk copy)
1891 # @inc: #optional incremental disk copy migration
1893 # @detach: this argument exists only for compatibility reasons and
1894 # is ignored by QEMU
1896 # Returns: nothing on success
1900 { 'command': 'migrate',
1901 'data': {'uri': 'str', '*blk': 'bool', '*inc': 'bool', '*detach': 'bool' } }
1906 # Start an incoming migration, the qemu must have been started
1907 # with -incoming defer
1909 # @uri: The Uniform Resource Identifier identifying the source or
1910 # address to listen on
1912 # Returns: nothing on success
1915 # Note: It's a bad idea to use a string for the uri, but it needs to stay
1916 # compatible with -incoming and the format of the uri is already exposed
1919 { 'command': 'migrate-incoming', 'data': {'uri': 'str' } }
1921 # @xen-save-devices-state:
1923 # Save the state of all devices to file. The RAM and the block devices
1924 # of the VM are not saved by this command.
1926 # @filename: the file to save the state of the devices to as binary
1927 # data. See xen-save-devices-state.txt for a description of the binary
1930 # Returns: Nothing on success
1934 { 'command': 'xen-save-devices-state', 'data': {'filename': 'str'} }
1937 # @xen-set-global-dirty-log
1939 # Enable or disable the global dirty log mode.
1941 # @enable: true to enable, false to disable.
1947 { 'command': 'xen-set-global-dirty-log', 'data': { 'enable': 'bool' } }
1952 # Remove a device from a guest
1954 # @id: the name or QOM path of the device
1956 # Returns: Nothing on success
1957 # If @id is not a valid device, DeviceNotFound
1959 # Notes: When this command completes, the device may not be removed from the
1960 # guest. Hot removal is an operation that requires guest cooperation.
1961 # This command merely requests that the guest begin the hot removal
1962 # process. Completion of the device removal process is signaled with a
1963 # DEVICE_DELETED event. Guest reset will automatically complete removal
1968 { 'command': 'device_del', 'data': {'id': 'str'} }
1971 # @DumpGuestMemoryFormat:
1973 # An enumeration of guest-memory-dump's format.
1977 # @kdump-zlib: kdump-compressed format with zlib-compressed
1979 # @kdump-lzo: kdump-compressed format with lzo-compressed
1981 # @kdump-snappy: kdump-compressed format with snappy-compressed
1985 { 'enum': 'DumpGuestMemoryFormat',
1986 'data': [ 'elf', 'kdump-zlib', 'kdump-lzo', 'kdump-snappy' ] }
1989 # @dump-guest-memory
1991 # Dump guest's memory to vmcore. It is a synchronous operation that can take
1992 # very long depending on the amount of guest memory. This command is only
1993 # supported on i386 and x86_64.
1995 # @paging: if true, do paging to get guest's memory mapping. This allows
1996 # using gdb to process the core file.
1998 # IMPORTANT: this option can make QEMU allocate several gigabytes
1999 # of RAM. This can happen for a large guest, or a
2000 # malicious guest pretending to be large.
2002 # Also, paging=true has the following limitations:
2004 # 1. The guest may be in a catastrophic state or can have corrupted
2005 # memory, which cannot be trusted
2006 # 2. The guest can be in real-mode even if paging is enabled. For
2007 # example, the guest uses ACPI to sleep, and ACPI sleep state
2010 # @protocol: the filename or file descriptor of the vmcore. The supported
2013 # 1. file: the protocol starts with "file:", and the following
2014 # string is the file's path.
2015 # 2. fd: the protocol starts with "fd:", and the following string
2018 # @begin: #optional if specified, the starting physical address.
2020 # @length: #optional if specified, the memory size, in bytes. If you don't
2021 # want to dump all guest's memory, please specify the start @begin
2024 # @format: #optional if specified, the format of guest memory dump. But non-elf
2025 # format is conflict with paging and filter, ie. @paging, @begin and
2026 # @length is not allowed to be specified with non-elf @format at the
2027 # same time (since 2.0)
2029 # Returns: nothing on success
2033 { 'command': 'dump-guest-memory',
2034 'data': { 'paging': 'bool', 'protocol': 'str', '*begin': 'int',
2035 '*length': 'int', '*format': 'DumpGuestMemoryFormat' } }
2038 # @DumpGuestMemoryCapability:
2040 # A list of the available formats for dump-guest-memory
2044 { 'struct': 'DumpGuestMemoryCapability',
2046 'formats': ['DumpGuestMemoryFormat'] } }
2049 # @query-dump-guest-memory-capability:
2051 # Returns the available formats for dump-guest-memory
2053 # Returns: A @DumpGuestMemoryCapability object listing available formats for
2058 { 'command': 'query-dump-guest-memory-capability',
2059 'returns': 'DumpGuestMemoryCapability' }
2064 # Dump guest's storage keys
2066 # @filename: the path to the file to dump to
2068 # This command is only supported on s390 architecture.
2072 { 'command': 'dump-skeys',
2073 'data': { 'filename': 'str' } }
2078 # Add a network backend.
2080 # @type: the type of network backend. Current valid values are 'user', 'tap',
2081 # 'vde', 'socket', 'dump' and 'bridge'
2083 # @id: the name of the new network backend
2085 # Additional arguments depend on the type.
2087 # TODO This command effectively bypasses QAPI completely due to its
2088 # "additional arguments" business. It shouldn't have been added to
2089 # the schema in this form. It should be qapified properly, or
2090 # replaced by a properly qapified command.
2094 # Returns: Nothing on success
2095 # If @type is not a valid network backend, DeviceNotFound
2097 { 'command': 'netdev_add',
2098 'data': {'type': 'str', 'id': 'str'},
2099 'gen': false } # so we can get the additional arguments
2104 # Remove a network backend.
2106 # @id: the name of the network backend to remove
2108 # Returns: Nothing on success
2109 # If @id is not a valid network backend, DeviceNotFound
2113 { 'command': 'netdev_del', 'data': {'id': 'str'} }
2118 # Create a QOM object.
2120 # @qom-type: the class name for the object to be created
2122 # @id: the name of the new object
2124 # @props: #optional a dictionary of properties to be passed to the backend
2126 # Returns: Nothing on success
2127 # Error if @qom-type is not a valid class name
2131 { 'command': 'object-add',
2132 'data': {'qom-type': 'str', 'id': 'str', '*props': 'any'} }
2137 # Remove a QOM object.
2139 # @id: the name of the QOM object to remove
2141 # Returns: Nothing on success
2142 # Error if @id is not a valid id for a QOM object
2146 { 'command': 'object-del', 'data': {'id': 'str'} }
2149 # @NetdevNoneOptions
2151 # Use it alone to have zero network devices.
2155 { 'struct': 'NetdevNoneOptions',
2159 # @NetLegacyNicOptions
2161 # Create a new Network Interface Card.
2163 # @netdev: #optional id of -netdev to connect to
2165 # @macaddr: #optional MAC address
2167 # @model: #optional device model (e1000, rtl8139, virtio etc.)
2169 # @addr: #optional PCI device address
2171 # @vectors: #optional number of MSI-x vectors, 0 to disable MSI-X
2175 { 'struct': 'NetLegacyNicOptions',
2181 '*vectors': 'uint32' } }
2186 # A fat type wrapping 'str', to be embedded in lists.
2190 { 'struct': 'String',
2195 # @NetdevUserOptions
2197 # Use the user mode network stack which requires no administrator privilege to
2200 # @hostname: #optional client hostname reported by the builtin DHCP server
2202 # @restrict: #optional isolate the guest from the host
2204 # @ip: #optional legacy parameter, use net= instead
2206 # @net: #optional IP address and optional netmask
2208 # @host: #optional guest-visible address of the host
2210 # @tftp: #optional root directory of the built-in TFTP server
2212 # @bootfile: #optional BOOTP filename, for use with tftp=
2214 # @dhcpstart: #optional the first of the 16 IPs the built-in DHCP server can
2217 # @dns: #optional guest-visible address of the virtual nameserver
2219 # @dnssearch: #optional list of DNS suffixes to search, passed as DHCP option
2222 # @smb: #optional root directory of the built-in SMB server
2224 # @smbserver: #optional IP address of the built-in SMB server
2226 # @hostfwd: #optional redirect incoming TCP or UDP host connections to guest
2229 # @guestfwd: #optional forward guest TCP connections
2233 { 'struct': 'NetdevUserOptions',
2236 '*restrict': 'bool',
2242 '*dhcpstart': 'str',
2244 '*dnssearch': ['String'],
2246 '*smbserver': 'str',
2247 '*hostfwd': ['String'],
2248 '*guestfwd': ['String'] } }
2253 # Connect the host TAP network interface name to the VLAN.
2255 # @ifname: #optional interface name
2257 # @fd: #optional file descriptor of an already opened tap
2259 # @fds: #optional multiple file descriptors of already opened multiqueue capable
2262 # @script: #optional script to initialize the interface
2264 # @downscript: #optional script to shut down the interface
2266 # @helper: #optional command to execute to configure bridge
2268 # @sndbuf: #optional send buffer limit. Understands [TGMKkb] suffixes.
2270 # @vnet_hdr: #optional enable the IFF_VNET_HDR flag on the tap interface
2272 # @vhost: #optional enable vhost-net network accelerator
2274 # @vhostfd: #optional file descriptor of an already opened vhost net device
2276 # @vhostfds: #optional file descriptors of multiple already opened vhost net
2279 # @vhostforce: #optional vhost on for non-MSIX virtio guests
2281 # @queues: #optional number of queues to be created for multiqueue capable tap
2285 { 'struct': 'NetdevTapOptions',
2291 '*downscript': 'str',
2294 '*vnet_hdr': 'bool',
2298 '*vhostforce': 'bool',
2299 '*queues': 'uint32'} }
2302 # @NetdevSocketOptions
2304 # Connect the VLAN to a remote VLAN in another QEMU virtual machine using a TCP
2305 # socket connection.
2307 # @fd: #optional file descriptor of an already opened socket
2309 # @listen: #optional port number, and optional hostname, to listen on
2311 # @connect: #optional port number, and optional hostname, to connect to
2313 # @mcast: #optional UDP multicast address and port number
2315 # @localaddr: #optional source address and port for multicast and udp packets
2317 # @udp: #optional UDP unicast address and port number
2321 { 'struct': 'NetdevSocketOptions',
2327 '*localaddr': 'str',
2331 # @NetdevL2TPv3Options
2333 # Connect the VLAN to Ethernet over L2TPv3 Static tunnel
2335 # @src: source address
2337 # @dst: destination address
2339 # @srcport: #optional source port - mandatory for udp, optional for ip
2341 # @dstport: #optional destination port - mandatory for udp, optional for ip
2343 # @ipv6: #optional - force the use of ipv6
2345 # @udp: #optional - use the udp version of l2tpv3 encapsulation
2347 # @cookie64: #optional - use 64 bit coookies
2349 # @counter: #optional have sequence counter
2351 # @pincounter: #optional pin sequence counter to zero -
2352 # workaround for buggy implementations or
2353 # networks with packet reorder
2355 # @txcookie: #optional 32 or 64 bit transmit cookie
2357 # @rxcookie: #optional 32 or 64 bit receive cookie
2359 # @txsession: 32 bit transmit session
2361 # @rxsession: #optional 32 bit receive session - if not specified
2362 # set to the same value as transmit
2364 # @offset: #optional additional offset - allows the insertion of
2365 # additional application-specific data before the packet payload
2369 { 'struct': 'NetdevL2TPv3Options',
2377 '*cookie64': 'bool',
2379 '*pincounter': 'bool',
2380 '*txcookie': 'uint64',
2381 '*rxcookie': 'uint64',
2382 'txsession': 'uint32',
2383 '*rxsession': 'uint32',
2384 '*offset': 'uint32' } }
2389 # Connect the VLAN to a vde switch running on the host.
2391 # @sock: #optional socket path
2393 # @port: #optional port number
2395 # @group: #optional group owner of socket
2397 # @mode: #optional permissions for socket
2401 { 'struct': 'NetdevVdeOptions',
2406 '*mode': 'uint16' } }
2409 # @NetdevDumpOptions
2411 # Dump VLAN network traffic to a file.
2413 # @len: #optional per-packet size limit (64k default). Understands [TGMKkb]
2416 # @file: #optional dump file path (default is qemu-vlan0.pcap)
2420 { 'struct': 'NetdevDumpOptions',
2426 # @NetdevBridgeOptions
2428 # Connect a host TAP network interface to a host bridge device.
2430 # @br: #optional bridge name
2432 # @helper: #optional command to execute to configure bridge
2436 { 'struct': 'NetdevBridgeOptions',
2439 '*helper': 'str' } }
2442 # @NetdevHubPortOptions
2444 # Connect two or more net clients through a software hub.
2446 # @hubid: hub identifier number
2450 { 'struct': 'NetdevHubPortOptions',
2452 'hubid': 'int32' } }
2455 # @NetdevNetmapOptions
2457 # Connect a client to a netmap-enabled NIC or to a VALE switch port
2459 # @ifname: Either the name of an existing network interface supported by
2460 # netmap, or the name of a VALE port (created on the fly).
2461 # A VALE port name is in the form 'valeXXX:YYY', where XXX and
2462 # YYY are non-negative integers. XXX identifies a switch and
2463 # YYY identifies a port of the switch. VALE ports having the
2464 # same XXX are therefore connected to the same switch.
2466 # @devname: #optional path of the netmap device (default: '/dev/netmap').
2470 { 'struct': 'NetdevNetmapOptions',
2473 '*devname': 'str' } }
2476 # @NetdevVhostUserOptions
2478 # Vhost-user network backend
2480 # @chardev: name of a unix socket chardev
2482 # @vhostforce: #optional vhost on for non-MSIX virtio guests (default: false).
2486 { 'struct': 'NetdevVhostUserOptions',
2489 '*vhostforce': 'bool' } }
2494 # A discriminated record of network device traits.
2498 # 'l2tpv3' - since 2.1
2501 { 'union': 'NetClientOptions',
2503 'none': 'NetdevNoneOptions',
2504 'nic': 'NetLegacyNicOptions',
2505 'user': 'NetdevUserOptions',
2506 'tap': 'NetdevTapOptions',
2507 'l2tpv3': 'NetdevL2TPv3Options',
2508 'socket': 'NetdevSocketOptions',
2509 'vde': 'NetdevVdeOptions',
2510 'dump': 'NetdevDumpOptions',
2511 'bridge': 'NetdevBridgeOptions',
2512 'hubport': 'NetdevHubPortOptions',
2513 'netmap': 'NetdevNetmapOptions',
2514 'vhost-user': 'NetdevVhostUserOptions' } }
2519 # Captures the configuration of a network device; legacy.
2521 # @vlan: #optional vlan number
2523 # @id: #optional identifier for monitor commands
2525 # @name: #optional identifier for monitor commands, ignored if @id is present
2527 # @opts: device type specific properties (legacy)
2531 { 'struct': 'NetLegacy',
2536 'opts': 'NetClientOptions' } }
2541 # Captures the configuration of a network device.
2543 # @id: identifier for monitor commands.
2545 # @opts: device type specific properties
2549 { 'struct': 'Netdev',
2552 'opts': 'NetClientOptions' } }
2555 # @InetSocketAddress
2557 # Captures a socket address or address range in the Internet namespace.
2559 # @host: host part of the address
2561 # @port: port part of the address, or lowest port if @to is present
2563 # @to: highest port to try
2565 # @ipv4: whether to accept IPv4 addresses, default try both IPv4 and IPv6
2568 # @ipv6: whether to accept IPv6 addresses, default try both IPv4 and IPv6
2573 { 'struct': 'InetSocketAddress',
2582 # @UnixSocketAddress
2584 # Captures a socket address in the local ("Unix socket") namespace.
2586 # @path: filesystem path to use
2590 { 'struct': 'UnixSocketAddress',
2597 # Captures the address of a socket, which could also be a named file descriptor
2601 { 'union': 'SocketAddress',
2603 'inet': 'InetSocketAddress',
2604 'unix': 'UnixSocketAddress',
2610 # Receive a file descriptor via SCM rights and assign it a name
2612 # @fdname: file descriptor name
2614 # Returns: Nothing on success
2618 # Notes: If @fdname already exists, the file descriptor assigned to
2619 # it will be closed and replaced by the received file
2621 # The 'closefd' command can be used to explicitly close the
2622 # file descriptor when it is no longer needed.
2624 { 'command': 'getfd', 'data': {'fdname': 'str'} }
2629 # Close a file descriptor previously passed via SCM rights
2631 # @fdname: file descriptor name
2633 # Returns: Nothing on success
2637 { 'command': 'closefd', 'data': {'fdname': 'str'} }
2642 # Information describing a machine.
2644 # @name: the name of the machine
2646 # @alias: #optional an alias for the machine name
2648 # @default: #optional whether the machine is default
2650 # @cpu-max: maximum number of CPUs supported by the machine type
2655 { 'struct': 'MachineInfo',
2656 'data': { 'name': 'str', '*alias': 'str',
2657 '*is-default': 'bool', 'cpu-max': 'int' } }
2662 # Return a list of supported machines
2664 # Returns: a list of MachineInfo
2668 { 'command': 'query-machines', 'returns': ['MachineInfo'] }
2671 # @CpuDefinitionInfo:
2673 # Virtual CPU definition.
2675 # @name: the name of the CPU definition
2679 { 'struct': 'CpuDefinitionInfo',
2680 'data': { 'name': 'str' } }
2683 # @query-cpu-definitions:
2685 # Return a list of supported virtual CPU definitions
2687 # Returns: a list of CpuDefInfo
2691 { 'command': 'query-cpu-definitions', 'returns': ['CpuDefinitionInfo'] }
2695 # Information about a file descriptor that was added to an fd set.
2697 # @fdset-id: The ID of the fd set that @fd was added to.
2699 # @fd: The file descriptor that was received via SCM rights and
2700 # added to the fd set.
2704 { 'struct': 'AddfdInfo', 'data': {'fdset-id': 'int', 'fd': 'int'} }
2709 # Add a file descriptor, that was passed via SCM rights, to an fd set.
2711 # @fdset-id: #optional The ID of the fd set to add the file descriptor to.
2713 # @opaque: #optional A free-form string that can be used to describe the fd.
2715 # Returns: @AddfdInfo on success
2716 # If file descriptor was not received, FdNotSupplied
2717 # If @fdset-id is a negative value, InvalidParameterValue
2719 # Notes: The list of fd sets is shared by all monitor connections.
2721 # If @fdset-id is not specified, a new fd set will be created.
2725 { 'command': 'add-fd', 'data': {'*fdset-id': 'int', '*opaque': 'str'},
2726 'returns': 'AddfdInfo' }
2731 # Remove a file descriptor from an fd set.
2733 # @fdset-id: The ID of the fd set that the file descriptor belongs to.
2735 # @fd: #optional The file descriptor that is to be removed.
2737 # Returns: Nothing on success
2738 # If @fdset-id or @fd is not found, FdNotFound
2742 # Notes: The list of fd sets is shared by all monitor connections.
2744 # If @fd is not specified, all file descriptors in @fdset-id
2747 { 'command': 'remove-fd', 'data': {'fdset-id': 'int', '*fd': 'int'} }
2752 # Information about a file descriptor that belongs to an fd set.
2754 # @fd: The file descriptor value.
2756 # @opaque: #optional A free-form string that can be used to describe the fd.
2760 { 'struct': 'FdsetFdInfo',
2761 'data': {'fd': 'int', '*opaque': 'str'} }
2766 # Information about an fd set.
2768 # @fdset-id: The ID of the fd set.
2770 # @fds: A list of file descriptors that belong to this fd set.
2774 { 'struct': 'FdsetInfo',
2775 'data': {'fdset-id': 'int', 'fds': ['FdsetFdInfo']} }
2780 # Return information describing all fd sets.
2782 # Returns: A list of @FdsetInfo
2786 # Note: The list of fd sets is shared by all monitor connections.
2789 { 'command': 'query-fdsets', 'returns': ['FdsetInfo'] }
2794 # Information describing the QEMU target.
2796 # @arch: the target architecture (eg "x86_64", "i386", etc)
2800 { 'struct': 'TargetInfo',
2801 'data': { 'arch': 'str' } }
2806 # Return information about the target for this QEMU
2808 # Returns: TargetInfo
2812 { 'command': 'query-target', 'returns': 'TargetInfo' }
2817 # An enumeration of key name.
2819 # This is used by the send-key command.
2823 # 'unmapped' and 'pause' since 2.0
2824 # 'ro' and 'kp_comma' since 2.4
2826 { 'enum': 'QKeyCode',
2827 'data': [ 'unmapped',
2828 'shift', 'shift_r', 'alt', 'alt_r', 'altgr', 'altgr_r', 'ctrl',
2829 'ctrl_r', 'menu', 'esc', '1', '2', '3', '4', '5', '6', '7', '8',
2830 '9', '0', 'minus', 'equal', 'backspace', 'tab', 'q', 'w', 'e',
2831 'r', 't', 'y', 'u', 'i', 'o', 'p', 'bracket_left', 'bracket_right',
2832 'ret', 'a', 's', 'd', 'f', 'g', 'h', 'j', 'k', 'l', 'semicolon',
2833 'apostrophe', 'grave_accent', 'backslash', 'z', 'x', 'c', 'v', 'b',
2834 'n', 'm', 'comma', 'dot', 'slash', 'asterisk', 'spc', 'caps_lock',
2835 'f1', 'f2', 'f3', 'f4', 'f5', 'f6', 'f7', 'f8', 'f9', 'f10',
2836 'num_lock', 'scroll_lock', 'kp_divide', 'kp_multiply',
2837 'kp_subtract', 'kp_add', 'kp_enter', 'kp_decimal', 'sysrq', 'kp_0',
2838 'kp_1', 'kp_2', 'kp_3', 'kp_4', 'kp_5', 'kp_6', 'kp_7', 'kp_8',
2839 'kp_9', 'less', 'f11', 'f12', 'print', 'home', 'pgup', 'pgdn', 'end',
2840 'left', 'up', 'down', 'right', 'insert', 'delete', 'stop', 'again',
2841 'props', 'undo', 'front', 'copy', 'open', 'paste', 'find', 'cut',
2842 'lf', 'help', 'meta_l', 'meta_r', 'compose', 'pause', 'ro',
2848 # Represents a keyboard key.
2852 { 'union': 'KeyValue',
2855 'qcode': 'QKeyCode' } }
2860 # Send keys to guest.
2862 # @keys: An array of @KeyValue elements. All @KeyValues in this array are
2863 # simultaneously sent to the guest. A @KeyValue.number value is sent
2864 # directly to the guest, while @KeyValue.qcode must be a valid
2867 # @hold-time: #optional time to delay key up events, milliseconds. Defaults
2870 # Returns: Nothing on success
2871 # If key is unknown or redundant, InvalidParameter
2876 { 'command': 'send-key',
2877 'data': { 'keys': ['KeyValue'], '*hold-time': 'int' } }
2882 # Write a PPM of the VGA screen to a file.
2884 # @filename: the path of a new PPM file to store the image
2886 # Returns: Nothing on success
2890 { 'command': 'screendump', 'data': {'filename': 'str'} }
2895 # Configuration info for file chardevs.
2897 # @in: #optional The name of the input file
2898 # @out: The name of the output file
2902 { 'struct': 'ChardevFile', 'data': { '*in' : 'str',
2908 # Configuration info for device and pipe chardevs.
2910 # @device: The name of the special file for the device,
2911 # i.e. /dev/ttyS0 on Unix or COM1: on Windows
2912 # @type: What kind of device this is.
2916 { 'struct': 'ChardevHostdev', 'data': { 'device' : 'str' } }
2921 # Configuration info for (stream) socket chardevs.
2923 # @addr: socket address to listen on (server=true)
2924 # or connect to (server=false)
2925 # @server: #optional create server socket (default: true)
2926 # @wait: #optional wait for incoming connection on server
2927 # sockets (default: false).
2928 # @nodelay: #optional set TCP_NODELAY socket option (default: false)
2929 # @telnet: #optional enable telnet protocol on server
2930 # sockets (default: false)
2931 # @reconnect: #optional For a client socket, if a socket is disconnected,
2932 # then attempt a reconnect after the given number of seconds.
2933 # Setting this to zero disables this function. (default: 0)
2938 { 'struct': 'ChardevSocket', 'data': { 'addr' : 'SocketAddress',
2941 '*nodelay' : 'bool',
2943 '*reconnect' : 'int' } }
2948 # Configuration info for datagram socket chardevs.
2950 # @remote: remote address
2951 # @local: #optional local address
2955 { 'struct': 'ChardevUdp', 'data': { 'remote' : 'SocketAddress',
2956 '*local' : 'SocketAddress' } }
2961 # Configuration info for mux chardevs.
2963 # @chardev: name of the base chardev.
2967 { 'struct': 'ChardevMux', 'data': { 'chardev' : 'str' } }
2972 # Configuration info for stdio chardevs.
2974 # @signal: #optional Allow signals (such as SIGINT triggered by ^C)
2975 # be delivered to qemu. Default: true in -nographic mode,
2980 { 'struct': 'ChardevStdio', 'data': { '*signal' : 'bool' } }
2983 # @ChardevSpiceChannel:
2985 # Configuration info for spice vm channel chardevs.
2987 # @type: kind of channel (for example vdagent).
2991 { 'struct': 'ChardevSpiceChannel', 'data': { 'type' : 'str' } }
2994 # @ChardevSpicePort:
2996 # Configuration info for spice port chardevs.
2998 # @fqdn: name of the channel (see docs/spice-port-fqdn.txt)
3002 { 'struct': 'ChardevSpicePort', 'data': { 'fqdn' : 'str' } }
3007 # Configuration info for virtual console chardevs.
3009 # @width: console width, in pixels
3010 # @height: console height, in pixels
3011 # @cols: console width, in chars
3012 # @rows: console height, in chars
3016 { 'struct': 'ChardevVC', 'data': { '*width' : 'int',
3024 # Configuration info for ring buffer chardevs.
3026 # @size: #optional ring buffer size, must be power of two, default is 65536
3030 { 'struct': 'ChardevRingbuf', 'data': { '*size' : 'int' } }
3035 # Configuration info for the new chardev backend.
3037 # Since: 1.4 (testdev since 2.2)
3039 { 'struct': 'ChardevDummy', 'data': { } }
3041 { 'union': 'ChardevBackend', 'data': { 'file' : 'ChardevFile',
3042 'serial' : 'ChardevHostdev',
3043 'parallel': 'ChardevHostdev',
3044 'pipe' : 'ChardevHostdev',
3045 'socket' : 'ChardevSocket',
3046 'udp' : 'ChardevUdp',
3047 'pty' : 'ChardevDummy',
3048 'null' : 'ChardevDummy',
3049 'mux' : 'ChardevMux',
3050 'msmouse': 'ChardevDummy',
3051 'braille': 'ChardevDummy',
3052 'testdev': 'ChardevDummy',
3053 'stdio' : 'ChardevStdio',
3054 'console': 'ChardevDummy',
3055 'spicevmc' : 'ChardevSpiceChannel',
3056 'spiceport' : 'ChardevSpicePort',
3058 'ringbuf': 'ChardevRingbuf',
3059 # next one is just for compatibility
3060 'memory' : 'ChardevRingbuf' } }
3065 # Return info about the chardev backend just created.
3067 # @pty: #optional name of the slave pseudoterminal device, present if
3068 # and only if a chardev of type 'pty' was created
3072 { 'struct' : 'ChardevReturn', 'data': { '*pty' : 'str' } }
3077 # Add a character device backend
3079 # @id: the chardev's ID, must be unique
3080 # @backend: backend type and parameters
3082 # Returns: ChardevReturn.
3086 { 'command': 'chardev-add', 'data': {'id' : 'str',
3087 'backend' : 'ChardevBackend' },
3088 'returns': 'ChardevReturn' }
3093 # Remove a character device backend
3095 # @id: the chardev's ID, must exist and not be in use
3097 # Returns: Nothing on success
3101 { 'command': 'chardev-remove', 'data': {'id': 'str'} }
3106 # An enumeration of TPM models
3108 # @tpm-tis: TPM TIS model
3112 { 'enum': 'TpmModel', 'data': [ 'tpm-tis' ] }
3115 # @query-tpm-models:
3117 # Return a list of supported TPM models
3119 # Returns: a list of TpmModel
3123 { 'command': 'query-tpm-models', 'returns': ['TpmModel'] }
3128 # An enumeration of TPM types
3130 # @passthrough: TPM passthrough type
3134 { 'enum': 'TpmType', 'data': [ 'passthrough' ] }
3139 # Return a list of supported TPM types
3141 # Returns: a list of TpmType
3145 { 'command': 'query-tpm-types', 'returns': ['TpmType'] }
3148 # @TPMPassthroughOptions:
3150 # Information about the TPM passthrough type
3152 # @path: #optional string describing the path used for accessing the TPM device
3154 # @cancel-path: #optional string showing the TPM's sysfs cancel file
3155 # for cancellation of TPM commands while they are executing
3159 { 'struct': 'TPMPassthroughOptions', 'data': { '*path' : 'str',
3160 '*cancel-path' : 'str'} }
3165 # A union referencing different TPM backend types' configuration options
3167 # @passthrough: The configuration options for the TPM passthrough type
3171 { 'union': 'TpmTypeOptions',
3172 'data': { 'passthrough' : 'TPMPassthroughOptions' } }
3177 # Information about the TPM
3179 # @id: The Id of the TPM
3181 # @model: The TPM frontend model
3183 # @options: The TPM (backend) type configuration options
3187 { 'struct': 'TPMInfo',
3188 'data': {'id': 'str',
3189 'model': 'TpmModel',
3190 'options': 'TpmTypeOptions' } }
3195 # Return information about the TPM device
3197 # Returns: @TPMInfo on success
3201 { 'command': 'query-tpm', 'returns': ['TPMInfo'] }
3206 # Specify an ACPI table on the command line to load.
3208 # At most one of @file and @data can be specified. The list of files specified
3209 # by any one of them is loaded and concatenated in order. If both are omitted,
3212 # Other fields / optargs can be used to override fields of the generic ACPI
3213 # table header; refer to the ACPI specification 5.0, section 5.2.6 System
3214 # Description Table Header. If a header field is not overridden, then the
3215 # corresponding value from the concatenated blob is used (in case of @file), or
3216 # it is filled in with a hard-coded value (in case of @data).
3218 # String fields are copied into the matching ACPI member from lowest address
3219 # upwards, and silently truncated / NUL-padded to length.
3221 # @sig: #optional table signature / identifier (4 bytes)
3223 # @rev: #optional table revision number (dependent on signature, 1 byte)
3225 # @oem_id: #optional OEM identifier (6 bytes)
3227 # @oem_table_id: #optional OEM table identifier (8 bytes)
3229 # @oem_rev: #optional OEM-supplied revision number (4 bytes)
3231 # @asl_compiler_id: #optional identifier of the utility that created the table
3234 # @asl_compiler_rev: #optional revision number of the utility that created the
3237 # @file: #optional colon (:) separated list of pathnames to load and
3238 # concatenate as table data. The resultant binary blob is expected to
3239 # have an ACPI table header. At least one file is required. This field
3242 # @data: #optional colon (:) separated list of pathnames to load and
3243 # concatenate as table data. The resultant binary blob must not have an
3244 # ACPI table header. At least one file is required. This field excludes
3249 { 'struct': 'AcpiTableOptions',
3254 '*oem_table_id': 'str',
3255 '*oem_rev': 'uint32',
3256 '*asl_compiler_id': 'str',
3257 '*asl_compiler_rev': 'uint32',
3262 # @CommandLineParameterType:
3264 # Possible types for an option parameter.
3266 # @string: accepts a character string
3268 # @boolean: accepts "on" or "off"
3270 # @number: accepts a number
3272 # @size: accepts a number followed by an optional suffix (K)ilo,
3273 # (M)ega, (G)iga, (T)era
3277 { 'enum': 'CommandLineParameterType',
3278 'data': ['string', 'boolean', 'number', 'size'] }
3281 # @CommandLineParameterInfo:
3283 # Details about a single parameter of a command line option.
3285 # @name: parameter name
3287 # @type: parameter @CommandLineParameterType
3289 # @help: #optional human readable text string, not suitable for parsing.
3291 # @default: #optional default value string (since 2.1)
3295 { 'struct': 'CommandLineParameterInfo',
3296 'data': { 'name': 'str',
3297 'type': 'CommandLineParameterType',
3299 '*default': 'str' } }
3302 # @CommandLineOptionInfo:
3304 # Details about a command line option, including its list of parameter details
3306 # @option: option name
3308 # @parameters: an array of @CommandLineParameterInfo
3312 { 'struct': 'CommandLineOptionInfo',
3313 'data': { 'option': 'str', 'parameters': ['CommandLineParameterInfo'] } }
3316 # @query-command-line-options:
3318 # Query command line option schema.
3320 # @option: #optional option name
3322 # Returns: list of @CommandLineOptionInfo for all options (or for the given
3323 # @option). Returns an error if the given @option doesn't exist.
3327 {'command': 'query-command-line-options', 'data': { '*option': 'str' },
3328 'returns': ['CommandLineOptionInfo'] }
3333 # A X86 32-bit register
3337 { 'enum': 'X86CPURegister32',
3338 'data': [ 'EAX', 'EBX', 'ECX', 'EDX', 'ESP', 'EBP', 'ESI', 'EDI' ] }
3341 # @X86CPUFeatureWordInfo
3343 # Information about a X86 CPU feature word
3345 # @cpuid-input-eax: Input EAX value for CPUID instruction for that feature word
3347 # @cpuid-input-ecx: #optional Input ECX value for CPUID instruction for that
3350 # @cpuid-register: Output register containing the feature bits
3352 # @features: value of output register, containing the feature bits
3356 { 'struct': 'X86CPUFeatureWordInfo',
3357 'data': { 'cpuid-input-eax': 'int',
3358 '*cpuid-input-ecx': 'int',
3359 'cpuid-register': 'X86CPURegister32',
3360 'features': 'int' } }
3365 # Packets receiving state
3367 # @normal: filter assigned packets according to the mac-table
3369 # @none: don't receive any assigned packet
3371 # @all: receive all assigned packets
3375 { 'enum': 'RxState', 'data': [ 'normal', 'none', 'all' ] }
3380 # Rx-filter information for a NIC.
3382 # @name: net client name
3384 # @promiscuous: whether promiscuous mode is enabled
3386 # @multicast: multicast receive state
3388 # @unicast: unicast receive state
3390 # @vlan: vlan receive state (Since 2.0)
3392 # @broadcast-allowed: whether to receive broadcast
3394 # @multicast-overflow: multicast table is overflowed or not
3396 # @unicast-overflow: unicast table is overflowed or not
3398 # @main-mac: the main macaddr string
3400 # @vlan-table: a list of active vlan id
3402 # @unicast-table: a list of unicast macaddr string
3404 # @multicast-table: a list of multicast macaddr string
3409 { 'struct': 'RxFilterInfo',
3412 'promiscuous': 'bool',
3413 'multicast': 'RxState',
3414 'unicast': 'RxState',
3416 'broadcast-allowed': 'bool',
3417 'multicast-overflow': 'bool',
3418 'unicast-overflow': 'bool',
3420 'vlan-table': ['int'],
3421 'unicast-table': ['str'],
3422 'multicast-table': ['str'] }}
3427 # Return rx-filter information for all NICs (or for the given NIC).
3429 # @name: #optional net client name
3431 # Returns: list of @RxFilterInfo for all NICs (or for the given NIC).
3432 # Returns an error if the given @name doesn't exist, or given
3433 # NIC doesn't support rx-filter querying, or given net client
3438 { 'command': 'query-rx-filter', 'data': { '*name': 'str' },
3439 'returns': ['RxFilterInfo'] }
3444 # Button of a pointer input device (mouse, tablet).
3448 { 'enum' : 'InputButton',
3449 'data' : [ 'Left', 'Middle', 'Right', 'WheelUp', 'WheelDown' ] }
3454 # Position axis of a pointer input device (mouse, tablet).
3458 { 'enum' : 'InputAxis',
3459 'data' : [ 'X', 'Y' ] }
3464 # Keyboard input event.
3466 # @key: Which key this event is for.
3467 # @down: True for key-down and false for key-up events.
3471 { 'struct' : 'InputKeyEvent',
3472 'data' : { 'key' : 'KeyValue',
3478 # Pointer button input event.
3480 # @button: Which button this event is for.
3481 # @down: True for key-down and false for key-up events.
3485 { 'struct' : 'InputBtnEvent',
3486 'data' : { 'button' : 'InputButton',
3492 # Pointer motion input event.
3494 # @axis: Which axis is referenced by @value.
3495 # @value: Pointer position. For absolute coordinates the
3496 # valid range is 0 -> 0x7ffff
3500 { 'struct' : 'InputMoveEvent',
3501 'data' : { 'axis' : 'InputAxis',
3507 # Input event union.
3509 # @key: Input event of Keyboard
3510 # @btn: Input event of pointer buttons
3511 # @rel: Input event of relative pointer motion
3512 # @abs: Input event of absolute pointer motion
3516 { 'union' : 'InputEvent',
3517 'data' : { 'key' : 'InputKeyEvent',
3518 'btn' : 'InputBtnEvent',
3519 'rel' : 'InputMoveEvent',
3520 'abs' : 'InputMoveEvent' } }
3523 # @x-input-send-event
3525 # Send input event(s) to guest.
3527 # @console: #optional console to send event(s) to.
3528 # This parameter can be used to send the input event to
3529 # specific input devices in case (a) multiple input devices
3530 # of the same kind are added to the virtual machine and (b)
3531 # you have configured input routing (see docs/multiseat.txt)
3532 # for those input devices. If input routing is not
3533 # configured this parameter has no effect.
3534 # If @console is missing, only devices that aren't associated
3535 # with a console are admissible.
3536 # If @console is specified, it must exist, and both devices
3537 # associated with that console and devices not associated with a
3538 # console are admissible, but the former take precedence.
3541 # @events: List of InputEvent union.
3543 # Returns: Nothing on success.
3547 # Note: this command is experimental, and not a stable API.
3550 { 'command': 'x-input-send-event',
3551 'data': { '*console':'int', 'events': [ 'InputEvent' ] } }
3556 # A discriminated record of NUMA options. (for OptsVisitor)
3560 { 'union': 'NumaOptions',
3562 'node': 'NumaNodeOptions' }}
3567 # Create a guest NUMA node. (for OptsVisitor)
3569 # @nodeid: #optional NUMA node ID (increase by 1 from 0 if omitted)
3571 # @cpus: #optional VCPUs belonging to this node (assign VCPUS round-robin
3574 # @mem: #optional memory size of this node; mutually exclusive with @memdev.
3575 # Equally divide total memory among nodes if both @mem and @memdev are
3578 # @memdev: #optional memory backend object. If specified for one node,
3579 # it must be specified for all nodes.
3583 { 'struct': 'NumaNodeOptions',
3585 '*nodeid': 'uint16',
3586 '*cpus': ['uint16'],
3593 # Host memory policy types
3595 # @default: restore default policy, remove any nondefault policy
3597 # @preferred: set the preferred host nodes for allocation
3599 # @bind: a strict policy that restricts memory allocation to the
3600 # host nodes specified
3602 # @interleave: memory allocations are interleaved across the set
3603 # of host nodes specified
3607 { 'enum': 'HostMemPolicy',
3608 'data': [ 'default', 'preferred', 'bind', 'interleave' ] }
3613 # Information about memory backend
3615 # @size: memory backend size
3617 # @merge: enables or disables memory merge support
3619 # @dump: includes memory backend's memory in a core dump or not
3621 # @prealloc: enables or disables memory preallocation
3623 # @host-nodes: host nodes for its memory policy
3625 # @policy: memory policy of memory backend
3630 { 'struct': 'Memdev',
3636 'host-nodes': ['uint16'],
3637 'policy': 'HostMemPolicy' }}
3642 # Returns information for all memory backends.
3644 # Returns: a list of @Memdev.
3648 { 'command': 'query-memdev', 'returns': ['Memdev'] }
3651 # @PCDIMMDeviceInfo:
3653 # PCDIMMDevice state information
3655 # @id: #optional device's ID
3657 # @addr: physical address, where device is mapped
3659 # @size: size of memory that the device provides
3661 # @slot: slot number at which device is plugged in
3663 # @node: NUMA node number where device is plugged in
3665 # @memdev: memory backend linked with device
3667 # @hotplugged: true if device was hotplugged
3669 # @hotpluggable: true if device if could be added/removed while machine is running
3673 { 'struct': 'PCDIMMDeviceInfo',
3674 'data': { '*id': 'str',
3680 'hotplugged': 'bool',
3681 'hotpluggable': 'bool'
3686 # @MemoryDeviceInfo:
3688 # Union containing information about a memory device
3692 { 'union': 'MemoryDeviceInfo', 'data': {'dimm': 'PCDIMMDeviceInfo'} }
3695 # @query-memory-devices
3697 # Lists available memory devices and their state
3701 { 'command': 'query-memory-devices', 'returns': ['MemoryDeviceInfo'] }
3705 # @DIMM: memory slot
3707 { 'enum': 'ACPISlotType', 'data': [ 'DIMM' ] }
3711 # OSPM Status Indication for a device
3712 # For description of possible values of @source and @status fields
3713 # see "_OST (OSPM Status Indication)" chapter of ACPI5.0 spec.
3715 # @device: #optional device ID associated with slot
3717 # @slot: slot ID, unique per slot of a given @slot-type
3719 # @slot-type: type of the slot
3721 # @source: an integer containing the source event
3723 # @status: an integer containing the status code
3727 { 'struct': 'ACPIOSTInfo',
3728 'data' : { '*device': 'str',
3730 'slot-type': 'ACPISlotType',
3735 # @query-acpi-ospm-status
3737 # Lists ACPI OSPM status of ACPI device objects,
3738 # which might be reported via _OST method
3742 { 'command': 'query-acpi-ospm-status', 'returns': ['ACPIOSTInfo'] }
3745 # @WatchdogExpirationAction
3747 # An enumeration of the actions taken when the watchdog device's timer is
3750 # @reset: system resets
3752 # @shutdown: system shutdown, note that it is similar to @powerdown, which
3753 # tries to set to system status and notify guest
3755 # @poweroff: system poweroff, the emulator program exits
3757 # @pause: system pauses, similar to @stop
3759 # @debug: system enters debug state
3761 # @none: nothing is done
3763 # @inject-nmi: a non-maskable interrupt is injected into the first VCPU (all
3764 # VCPUS on x86) (since 2.4)
3768 { 'enum': 'WatchdogExpirationAction',
3769 'data': [ 'reset', 'shutdown', 'poweroff', 'pause', 'debug', 'none',
3775 # An enumeration of the I/O operation types
3777 # @read: read operation
3779 # @write: write operation
3783 { 'enum': 'IoOperationType',
3784 'data': [ 'read', 'write' ] }
3789 # An enumeration of the actions taken when guest OS panic is detected
3791 # @pause: system pauses
3795 { 'enum': 'GuestPanicAction',
3796 'data': [ 'pause' ] }
3799 # @rtc-reset-reinjection
3801 # This command will reset the RTC interrupt reinjection backlog.
3802 # Can be used if another mechanism to synchronize guest time
3803 # is in effect, for example QEMU guest agent's guest-set-time
3808 { 'command': 'rtc-reset-reinjection' }
3810 # Rocker ethernet network switch
3811 { 'include': 'qapi/rocker.json' }