8 { 'include': 'common.json' }
13 # Enable QMP capabilities.
17 # @enable: An optional list of QMPCapability values to enable. The
18 # client must not enable any capability that is not
19 # mentioned in the QMP greeting message. If the field is not
20 # provided, it means no QMP capabilities will be enabled.
25 # -> { "execute": "qmp_capabilities",
26 # "arguments": { "enable": [ "oob" ] } }
29 # Notes: This command is valid exactly when first connecting: it must be
30 # issued before any other command will be accepted, and will fail once the
31 # monitor is accepting other commands. (see qemu docs/interop/qmp-spec.txt)
33 # The QMP client needs to explicitly enable QMP capabilities, otherwise
34 # all the QMP capabilities will be turned off by default.
39 { 'command': 'qmp_capabilities',
40 'data': { '*enable': [ 'QMPCapability' ] },
41 'allow-preconfig': true }
46 # Enumeration of capabilities to be advertised during initial client
47 # connection, used for agreeing on particular QMP extension behaviors.
49 # @oob: QMP ability to support out-of-band requests.
50 # (Please refer to qmp-spec.txt for more information on OOB)
55 { 'enum': 'QMPCapability',
61 # A three-part version number.
63 # @major: The major version number.
65 # @minor: The minor version number.
67 # @micro: The micro version number.
71 { 'struct': 'VersionTriple',
72 'data': {'major': 'int', 'minor': 'int', 'micro': 'int'} }
78 # A description of QEMU's version.
80 # @qemu: The version of QEMU. By current convention, a micro
81 # version of 50 signifies a development branch. A micro version
82 # greater than or equal to 90 signifies a release candidate for
83 # the next minor version. A micro version of less than 50
84 # signifies a stable release.
86 # @package: QEMU will always set this field to an empty string. Downstream
87 # versions of QEMU should set this to a non-empty string. The
88 # exact format depends on the downstream however it highly
89 # recommended that a unique name is used.
93 { 'struct': 'VersionInfo',
94 'data': {'qemu': 'VersionTriple', 'package': 'str'} }
99 # Returns the current version of QEMU.
101 # Returns: A @VersionInfo object describing the current version of QEMU.
107 # -> { "execute": "query-version" }
120 { 'command': 'query-version', 'returns': 'VersionInfo',
121 'allow-preconfig': true }
126 # Information about a QMP command
128 # @name: The command name
132 { 'struct': 'CommandInfo', 'data': {'name': 'str'} }
137 # Return a list of supported QMP commands by this server
139 # Returns: A list of @CommandInfo for all supported commands
145 # -> { "execute": "query-commands" }
149 # "name":"query-balloon"
152 # "name":"system_powerdown"
157 # Note: This example has been shortened as the real response is too long.
160 { 'command': 'query-commands', 'returns': ['CommandInfo'],
161 'allow-preconfig': true }
166 # Policy for handling lost ticks in timer devices. Ticks end up getting
167 # lost when, for example, the guest is paused.
169 # @discard: throw away the missed ticks and continue with future injection
170 # normally. The guest OS will see the timer jump ahead by a
171 # potentially quite significant amount all at once, as if the
172 # intervening chunk of time had simply not existed; needless to
173 # say, such a sudden jump can easily confuse a guest OS which is
174 # not specifically prepared to deal with it. Assuming the guest
175 # OS can deal correctly with the time jump, the time in the guest
176 # and in the host should now match.
178 # @delay: continue to deliver ticks at the normal rate. The guest OS will
179 # not notice anything is amiss, as from its point of view time will
180 # have continued to flow normally. The time in the guest should now
181 # be behind the time in the host by exactly the amount of time during
182 # which ticks have been missed.
184 # @slew: deliver ticks at a higher rate to catch up with the missed ticks.
185 # The guest OS will not notice anything is amiss, as from its point
186 # of view time will have continued to flow normally. Once the timer
187 # has managed to catch up with all the missing ticks, the time in
188 # the guest and in the host should match.
192 { 'enum': 'LostTickPolicy',
193 'data': ['discard', 'delay', 'slew' ] }
198 # Allow client connections for VNC, Spice and socket based
199 # character devices to be passed in to QEMU via SCM_RIGHTS.
201 # @protocol: protocol name. Valid names are "vnc", "spice" or the
202 # name of a character device (eg. from -chardev id=XXXX)
204 # @fdname: file descriptor name previously passed via 'getfd' command
206 # @skipauth: whether to skip authentication. Only applies
207 # to "vnc" and "spice" protocols
209 # @tls: whether to perform TLS. Only applies to the "spice"
212 # Returns: nothing on success.
218 # -> { "execute": "add_client", "arguments": { "protocol": "vnc",
219 # "fdname": "myclient" } }
220 # <- { "return": {} }
223 { 'command': 'add_client',
224 'data': { 'protocol': 'str', 'fdname': 'str', '*skipauth': 'bool',
230 # Guest name information.
232 # @name: The name of the guest
236 { 'struct': 'NameInfo', 'data': {'*name': 'str'} }
241 # Return the name information of a guest.
243 # Returns: @NameInfo of the guest
249 # -> { "execute": "query-name" }
250 # <- { "return": { "name": "qemu-name" } }
253 { 'command': 'query-name', 'returns': 'NameInfo', 'allow-preconfig': true }
258 # Information about support for KVM acceleration
260 # @enabled: true if KVM acceleration is active
262 # @present: true if KVM acceleration is built into this executable
266 { 'struct': 'KvmInfo', 'data': {'enabled': 'bool', 'present': 'bool'} }
271 # Returns information about KVM acceleration
279 # -> { "execute": "query-kvm" }
280 # <- { "return": { "enabled": true, "present": true } }
283 { 'command': 'query-kvm', 'returns': 'KvmInfo' }
288 # Guest UUID information (Universally Unique Identifier).
290 # @UUID: the UUID of the guest
294 # Notes: If no UUID was specified for the guest, a null UUID is returned.
296 { 'struct': 'UuidInfo', 'data': {'UUID': 'str'} }
301 # Query the guest UUID information.
303 # Returns: The @UuidInfo for the guest
309 # -> { "execute": "query-uuid" }
310 # <- { "return": { "UUID": "550e8400-e29b-41d4-a716-446655440000" } }
313 { 'command': 'query-uuid', 'returns': 'UuidInfo', 'allow-preconfig': true }
318 # Information about a QMP event
320 # @name: The event name
324 { 'struct': 'EventInfo', 'data': {'name': 'str'} }
329 # Return information on QMP events.
331 # Returns: A list of @EventInfo.
335 # Note: This command is deprecated, because its output doesn't reflect
336 # compile-time configuration. Use query-qmp-schema instead.
340 # -> { "execute": "query-events" }
352 # Note: This example has been shortened as the real response is too long.
355 { 'command': 'query-events', 'returns': ['EventInfo'] }
360 # Information about an iothread
362 # @id: the identifier of the iothread
364 # @thread-id: ID of the underlying host thread
366 # @poll-max-ns: maximum polling time in ns, 0 means polling is disabled
369 # @poll-grow: how many ns will be added to polling time, 0 means that it's not
370 # configured (since 2.9)
372 # @poll-shrink: how many ns will be removed from polling time, 0 means that
373 # it's not configured (since 2.9)
377 { 'struct': 'IOThreadInfo',
378 'data': {'id': 'str',
380 'poll-max-ns': 'int',
382 'poll-shrink': 'int' } }
387 # Returns a list of information about each iothread.
389 # Note: this list excludes the QEMU main loop thread, which is not declared
390 # using the -object iothread command-line option. It is always the main thread
393 # Returns: a list of @IOThreadInfo for each iothread
399 # -> { "execute": "query-iothreads" }
413 { 'command': 'query-iothreads', 'returns': ['IOThreadInfo'],
414 'allow-preconfig': true }
419 # Information about the guest balloon device.
421 # @actual: the number of bytes the balloon currently contains
426 { 'struct': 'BalloonInfo', 'data': {'actual': 'int' } }
431 # Return information about the balloon device.
433 # Returns: - @BalloonInfo on success
434 # - If the balloon driver is enabled but not functional because the KVM
435 # kernel module cannot support it, KvmMissingCap
436 # - If no balloon device is present, DeviceNotActive
442 # -> { "execute": "query-balloon" }
444 # "actual": 1073741824,
449 { 'command': 'query-balloon', 'returns': 'BalloonInfo' }
454 # Emitted when the guest changes the actual BALLOON level. This value is
455 # equivalent to the @actual field return by the 'query-balloon' command
457 # @actual: actual level of the guest memory balloon in bytes
459 # Note: this event is rate-limited.
465 # <- { "event": "BALLOON_CHANGE",
466 # "data": { "actual": 944766976 },
467 # "timestamp": { "seconds": 1267020223, "microseconds": 435656 } }
470 { 'event': 'BALLOON_CHANGE',
471 'data': { 'actual': 'int' } }
476 # A PCI device memory region
478 # @base: the starting address (guest physical)
480 # @limit: the ending address (guest physical)
484 { 'struct': 'PciMemoryRange', 'data': {'base': 'int', 'limit': 'int'} }
489 # Information about a PCI device I/O region.
491 # @bar: the index of the Base Address Register for this region
493 # @type: - 'io' if the region is a PIO region
494 # - 'memory' if the region is a MMIO region
498 # @prefetch: if @type is 'memory', true if the memory is prefetchable
500 # @mem_type_64: if @type is 'memory', true if the BAR is 64-bit
504 { 'struct': 'PciMemoryRegion',
505 'data': {'bar': 'int', 'type': 'str', 'address': 'int', 'size': 'int',
506 '*prefetch': 'bool', '*mem_type_64': 'bool' } }
511 # Information about a bus of a PCI Bridge device
513 # @number: primary bus interface number. This should be the number of the
514 # bus the device resides on.
516 # @secondary: secondary bus interface number. This is the number of the
517 # main bus for the bridge
519 # @subordinate: This is the highest number bus that resides below the
522 # @io_range: The PIO range for all devices on this bridge
524 # @memory_range: The MMIO range for all devices on this bridge
526 # @prefetchable_range: The range of prefetchable MMIO for all devices on
531 { 'struct': 'PciBusInfo',
532 'data': {'number': 'int', 'secondary': 'int', 'subordinate': 'int',
533 'io_range': 'PciMemoryRange',
534 'memory_range': 'PciMemoryRange',
535 'prefetchable_range': 'PciMemoryRange' } }
540 # Information about a PCI Bridge device
542 # @bus: information about the bus the device resides on
544 # @devices: a list of @PciDeviceInfo for each device on this bridge
548 { 'struct': 'PciBridgeInfo',
549 'data': {'bus': 'PciBusInfo', '*devices': ['PciDeviceInfo']} }
554 # Information about the Class of a PCI device
556 # @desc: a string description of the device's class
558 # @class: the class code of the device
562 { 'struct': 'PciDeviceClass',
563 'data': {'*desc': 'str', 'class': 'int'} }
568 # Information about the Id of a PCI device
570 # @device: the PCI device id
572 # @vendor: the PCI vendor id
574 # @subsystem: the PCI subsystem id (since 3.1)
576 # @subsystem-vendor: the PCI subsystem vendor id (since 3.1)
580 { 'struct': 'PciDeviceId',
581 'data': {'device': 'int', 'vendor': 'int', '*subsystem': 'int',
582 '*subsystem-vendor': 'int'} }
587 # Information about a PCI device
589 # @bus: the bus number of the device
591 # @slot: the slot the device is located in
593 # @function: the function of the slot used by the device
595 # @class_info: the class of the device
597 # @id: the PCI device id
599 # @irq: if an IRQ is assigned to the device, the IRQ number
601 # @qdev_id: the device name of the PCI device
603 # @pci_bridge: if the device is a PCI bridge, the bridge information
605 # @regions: a list of the PCI I/O regions associated with the device
607 # Notes: the contents of @class_info.desc are not stable and should only be
608 # treated as informational.
612 { 'struct': 'PciDeviceInfo',
613 'data': {'bus': 'int', 'slot': 'int', 'function': 'int',
614 'class_info': 'PciDeviceClass', 'id': 'PciDeviceId',
615 '*irq': 'int', 'qdev_id': 'str', '*pci_bridge': 'PciBridgeInfo',
616 'regions': ['PciMemoryRegion']} }
621 # Information about a PCI bus
623 # @bus: the bus index
625 # @devices: a list of devices on this bus
629 { 'struct': 'PciInfo', 'data': {'bus': 'int', 'devices': ['PciDeviceInfo']} }
634 # Return information about the PCI bus topology of the guest.
636 # Returns: a list of @PciInfo for each PCI bus. Each bus is
637 # represented by a json-object, which has a key with a json-array of
638 # all PCI devices attached to it. Each device is represented by a
645 # -> { "execute": "query-pci" }
656 # "desc": "Host bridge"
672 # "desc": "ISA bridge"
688 # "desc": "IDE controller"
710 # "desc": "VGA controller"
720 # "mem_type_64": false,
723 # "address": 4026531840,
728 # "mem_type_64": false,
731 # "address": 4060086272,
736 # "mem_type_64": false,
751 # "desc": "RAM controller"
772 # Note: This example has been shortened as the real response is too long.
775 { 'command': 'query-pci', 'returns': ['PciInfo'] }
780 # This command will cause the QEMU process to exit gracefully. While every
781 # attempt is made to send the QMP response before terminating, this is not
782 # guaranteed. When using this interface, a premature EOF would not be
789 # -> { "execute": "quit" }
790 # <- { "return": {} }
792 { 'command': 'quit' }
797 # Stop all guest VCPU execution.
801 # Notes: This function will succeed even if the guest is already in the stopped
802 # state. In "inmigrate" state, it will ensure that the guest
803 # remains paused once migration finishes, as if the -S option was
804 # passed on the command line.
808 # -> { "execute": "stop" }
809 # <- { "return": {} }
812 { 'command': 'stop' }
817 # Performs a hard reset of a guest.
823 # -> { "execute": "system_reset" }
824 # <- { "return": {} }
827 { 'command': 'system_reset' }
832 # Requests that a guest perform a powerdown operation.
836 # Notes: A guest may or may not respond to this command. This command
837 # returning does not indicate that a guest has accepted the request or
838 # that it has shut down. Many guests will respond to this command by
839 # prompting the user in some way.
842 # -> { "execute": "system_powerdown" }
843 # <- { "return": {} }
846 { 'command': 'system_powerdown' }
851 # Save a portion of guest memory to a file.
853 # @val: the virtual address of the guest to start from
855 # @size: the size of memory region to save
857 # @filename: the file to save the memory to as binary data
859 # @cpu-index: the index of the virtual CPU to use for translating the
860 # virtual address (defaults to CPU 0)
862 # Returns: Nothing on success
866 # Notes: Errors were not reliably returned until 1.1
870 # -> { "execute": "memsave",
871 # "arguments": { "val": 10,
873 # "filename": "/tmp/virtual-mem-dump" } }
874 # <- { "return": {} }
877 { 'command': 'memsave',
878 'data': {'val': 'int', 'size': 'int', 'filename': 'str', '*cpu-index': 'int'} }
883 # Save a portion of guest physical memory to a file.
885 # @val: the physical address of the guest to start from
887 # @size: the size of memory region to save
889 # @filename: the file to save the memory to as binary data
891 # Returns: Nothing on success
895 # Notes: Errors were not reliably returned until 1.1
899 # -> { "execute": "pmemsave",
900 # "arguments": { "val": 10,
902 # "filename": "/tmp/physical-mem-dump" } }
903 # <- { "return": {} }
906 { 'command': 'pmemsave',
907 'data': {'val': 'int', 'size': 'int', 'filename': 'str'} }
912 # Resume guest VCPU execution.
916 # Returns: If successful, nothing
918 # Notes: This command will succeed if the guest is currently running. It
919 # will also succeed if the guest is in the "inmigrate" state; in
920 # this case, the effect of the command is to make sure the guest
921 # starts once migration finishes, removing the effect of the -S
922 # command line option if it was passed.
926 # -> { "execute": "cont" }
927 # <- { "return": {} }
930 { 'command': 'cont' }
935 # Exit from "preconfig" state
937 # This command makes QEMU exit the preconfig state and proceed with
938 # VM initialization using configuration data provided on the command line
939 # and via the QMP monitor during the preconfig state. The command is only
940 # available during the preconfig state (i.e. when the --preconfig command
941 # line option was in use).
949 # -> { "execute": "x-exit-preconfig" }
950 # <- { "return": {} }
953 { 'command': 'x-exit-preconfig', 'allow-preconfig': true }
958 # Wake up guest from suspend. If the guest has wake-up from suspend
959 # support enabled (wakeup-suspend-support flag from
960 # query-current-machine), wake-up guest from suspend if the guest is
961 # in SUSPENDED state. Return an error otherwise.
967 # Note: prior to 4.0, this command does nothing in case the guest
972 # -> { "execute": "system_wakeup" }
973 # <- { "return": {} }
976 { 'command': 'system_wakeup' }
981 # Injects a Non-Maskable Interrupt into the default CPU (x86/s390) or all CPUs (ppc64).
982 # The command fails when the guest doesn't support injecting.
984 # Returns: If successful, nothing
988 # Note: prior to 2.1, this command was only supported for x86 and s390 VMs
992 # -> { "execute": "inject-nmi" }
993 # <- { "return": {} }
996 { 'command': 'inject-nmi' }
1001 # Request the balloon driver to change its balloon size.
1003 # @value: the target size of the balloon in bytes
1005 # Returns: - Nothing on success
1006 # - If the balloon driver is enabled but not functional because the KVM
1007 # kernel module cannot support it, KvmMissingCap
1008 # - If no balloon device is present, DeviceNotActive
1010 # Notes: This command just issues a request to the guest. When it returns,
1011 # the balloon size may not have changed. A guest can change the balloon
1012 # size independent of this command.
1018 # -> { "execute": "balloon", "arguments": { "value": 536870912 } }
1019 # <- { "return": {} }
1022 { 'command': 'balloon', 'data': {'value': 'int'} }
1025 # @human-monitor-command:
1027 # Execute a command on the human monitor and return the output.
1029 # @command-line: the command to execute in the human monitor
1031 # @cpu-index: The CPU to use for commands that require an implicit CPU
1034 # @savevm-monitor-nodes: If present, HMP command savevm only snapshots
1035 # monitor-owned nodes if they have no parents.
1036 # This allows the use of 'savevm' with
1037 # -blockdev. (since 4.2)
1039 # Returns: the output of the command as a string
1043 # Notes: This command only exists as a stop-gap. Its use is highly
1044 # discouraged. The semantics of this command are not
1045 # guaranteed: this means that command names, arguments and
1046 # responses can change or be removed at ANY time. Applications
1047 # that rely on long term stability guarantees should NOT
1050 # Known limitations:
1052 # * This command is stateless, this means that commands that depend
1053 # on state information (such as getfd) might not work
1055 # * Commands that prompt the user for data don't currently work
1059 # -> { "execute": "human-monitor-command",
1060 # "arguments": { "command-line": "info kvm" } }
1061 # <- { "return": "kvm support: enabled\r\n" }
1064 { 'command': 'human-monitor-command',
1065 'data': {'command-line': 'str', '*cpu-index': 'int'},
1067 'features': [ 'savevm-monitor-nodes' ] }
1072 # This command is multiple commands multiplexed together.
1074 # @device: This is normally the name of a block device but it may also be 'vnc'.
1075 # when it's 'vnc', then sub command depends on @target
1077 # @target: If @device is a block device, then this is the new filename.
1078 # If @device is 'vnc', then if the value 'password' selects the vnc
1079 # change password command. Otherwise, this specifies a new server URI
1080 # address to listen to for VNC connections.
1082 # @arg: If @device is a block device, then this is an optional format to open
1084 # If @device is 'vnc' and @target is 'password', this is the new VNC
1085 # password to set. See change-vnc-password for additional notes.
1087 # Returns: - Nothing on success.
1088 # - If @device is not a valid block device, DeviceNotFound
1090 # Notes: This interface is deprecated, and it is strongly recommended that you
1091 # avoid using it. For changing block devices, use
1092 # blockdev-change-medium; for changing VNC parameters, use
1093 # change-vnc-password.
1099 # 1. Change a removable medium
1101 # -> { "execute": "change",
1102 # "arguments": { "device": "ide1-cd0",
1103 # "target": "/srv/images/Fedora-12-x86_64-DVD.iso" } }
1104 # <- { "return": {} }
1106 # 2. Change VNC password
1108 # -> { "execute": "change",
1109 # "arguments": { "device": "vnc", "target": "password",
1110 # "arg": "foobar1" } }
1111 # <- { "return": {} }
1114 { 'command': 'change',
1115 'data': {'device': 'str', 'target': 'str', '*arg': 'str'} }
1118 # @xen-set-global-dirty-log:
1120 # Enable or disable the global dirty log mode.
1122 # @enable: true to enable, false to disable.
1130 # -> { "execute": "xen-set-global-dirty-log",
1131 # "arguments": { "enable": true } }
1132 # <- { "return": {} }
1135 { 'command': 'xen-set-global-dirty-log', 'data': { 'enable': 'bool' } }
1140 # Receive a file descriptor via SCM rights and assign it a name
1142 # @fdname: file descriptor name
1144 # Returns: Nothing on success
1148 # Notes: If @fdname already exists, the file descriptor assigned to
1149 # it will be closed and replaced by the received file
1152 # The 'closefd' command can be used to explicitly close the
1153 # file descriptor when it is no longer needed.
1157 # -> { "execute": "getfd", "arguments": { "fdname": "fd1" } }
1158 # <- { "return": {} }
1161 { 'command': 'getfd', 'data': {'fdname': 'str'} }
1166 # Close a file descriptor previously passed via SCM rights
1168 # @fdname: file descriptor name
1170 # Returns: Nothing on success
1176 # -> { "execute": "closefd", "arguments": { "fdname": "fd1" } }
1177 # <- { "return": {} }
1180 { 'command': 'closefd', 'data': {'fdname': 'str'} }
1185 # Actual memory information in bytes.
1187 # @base-memory: size of "base" memory specified with command line
1190 # @plugged-memory: size of memory that can be hot-unplugged. This field
1191 # is omitted if target doesn't support memory hotplug
1192 # (i.e. CONFIG_MEM_DEVICE not defined at build time).
1196 { 'struct': 'MemoryInfo',
1197 'data' : { 'base-memory': 'size', '*plugged-memory': 'size' } }
1200 # @query-memory-size-summary:
1202 # Return the amount of initially allocated and present hotpluggable (if
1203 # enabled) memory in bytes.
1207 # -> { "execute": "query-memory-size-summary" }
1208 # <- { "return": { "base-memory": 4294967296, "plugged-memory": 0 } }
1212 { 'command': 'query-memory-size-summary', 'returns': 'MemoryInfo' }
1218 # Information about a file descriptor that was added to an fd set.
1220 # @fdset-id: The ID of the fd set that @fd was added to.
1222 # @fd: The file descriptor that was received via SCM rights and
1223 # added to the fd set.
1227 { 'struct': 'AddfdInfo', 'data': {'fdset-id': 'int', 'fd': 'int'} }
1232 # Add a file descriptor, that was passed via SCM rights, to an fd set.
1234 # @fdset-id: The ID of the fd set to add the file descriptor to.
1236 # @opaque: A free-form string that can be used to describe the fd.
1238 # Returns: - @AddfdInfo on success
1239 # - If file descriptor was not received, FdNotSupplied
1240 # - If @fdset-id is a negative value, InvalidParameterValue
1242 # Notes: The list of fd sets is shared by all monitor connections.
1244 # If @fdset-id is not specified, a new fd set will be created.
1250 # -> { "execute": "add-fd", "arguments": { "fdset-id": 1 } }
1251 # <- { "return": { "fdset-id": 1, "fd": 3 } }
1254 { 'command': 'add-fd',
1255 'data': { '*fdset-id': 'int',
1257 'returns': 'AddfdInfo' }
1262 # Remove a file descriptor from an fd set.
1264 # @fdset-id: The ID of the fd set that the file descriptor belongs to.
1266 # @fd: The file descriptor that is to be removed.
1268 # Returns: - Nothing on success
1269 # - If @fdset-id or @fd is not found, FdNotFound
1273 # Notes: The list of fd sets is shared by all monitor connections.
1275 # If @fd is not specified, all file descriptors in @fdset-id
1280 # -> { "execute": "remove-fd", "arguments": { "fdset-id": 1, "fd": 3 } }
1281 # <- { "return": {} }
1284 { 'command': 'remove-fd', 'data': {'fdset-id': 'int', '*fd': 'int'} }
1289 # Information about a file descriptor that belongs to an fd set.
1291 # @fd: The file descriptor value.
1293 # @opaque: A free-form string that can be used to describe the fd.
1297 { 'struct': 'FdsetFdInfo',
1298 'data': {'fd': 'int', '*opaque': 'str'} }
1303 # Information about an fd set.
1305 # @fdset-id: The ID of the fd set.
1307 # @fds: A list of file descriptors that belong to this fd set.
1311 { 'struct': 'FdsetInfo',
1312 'data': {'fdset-id': 'int', 'fds': ['FdsetFdInfo']} }
1317 # Return information describing all fd sets.
1319 # Returns: A list of @FdsetInfo
1323 # Note: The list of fd sets is shared by all monitor connections.
1327 # -> { "execute": "query-fdsets" }
1333 # "opaque": "rdonly:/path/to/file"
1337 # "opaque": "rdwr:/path/to/file"
1357 { 'command': 'query-fdsets', 'returns': ['FdsetInfo'] }
1360 # @AcpiTableOptions:
1362 # Specify an ACPI table on the command line to load.
1364 # At most one of @file and @data can be specified. The list of files specified
1365 # by any one of them is loaded and concatenated in order. If both are omitted,
1368 # Other fields / optargs can be used to override fields of the generic ACPI
1369 # table header; refer to the ACPI specification 5.0, section 5.2.6 System
1370 # Description Table Header. If a header field is not overridden, then the
1371 # corresponding value from the concatenated blob is used (in case of @file), or
1372 # it is filled in with a hard-coded value (in case of @data).
1374 # String fields are copied into the matching ACPI member from lowest address
1375 # upwards, and silently truncated / NUL-padded to length.
1377 # @sig: table signature / identifier (4 bytes)
1379 # @rev: table revision number (dependent on signature, 1 byte)
1381 # @oem_id: OEM identifier (6 bytes)
1383 # @oem_table_id: OEM table identifier (8 bytes)
1385 # @oem_rev: OEM-supplied revision number (4 bytes)
1387 # @asl_compiler_id: identifier of the utility that created the table
1390 # @asl_compiler_rev: revision number of the utility that created the
1393 # @file: colon (:) separated list of pathnames to load and
1394 # concatenate as table data. The resultant binary blob is expected to
1395 # have an ACPI table header. At least one file is required. This field
1398 # @data: colon (:) separated list of pathnames to load and
1399 # concatenate as table data. The resultant binary blob must not have an
1400 # ACPI table header. At least one file is required. This field excludes
1405 { 'struct': 'AcpiTableOptions',
1410 '*oem_table_id': 'str',
1411 '*oem_rev': 'uint32',
1412 '*asl_compiler_id': 'str',
1413 '*asl_compiler_rev': 'uint32',
1418 # @CommandLineParameterType:
1420 # Possible types for an option parameter.
1422 # @string: accepts a character string
1424 # @boolean: accepts "on" or "off"
1426 # @number: accepts a number
1428 # @size: accepts a number followed by an optional suffix (K)ilo,
1429 # (M)ega, (G)iga, (T)era
1433 { 'enum': 'CommandLineParameterType',
1434 'data': ['string', 'boolean', 'number', 'size'] }
1437 # @CommandLineParameterInfo:
1439 # Details about a single parameter of a command line option.
1441 # @name: parameter name
1443 # @type: parameter @CommandLineParameterType
1445 # @help: human readable text string, not suitable for parsing.
1447 # @default: default value string (since 2.1)
1451 { 'struct': 'CommandLineParameterInfo',
1452 'data': { 'name': 'str',
1453 'type': 'CommandLineParameterType',
1455 '*default': 'str' } }
1458 # @CommandLineOptionInfo:
1460 # Details about a command line option, including its list of parameter details
1462 # @option: option name
1464 # @parameters: an array of @CommandLineParameterInfo
1468 { 'struct': 'CommandLineOptionInfo',
1469 'data': { 'option': 'str', 'parameters': ['CommandLineParameterInfo'] } }
1472 # @query-command-line-options:
1474 # Query command line option schema.
1476 # @option: option name
1478 # Returns: list of @CommandLineOptionInfo for all options (or for the given
1479 # @option). Returns an error if the given @option doesn't exist.
1485 # -> { "execute": "query-command-line-options",
1486 # "arguments": { "option": "option-rom" } }
1491 # "name": "romfile",
1495 # "name": "bootindex",
1499 # "option": "option-rom"
1505 {'command': 'query-command-line-options',
1506 'data': { '*option': 'str' },
1507 'returns': ['CommandLineOptionInfo'],
1508 'allow-preconfig': true }
1511 # @PCDIMMDeviceInfo:
1513 # PCDIMMDevice state information
1517 # @addr: physical address, where device is mapped
1519 # @size: size of memory that the device provides
1521 # @slot: slot number at which device is plugged in
1523 # @node: NUMA node number where device is plugged in
1525 # @memdev: memory backend linked with device
1527 # @hotplugged: true if device was hotplugged
1529 # @hotpluggable: true if device if could be added/removed while machine is running
1533 { 'struct': 'PCDIMMDeviceInfo',
1534 'data': { '*id': 'str',
1540 'hotplugged': 'bool',
1541 'hotpluggable': 'bool'
1546 # @VirtioPMEMDeviceInfo:
1548 # VirtioPMEM state information
1552 # @memaddr: physical address in memory, where device is mapped
1554 # @size: size of memory that the device provides
1556 # @memdev: memory backend linked with device
1560 { 'struct': 'VirtioPMEMDeviceInfo',
1561 'data': { '*id': 'str',
1569 # @MemoryDeviceInfo:
1571 # Union containing information about a memory device
1573 # nvdimm is included since 2.12. virtio-pmem is included since 4.1.
1577 { 'union': 'MemoryDeviceInfo',
1578 'data': { 'dimm': 'PCDIMMDeviceInfo',
1579 'nvdimm': 'PCDIMMDeviceInfo',
1580 'virtio-pmem': 'VirtioPMEMDeviceInfo'
1585 # @query-memory-devices:
1587 # Lists available memory devices and their state
1593 # -> { "execute": "query-memory-devices" }
1594 # <- { "return": [ { "data":
1595 # { "addr": 5368709120,
1596 # "hotpluggable": true,
1597 # "hotplugged": true,
1599 # "memdev": "/objects/memX",
1601 # "size": 1073741824,
1607 { 'command': 'query-memory-devices', 'returns': ['MemoryDeviceInfo'] }
1610 # @MEM_UNPLUG_ERROR:
1612 # Emitted when memory hot unplug error occurs.
1614 # @device: device name
1616 # @msg: Informative message
1622 # <- { "event": "MEM_UNPLUG_ERROR"
1623 # "data": { "device": "dimm1",
1624 # "msg": "acpi: device unplug for unsupported device"
1626 # "timestamp": { "seconds": 1265044230, "microseconds": 450486 } }
1629 { 'event': 'MEM_UNPLUG_ERROR',
1630 'data': { 'device': 'str', 'msg': 'str' } }
1635 # @DIMM: memory slot
1636 # @CPU: logical CPU slot (since 2.7)
1638 { 'enum': 'ACPISlotType', 'data': [ 'DIMM', 'CPU' ] }
1643 # OSPM Status Indication for a device
1644 # For description of possible values of @source and @status fields
1645 # see "_OST (OSPM Status Indication)" chapter of ACPI5.0 spec.
1647 # @device: device ID associated with slot
1649 # @slot: slot ID, unique per slot of a given @slot-type
1651 # @slot-type: type of the slot
1653 # @source: an integer containing the source event
1655 # @status: an integer containing the status code
1659 { 'struct': 'ACPIOSTInfo',
1660 'data' : { '*device': 'str',
1662 'slot-type': 'ACPISlotType',
1667 # @query-acpi-ospm-status:
1669 # Return a list of ACPIOSTInfo for devices that support status
1670 # reporting via ACPI _OST method.
1676 # -> { "execute": "query-acpi-ospm-status" }
1677 # <- { "return": [ { "device": "d1", "slot": "0", "slot-type": "DIMM", "source": 1, "status": 0},
1678 # { "slot": "1", "slot-type": "DIMM", "source": 0, "status": 0},
1679 # { "slot": "2", "slot-type": "DIMM", "source": 0, "status": 0},
1680 # { "slot": "3", "slot-type": "DIMM", "source": 0, "status": 0}
1684 { 'command': 'query-acpi-ospm-status', 'returns': ['ACPIOSTInfo'] }
1689 # Emitted when guest executes ACPI _OST method.
1691 # @info: OSPM Status Indication
1697 # <- { "event": "ACPI_DEVICE_OST",
1698 # "data": { "device": "d1", "slot": "0",
1699 # "slot-type": "DIMM", "source": 1, "status": 0 } }
1702 { 'event': 'ACPI_DEVICE_OST',
1703 'data': { 'info': 'ACPIOSTInfo' } }
1708 # Mode of the replay subsystem.
1710 # @none: normal execution mode. Replay or record are not enabled.
1712 # @record: record mode. All non-deterministic data is written into the
1715 # @play: replay mode. Non-deterministic data required for system execution
1716 # is read from the log.
1720 { 'enum': 'ReplayMode',
1721 'data': [ 'none', 'record', 'play' ] }
1724 # @xen-load-devices-state:
1726 # Load the state of all devices from file. The RAM and the block devices
1727 # of the VM are not loaded by this command.
1729 # @filename: the file to load the state of the devices from as binary
1730 # data. See xen-save-devices-state.txt for a description of the binary
1737 # -> { "execute": "xen-load-devices-state",
1738 # "arguments": { "filename": "/tmp/resume" } }
1739 # <- { "return": {} }
1742 { 'command': 'xen-load-devices-state', 'data': {'filename': 'str'} }
1749 # @guid: the globally unique identifier
1753 { 'struct': 'GuidInfo', 'data': {'guid': 'str'} }
1756 # @query-vm-generation-id:
1758 # Show Virtual Machine Generation ID
1762 { 'command': 'query-vm-generation-id', 'returns': 'GuidInfo' }