10 # @GenericError: this is used for errors that don't require a specific error
11 # class. This should be the default case for most errors
13 # @CommandNotFound: the requested command has not been found
15 # @DeviceEncrypted: the requested operation can't be fulfilled because the
16 # selected device is encrypted
18 # @DeviceNotActive: a device has failed to be become active
20 # @DeviceNotFound: the requested device has not been found
22 # @KVMMissingCap: the requested operation can't be fulfilled because a
23 # required KVM capability is missing
27 { 'enum': 'ErrorClass',
28 'data': [ 'GenericError', 'CommandNotFound', 'DeviceEncrypted',
29 'DeviceNotActive', 'DeviceNotFound', 'KVMMissingCap' ] }
34 # Allow client connections for VNC, Spice and socket based
35 # character devices to be passed in to QEMU via SCM_RIGHTS.
37 # @protocol: protocol name. Valid names are "vnc", "spice" or the
38 # name of a character device (eg. from -chardev id=XXXX)
40 # @fdname: file descriptor name previously passed via 'getfd' command
42 # @skipauth: #optional whether to skip authentication. Only applies
43 # to "vnc" and "spice" protocols
45 # @tls: #optional whether to perform TLS. Only applies to the "spice"
48 # Returns: nothing on success.
52 { 'command': 'add_client',
53 'data': { 'protocol': 'str', 'fdname': 'str', '*skipauth': 'bool',
59 # Guest name information.
61 # @name: #optional The name of the guest
65 { 'type': 'NameInfo', 'data': {'*name': 'str'} }
70 # Return the name information of a guest.
72 # Returns: @NameInfo of the guest
76 { 'command': 'query-name', 'returns': 'NameInfo' }
81 # A description of QEMU's version.
83 # @qemu.major: The major version of QEMU
85 # @qemu.minor: The minor version of QEMU
87 # @qemu.micro: The micro version of QEMU. By current convention, a micro
88 # version of 50 signifies a development branch. A micro version
89 # greater than or equal to 90 signifies a release candidate for
90 # the next minor version. A micro version of less than 50
91 # signifies a stable release.
93 # @package: QEMU will always set this field to an empty string. Downstream
94 # versions of QEMU should set this to a non-empty string. The
95 # exact format depends on the downstream however it highly
96 # recommended that a unique name is used.
100 { 'type': 'VersionInfo',
101 'data': {'qemu': {'major': 'int', 'minor': 'int', 'micro': 'int'},
107 # Returns the current version of QEMU.
109 # Returns: A @VersionInfo object describing the current version of QEMU.
113 { 'command': 'query-version', 'returns': 'VersionInfo' }
118 # Information about support for KVM acceleration
120 # @enabled: true if KVM acceleration is active
122 # @present: true if KVM acceleration is built into this executable
126 { 'type': 'KvmInfo', 'data': {'enabled': 'bool', 'present': 'bool'} }
131 # Returns information about KVM acceleration
137 { 'command': 'query-kvm', 'returns': 'KvmInfo' }
142 # An enumeration of VM run states.
144 # @debug: QEMU is running on a debugger
146 # @finish-migrate: guest is paused to finish the migration process
148 # @inmigrate: guest is paused waiting for an incoming migration. Note
149 # that this state does not tell whether the machine will start at the
150 # end of the migration. This depends on the command-line -S option and
151 # any invocation of 'stop' or 'cont' that has happened since QEMU was
154 # @internal-error: An internal error that prevents further guest execution
157 # @io-error: the last IOP has failed and the device is configured to pause
160 # @paused: guest has been paused via the 'stop' command
162 # @postmigrate: guest is paused following a successful 'migrate'
164 # @prelaunch: QEMU was started with -S and guest has not started
166 # @restore-vm: guest is paused to restore VM state
168 # @running: guest is actively running
170 # @save-vm: guest is paused to save the VM state
172 # @shutdown: guest is shut down (and -no-shutdown is in use)
174 # @suspended: guest is suspended (ACPI S3)
176 # @watchdog: the watchdog action is configured to pause and has been triggered
178 # @guest-panicked: guest has been panicked as a result of guest OS panic
180 { 'enum': 'RunState',
181 'data': [ 'debug', 'inmigrate', 'internal-error', 'io-error', 'paused',
182 'postmigrate', 'prelaunch', 'finish-migrate', 'restore-vm',
183 'running', 'save-vm', 'shutdown', 'suspended', 'watchdog',
189 # @id: unique snapshot id
191 # @name: user chosen name
193 # @vm-state-size: size of the VM state
195 # @date-sec: UTC date of the snapshot in seconds
197 # @date-nsec: fractional part in nano seconds to be used with date-sec
199 # @vm-clock-sec: VM clock relative to boot in seconds
201 # @vm-clock-nsec: fractional part in nano seconds to be used with vm-clock-sec
207 { 'type': 'SnapshotInfo',
208 'data': { 'id': 'str', 'name': 'str', 'vm-state-size': 'int',
209 'date-sec': 'int', 'date-nsec': 'int',
210 'vm-clock-sec': 'int', 'vm-clock-nsec': 'int' } }
215 # Information about a QEMU image file
217 # @filename: name of the image file
219 # @format: format of the image file
221 # @virtual-size: maximum capacity in bytes of the image
223 # @actual-size: #optional actual size on disk in bytes of the image
225 # @dirty-flag: #optional true if image is not cleanly closed
227 # @cluster-size: #optional size of a cluster in bytes
229 # @encrypted: #optional true if the image is encrypted
231 # @backing-filename: #optional name of the backing file
233 # @full-backing-filename: #optional full path of the backing file
235 # @backing-filename-format: #optional the format of the backing file
237 # @snapshots: #optional list of VM snapshots
239 # @backing-image: #optional info of the backing image (since 1.6)
245 { 'type': 'ImageInfo',
246 'data': {'filename': 'str', 'format': 'str', '*dirty-flag': 'bool',
247 '*actual-size': 'int', 'virtual-size': 'int',
248 '*cluster-size': 'int', '*encrypted': 'bool',
249 '*backing-filename': 'str', '*full-backing-filename': 'str',
250 '*backing-filename-format': 'str', '*snapshots': ['SnapshotInfo'],
251 '*backing-image': 'ImageInfo' } }
256 # Information about a QEMU image file check
258 # @filename: name of the image file checked
260 # @format: format of the image file checked
262 # @check-errors: number of unexpected errors occurred during check
264 # @image-end-offset: #optional offset (in bytes) where the image ends, this
265 # field is present if the driver for the image format
268 # @corruptions: #optional number of corruptions found during the check if any
270 # @leaks: #optional number of leaks found during the check if any
272 # @corruptions-fixed: #optional number of corruptions fixed during the check
275 # @leaks-fixed: #optional number of leaks fixed during the check if any
277 # @total-clusters: #optional total number of clusters, this field is present
278 # if the driver for the image format supports it
280 # @allocated-clusters: #optional total number of allocated clusters, this
281 # field is present if the driver for the image format
284 # @fragmented-clusters: #optional total number of fragmented clusters, this
285 # field is present if the driver for the image format
288 # @compressed-clusters: #optional total number of compressed clusters, this
289 # field is present if the driver for the image format
296 { 'type': 'ImageCheck',
297 'data': {'filename': 'str', 'format': 'str', 'check-errors': 'int',
298 '*image-end-offset': 'int', '*corruptions': 'int', '*leaks': 'int',
299 '*corruptions-fixed': 'int', '*leaks-fixed': 'int',
300 '*total-clusters': 'int', '*allocated-clusters': 'int',
301 '*fragmented-clusters': 'int', '*compressed-clusters': 'int' } }
306 # Information about VCPU run state
308 # @running: true if all VCPUs are runnable, false if not runnable
310 # @singlestep: true if VCPUs are in single-step mode
312 # @status: the virtual machine @RunState
316 # Notes: @singlestep is enabled through the GDB stub
318 { 'type': 'StatusInfo',
319 'data': {'running': 'bool', 'singlestep': 'bool', 'status': 'RunState'} }
324 # Query the run status of all VCPUs
326 # Returns: @StatusInfo reflecting all VCPUs
330 { 'command': 'query-status', 'returns': 'StatusInfo' }
335 # Guest UUID information.
337 # @UUID: the UUID of the guest
341 # Notes: If no UUID was specified for the guest, a null UUID is returned.
343 { 'type': 'UuidInfo', 'data': {'UUID': 'str'} }
348 # Query the guest UUID information.
350 # Returns: The @UuidInfo for the guest
354 { 'command': 'query-uuid', 'returns': 'UuidInfo' }
359 # Information about a character device.
361 # @label: the label of the character device
363 # @filename: the filename of the character device
365 # Notes: @filename is encoded using the QEMU command line character device
366 # encoding. See the QEMU man page for details.
370 { 'type': 'ChardevInfo', 'data': {'label': 'str', 'filename': 'str'} }
375 # Returns information about current character devices.
377 # Returns: a list of @ChardevInfo
381 { 'command': 'query-chardev', 'returns': ['ChardevInfo'] }
386 # An enumeration of data format.
388 # @utf8: Data is a UTF-8 string (RFC 3629)
390 # @base64: Data is Base64 encoded binary (RFC 3548)
394 { 'enum': 'DataFormat'
395 'data': [ 'utf8', 'base64' ] }
400 # Write to a ring buffer character device.
402 # @device: the ring buffer character device name
404 # @data: data to write
406 # @format: #optional data encoding (default 'utf8').
407 # - base64: data must be base64 encoded text. Its binary
408 # decoding gets written.
409 # Bug: invalid base64 is currently not rejected.
410 # Whitespace *is* invalid.
411 # - utf8: data's UTF-8 encoding is written
412 # - data itself is always Unicode regardless of format, like
415 # Returns: Nothing on success
419 { 'command': 'ringbuf-write',
420 'data': {'device': 'str', 'data': 'str',
421 '*format': 'DataFormat'} }
426 # Read from a ring buffer character device.
428 # @device: the ring buffer character device name
430 # @size: how many bytes to read at most
432 # @format: #optional data encoding (default 'utf8').
433 # - base64: the data read is returned in base64 encoding.
434 # - utf8: the data read is interpreted as UTF-8.
435 # Bug: can screw up when the buffer contains invalid UTF-8
436 # sequences, NUL characters, after the ring buffer lost
437 # data, and when reading stops because the size limit is
439 # - The return value is always Unicode regardless of format,
440 # like any other string.
442 # Returns: data read from the device
446 { 'command': 'ringbuf-read',
447 'data': {'device': 'str', 'size': 'int', '*format': 'DataFormat'},
453 # Information about a QMP command
455 # @name: The command name
459 { 'type': 'CommandInfo', 'data': {'name': 'str'} }
464 # Return a list of supported QMP commands by this server
466 # Returns: A list of @CommandInfo for all supported commands
470 { 'command': 'query-commands', 'returns': ['CommandInfo'] }
475 # Information about a QMP event
477 # @name: The event name
481 { 'type': 'EventInfo', 'data': {'name': 'str'} }
486 # Return a list of supported QMP events by this server
488 # Returns: A list of @EventInfo for all supported events
492 { 'command': 'query-events', 'returns': ['EventInfo'] }
497 # Detailed migration status.
499 # @transferred: amount of bytes already transferred to the target VM
501 # @remaining: amount of bytes remaining to be transferred to the target VM
503 # @total: total amount of bytes involved in the migration process
505 # @duplicate: number of duplicate (zero) pages (since 1.2)
507 # @skipped: number of skipped zero pages (since 1.5)
509 # @normal : number of normal pages (since 1.2)
511 # @normal-bytes: number of normal bytes sent (since 1.2)
513 # @dirty-pages-rate: number of pages dirtied by second by the
518 { 'type': 'MigrationStats',
519 'data': {'transferred': 'int', 'remaining': 'int', 'total': 'int' ,
520 'duplicate': 'int', 'skipped': 'int', 'normal': 'int',
521 'normal-bytes': 'int', 'dirty-pages-rate' : 'int' } }
526 # Detailed XBZRLE migration cache statistics
528 # @cache-size: XBZRLE cache size
530 # @bytes: amount of bytes already transferred to the target VM
532 # @pages: amount of pages transferred to the target VM
534 # @cache-miss: number of cache miss
536 # @overflow: number of overflows
540 { 'type': 'XBZRLECacheStats',
541 'data': {'cache-size': 'int', 'bytes': 'int', 'pages': 'int',
542 'cache-miss': 'int', 'overflow': 'int' } }
547 # Information about current migration process.
549 # @status: #optional string describing the current migration status.
550 # As of 0.14.0 this can be 'active', 'completed', 'failed' or
551 # 'cancelled'. If this field is not returned, no migration process
554 # @ram: #optional @MigrationStats containing detailed migration
555 # status, only returned if status is 'active' or
556 # 'completed'. 'comppleted' (since 1.2)
558 # @disk: #optional @MigrationStats containing detailed disk migration
559 # status, only returned if status is 'active' and it is a block
562 # @xbzrle-cache: #optional @XBZRLECacheStats containing detailed XBZRLE
563 # migration statistics, only returned if XBZRLE feature is on and
564 # status is 'active' or 'completed' (since 1.2)
566 # @total-time: #optional total amount of milliseconds since migration started.
567 # If migration has ended, it returns the total migration
570 # @downtime: #optional only present when migration finishes correctly
571 # total downtime in milliseconds for the guest.
574 # @expected-downtime: #optional only present while migration is active
575 # expected downtime in milliseconds for the guest in last walk
576 # of the dirty bitmap. (since 1.3)
580 { 'type': 'MigrationInfo',
581 'data': {'*status': 'str', '*ram': 'MigrationStats',
582 '*disk': 'MigrationStats',
583 '*xbzrle-cache': 'XBZRLECacheStats',
584 '*total-time': 'int',
585 '*expected-downtime': 'int',
586 '*downtime': 'int'} }
591 # Returns information about current migration process.
593 # Returns: @MigrationInfo
597 { 'command': 'query-migrate', 'returns': 'MigrationInfo' }
600 # @MigrationCapability
602 # Migration capabilities enumeration
604 # @xbzrle: Migration supports xbzrle (Xor Based Zero Run Length Encoding).
605 # This feature allows us to minimize migration traffic for certain work
606 # loads, by sending compressed difference of the pages
610 { 'enum': 'MigrationCapability',
614 # @MigrationCapabilityStatus
616 # Migration capability information
618 # @capability: capability enum
620 # @state: capability state bool
624 { 'type': 'MigrationCapabilityStatus',
625 'data': { 'capability' : 'MigrationCapability', 'state' : 'bool' } }
628 # @migrate-set-capabilities
630 # Enable/Disable the following migration capabilities (like xbzrle)
632 # @capabilities: json array of capability modifications to make
636 { 'command': 'migrate-set-capabilities',
637 'data': { 'capabilities': ['MigrationCapabilityStatus'] } }
640 # @query-migrate-capabilities
642 # Returns information about the current migration capabilities status
644 # Returns: @MigrationCapabilitiesStatus
648 { 'command': 'query-migrate-capabilities', 'returns': ['MigrationCapabilityStatus']}
653 # Information about a mouse device.
655 # @name: the name of the mouse device
657 # @index: the index of the mouse device
659 # @current: true if this device is currently receiving mouse events
661 # @absolute: true if this device supports absolute coordinates as input
665 { 'type': 'MouseInfo',
666 'data': {'name': 'str', 'index': 'int', 'current': 'bool',
667 'absolute': 'bool'} }
672 # Returns information about each active mouse device
674 # Returns: a list of @MouseInfo for each device
678 { 'command': 'query-mice', 'returns': ['MouseInfo'] }
683 # Information about a virtual CPU
685 # @CPU: the index of the virtual CPU
687 # @current: this only exists for backwards compatible and should be ignored
689 # @halted: true if the virtual CPU is in the halt state. Halt usually refers
690 # to a processor specific low power mode.
692 # @pc: #optional If the target is i386 or x86_64, this is the 64-bit instruction
694 # If the target is Sparc, this is the PC component of the
695 # instruction pointer.
697 # @nip: #optional If the target is PPC, the instruction pointer
699 # @npc: #optional If the target is Sparc, the NPC component of the instruction
702 # @PC: #optional If the target is MIPS, the instruction pointer
704 # @thread_id: ID of the underlying host thread
708 # Notes: @halted is a transient state that changes frequently. By the time the
709 # data is sent to the client, the guest may no longer be halted.
712 'data': {'CPU': 'int', 'current': 'bool', 'halted': 'bool', '*pc': 'int',
713 '*nip': 'int', '*npc': 'int', '*PC': 'int', 'thread_id': 'int'} }
718 # Returns a list of information about each virtual CPU.
720 # Returns: a list of @CpuInfo for each virtual CPU
724 { 'command': 'query-cpus', 'returns': ['CpuInfo'] }
729 # Information about the backing device for a block device.
731 # @file: the filename of the backing device
733 # @ro: true if the backing device was open read-only
735 # @drv: the name of the block format used to open the backing device. As of
736 # 0.14.0 this can be: 'blkdebug', 'bochs', 'cloop', 'cow', 'dmg',
737 # 'file', 'file', 'ftp', 'ftps', 'host_cdrom', 'host_device',
738 # 'host_floppy', 'http', 'https', 'nbd', 'parallels', 'qcow',
739 # 'qcow2', 'raw', 'tftp', 'vdi', 'vmdk', 'vpc', 'vvfat'
741 # @backing_file: #optional the name of the backing file (for copy-on-write)
743 # @backing_file_depth: number of files in the backing file chain (since: 1.2)
745 # @encrypted: true if the backing device is encrypted
747 # @encryption_key_missing: true if the backing device is encrypted but an
748 # valid encryption key is missing
750 # @bps: total throughput limit in bytes per second is specified
752 # @bps_rd: read throughput limit in bytes per second is specified
754 # @bps_wr: write throughput limit in bytes per second is specified
756 # @iops: total I/O operations per second is specified
758 # @iops_rd: read I/O operations per second is specified
760 # @iops_wr: write I/O operations per second is specified
762 # @image: the info of image used (since: 1.6)
766 # Notes: This interface is only found in @BlockInfo.
768 { 'type': 'BlockDeviceInfo',
769 'data': { 'file': 'str', 'ro': 'bool', 'drv': 'str',
770 '*backing_file': 'str', 'backing_file_depth': 'int',
771 'encrypted': 'bool', 'encryption_key_missing': 'bool',
772 'bps': 'int', 'bps_rd': 'int', 'bps_wr': 'int',
773 'iops': 'int', 'iops_rd': 'int', 'iops_wr': 'int',
774 'image': 'ImageInfo' } }
777 # @BlockDeviceIoStatus:
779 # An enumeration of block device I/O status.
781 # @ok: The last I/O operation has succeeded
783 # @failed: The last I/O operation has failed
785 # @nospace: The last I/O operation has failed due to a no-space condition
789 { 'enum': 'BlockDeviceIoStatus', 'data': [ 'ok', 'failed', 'nospace' ] }
794 # Block dirty bitmap information.
796 # @count: number of dirty bytes according to the dirty bitmap
798 # @granularity: granularity of the dirty bitmap in bytes (since 1.4)
802 { 'type': 'BlockDirtyInfo',
803 'data': {'count': 'int', 'granularity': 'int'} }
808 # Block device information. This structure describes a virtual device and
809 # the backing device associated with it.
811 # @device: The device name associated with the virtual device.
813 # @type: This field is returned only for compatibility reasons, it should
814 # not be used (always returns 'unknown')
816 # @removable: True if the device supports removable media.
818 # @locked: True if the guest has locked this device from having its media
821 # @tray_open: #optional True if the device has a tray and it is open
822 # (only present if removable is true)
824 # @dirty: #optional dirty bitmap information (only present if the dirty
827 # @io-status: #optional @BlockDeviceIoStatus. Only present if the device
828 # supports it and the VM is configured to stop on errors
830 # @inserted: #optional @BlockDeviceInfo describing the device if media is
835 { 'type': 'BlockInfo',
836 'data': {'device': 'str', 'type': 'str', 'removable': 'bool',
837 'locked': 'bool', '*inserted': 'BlockDeviceInfo',
838 '*tray_open': 'bool', '*io-status': 'BlockDeviceIoStatus',
839 '*dirty': 'BlockDirtyInfo' } }
844 # Get a list of BlockInfo for all virtual block devices.
846 # Returns: a list of @BlockInfo describing each virtual block device
850 { 'command': 'query-block', 'returns': ['BlockInfo'] }
855 # Statistics of a virtual block device or a block backing device.
857 # @rd_bytes: The number of bytes read by the device.
859 # @wr_bytes: The number of bytes written by the device.
861 # @rd_operations: The number of read operations performed by the device.
863 # @wr_operations: The number of write operations performed by the device.
865 # @flush_operations: The number of cache flush operations performed by the
866 # device (since 0.15.0)
868 # @flush_total_time_ns: Total time spend on cache flushes in nano-seconds
871 # @wr_total_time_ns: Total time spend on writes in nano-seconds (since 0.15.0).
873 # @rd_total_time_ns: Total_time_spend on reads in nano-seconds (since 0.15.0).
875 # @wr_highest_offset: The offset after the greatest byte written to the
876 # device. The intended use of this information is for
877 # growable sparse files (like qcow2) that are used on top
878 # of a physical device.
882 { 'type': 'BlockDeviceStats',
883 'data': {'rd_bytes': 'int', 'wr_bytes': 'int', 'rd_operations': 'int',
884 'wr_operations': 'int', 'flush_operations': 'int',
885 'flush_total_time_ns': 'int', 'wr_total_time_ns': 'int',
886 'rd_total_time_ns': 'int', 'wr_highest_offset': 'int' } }
891 # Statistics of a virtual block device or a block backing device.
893 # @device: #optional If the stats are for a virtual block device, the name
894 # corresponding to the virtual block device.
896 # @stats: A @BlockDeviceStats for the device.
898 # @parent: #optional This may point to the backing block device if this is a
899 # a virtual block device. If it's a backing block, this will point
900 # to the backing file is one is present.
904 { 'type': 'BlockStats',
905 'data': {'*device': 'str', 'stats': 'BlockDeviceStats',
906 '*parent': 'BlockStats'} }
911 # Query the @BlockStats for all virtual block devices.
913 # Returns: A list of @BlockStats for each virtual block devices.
917 { 'command': 'query-blockstats', 'returns': ['BlockStats'] }
922 # Information about a connected VNC client.
924 # @host: The host name of the client. QEMU tries to resolve this to a DNS name
927 # @family: 'ipv6' if the client is connected via IPv6 and TCP
928 # 'ipv4' if the client is connected via IPv4 and TCP
929 # 'unix' if the client is connected via a unix domain socket
930 # 'unknown' otherwise
932 # @service: The service name of the client's port. This may depends on the
933 # host system's service database so symbolic names should not be
936 # @x509_dname: #optional If x509 authentication is in use, the Distinguished
937 # Name of the client.
939 # @sasl_username: #optional If SASL authentication is in use, the SASL username
940 # used for authentication.
944 { 'type': 'VncClientInfo',
945 'data': {'host': 'str', 'family': 'str', 'service': 'str',
946 '*x509_dname': 'str', '*sasl_username': 'str'} }
951 # Information about the VNC session.
953 # @enabled: true if the VNC server is enabled, false otherwise
955 # @host: #optional The hostname the VNC server is bound to. This depends on
956 # the name resolution on the host and may be an IP address.
958 # @family: #optional 'ipv6' if the host is listening for IPv6 connections
959 # 'ipv4' if the host is listening for IPv4 connections
960 # 'unix' if the host is listening on a unix domain socket
961 # 'unknown' otherwise
963 # @service: #optional The service name of the server's port. This may depends
964 # on the host system's service database so symbolic names should not
967 # @auth: #optional the current authentication type used by the server
968 # 'none' if no authentication is being used
969 # 'vnc' if VNC authentication is being used
970 # 'vencrypt+plain' if VEncrypt is used with plain text authentication
971 # 'vencrypt+tls+none' if VEncrypt is used with TLS and no authentication
972 # 'vencrypt+tls+vnc' if VEncrypt is used with TLS and VNC authentication
973 # 'vencrypt+tls+plain' if VEncrypt is used with TLS and plain text auth
974 # 'vencrypt+x509+none' if VEncrypt is used with x509 and no auth
975 # 'vencrypt+x509+vnc' if VEncrypt is used with x509 and VNC auth
976 # 'vencrypt+x509+plain' if VEncrypt is used with x509 and plain text auth
977 # 'vencrypt+tls+sasl' if VEncrypt is used with TLS and SASL auth
978 # 'vencrypt+x509+sasl' if VEncrypt is used with x509 and SASL auth
980 # @clients: a list of @VncClientInfo of all currently connected clients
985 'data': {'enabled': 'bool', '*host': 'str', '*family': 'str',
986 '*service': 'str', '*auth': 'str', '*clients': ['VncClientInfo']} }
991 # Returns information about the current VNC server
997 { 'command': 'query-vnc', 'returns': 'VncInfo' }
1002 # Information about a SPICE client channel.
1004 # @host: The host name of the client. QEMU tries to resolve this to a DNS name
1007 # @family: 'ipv6' if the client is connected via IPv6 and TCP
1008 # 'ipv4' if the client is connected via IPv4 and TCP
1009 # 'unix' if the client is connected via a unix domain socket
1010 # 'unknown' otherwise
1012 # @port: The client's port number.
1014 # @connection-id: SPICE connection id number. All channels with the same id
1015 # belong to the same SPICE session.
1017 # @connection-type: SPICE channel type number. "1" is the main control
1018 # channel, filter for this one if you want to track spice
1021 # @channel-id: SPICE channel ID number. Usually "0", might be different when
1022 # multiple channels of the same type exist, such as multiple
1023 # display channels in a multihead setup
1025 # @tls: true if the channel is encrypted, false otherwise.
1029 { 'type': 'SpiceChannel',
1030 'data': {'host': 'str', 'family': 'str', 'port': 'str',
1031 'connection-id': 'int', 'channel-type': 'int', 'channel-id': 'int',
1035 # @SpiceQueryMouseMode
1037 # An enumeration of Spice mouse states.
1039 # @client: Mouse cursor position is determined by the client.
1041 # @server: Mouse cursor position is determined by the server.
1043 # @unknown: No information is available about mouse mode used by
1046 # Note: spice/enums.h has a SpiceMouseMode already, hence the name.
1050 { 'enum': 'SpiceQueryMouseMode',
1051 'data': [ 'client', 'server', 'unknown' ] }
1056 # Information about the SPICE session.
1058 # @enabled: true if the SPICE server is enabled, false otherwise
1060 # @migrated: true if the last guest migration completed and spice
1061 # migration had completed as well. false otherwise.
1063 # @host: #optional The hostname the SPICE server is bound to. This depends on
1064 # the name resolution on the host and may be an IP address.
1066 # @port: #optional The SPICE server's port number.
1068 # @compiled-version: #optional SPICE server version.
1070 # @tls-port: #optional The SPICE server's TLS port number.
1072 # @auth: #optional the current authentication type used by the server
1073 # 'none' if no authentication is being used
1074 # 'spice' uses SASL or direct TLS authentication, depending on command
1077 # @mouse-mode: The mode in which the mouse cursor is displayed currently. Can
1078 # be determined by the client or the server, or unknown if spice
1079 # server doesn't provide this information.
1083 # @channels: a list of @SpiceChannel for each active spice channel
1087 { 'type': 'SpiceInfo',
1088 'data': {'enabled': 'bool', 'migrated': 'bool', '*host': 'str', '*port': 'int',
1089 '*tls-port': 'int', '*auth': 'str', '*compiled-version': 'str',
1090 'mouse-mode': 'SpiceQueryMouseMode', '*channels': ['SpiceChannel']} }
1095 # Returns information about the current SPICE server
1097 # Returns: @SpiceInfo
1101 { 'command': 'query-spice', 'returns': 'SpiceInfo' }
1106 # Information about the guest balloon device.
1108 # @actual: the number of bytes the balloon currently contains
1113 { 'type': 'BalloonInfo', 'data': {'actual': 'int' } }
1118 # Return information about the balloon device.
1120 # Returns: @BalloonInfo on success
1121 # If the balloon driver is enabled but not functional because the KVM
1122 # kernel module cannot support it, KvmMissingCap
1123 # If no balloon device is present, DeviceNotActive
1127 { 'command': 'query-balloon', 'returns': 'BalloonInfo' }
1132 # A PCI device memory region
1134 # @base: the starting address (guest physical)
1136 # @limit: the ending address (guest physical)
1140 { 'type': 'PciMemoryRange', 'data': {'base': 'int', 'limit': 'int'} }
1145 # Information about a PCI device I/O region.
1147 # @bar: the index of the Base Address Register for this region
1149 # @type: 'io' if the region is a PIO region
1150 # 'memory' if the region is a MMIO region
1152 # @prefetch: #optional if @type is 'memory', true if the memory is prefetchable
1154 # @mem_type_64: #optional if @type is 'memory', true if the BAR is 64-bit
1158 { 'type': 'PciMemoryRegion',
1159 'data': {'bar': 'int', 'type': 'str', 'address': 'int', 'size': 'int',
1160 '*prefetch': 'bool', '*mem_type_64': 'bool' } }
1165 # Information about a PCI Bridge device
1167 # @bus.number: primary bus interface number. This should be the number of the
1168 # bus the device resides on.
1170 # @bus.secondary: secondary bus interface number. This is the number of the
1171 # main bus for the bridge
1173 # @bus.subordinate: This is the highest number bus that resides below the
1176 # @bus.io_range: The PIO range for all devices on this bridge
1178 # @bus.memory_range: The MMIO range for all devices on this bridge
1180 # @bus.prefetchable_range: The range of prefetchable MMIO for all devices on
1183 # @devices: a list of @PciDeviceInfo for each device on this bridge
1187 { 'type': 'PciBridgeInfo',
1188 'data': {'bus': { 'number': 'int', 'secondary': 'int', 'subordinate': 'int',
1189 'io_range': 'PciMemoryRange',
1190 'memory_range': 'PciMemoryRange',
1191 'prefetchable_range': 'PciMemoryRange' },
1192 '*devices': ['PciDeviceInfo']} }
1197 # Information about a PCI device
1199 # @bus: the bus number of the device
1201 # @slot: the slot the device is located in
1203 # @function: the function of the slot used by the device
1205 # @class_info.desc: #optional a string description of the device's class
1207 # @class_info.class: the class code of the device
1209 # @id.device: the PCI device id
1211 # @id.vendor: the PCI vendor id
1213 # @irq: #optional if an IRQ is assigned to the device, the IRQ number
1215 # @qdev_id: the device name of the PCI device
1217 # @pci_bridge: if the device is a PCI bridge, the bridge information
1219 # @regions: a list of the PCI I/O regions associated with the device
1221 # Notes: the contents of @class_info.desc are not stable and should only be
1222 # treated as informational.
1226 { 'type': 'PciDeviceInfo',
1227 'data': {'bus': 'int', 'slot': 'int', 'function': 'int',
1228 'class_info': {'*desc': 'str', 'class': 'int'},
1229 'id': {'device': 'int', 'vendor': 'int'},
1230 '*irq': 'int', 'qdev_id': 'str', '*pci_bridge': 'PciBridgeInfo',
1231 'regions': ['PciMemoryRegion']} }
1236 # Information about a PCI bus
1238 # @bus: the bus index
1240 # @devices: a list of devices on this bus
1244 { 'type': 'PciInfo', 'data': {'bus': 'int', 'devices': ['PciDeviceInfo']} }
1249 # Return information about the PCI bus topology of the guest.
1251 # Returns: a list of @PciInfo for each PCI bus
1255 { 'command': 'query-pci', 'returns': ['PciInfo'] }
1260 # An enumeration of possible behaviors for errors on I/O operations.
1261 # The exact meaning depends on whether the I/O was initiated by a guest
1264 # @report: for guest operations, report the error to the guest;
1265 # for jobs, cancel the job
1267 # @ignore: ignore the error, only report a QMP event (BLOCK_IO_ERROR
1268 # or BLOCK_JOB_ERROR)
1270 # @enospc: same as @stop on ENOSPC, same as @report otherwise.
1272 # @stop: for guest operations, stop the virtual machine;
1273 # for jobs, pause the job
1277 { 'enum': 'BlockdevOnError',
1278 'data': ['report', 'ignore', 'enospc', 'stop'] }
1283 # An enumeration of possible behaviors for the initial synchronization
1284 # phase of storage mirroring.
1286 # @top: copies data in the topmost image to the destination
1288 # @full: copies data from all images to the destination
1290 # @none: only copy data written from now on
1294 { 'enum': 'MirrorSyncMode',
1295 'data': ['top', 'full', 'none'] }
1300 # Information about a long-running block device operation.
1302 # @type: the job type ('stream' for image streaming)
1304 # @device: the block device name
1306 # @len: the maximum progress value
1308 # @busy: false if the job is known to be in a quiescent state, with
1309 # no pending I/O. Since 1.3.
1311 # @paused: whether the job is paused or, if @busy is true, will
1312 # pause itself as soon as possible. Since 1.3.
1314 # @offset: the current progress value
1316 # @speed: the rate limit, bytes per second
1318 # @io-status: the status of the job (since 1.3)
1322 { 'type': 'BlockJobInfo',
1323 'data': {'type': 'str', 'device': 'str', 'len': 'int',
1324 'offset': 'int', 'busy': 'bool', 'paused': 'bool', 'speed': 'int',
1325 'io-status': 'BlockDeviceIoStatus'} }
1328 # @query-block-jobs:
1330 # Return information about long-running block device operations.
1332 # Returns: a list of @BlockJobInfo for each active block job
1336 { 'command': 'query-block-jobs', 'returns': ['BlockJobInfo'] }
1341 # This command will cause the QEMU process to exit gracefully. While every
1342 # attempt is made to send the QMP response before terminating, this is not
1343 # guaranteed. When using this interface, a premature EOF would not be
1348 { 'command': 'quit' }
1353 # Stop all guest VCPU execution.
1357 # Notes: This function will succeed even if the guest is already in the stopped
1358 # state. In "inmigrate" state, it will ensure that the guest
1359 # remains paused once migration finishes, as if the -S option was
1360 # passed on the command line.
1362 { 'command': 'stop' }
1367 # Performs a hard reset of a guest.
1371 { 'command': 'system_reset' }
1374 # @system_powerdown:
1376 # Requests that a guest perform a powerdown operation.
1380 # Notes: A guest may or may not respond to this command. This command
1381 # returning does not indicate that a guest has accepted the request or
1382 # that it has shut down. Many guests will respond to this command by
1383 # prompting the user in some way.
1385 { 'command': 'system_powerdown' }
1390 # This command is a nop that is only provided for the purposes of compatibility.
1394 # Notes: Do not use this command.
1396 { 'command': 'cpu', 'data': {'index': 'int'} }
1401 # Adds CPU with specified ID
1403 # @id: ID of CPU to be created, valid values [0..max_cpus)
1405 # Returns: Nothing on success
1409 { 'command': 'cpu-add', 'data': {'id': 'int'} }
1414 # Save a portion of guest memory to a file.
1416 # @val: the virtual address of the guest to start from
1418 # @size: the size of memory region to save
1420 # @filename: the file to save the memory to as binary data
1422 # @cpu-index: #optional the index of the virtual CPU to use for translating the
1423 # virtual address (defaults to CPU 0)
1425 # Returns: Nothing on success
1429 # Notes: Errors were not reliably returned until 1.1
1431 { 'command': 'memsave',
1432 'data': {'val': 'int', 'size': 'int', 'filename': 'str', '*cpu-index': 'int'} }
1437 # Save a portion of guest physical memory to a file.
1439 # @val: the physical address of the guest to start from
1441 # @size: the size of memory region to save
1443 # @filename: the file to save the memory to as binary data
1445 # Returns: Nothing on success
1449 # Notes: Errors were not reliably returned until 1.1
1451 { 'command': 'pmemsave',
1452 'data': {'val': 'int', 'size': 'int', 'filename': 'str'} }
1457 # Resume guest VCPU execution.
1461 # Returns: If successful, nothing
1462 # If QEMU was started with an encrypted block device and a key has
1463 # not yet been set, DeviceEncrypted.
1465 # Notes: This command will succeed if the guest is currently running. It
1466 # will also succeed if the guest is in the "inmigrate" state; in
1467 # this case, the effect of the command is to make sure the guest
1468 # starts once migration finishes, removing the effect of the -S
1469 # command line option if it was passed.
1471 { 'command': 'cont' }
1476 # Wakeup guest from suspend. Does nothing in case the guest isn't suspended.
1482 { 'command': 'system_wakeup' }
1487 # Injects an Non-Maskable Interrupt into all guest's VCPUs.
1489 # Returns: If successful, nothing
1493 # Notes: Only x86 Virtual Machines support this command.
1495 { 'command': 'inject-nmi' }
1500 # Sets the link status of a virtual network adapter.
1502 # @name: the device name of the virtual network adapter
1504 # @up: true to set the link status to be up
1506 # Returns: Nothing on success
1507 # If @name is not a valid network device, DeviceNotFound
1511 # Notes: Not all network adapters support setting link status. This command
1512 # will succeed even if the network adapter does not support link status
1515 { 'command': 'set_link', 'data': {'name': 'str', 'up': 'bool'} }
1520 # This command sets the password of a block device that has not been open
1521 # with a password and requires one.
1523 # The two cases where this can happen are a block device is created through
1524 # QEMU's initial command line or a block device is changed through the legacy
1525 # @change interface.
1527 # In the event that the block device is created through the initial command
1528 # line, the VM will start in the stopped state regardless of whether '-S' is
1529 # used. The intention is for a management tool to query the block devices to
1530 # determine which ones are encrypted, set the passwords with this command, and
1531 # then start the guest with the @cont command.
1533 # @device: the name of the device to set the password on
1535 # @password: the password to use for the device
1537 # Returns: nothing on success
1538 # If @device is not a valid block device, DeviceNotFound
1539 # If @device is not encrypted, DeviceNotEncrypted
1541 # Notes: Not all block formats support encryption and some that do are not
1542 # able to validate that a password is correct. Disk corruption may
1543 # occur if an invalid password is specified.
1547 { 'command': 'block_passwd', 'data': {'device': 'str', 'password': 'str'} }
1552 # Request the balloon driver to change its balloon size.
1554 # @value: the target size of the balloon in bytes
1556 # Returns: Nothing on success
1557 # If the balloon driver is enabled but not functional because the KVM
1558 # kernel module cannot support it, KvmMissingCap
1559 # If no balloon device is present, DeviceNotActive
1561 # Notes: This command just issues a request to the guest. When it returns,
1562 # the balloon size may not have changed. A guest can change the balloon
1563 # size independent of this command.
1567 { 'command': 'balloon', 'data': {'value': 'int'} }
1572 # Resize a block image while a guest is running.
1574 # @device: the name of the device to get the image resized
1576 # @size: new image size in bytes
1578 # Returns: nothing on success
1579 # If @device is not a valid block device, DeviceNotFound
1583 { 'command': 'block_resize', 'data': { 'device': 'str', 'size': 'int' }}
1588 # An enumeration that tells QEMU how to set the backing file path in
1591 # @existing: QEMU should look for an existing image file.
1593 # @absolute-paths: QEMU should create a new image with absolute paths
1594 # for the backing file.
1598 { 'enum': 'NewImageMode'
1599 'data': [ 'existing', 'absolute-paths' ] }
1604 # @device: the name of the device to generate the snapshot from.
1606 # @snapshot-file: the target of the new image. A new file will be created.
1608 # @format: #optional the format of the snapshot image, default is 'qcow2'.
1610 # @mode: #optional whether and how QEMU should create a new image, default is
1613 { 'type': 'BlockdevSnapshot',
1614 'data': { 'device': 'str', 'snapshot-file': 'str', '*format': 'str',
1615 '*mode': 'NewImageMode' } }
1618 # @TransactionAction
1620 # A discriminated record of operations that can be performed with
1623 { 'union': 'TransactionAction',
1625 'blockdev-snapshot-sync': 'BlockdevSnapshot'
1631 # Executes a number of transactionable QMP commands atomically. If any
1632 # operation fails, then the entire set of actions will be abandoned and the
1633 # appropriate error returned.
1636 # @TransactionAction: information needed for the respective operation
1638 # Returns: nothing on success
1639 # Errors depend on the operations of the transaction
1641 # Note: The transaction aborts on the first failure. Therefore, there will be
1642 # information on only one failed operation returned in an error condition, and
1643 # subsequent actions will not have been attempted.
1647 { 'command': 'transaction',
1648 'data': { 'actions': [ 'TransactionAction' ] } }
1651 # @blockdev-snapshot-sync
1653 # Generates a synchronous snapshot of a block device.
1655 # @device: the name of the device to generate the snapshot from.
1657 # @snapshot-file: the target of the new image. If the file exists, or if it
1658 # is a device, the snapshot will be created in the existing
1659 # file/device. If does not exist, a new file will be created.
1661 # @format: #optional the format of the snapshot image, default is 'qcow2'.
1663 # @mode: #optional whether and how QEMU should create a new image, default is
1666 # Returns: nothing on success
1667 # If @device is not a valid block device, DeviceNotFound
1671 { 'command': 'blockdev-snapshot-sync',
1672 'data': { 'device': 'str', 'snapshot-file': 'str', '*format': 'str',
1673 '*mode': 'NewImageMode'} }
1676 # @human-monitor-command:
1678 # Execute a command on the human monitor and return the output.
1680 # @command-line: the command to execute in the human monitor
1682 # @cpu-index: #optional The CPU to use for commands that require an implicit CPU
1684 # Returns: the output of the command as a string
1688 # Notes: This command only exists as a stop-gap. It's use is highly
1689 # discouraged. The semantics of this command are not guaranteed.
1691 # Known limitations:
1693 # o This command is stateless, this means that commands that depend
1694 # on state information (such as getfd) might not work
1696 # o Commands that prompt the user for data (eg. 'cont' when the block
1697 # device is encrypted) don't currently work
1699 { 'command': 'human-monitor-command',
1700 'data': {'command-line': 'str', '*cpu-index': 'int'},
1706 # Live commit of data from overlay image nodes into backing nodes - i.e.,
1707 # writes data between 'top' and 'base' into 'base'.
1709 # @device: the name of the device
1711 # @base: #optional The file name of the backing image to write data into.
1712 # If not specified, this is the deepest backing image
1714 # @top: The file name of the backing image within the image chain,
1715 # which contains the topmost data to be committed down.
1716 # Note, the active layer as 'top' is currently unsupported.
1718 # If top == base, that is an error.
1721 # @speed: #optional the maximum speed, in bytes per second
1723 # Returns: Nothing on success
1724 # If commit or stream is already active on this device, DeviceInUse
1725 # If @device does not exist, DeviceNotFound
1726 # If image commit is not supported by this device, NotSupported
1727 # If @base or @top is invalid, a generic error is returned
1728 # If @top is the active layer, or omitted, a generic error is returned
1729 # If @speed is invalid, InvalidParameter
1734 { 'command': 'block-commit',
1735 'data': { 'device': 'str', '*base': 'str', 'top': 'str',
1741 # Start mirroring a block device's writes to a new destination.
1743 # @device: the name of the device whose writes should be mirrored.
1745 # @target: the target of the new image. If the file exists, or if it
1746 # is a device, the existing file/device will be used as the new
1747 # destination. If it does not exist, a new file will be created.
1749 # @format: #optional the format of the new destination, default is to
1750 # probe if @mode is 'existing', else the format of the source
1752 # @mode: #optional whether and how QEMU should create a new image, default is
1755 # @speed: #optional the maximum speed, in bytes per second
1757 # @sync: what parts of the disk image should be copied to the destination
1758 # (all the disk, only the sectors allocated in the topmost image, or
1761 # @granularity: #optional granularity of the dirty bitmap, default is 64K
1762 # if the image format doesn't have clusters, 4K if the clusters
1763 # are smaller than that, else the cluster size. Must be a
1764 # power of 2 between 512 and 64M (since 1.4).
1766 # @buf-size: #optional maximum amount of data in flight from source to
1767 # target (since 1.4).
1769 # @on-source-error: #optional the action to take on an error on the source,
1770 # default 'report'. 'stop' and 'enospc' can only be used
1771 # if the block device supports io-status (see BlockInfo).
1773 # @on-target-error: #optional the action to take on an error on the target,
1774 # default 'report' (no limitations, since this applies to
1775 # a different block device than @device).
1777 # Returns: nothing on success
1778 # If @device is not a valid block device, DeviceNotFound
1782 { 'command': 'drive-mirror',
1783 'data': { 'device': 'str', 'target': 'str', '*format': 'str',
1784 'sync': 'MirrorSyncMode', '*mode': 'NewImageMode',
1785 '*speed': 'int', '*granularity': 'uint32',
1786 '*buf-size': 'int', '*on-source-error': 'BlockdevOnError',
1787 '*on-target-error': 'BlockdevOnError' } }
1792 # Cancel the current executing migration process.
1794 # Returns: nothing on success
1796 # Notes: This command succeeds even if there is no migration process running.
1800 { 'command': 'migrate_cancel' }
1803 # @migrate_set_downtime
1805 # Set maximum tolerated downtime for migration.
1807 # @value: maximum downtime in seconds
1809 # Returns: nothing on success
1813 { 'command': 'migrate_set_downtime', 'data': {'value': 'number'} }
1816 # @migrate_set_speed
1818 # Set maximum speed for migration.
1820 # @value: maximum speed in bytes.
1822 # Returns: nothing on success
1824 # Notes: A value lesser than zero will be automatically round up to zero.
1828 { 'command': 'migrate_set_speed', 'data': {'value': 'int'} }
1831 # @migrate-set-cache-size
1833 # Set XBZRLE cache size
1835 # @value: cache size in bytes
1837 # The size will be rounded down to the nearest power of 2.
1838 # The cache size can be modified before and during ongoing migration
1840 # Returns: nothing on success
1844 { 'command': 'migrate-set-cache-size', 'data': {'value': 'int'} }
1847 # @query-migrate-cache-size
1849 # query XBZRLE cache size
1851 # Returns: XBZRLE cache size in bytes
1855 { 'command': 'query-migrate-cache-size', 'returns': 'int' }
1858 # @ObjectPropertyInfo:
1860 # @name: the name of the property
1862 # @type: the type of the property. This will typically come in one of four
1865 # 1) A primitive type such as 'u8', 'u16', 'bool', 'str', or 'double'.
1866 # These types are mapped to the appropriate JSON type.
1868 # 2) A legacy type in the form 'legacy<subtype>' where subtype is the
1869 # legacy qdev typename. These types are always treated as strings.
1871 # 3) A child type in the form 'child<subtype>' where subtype is a qdev
1872 # device type name. Child properties create the composition tree.
1874 # 4) A link type in the form 'link<subtype>' where subtype is a qdev
1875 # device type name. Link properties form the device model graph.
1879 { 'type': 'ObjectPropertyInfo',
1880 'data': { 'name': 'str', 'type': 'str' } }
1885 # This command will list any properties of a object given a path in the object
1888 # @path: the path within the object model. See @qom-get for a description of
1891 # Returns: a list of @ObjectPropertyInfo that describe the properties of the
1896 { 'command': 'qom-list',
1897 'data': { 'path': 'str' },
1898 'returns': [ 'ObjectPropertyInfo' ] }
1903 # This command will get a property from a object model path and return the
1906 # @path: The path within the object model. There are two forms of supported
1907 # paths--absolute and partial paths.
1909 # Absolute paths are derived from the root object and can follow child<>
1910 # or link<> properties. Since they can follow link<> properties, they
1911 # can be arbitrarily long. Absolute paths look like absolute filenames
1912 # and are prefixed with a leading slash.
1914 # Partial paths look like relative filenames. They do not begin
1915 # with a prefix. The matching rules for partial paths are subtle but
1916 # designed to make specifying objects easy. At each level of the
1917 # composition tree, the partial path is matched as an absolute path.
1918 # The first match is not returned. At least two matches are searched
1919 # for. A successful result is only returned if only one match is
1920 # found. If more than one match is found, a flag is return to
1921 # indicate that the match was ambiguous.
1923 # @property: The property name to read
1925 # Returns: The property value. The type depends on the property type. legacy<>
1926 # properties are returned as #str. child<> and link<> properties are
1927 # returns as #str pathnames. All integer property types (u8, u16, etc)
1928 # are returned as #int.
1932 { 'command': 'qom-get',
1933 'data': { 'path': 'str', 'property': 'str' },
1934 'returns': 'visitor',
1940 # This command will set a property from a object model path.
1942 # @path: see @qom-get for a description of this parameter
1944 # @property: the property name to set
1946 # @value: a value who's type is appropriate for the property type. See @qom-get
1947 # for a description of type mapping.
1951 { 'command': 'qom-set',
1952 'data': { 'path': 'str', 'property': 'str', 'value': 'visitor' },
1958 # Sets the password of a remote display session.
1960 # @protocol: `vnc' to modify the VNC server password
1961 # `spice' to modify the Spice server password
1963 # @password: the new password
1965 # @connected: #optional how to handle existing clients when changing the
1966 # password. If nothing is specified, defaults to `keep'
1967 # `fail' to fail the command if clients are connected
1968 # `disconnect' to disconnect existing clients
1969 # `keep' to maintain existing clients
1971 # Returns: Nothing on success
1972 # If Spice is not enabled, DeviceNotFound
1976 { 'command': 'set_password',
1977 'data': {'protocol': 'str', 'password': 'str', '*connected': 'str'} }
1982 # Expire the password of a remote display server.
1984 # @protocol: the name of the remote display protocol `vnc' or `spice'
1986 # @time: when to expire the password.
1987 # `now' to expire the password immediately
1988 # `never' to cancel password expiration
1989 # `+INT' where INT is the number of seconds from now (integer)
1990 # `INT' where INT is the absolute time in seconds
1992 # Returns: Nothing on success
1993 # If @protocol is `spice' and Spice is not active, DeviceNotFound
1997 # Notes: Time is relative to the server and currently there is no way to
1998 # coordinate server time with client time. It is not recommended to
1999 # use the absolute time version of the @time parameter unless you're
2000 # sure you are on the same machine as the QEMU instance.
2002 { 'command': 'expire_password', 'data': {'protocol': 'str', 'time': 'str'} }
2007 # Ejects a device from a removable drive.
2009 # @device: The name of the device
2011 # @force: @optional If true, eject regardless of whether the drive is locked.
2012 # If not specified, the default value is false.
2014 # Returns: Nothing on success
2015 # If @device is not a valid block device, DeviceNotFound
2017 # Notes: Ejecting a device will no media results in success
2021 { 'command': 'eject', 'data': {'device': 'str', '*force': 'bool'} }
2024 # @change-vnc-password:
2026 # Change the VNC server password.
2028 # @target: the new password to use with VNC authentication
2032 # Notes: An empty password in this command will set the password to the empty
2033 # string. Existing clients are unaffected by executing this command.
2035 { 'command': 'change-vnc-password', 'data': {'password': 'str'} }
2040 # This command is multiple commands multiplexed together.
2042 # @device: This is normally the name of a block device but it may also be 'vnc'.
2043 # when it's 'vnc', then sub command depends on @target
2045 # @target: If @device is a block device, then this is the new filename.
2046 # If @device is 'vnc', then if the value 'password' selects the vnc
2047 # change password command. Otherwise, this specifies a new server URI
2048 # address to listen to for VNC connections.
2050 # @arg: If @device is a block device, then this is an optional format to open
2052 # If @device is 'vnc' and @target is 'password', this is the new VNC
2053 # password to set. If this argument is an empty string, then no future
2054 # logins will be allowed.
2056 # Returns: Nothing on success.
2057 # If @device is not a valid block device, DeviceNotFound
2058 # If the new block device is encrypted, DeviceEncrypted. Note that
2059 # if this error is returned, the device has been opened successfully
2060 # and an additional call to @block_passwd is required to set the
2061 # device's password. The behavior of reads and writes to the block
2062 # device between when these calls are executed is undefined.
2064 # Notes: It is strongly recommended that this interface is not used especially
2065 # for changing block devices.
2069 { 'command': 'change',
2070 'data': {'device': 'str', 'target': 'str', '*arg': 'str'} }
2073 # @block_set_io_throttle:
2075 # Change I/O throttle limits for a block drive.
2077 # @device: The name of the device
2079 # @bps: total throughput limit in bytes per second
2081 # @bps_rd: read throughput limit in bytes per second
2083 # @bps_wr: write throughput limit in bytes per second
2085 # @iops: total I/O operations per second
2087 # @ops_rd: read I/O operations per second
2089 # @iops_wr: write I/O operations per second
2091 # Returns: Nothing on success
2092 # If @device is not a valid block device, DeviceNotFound
2096 { 'command': 'block_set_io_throttle',
2097 'data': { 'device': 'str', 'bps': 'int', 'bps_rd': 'int', 'bps_wr': 'int',
2098 'iops': 'int', 'iops_rd': 'int', 'iops_wr': 'int' } }
2103 # Copy data from a backing file into a block device.
2105 # The block streaming operation is performed in the background until the entire
2106 # backing file has been copied. This command returns immediately once streaming
2107 # has started. The status of ongoing block streaming operations can be checked
2108 # with query-block-jobs. The operation can be stopped before it has completed
2109 # using the block-job-cancel command.
2111 # If a base file is specified then sectors are not copied from that base file and
2112 # its backing chain. When streaming completes the image file will have the base
2113 # file as its backing file. This can be used to stream a subset of the backing
2114 # file chain instead of flattening the entire image.
2116 # On successful completion the image file is updated to drop the backing file
2117 # and the BLOCK_JOB_COMPLETED event is emitted.
2119 # @device: the device name
2121 # @base: #optional the common backing file name
2123 # @speed: #optional the maximum speed, in bytes per second
2125 # @on-error: #optional the action to take on an error (default report).
2126 # 'stop' and 'enospc' can only be used if the block device
2127 # supports io-status (see BlockInfo). Since 1.3.
2129 # Returns: Nothing on success
2130 # If @device does not exist, DeviceNotFound
2134 { 'command': 'block-stream',
2135 'data': { 'device': 'str', '*base': 'str', '*speed': 'int',
2136 '*on-error': 'BlockdevOnError' } }
2139 # @block-job-set-speed:
2141 # Set maximum speed for a background block operation.
2143 # This command can only be issued when there is an active block job.
2145 # Throttling can be disabled by setting the speed to 0.
2147 # @device: the device name
2149 # @speed: the maximum speed, in bytes per second, or 0 for unlimited.
2152 # Returns: Nothing on success
2153 # If no background operation is active on this device, DeviceNotActive
2157 { 'command': 'block-job-set-speed',
2158 'data': { 'device': 'str', 'speed': 'int' } }
2161 # @block-job-cancel:
2163 # Stop an active background block operation.
2165 # This command returns immediately after marking the active background block
2166 # operation for cancellation. It is an error to call this command if no
2167 # operation is in progress.
2169 # The operation will cancel as soon as possible and then emit the
2170 # BLOCK_JOB_CANCELLED event. Before that happens the job is still visible when
2171 # enumerated using query-block-jobs.
2173 # For streaming, the image file retains its backing file unless the streaming
2174 # operation happens to complete just as it is being cancelled. A new streaming
2175 # operation can be started at a later time to finish copying all data from the
2178 # @device: the device name
2180 # @force: #optional whether to allow cancellation of a paused job (default
2181 # false). Since 1.3.
2183 # Returns: Nothing on success
2184 # If no background operation is active on this device, DeviceNotActive
2188 { 'command': 'block-job-cancel', 'data': { 'device': 'str', '*force': 'bool' } }
2193 # Pause an active background block operation.
2195 # This command returns immediately after marking the active background block
2196 # operation for pausing. It is an error to call this command if no
2197 # operation is in progress. Pausing an already paused job has no cumulative
2198 # effect; a single block-job-resume command will resume the job.
2200 # The operation will pause as soon as possible. No event is emitted when
2201 # the operation is actually paused. Cancelling a paused job automatically
2204 # @device: the device name
2206 # Returns: Nothing on success
2207 # If no background operation is active on this device, DeviceNotActive
2211 { 'command': 'block-job-pause', 'data': { 'device': 'str' } }
2214 # @block-job-resume:
2216 # Resume an active background block operation.
2218 # This command returns immediately after resuming a paused background block
2219 # operation. It is an error to call this command if no operation is in
2220 # progress. Resuming an already running job is not an error.
2222 # This command also clears the error status of the job.
2224 # @device: the device name
2226 # Returns: Nothing on success
2227 # If no background operation is active on this device, DeviceNotActive
2231 { 'command': 'block-job-resume', 'data': { 'device': 'str' } }
2234 # @block-job-complete:
2236 # Manually trigger completion of an active background block operation. This
2237 # is supported for drive mirroring, where it also switches the device to
2238 # write to the target path only. The ability to complete is signaled with
2239 # a BLOCK_JOB_READY event.
2241 # This command completes an active background block operation synchronously.
2242 # The ordering of this command's return with the BLOCK_JOB_COMPLETED event
2243 # is not defined. Note that if an I/O error occurs during the processing of
2244 # this command: 1) the command itself will fail; 2) the error will be processed
2245 # according to the rerror/werror arguments that were specified when starting
2248 # A cancelled or paused job cannot be completed.
2250 # @device: the device name
2252 # Returns: Nothing on success
2253 # If no background operation is active on this device, DeviceNotActive
2257 { 'command': 'block-job-complete', 'data': { 'device': 'str' } }
2262 # This structure describes a search result from @qom-list-types
2264 # @name: the type name found in the search
2268 # Notes: This command is experimental and may change syntax in future releases.
2270 { 'type': 'ObjectTypeInfo',
2271 'data': { 'name': 'str' } }
2276 # This command will return a list of types given search parameters
2278 # @implements: if specified, only return types that implement this type name
2280 # @abstract: if true, include abstract types in the results
2282 # Returns: a list of @ObjectTypeInfo or an empty list if no results are found
2286 { 'command': 'qom-list-types',
2287 'data': { '*implements': 'str', '*abstract': 'bool' },
2288 'returns': [ 'ObjectTypeInfo' ] }
2291 # @DevicePropertyInfo:
2293 # Information about device properties.
2295 # @name: the name of the property
2296 # @type: the typename of the property
2300 { 'type': 'DevicePropertyInfo',
2301 'data': { 'name': 'str', 'type': 'str' } }
2304 # @device-list-properties:
2306 # List properties associated with a device.
2308 # @typename: the type name of a device
2310 # Returns: a list of DevicePropertyInfo describing a devices properties
2314 { 'command': 'device-list-properties',
2315 'data': { 'typename': 'str'},
2316 'returns': [ 'DevicePropertyInfo' ] }
2321 # Migrates the current running guest to another Virtual Machine.
2323 # @uri: the Uniform Resource Identifier of the destination VM
2325 # @blk: #optional do block migration (full disk copy)
2327 # @inc: #optional incremental disk copy migration
2329 # @detach: this argument exists only for compatibility reasons and
2330 # is ignored by QEMU
2332 # Returns: nothing on success
2336 { 'command': 'migrate',
2337 'data': {'uri': 'str', '*blk': 'bool', '*inc': 'bool', '*detach': 'bool' } }
2339 # @xen-save-devices-state:
2341 # Save the state of all devices to file. The RAM and the block devices
2342 # of the VM are not saved by this command.
2344 # @filename: the file to save the state of the devices to as binary
2345 # data. See xen-save-devices-state.txt for a description of the binary
2348 # Returns: Nothing on success
2352 { 'command': 'xen-save-devices-state', 'data': {'filename': 'str'} }
2355 # @xen-set-global-dirty-log
2357 # Enable or disable the global dirty log mode.
2359 # @enable: true to enable, false to disable.
2365 { 'command': 'xen-set-global-dirty-log', 'data': { 'enable': 'bool' } }
2370 # Remove a device from a guest
2372 # @id: the name of the device
2374 # Returns: Nothing on success
2375 # If @id is not a valid device, DeviceNotFound
2377 # Notes: When this command completes, the device may not be removed from the
2378 # guest. Hot removal is an operation that requires guest cooperation.
2379 # This command merely requests that the guest begin the hot removal
2380 # process. Completion of the device removal process is signaled with a
2381 # DEVICE_DELETED event. Guest reset will automatically complete removal
2386 { 'command': 'device_del', 'data': {'id': 'str'} }
2389 # @dump-guest-memory
2391 # Dump guest's memory to vmcore. It is a synchronous operation that can take
2392 # very long depending on the amount of guest memory. This command is only
2393 # supported on i386 and x86_64.
2395 # @paging: if true, do paging to get guest's memory mapping. This allows
2396 # using gdb to process the core file.
2398 # IMPORTANT: this option can make QEMU allocate several gigabytes
2399 # of RAM. This can happen for a large guest, or a
2400 # malicious guest pretending to be large.
2402 # Also, paging=true has the following limitations:
2404 # 1. The guest may be in a catastrophic state or can have corrupted
2405 # memory, which cannot be trusted
2406 # 2. The guest can be in real-mode even if paging is enabled. For
2407 # example, the guest uses ACPI to sleep, and ACPI sleep state
2410 # @protocol: the filename or file descriptor of the vmcore. The supported
2413 # 1. file: the protocol starts with "file:", and the following
2414 # string is the file's path.
2415 # 2. fd: the protocol starts with "fd:", and the following string
2418 # @begin: #optional if specified, the starting physical address.
2420 # @length: #optional if specified, the memory size, in bytes. If you don't
2421 # want to dump all guest's memory, please specify the start @begin
2424 # Returns: nothing on success
2428 { 'command': 'dump-guest-memory',
2429 'data': { 'paging': 'bool', 'protocol': 'str', '*begin': 'int',
2430 '*length': 'int' } }
2435 # Add a network backend.
2437 # @type: the type of network backend. Current valid values are 'user', 'tap',
2438 # 'vde', 'socket', 'dump' and 'bridge'
2440 # @id: the name of the new network backend
2442 # @props: #optional a list of properties to be passed to the backend in
2443 # the format 'name=value', like 'ifname=tap0,script=no'
2445 # Notes: The semantics of @props is not well defined. Future commands will be
2446 # introduced that provide stronger typing for backend creation.
2450 # Returns: Nothing on success
2451 # If @type is not a valid network backend, DeviceNotFound
2453 { 'command': 'netdev_add',
2454 'data': {'type': 'str', 'id': 'str', '*props': '**'},
2460 # Remove a network backend.
2462 # @id: the name of the network backend to remove
2464 # Returns: Nothing on success
2465 # If @id is not a valid network backend, DeviceNotFound
2469 { 'command': 'netdev_del', 'data': {'id': 'str'} }
2472 # @NetdevNoneOptions
2474 # Use it alone to have zero network devices.
2478 { 'type': 'NetdevNoneOptions',
2482 # @NetLegacyNicOptions
2484 # Create a new Network Interface Card.
2486 # @netdev: #optional id of -netdev to connect to
2488 # @macaddr: #optional MAC address
2490 # @model: #optional device model (e1000, rtl8139, virtio etc.)
2492 # @addr: #optional PCI device address
2494 # @vectors: #optional number of MSI-x vectors, 0 to disable MSI-X
2498 { 'type': 'NetLegacyNicOptions',
2504 '*vectors': 'uint32' } }
2509 # A fat type wrapping 'str', to be embedded in lists.
2518 # @NetdevUserOptions
2520 # Use the user mode network stack which requires no administrator privilege to
2523 # @hostname: #optional client hostname reported by the builtin DHCP server
2525 # @restrict: #optional isolate the guest from the host
2527 # @ip: #optional legacy parameter, use net= instead
2529 # @net: #optional IP address and optional netmask
2531 # @host: #optional guest-visible address of the host
2533 # @tftp: #optional root directory of the built-in TFTP server
2535 # @bootfile: #optional BOOTP filename, for use with tftp=
2537 # @dhcpstart: #optional the first of the 16 IPs the built-in DHCP server can
2540 # @dns: #optional guest-visible address of the virtual nameserver
2542 # @dnssearch: #optional list of DNS suffixes to search, passed as DHCP option
2545 # @smb: #optional root directory of the built-in SMB server
2547 # @smbserver: #optional IP address of the built-in SMB server
2549 # @hostfwd: #optional redirect incoming TCP or UDP host connections to guest
2552 # @guestfwd: #optional forward guest TCP connections
2556 { 'type': 'NetdevUserOptions',
2559 '*restrict': 'bool',
2565 '*dhcpstart': 'str',
2567 '*dnssearch': ['String'],
2569 '*smbserver': 'str',
2570 '*hostfwd': ['String'],
2571 '*guestfwd': ['String'] } }
2576 # Connect the host TAP network interface name to the VLAN.
2578 # @ifname: #optional interface name
2580 # @fd: #optional file descriptor of an already opened tap
2582 # @fds: #optional multiple file descriptors of already opened multiqueue capable
2585 # @script: #optional script to initialize the interface
2587 # @downscript: #optional script to shut down the interface
2589 # @helper: #optional command to execute to configure bridge
2591 # @sndbuf: #optional send buffer limit. Understands [TGMKkb] suffixes.
2593 # @vnet_hdr: #optional enable the IFF_VNET_HDR flag on the tap interface
2595 # @vhost: #optional enable vhost-net network accelerator
2597 # @vhostfd: #optional file descriptor of an already opened vhost net device
2599 # @vhostfds: #optional file descriptors of multiple already opened vhost net
2602 # @vhostforce: #optional vhost on for non-MSIX virtio guests
2604 # @queues: #optional number of queues to be created for multiqueue capable tap
2608 { 'type': 'NetdevTapOptions',
2614 '*downscript': 'str',
2617 '*vnet_hdr': 'bool',
2621 '*vhostforce': 'bool',
2622 '*queues': 'uint32'} }
2625 # @NetdevSocketOptions
2627 # Connect the VLAN to a remote VLAN in another QEMU virtual machine using a TCP
2628 # socket connection.
2630 # @fd: #optional file descriptor of an already opened socket
2632 # @listen: #optional port number, and optional hostname, to listen on
2634 # @connect: #optional port number, and optional hostname, to connect to
2636 # @mcast: #optional UDP multicast address and port number
2638 # @localaddr: #optional source address and port for multicast and udp packets
2640 # @udp: #optional UDP unicast address and port number
2644 { 'type': 'NetdevSocketOptions',
2650 '*localaddr': 'str',
2656 # Connect the VLAN to a vde switch running on the host.
2658 # @sock: #optional socket path
2660 # @port: #optional port number
2662 # @group: #optional group owner of socket
2664 # @mode: #optional permissions for socket
2668 { 'type': 'NetdevVdeOptions',
2673 '*mode': 'uint16' } }
2676 # @NetdevDumpOptions
2678 # Dump VLAN network traffic to a file.
2680 # @len: #optional per-packet size limit (64k default). Understands [TGMKkb]
2683 # @file: #optional dump file path (default is qemu-vlan0.pcap)
2687 { 'type': 'NetdevDumpOptions',
2693 # @NetdevBridgeOptions
2695 # Connect a host TAP network interface to a host bridge device.
2697 # @br: #optional bridge name
2699 # @helper: #optional command to execute to configure bridge
2703 { 'type': 'NetdevBridgeOptions',
2706 '*helper': 'str' } }
2709 # @NetdevHubPortOptions
2711 # Connect two or more net clients through a software hub.
2713 # @hubid: hub identifier number
2717 { 'type': 'NetdevHubPortOptions',
2719 'hubid': 'int32' } }
2724 # A discriminated record of network device traits.
2728 { 'union': 'NetClientOptions',
2730 'none': 'NetdevNoneOptions',
2731 'nic': 'NetLegacyNicOptions',
2732 'user': 'NetdevUserOptions',
2733 'tap': 'NetdevTapOptions',
2734 'socket': 'NetdevSocketOptions',
2735 'vde': 'NetdevVdeOptions',
2736 'dump': 'NetdevDumpOptions',
2737 'bridge': 'NetdevBridgeOptions',
2738 'hubport': 'NetdevHubPortOptions' } }
2743 # Captures the configuration of a network device; legacy.
2745 # @vlan: #optional vlan number
2747 # @id: #optional identifier for monitor commands
2749 # @name: #optional identifier for monitor commands, ignored if @id is present
2751 # @opts: device type specific properties (legacy)
2755 { 'type': 'NetLegacy',
2760 'opts': 'NetClientOptions' } }
2765 # Captures the configuration of a network device.
2767 # @id: identifier for monitor commands.
2769 # @opts: device type specific properties
2776 'opts': 'NetClientOptions' } }
2779 # @InetSocketAddress
2781 # Captures a socket address or address range in the Internet namespace.
2783 # @host: host part of the address
2785 # @port: port part of the address, or lowest port if @to is present
2787 # @to: highest port to try
2789 # @ipv4: whether to accept IPv4 addresses, default try both IPv4 and IPv6
2792 # @ipv6: whether to accept IPv6 addresses, default try both IPv4 and IPv6
2797 { 'type': 'InetSocketAddress',
2806 # @UnixSocketAddress
2808 # Captures a socket address in the local ("Unix socket") namespace.
2810 # @path: filesystem path to use
2814 { 'type': 'UnixSocketAddress',
2821 # Captures the address of a socket, which could also be a named file descriptor
2825 { 'union': 'SocketAddress',
2827 'inet': 'InetSocketAddress',
2828 'unix': 'UnixSocketAddress',
2834 # Receive a file descriptor via SCM rights and assign it a name
2836 # @fdname: file descriptor name
2838 # Returns: Nothing on success
2842 # Notes: If @fdname already exists, the file descriptor assigned to
2843 # it will be closed and replaced by the received file
2845 # The 'closefd' command can be used to explicitly close the
2846 # file descriptor when it is no longer needed.
2848 { 'command': 'getfd', 'data': {'fdname': 'str'} }
2853 # Close a file descriptor previously passed via SCM rights
2855 # @fdname: file descriptor name
2857 # Returns: Nothing on success
2861 { 'command': 'closefd', 'data': {'fdname': 'str'} }
2866 # Information describing a machine.
2868 # @name: the name of the machine
2870 # @alias: #optional an alias for the machine name
2872 # @default: #optional whether the machine is default
2874 # @cpu-max: maximum number of CPUs supported by the machine type
2879 { 'type': 'MachineInfo',
2880 'data': { 'name': 'str', '*alias': 'str',
2881 '*is-default': 'bool', 'cpu-max': 'int' } }
2886 # Return a list of supported machines
2888 # Returns: a list of MachineInfo
2892 { 'command': 'query-machines', 'returns': ['MachineInfo'] }
2895 # @CpuDefinitionInfo:
2897 # Virtual CPU definition.
2899 # @name: the name of the CPU definition
2903 { 'type': 'CpuDefinitionInfo',
2904 'data': { 'name': 'str' } }
2907 # @query-cpu-definitions:
2909 # Return a list of supported virtual CPU definitions
2911 # Returns: a list of CpuDefInfo
2915 { 'command': 'query-cpu-definitions', 'returns': ['CpuDefinitionInfo'] }
2919 # Information about a file descriptor that was added to an fd set.
2921 # @fdset-id: The ID of the fd set that @fd was added to.
2923 # @fd: The file descriptor that was received via SCM rights and
2924 # added to the fd set.
2928 { 'type': 'AddfdInfo', 'data': {'fdset-id': 'int', 'fd': 'int'} }
2933 # Add a file descriptor, that was passed via SCM rights, to an fd set.
2935 # @fdset-id: #optional The ID of the fd set to add the file descriptor to.
2937 # @opaque: #optional A free-form string that can be used to describe the fd.
2939 # Returns: @AddfdInfo on success
2940 # If file descriptor was not received, FdNotSupplied
2941 # If @fdset-id is a negative value, InvalidParameterValue
2943 # Notes: The list of fd sets is shared by all monitor connections.
2945 # If @fdset-id is not specified, a new fd set will be created.
2949 { 'command': 'add-fd', 'data': {'*fdset-id': 'int', '*opaque': 'str'},
2950 'returns': 'AddfdInfo' }
2955 # Remove a file descriptor from an fd set.
2957 # @fdset-id: The ID of the fd set that the file descriptor belongs to.
2959 # @fd: #optional The file descriptor that is to be removed.
2961 # Returns: Nothing on success
2962 # If @fdset-id or @fd is not found, FdNotFound
2966 # Notes: The list of fd sets is shared by all monitor connections.
2968 # If @fd is not specified, all file descriptors in @fdset-id
2971 { 'command': 'remove-fd', 'data': {'fdset-id': 'int', '*fd': 'int'} }
2976 # Information about a file descriptor that belongs to an fd set.
2978 # @fd: The file descriptor value.
2980 # @opaque: #optional A free-form string that can be used to describe the fd.
2984 { 'type': 'FdsetFdInfo',
2985 'data': {'fd': 'int', '*opaque': 'str'} }
2990 # Information about an fd set.
2992 # @fdset-id: The ID of the fd set.
2994 # @fds: A list of file descriptors that belong to this fd set.
2998 { 'type': 'FdsetInfo',
2999 'data': {'fdset-id': 'int', 'fds': ['FdsetFdInfo']} }
3004 # Return information describing all fd sets.
3006 # Returns: A list of @FdsetInfo
3010 # Note: The list of fd sets is shared by all monitor connections.
3013 { 'command': 'query-fdsets', 'returns': ['FdsetInfo'] }
3018 # Information describing the QEMU target.
3020 # @arch: the target architecture (eg "x86_64", "i386", etc)
3024 { 'type': 'TargetInfo',
3025 'data': { 'arch': 'str' } }
3030 # Return information about the target for this QEMU
3032 # Returns: TargetInfo
3036 { 'command': 'query-target', 'returns': 'TargetInfo' }
3041 # An enumeration of key name.
3043 # This is used by the send-key command.
3047 { 'enum': 'QKeyCode',
3048 'data': [ 'shift', 'shift_r', 'alt', 'alt_r', 'altgr', 'altgr_r', 'ctrl',
3049 'ctrl_r', 'menu', 'esc', '1', '2', '3', '4', '5', '6', '7', '8',
3050 '9', '0', 'minus', 'equal', 'backspace', 'tab', 'q', 'w', 'e',
3051 'r', 't', 'y', 'u', 'i', 'o', 'p', 'bracket_left', 'bracket_right',
3052 'ret', 'a', 's', 'd', 'f', 'g', 'h', 'j', 'k', 'l', 'semicolon',
3053 'apostrophe', 'grave_accent', 'backslash', 'z', 'x', 'c', 'v', 'b',
3054 'n', 'm', 'comma', 'dot', 'slash', 'asterisk', 'spc', 'caps_lock',
3055 'f1', 'f2', 'f3', 'f4', 'f5', 'f6', 'f7', 'f8', 'f9', 'f10',
3056 'num_lock', 'scroll_lock', 'kp_divide', 'kp_multiply',
3057 'kp_subtract', 'kp_add', 'kp_enter', 'kp_decimal', 'sysrq', 'kp_0',
3058 'kp_1', 'kp_2', 'kp_3', 'kp_4', 'kp_5', 'kp_6', 'kp_7', 'kp_8',
3059 'kp_9', 'less', 'f11', 'f12', 'print', 'home', 'pgup', 'pgdn', 'end',
3060 'left', 'up', 'down', 'right', 'insert', 'delete', 'stop', 'again',
3061 'props', 'undo', 'front', 'copy', 'open', 'paste', 'find', 'cut',
3062 'lf', 'help', 'meta_l', 'meta_r', 'compose' ] }
3067 # Represents a keyboard key.
3071 { 'union': 'KeyValue',
3074 'qcode': 'QKeyCode' } }
3079 # Send keys to guest.
3081 # @keys: An array of @KeyValue elements. All @KeyValues in this array are
3082 # simultaneously sent to the guest. A @KeyValue.number value is sent
3083 # directly to the guest, while @KeyValue.qcode must be a valid
3086 # @hold-time: #optional time to delay key up events, milliseconds. Defaults
3089 # Returns: Nothing on success
3090 # If key is unknown or redundant, InvalidParameter
3095 { 'command': 'send-key',
3096 'data': { 'keys': ['KeyValue'], '*hold-time': 'int' } }
3101 # Write a PPM of the VGA screen to a file.
3103 # @filename: the path of a new PPM file to store the image
3105 # Returns: Nothing on success
3109 { 'command': 'screendump', 'data': {'filename': 'str'} }
3112 # @nbd-server-start:
3114 # Start an NBD server listening on the given host and port. Block
3115 # devices can then be exported using @nbd-server-add. The NBD
3116 # server will present them as named exports; for example, another
3117 # QEMU instance could refer to them as "nbd:HOST:PORT:exportname=NAME".
3119 # @addr: Address on which to listen.
3121 # Returns: error if the server is already running.
3125 { 'command': 'nbd-server-start',
3126 'data': { 'addr': 'SocketAddress' } }
3131 # Export a device to QEMU's embedded NBD server.
3133 # @device: Block device to be exported
3135 # @writable: Whether clients should be able to write to the device via the
3136 # NBD connection (default false). #optional
3138 # Returns: error if the device is already marked for export.
3142 { 'command': 'nbd-server-add', 'data': {'device': 'str', '*writable': 'bool'} }
3147 # Stop QEMU's embedded NBD server, and unregister all devices previously
3148 # added via @nbd-server-add.
3152 { 'command': 'nbd-server-stop' }
3157 # Configuration info for file chardevs.
3159 # @in: #optional The name of the input file
3160 # @out: The name of the output file
3164 { 'type': 'ChardevFile', 'data': { '*in' : 'str',
3170 # Configuration info for device and pipe chardevs.
3172 # @device: The name of the special file for the device,
3173 # i.e. /dev/ttyS0 on Unix or COM1: on Windows
3174 # @type: What kind of device this is.
3178 { 'type': 'ChardevHostdev', 'data': { 'device' : 'str' } }
3183 # Configuration info for (stream) socket chardevs.
3185 # @addr: socket address to listen on (server=true)
3186 # or connect to (server=false)
3187 # @server: #optional create server socket (default: true)
3188 # @wait: #optional wait for connect (not used for server
3189 # sockets, default: false)
3190 # @nodelay: #optional set TCP_NODELAY socket option (default: false)
3191 # @telnet: #optional enable telnet protocol (default: false)
3195 { 'type': 'ChardevSocket', 'data': { 'addr' : 'SocketAddress',
3198 '*nodelay' : 'bool',
3199 '*telnet' : 'bool' } }
3204 # Configuration info for datagram socket chardevs.
3206 # @remote: remote address
3207 # @local: #optional local address
3211 { 'type': 'ChardevUdp', 'data': { 'remote' : 'SocketAddress',
3212 '*local' : 'SocketAddress' } }
3217 # Configuration info for mux chardevs.
3219 # @chardev: name of the base chardev.
3223 { 'type': 'ChardevMux', 'data': { 'chardev' : 'str' } }
3228 # Configuration info for stdio chardevs.
3230 # @signal: #optional Allow signals (such as SIGINT triggered by ^C)
3231 # be delivered to qemu. Default: true in -nographic mode,
3236 { 'type': 'ChardevStdio', 'data': { '*signal' : 'bool' } }
3239 # @ChardevSpiceChannel:
3241 # Configuration info for spice vm channel chardevs.
3243 # @type: kind of channel (for example vdagent).
3247 { 'type': 'ChardevSpiceChannel', 'data': { 'type' : 'str' } }
3250 # @ChardevSpicePort:
3252 # Configuration info for spice port chardevs.
3254 # @fqdn: name of the channel (see docs/spice-port-fqdn.txt)
3258 { 'type': 'ChardevSpicePort', 'data': { 'fqdn' : 'str' } }
3263 # Configuration info for virtual console chardevs.
3265 # @width: console width, in pixels
3266 # @height: console height, in pixels
3267 # @cols: console width, in chars
3268 # @rows: console height, in chars
3272 { 'type': 'ChardevVC', 'data': { '*width' : 'int',
3280 # Configuration info for memory chardevs
3282 # @size: #optional Ringbuffer size, must be power of two, default is 65536
3286 { 'type': 'ChardevMemory', 'data': { '*size' : 'int' } }
3291 # Configuration info for the new chardev backend.
3295 { 'type': 'ChardevDummy', 'data': { } }
3297 { 'union': 'ChardevBackend', 'data': { 'file' : 'ChardevFile',
3298 'serial' : 'ChardevHostdev',
3299 'parallel': 'ChardevHostdev',
3300 'pipe' : 'ChardevHostdev',
3301 'socket' : 'ChardevSocket',
3302 'udp' : 'ChardevUdp',
3303 'pty' : 'ChardevDummy',
3304 'null' : 'ChardevDummy',
3305 'mux' : 'ChardevMux',
3306 'msmouse': 'ChardevDummy',
3307 'braille': 'ChardevDummy',
3308 'stdio' : 'ChardevStdio',
3309 'console': 'ChardevDummy',
3310 'spicevmc' : 'ChardevSpiceChannel',
3311 'spiceport' : 'ChardevSpicePort',
3313 'memory' : 'ChardevMemory' } }
3318 # Return info about the chardev backend just created.
3320 # @pty: #optional name of the slave pseudoterminal device, present if
3321 # and only if a chardev of type 'pty' was created
3325 { 'type' : 'ChardevReturn', 'data': { '*pty' : 'str' } }
3330 # Add a character device backend
3332 # @id: the chardev's ID, must be unique
3333 # @backend: backend type and parameters
3335 # Returns: ChardevReturn.
3339 { 'command': 'chardev-add', 'data': {'id' : 'str',
3340 'backend' : 'ChardevBackend' },
3341 'returns': 'ChardevReturn' }
3346 # Remove a character device backend
3348 # @id: the chardev's ID, must exist and not be in use
3350 # Returns: Nothing on success
3354 { 'command': 'chardev-remove', 'data': {'id': 'str'} }
3359 # An enumeration of TPM models
3361 # @tpm-tis: TPM TIS model
3365 { 'enum': 'TpmModel', 'data': [ 'tpm-tis' ] }
3368 # @query-tpm-models:
3370 # Return a list of supported TPM models
3372 # Returns: a list of TpmModel
3376 { 'command': 'query-tpm-models', 'returns': ['TpmModel'] }
3381 # An enumeration of TPM types
3383 # @passthrough: TPM passthrough type
3387 { 'enum': 'TpmType', 'data': [ 'passthrough' ] }
3392 # Return a list of supported TPM types
3394 # Returns: a list of TpmType
3398 { 'command': 'query-tpm-types', 'returns': ['TpmType'] }
3401 # @TPMPassthroughOptions:
3403 # Information about the TPM passthrough type
3405 # @path: #optional string describing the path used for accessing the TPM device
3407 # @cancel-path: #optional string showing the TPM's sysfs cancel file
3408 # for cancellation of TPM commands while they are executing
3412 { 'type': 'TPMPassthroughOptions', 'data': { '*path' : 'str',
3413 '*cancel-path' : 'str'} }
3418 # A union referencing different TPM backend types' configuration options
3420 # @passthrough: The configuration options for the TPM passthrough type
3424 { 'union': 'TpmTypeOptions',
3425 'data': { 'passthrough' : 'TPMPassthroughOptions' } }
3430 # Information about the TPM
3432 # @id: The Id of the TPM
3434 # @model: The TPM frontend model
3436 # @options: The TPM (backend) type configuration options
3440 { 'type': 'TPMInfo',
3441 'data': {'id': 'str',
3442 'model': 'TpmModel',
3443 'options': 'TpmTypeOptions' } }
3448 # Return information about the TPM device
3450 # Returns: @TPMInfo on success
3454 { 'command': 'query-tpm', 'returns': ['TPMInfo'] }
3459 # Specify an ACPI table on the command line to load.
3461 # At most one of @file and @data can be specified. The list of files specified
3462 # by any one of them is loaded and concatenated in order. If both are omitted,
3465 # Other fields / optargs can be used to override fields of the generic ACPI
3466 # table header; refer to the ACPI specification 5.0, section 5.2.6 System
3467 # Description Table Header. If a header field is not overridden, then the
3468 # corresponding value from the concatenated blob is used (in case of @file), or
3469 # it is filled in with a hard-coded value (in case of @data).
3471 # String fields are copied into the matching ACPI member from lowest address
3472 # upwards, and silently truncated / NUL-padded to length.
3474 # @sig: #optional table signature / identifier (4 bytes)
3476 # @rev: #optional table revision number (dependent on signature, 1 byte)
3478 # @oem_id: #optional OEM identifier (6 bytes)
3480 # @oem_table_id: #optional OEM table identifier (8 bytes)
3482 # @oem_rev: #optional OEM-supplied revision number (4 bytes)
3484 # @asl_compiler_id: #optional identifier of the utility that created the table
3487 # @asl_compiler_rev: #optional revision number of the utility that created the
3490 # @file: #optional colon (:) separated list of pathnames to load and
3491 # concatenate as table data. The resultant binary blob is expected to
3492 # have an ACPI table header. At least one file is required. This field
3495 # @data: #optional colon (:) separated list of pathnames to load and
3496 # concatenate as table data. The resultant binary blob must not have an
3497 # ACPI table header. At least one file is required. This field excludes
3502 { 'type': 'AcpiTableOptions',
3507 '*oem_table_id': 'str',
3508 '*oem_rev': 'uint32',
3509 '*asl_compiler_id': 'str',
3510 '*asl_compiler_rev': 'uint32',
3515 # @CommandLineParameterType:
3517 # Possible types for an option parameter.
3519 # @string: accepts a character string
3521 # @boolean: accepts "on" or "off"
3523 # @number: accepts a number
3525 # @size: accepts a number followed by an optional suffix (K)ilo,
3526 # (M)ega, (G)iga, (T)era
3530 { 'enum': 'CommandLineParameterType',
3531 'data': ['string', 'boolean', 'number', 'size'] }
3534 # @CommandLineParameterInfo:
3536 # Details about a single parameter of a command line option.
3538 # @name: parameter name
3540 # @type: parameter @CommandLineParameterType
3542 # @help: #optional human readable text string, not suitable for parsing.
3546 { 'type': 'CommandLineParameterInfo',
3547 'data': { 'name': 'str',
3548 'type': 'CommandLineParameterType',
3552 # @CommandLineOptionInfo:
3554 # Details about a command line option, including its list of parameter details
3556 # @option: option name
3558 # @parameters: an array of @CommandLineParameterInfo
3562 { 'type': 'CommandLineOptionInfo',
3563 'data': { 'option': 'str', 'parameters': ['CommandLineParameterInfo'] } }
3566 # @query-command-line-options:
3568 # Query command line option schema.
3570 # @option: #optional option name
3572 # Returns: list of @CommandLineOptionInfo for all options (or for the given
3573 # @option). Returns an error if the given @option doesn't exist.
3577 {'command': 'query-command-line-options', 'data': { '*option': 'str' },
3578 'returns': ['CommandLineOptionInfo'] }
3583 # A X86 32-bit register
3587 { 'enum': 'X86CPURegister32',
3588 'data': [ 'EAX', 'EBX', 'ECX', 'EDX', 'ESP', 'EBP', 'ESI', 'EDI' ] }
3591 # @X86CPUFeatureWordInfo
3593 # Information about a X86 CPU feature word
3595 # @cpuid-input-eax: Input EAX value for CPUID instruction for that feature word
3597 # @cpuid-input-ecx: #optional Input ECX value for CPUID instruction for that
3600 # @cpuid-register: Output register containing the feature bits
3602 # @features: value of output register, containing the feature bits
3606 { 'type': 'X86CPUFeatureWordInfo',
3607 'data': { 'cpuid-input-eax': 'int',
3608 '*cpuid-input-ecx': 'int',
3609 'cpuid-register': 'X86CPURegister32',
3610 'features': 'int' } }