8 { 'include': 'common.json' }
13 # Policy for handling lost ticks in timer devices. Ticks end up getting
14 # lost when, for example, the guest is paused.
16 # @discard: throw away the missed ticks and continue with future injection
17 # normally. The guest OS will see the timer jump ahead by a
18 # potentially quite significant amount all at once, as if the
19 # intervening chunk of time had simply not existed; needless to
20 # say, such a sudden jump can easily confuse a guest OS which is
21 # not specifically prepared to deal with it. Assuming the guest
22 # OS can deal correctly with the time jump, the time in the guest
23 # and in the host should now match.
25 # @delay: continue to deliver ticks at the normal rate. The guest OS will
26 # not notice anything is amiss, as from its point of view time will
27 # have continued to flow normally. The time in the guest should now
28 # be behind the time in the host by exactly the amount of time during
29 # which ticks have been missed.
31 # @slew: deliver ticks at a higher rate to catch up with the missed ticks.
32 # The guest OS will not notice anything is amiss, as from its point
33 # of view time will have continued to flow normally. Once the timer
34 # has managed to catch up with all the missing ticks, the time in
35 # the guest and in the host should match.
39 { 'enum': 'LostTickPolicy',
40 'data': ['discard', 'delay', 'slew' ] }
45 # Allow client connections for VNC, Spice and socket based
46 # character devices to be passed in to QEMU via SCM_RIGHTS.
48 # @protocol: protocol name. Valid names are "vnc", "spice" or the
49 # name of a character device (eg. from -chardev id=XXXX)
51 # @fdname: file descriptor name previously passed via 'getfd' command
53 # @skipauth: whether to skip authentication. Only applies
54 # to "vnc" and "spice" protocols
56 # @tls: whether to perform TLS. Only applies to the "spice"
59 # Returns: nothing on success.
65 # -> { "execute": "add_client", "arguments": { "protocol": "vnc",
66 # "fdname": "myclient" } }
70 { 'command': 'add_client',
71 'data': { 'protocol': 'str', 'fdname': 'str', '*skipauth': 'bool',
77 # Guest name information.
79 # @name: The name of the guest
83 { 'struct': 'NameInfo', 'data': {'*name': 'str'} }
88 # Return the name information of a guest.
90 # Returns: @NameInfo of the guest
96 # -> { "execute": "query-name" }
97 # <- { "return": { "name": "qemu-name" } }
100 { 'command': 'query-name', 'returns': 'NameInfo', 'allow-preconfig': true }
105 # Information about support for KVM acceleration
107 # @enabled: true if KVM acceleration is active
109 # @present: true if KVM acceleration is built into this executable
113 { 'struct': 'KvmInfo', 'data': {'enabled': 'bool', 'present': 'bool'} }
118 # Returns information about KVM acceleration
126 # -> { "execute": "query-kvm" }
127 # <- { "return": { "enabled": true, "present": true } }
130 { 'command': 'query-kvm', 'returns': 'KvmInfo' }
135 # Guest UUID information (Universally Unique Identifier).
137 # @UUID: the UUID of the guest
141 # Notes: If no UUID was specified for the guest, a null UUID is returned.
143 { 'struct': 'UuidInfo', 'data': {'UUID': 'str'} }
148 # Query the guest UUID information.
150 # Returns: The @UuidInfo for the guest
156 # -> { "execute": "query-uuid" }
157 # <- { "return": { "UUID": "550e8400-e29b-41d4-a716-446655440000" } }
160 { 'command': 'query-uuid', 'returns': 'UuidInfo', 'allow-preconfig': true }
165 # Information about an iothread
167 # @id: the identifier of the iothread
169 # @thread-id: ID of the underlying host thread
171 # @poll-max-ns: maximum polling time in ns, 0 means polling is disabled
174 # @poll-grow: how many ns will be added to polling time, 0 means that it's not
175 # configured (since 2.9)
177 # @poll-shrink: how many ns will be removed from polling time, 0 means that
178 # it's not configured (since 2.9)
182 { 'struct': 'IOThreadInfo',
183 'data': {'id': 'str',
185 'poll-max-ns': 'int',
187 'poll-shrink': 'int' } }
192 # Returns a list of information about each iothread.
194 # Note: this list excludes the QEMU main loop thread, which is not declared
195 # using the -object iothread command-line option. It is always the main thread
198 # Returns: a list of @IOThreadInfo for each iothread
204 # -> { "execute": "query-iothreads" }
218 { 'command': 'query-iothreads', 'returns': ['IOThreadInfo'],
219 'allow-preconfig': true }
224 # Information about the guest balloon device.
226 # @actual: the number of bytes the balloon currently contains
231 { 'struct': 'BalloonInfo', 'data': {'actual': 'int' } }
236 # Return information about the balloon device.
238 # Returns: - @BalloonInfo on success
239 # - If the balloon driver is enabled but not functional because the KVM
240 # kernel module cannot support it, KvmMissingCap
241 # - If no balloon device is present, DeviceNotActive
247 # -> { "execute": "query-balloon" }
249 # "actual": 1073741824,
254 { 'command': 'query-balloon', 'returns': 'BalloonInfo' }
259 # Emitted when the guest changes the actual BALLOON level. This value is
260 # equivalent to the @actual field return by the 'query-balloon' command
262 # @actual: actual level of the guest memory balloon in bytes
264 # Note: this event is rate-limited.
270 # <- { "event": "BALLOON_CHANGE",
271 # "data": { "actual": 944766976 },
272 # "timestamp": { "seconds": 1267020223, "microseconds": 435656 } }
275 { 'event': 'BALLOON_CHANGE',
276 'data': { 'actual': 'int' } }
281 # A PCI device memory region
283 # @base: the starting address (guest physical)
285 # @limit: the ending address (guest physical)
289 { 'struct': 'PciMemoryRange', 'data': {'base': 'int', 'limit': 'int'} }
294 # Information about a PCI device I/O region.
296 # @bar: the index of the Base Address Register for this region
298 # @type: - 'io' if the region is a PIO region
299 # - 'memory' if the region is a MMIO region
303 # @prefetch: if @type is 'memory', true if the memory is prefetchable
305 # @mem_type_64: if @type is 'memory', true if the BAR is 64-bit
309 { 'struct': 'PciMemoryRegion',
310 'data': {'bar': 'int', 'type': 'str', 'address': 'int', 'size': 'int',
311 '*prefetch': 'bool', '*mem_type_64': 'bool' } }
316 # Information about a bus of a PCI Bridge device
318 # @number: primary bus interface number. This should be the number of the
319 # bus the device resides on.
321 # @secondary: secondary bus interface number. This is the number of the
322 # main bus for the bridge
324 # @subordinate: This is the highest number bus that resides below the
327 # @io_range: The PIO range for all devices on this bridge
329 # @memory_range: The MMIO range for all devices on this bridge
331 # @prefetchable_range: The range of prefetchable MMIO for all devices on
336 { 'struct': 'PciBusInfo',
337 'data': {'number': 'int', 'secondary': 'int', 'subordinate': 'int',
338 'io_range': 'PciMemoryRange',
339 'memory_range': 'PciMemoryRange',
340 'prefetchable_range': 'PciMemoryRange' } }
345 # Information about a PCI Bridge device
347 # @bus: information about the bus the device resides on
349 # @devices: a list of @PciDeviceInfo for each device on this bridge
353 { 'struct': 'PciBridgeInfo',
354 'data': {'bus': 'PciBusInfo', '*devices': ['PciDeviceInfo']} }
359 # Information about the Class of a PCI device
361 # @desc: a string description of the device's class
363 # @class: the class code of the device
367 { 'struct': 'PciDeviceClass',
368 'data': {'*desc': 'str', 'class': 'int'} }
373 # Information about the Id of a PCI device
375 # @device: the PCI device id
377 # @vendor: the PCI vendor id
379 # @subsystem: the PCI subsystem id (since 3.1)
381 # @subsystem-vendor: the PCI subsystem vendor id (since 3.1)
385 { 'struct': 'PciDeviceId',
386 'data': {'device': 'int', 'vendor': 'int', '*subsystem': 'int',
387 '*subsystem-vendor': 'int'} }
392 # Information about a PCI device
394 # @bus: the bus number of the device
396 # @slot: the slot the device is located in
398 # @function: the function of the slot used by the device
400 # @class_info: the class of the device
402 # @id: the PCI device id
404 # @irq: if an IRQ is assigned to the device, the IRQ number
406 # @irq_pin: the IRQ pin, zero means no IRQ (since 5.1)
408 # @qdev_id: the device name of the PCI device
410 # @pci_bridge: if the device is a PCI bridge, the bridge information
412 # @regions: a list of the PCI I/O regions associated with the device
414 # Notes: the contents of @class_info.desc are not stable and should only be
415 # treated as informational.
419 { 'struct': 'PciDeviceInfo',
420 'data': {'bus': 'int', 'slot': 'int', 'function': 'int',
421 'class_info': 'PciDeviceClass', 'id': 'PciDeviceId',
422 '*irq': 'int', 'irq_pin': 'int', 'qdev_id': 'str',
423 '*pci_bridge': 'PciBridgeInfo', 'regions': ['PciMemoryRegion'] }}
428 # Information about a PCI bus
430 # @bus: the bus index
432 # @devices: a list of devices on this bus
436 { 'struct': 'PciInfo', 'data': {'bus': 'int', 'devices': ['PciDeviceInfo']} }
441 # Return information about the PCI bus topology of the guest.
443 # Returns: a list of @PciInfo for each PCI bus. Each bus is
444 # represented by a json-object, which has a key with a json-array of
445 # all PCI devices attached to it. Each device is represented by a
452 # -> { "execute": "query-pci" }
463 # "desc": "Host bridge"
479 # "desc": "ISA bridge"
495 # "desc": "IDE controller"
517 # "desc": "VGA controller"
527 # "mem_type_64": false,
530 # "address": 4026531840,
535 # "mem_type_64": false,
538 # "address": 4060086272,
543 # "mem_type_64": false,
558 # "desc": "RAM controller"
579 # Note: This example has been shortened as the real response is too long.
582 { 'command': 'query-pci', 'returns': ['PciInfo'] }
587 # Stop all guest VCPU execution.
591 # Notes: This function will succeed even if the guest is already in the stopped
592 # state. In "inmigrate" state, it will ensure that the guest
593 # remains paused once migration finishes, as if the -S option was
594 # passed on the command line.
598 # -> { "execute": "stop" }
599 # <- { "return": {} }
602 { 'command': 'stop' }
607 # Performs a hard reset of a guest.
613 # -> { "execute": "system_reset" }
614 # <- { "return": {} }
617 { 'command': 'system_reset' }
622 # Requests that a guest perform a powerdown operation.
626 # Notes: A guest may or may not respond to this command. This command
627 # returning does not indicate that a guest has accepted the request or
628 # that it has shut down. Many guests will respond to this command by
629 # prompting the user in some way.
632 # -> { "execute": "system_powerdown" }
633 # <- { "return": {} }
636 { 'command': 'system_powerdown' }
641 # Save a portion of guest memory to a file.
643 # @val: the virtual address of the guest to start from
645 # @size: the size of memory region to save
647 # @filename: the file to save the memory to as binary data
649 # @cpu-index: the index of the virtual CPU to use for translating the
650 # virtual address (defaults to CPU 0)
652 # Returns: Nothing on success
656 # Notes: Errors were not reliably returned until 1.1
660 # -> { "execute": "memsave",
661 # "arguments": { "val": 10,
663 # "filename": "/tmp/virtual-mem-dump" } }
664 # <- { "return": {} }
667 { 'command': 'memsave',
668 'data': {'val': 'int', 'size': 'int', 'filename': 'str', '*cpu-index': 'int'} }
673 # Save a portion of guest physical memory to a file.
675 # @val: the physical address of the guest to start from
677 # @size: the size of memory region to save
679 # @filename: the file to save the memory to as binary data
681 # Returns: Nothing on success
685 # Notes: Errors were not reliably returned until 1.1
689 # -> { "execute": "pmemsave",
690 # "arguments": { "val": 10,
692 # "filename": "/tmp/physical-mem-dump" } }
693 # <- { "return": {} }
696 { 'command': 'pmemsave',
697 'data': {'val': 'int', 'size': 'int', 'filename': 'str'} }
702 # Resume guest VCPU execution.
706 # Returns: If successful, nothing
708 # Notes: This command will succeed if the guest is currently running. It
709 # will also succeed if the guest is in the "inmigrate" state; in
710 # this case, the effect of the command is to make sure the guest
711 # starts once migration finishes, removing the effect of the -S
712 # command line option if it was passed.
716 # -> { "execute": "cont" }
717 # <- { "return": {} }
720 { 'command': 'cont' }
725 # Exit from "preconfig" state
727 # This command makes QEMU exit the preconfig state and proceed with
728 # VM initialization using configuration data provided on the command line
729 # and via the QMP monitor during the preconfig state. The command is only
730 # available during the preconfig state (i.e. when the --preconfig command
731 # line option was in use).
739 # -> { "execute": "x-exit-preconfig" }
740 # <- { "return": {} }
743 { 'command': 'x-exit-preconfig', 'allow-preconfig': true }
748 # Wake up guest from suspend. If the guest has wake-up from suspend
749 # support enabled (wakeup-suspend-support flag from
750 # query-current-machine), wake-up guest from suspend if the guest is
751 # in SUSPENDED state. Return an error otherwise.
757 # Note: prior to 4.0, this command does nothing in case the guest
762 # -> { "execute": "system_wakeup" }
763 # <- { "return": {} }
766 { 'command': 'system_wakeup' }
771 # Injects a Non-Maskable Interrupt into the default CPU (x86/s390) or all CPUs (ppc64).
772 # The command fails when the guest doesn't support injecting.
774 # Returns: If successful, nothing
778 # Note: prior to 2.1, this command was only supported for x86 and s390 VMs
782 # -> { "execute": "inject-nmi" }
783 # <- { "return": {} }
786 { 'command': 'inject-nmi' }
791 # Request the balloon driver to change its balloon size.
793 # @value: the target size of the balloon in bytes
795 # Returns: - Nothing on success
796 # - If the balloon driver is enabled but not functional because the KVM
797 # kernel module cannot support it, KvmMissingCap
798 # - If no balloon device is present, DeviceNotActive
800 # Notes: This command just issues a request to the guest. When it returns,
801 # the balloon size may not have changed. A guest can change the balloon
802 # size independent of this command.
808 # -> { "execute": "balloon", "arguments": { "value": 536870912 } }
809 # <- { "return": {} }
812 { 'command': 'balloon', 'data': {'value': 'int'} }
815 # @human-monitor-command:
817 # Execute a command on the human monitor and return the output.
819 # @command-line: the command to execute in the human monitor
821 # @cpu-index: The CPU to use for commands that require an implicit CPU
824 # @savevm-monitor-nodes: If present, HMP command savevm only snapshots
825 # monitor-owned nodes if they have no parents.
826 # This allows the use of 'savevm' with
827 # -blockdev. (since 4.2)
829 # Returns: the output of the command as a string
833 # Notes: This command only exists as a stop-gap. Its use is highly
834 # discouraged. The semantics of this command are not
835 # guaranteed: this means that command names, arguments and
836 # responses can change or be removed at ANY time. Applications
837 # that rely on long term stability guarantees should NOT
842 # * This command is stateless, this means that commands that depend
843 # on state information (such as getfd) might not work
845 # * Commands that prompt the user for data don't currently work
849 # -> { "execute": "human-monitor-command",
850 # "arguments": { "command-line": "info kvm" } }
851 # <- { "return": "kvm support: enabled\r\n" }
854 { 'command': 'human-monitor-command',
855 'data': {'command-line': 'str', '*cpu-index': 'int'},
857 'features': [ 'savevm-monitor-nodes' ] }
862 # This command is multiple commands multiplexed together.
864 # @device: This is normally the name of a block device but it may also be 'vnc'.
865 # when it's 'vnc', then sub command depends on @target
867 # @target: If @device is a block device, then this is the new filename.
868 # If @device is 'vnc', then if the value 'password' selects the vnc
869 # change password command. Otherwise, this specifies a new server URI
870 # address to listen to for VNC connections.
872 # @arg: If @device is a block device, then this is an optional format to open
874 # If @device is 'vnc' and @target is 'password', this is the new VNC
875 # password to set. See change-vnc-password for additional notes.
878 # @deprecated: This command is deprecated. For changing block
879 # devices, use 'blockdev-change-medium' instead; for changing VNC
880 # parameters, use 'change-vnc-password' instead.
882 # Returns: - Nothing on success.
883 # - If @device is not a valid block device, DeviceNotFound
889 # 1. Change a removable medium
891 # -> { "execute": "change",
892 # "arguments": { "device": "ide1-cd0",
893 # "target": "/srv/images/Fedora-12-x86_64-DVD.iso" } }
894 # <- { "return": {} }
896 # 2. Change VNC password
898 # -> { "execute": "change",
899 # "arguments": { "device": "vnc", "target": "password",
900 # "arg": "foobar1" } }
901 # <- { "return": {} }
904 { 'command': 'change',
905 'data': {'device': 'str', 'target': 'str', '*arg': 'str'},
906 'features': [ 'deprecated' ] }
909 # @xen-set-global-dirty-log:
911 # Enable or disable the global dirty log mode.
913 # @enable: true to enable, false to disable.
921 # -> { "execute": "xen-set-global-dirty-log",
922 # "arguments": { "enable": true } }
923 # <- { "return": {} }
926 { 'command': 'xen-set-global-dirty-log', 'data': { 'enable': 'bool' } }
931 # Receive a file descriptor via SCM rights and assign it a name
933 # @fdname: file descriptor name
935 # Returns: Nothing on success
939 # Notes: If @fdname already exists, the file descriptor assigned to
940 # it will be closed and replaced by the received file
943 # The 'closefd' command can be used to explicitly close the
944 # file descriptor when it is no longer needed.
948 # -> { "execute": "getfd", "arguments": { "fdname": "fd1" } }
949 # <- { "return": {} }
952 { 'command': 'getfd', 'data': {'fdname': 'str'} }
957 # Close a file descriptor previously passed via SCM rights
959 # @fdname: file descriptor name
961 # Returns: Nothing on success
967 # -> { "execute": "closefd", "arguments": { "fdname": "fd1" } }
968 # <- { "return": {} }
971 { 'command': 'closefd', 'data': {'fdname': 'str'} }
976 # Actual memory information in bytes.
978 # @base-memory: size of "base" memory specified with command line
981 # @plugged-memory: size of memory that can be hot-unplugged. This field
982 # is omitted if target doesn't support memory hotplug
983 # (i.e. CONFIG_MEM_DEVICE not defined at build time).
987 { 'struct': 'MemoryInfo',
988 'data' : { 'base-memory': 'size', '*plugged-memory': 'size' } }
991 # @query-memory-size-summary:
993 # Return the amount of initially allocated and present hotpluggable (if
994 # enabled) memory in bytes.
998 # -> { "execute": "query-memory-size-summary" }
999 # <- { "return": { "base-memory": 4294967296, "plugged-memory": 0 } }
1003 { 'command': 'query-memory-size-summary', 'returns': 'MemoryInfo' }
1009 # Information about a file descriptor that was added to an fd set.
1011 # @fdset-id: The ID of the fd set that @fd was added to.
1013 # @fd: The file descriptor that was received via SCM rights and
1014 # added to the fd set.
1018 { 'struct': 'AddfdInfo', 'data': {'fdset-id': 'int', 'fd': 'int'} }
1023 # Add a file descriptor, that was passed via SCM rights, to an fd set.
1025 # @fdset-id: The ID of the fd set to add the file descriptor to.
1027 # @opaque: A free-form string that can be used to describe the fd.
1029 # Returns: - @AddfdInfo on success
1030 # - If file descriptor was not received, FdNotSupplied
1031 # - If @fdset-id is a negative value, InvalidParameterValue
1033 # Notes: The list of fd sets is shared by all monitor connections.
1035 # If @fdset-id is not specified, a new fd set will be created.
1041 # -> { "execute": "add-fd", "arguments": { "fdset-id": 1 } }
1042 # <- { "return": { "fdset-id": 1, "fd": 3 } }
1045 { 'command': 'add-fd',
1046 'data': { '*fdset-id': 'int',
1048 'returns': 'AddfdInfo' }
1053 # Remove a file descriptor from an fd set.
1055 # @fdset-id: The ID of the fd set that the file descriptor belongs to.
1057 # @fd: The file descriptor that is to be removed.
1059 # Returns: - Nothing on success
1060 # - If @fdset-id or @fd is not found, FdNotFound
1064 # Notes: The list of fd sets is shared by all monitor connections.
1066 # If @fd is not specified, all file descriptors in @fdset-id
1071 # -> { "execute": "remove-fd", "arguments": { "fdset-id": 1, "fd": 3 } }
1072 # <- { "return": {} }
1075 { 'command': 'remove-fd', 'data': {'fdset-id': 'int', '*fd': 'int'} }
1080 # Information about a file descriptor that belongs to an fd set.
1082 # @fd: The file descriptor value.
1084 # @opaque: A free-form string that can be used to describe the fd.
1088 { 'struct': 'FdsetFdInfo',
1089 'data': {'fd': 'int', '*opaque': 'str'} }
1094 # Information about an fd set.
1096 # @fdset-id: The ID of the fd set.
1098 # @fds: A list of file descriptors that belong to this fd set.
1102 { 'struct': 'FdsetInfo',
1103 'data': {'fdset-id': 'int', 'fds': ['FdsetFdInfo']} }
1108 # Return information describing all fd sets.
1110 # Returns: A list of @FdsetInfo
1114 # Note: The list of fd sets is shared by all monitor connections.
1118 # -> { "execute": "query-fdsets" }
1124 # "opaque": "rdonly:/path/to/file"
1128 # "opaque": "rdwr:/path/to/file"
1148 { 'command': 'query-fdsets', 'returns': ['FdsetInfo'] }
1151 # @AcpiTableOptions:
1153 # Specify an ACPI table on the command line to load.
1155 # At most one of @file and @data can be specified. The list of files specified
1156 # by any one of them is loaded and concatenated in order. If both are omitted,
1159 # Other fields / optargs can be used to override fields of the generic ACPI
1160 # table header; refer to the ACPI specification 5.0, section 5.2.6 System
1161 # Description Table Header. If a header field is not overridden, then the
1162 # corresponding value from the concatenated blob is used (in case of @file), or
1163 # it is filled in with a hard-coded value (in case of @data).
1165 # String fields are copied into the matching ACPI member from lowest address
1166 # upwards, and silently truncated / NUL-padded to length.
1168 # @sig: table signature / identifier (4 bytes)
1170 # @rev: table revision number (dependent on signature, 1 byte)
1172 # @oem_id: OEM identifier (6 bytes)
1174 # @oem_table_id: OEM table identifier (8 bytes)
1176 # @oem_rev: OEM-supplied revision number (4 bytes)
1178 # @asl_compiler_id: identifier of the utility that created the table
1181 # @asl_compiler_rev: revision number of the utility that created the
1184 # @file: colon (:) separated list of pathnames to load and
1185 # concatenate as table data. The resultant binary blob is expected to
1186 # have an ACPI table header. At least one file is required. This field
1189 # @data: colon (:) separated list of pathnames to load and
1190 # concatenate as table data. The resultant binary blob must not have an
1191 # ACPI table header. At least one file is required. This field excludes
1196 { 'struct': 'AcpiTableOptions',
1201 '*oem_table_id': 'str',
1202 '*oem_rev': 'uint32',
1203 '*asl_compiler_id': 'str',
1204 '*asl_compiler_rev': 'uint32',
1209 # @CommandLineParameterType:
1211 # Possible types for an option parameter.
1213 # @string: accepts a character string
1215 # @boolean: accepts "on" or "off"
1217 # @number: accepts a number
1219 # @size: accepts a number followed by an optional suffix (K)ilo,
1220 # (M)ega, (G)iga, (T)era
1224 { 'enum': 'CommandLineParameterType',
1225 'data': ['string', 'boolean', 'number', 'size'] }
1228 # @CommandLineParameterInfo:
1230 # Details about a single parameter of a command line option.
1232 # @name: parameter name
1234 # @type: parameter @CommandLineParameterType
1236 # @help: human readable text string, not suitable for parsing.
1238 # @default: default value string (since 2.1)
1242 { 'struct': 'CommandLineParameterInfo',
1243 'data': { 'name': 'str',
1244 'type': 'CommandLineParameterType',
1246 '*default': 'str' } }
1249 # @CommandLineOptionInfo:
1251 # Details about a command line option, including its list of parameter details
1253 # @option: option name
1255 # @parameters: an array of @CommandLineParameterInfo
1259 { 'struct': 'CommandLineOptionInfo',
1260 'data': { 'option': 'str', 'parameters': ['CommandLineParameterInfo'] } }
1263 # @query-command-line-options:
1265 # Query command line option schema.
1267 # @option: option name
1269 # Returns: list of @CommandLineOptionInfo for all options (or for the given
1270 # @option). Returns an error if the given @option doesn't exist.
1276 # -> { "execute": "query-command-line-options",
1277 # "arguments": { "option": "option-rom" } }
1282 # "name": "romfile",
1286 # "name": "bootindex",
1290 # "option": "option-rom"
1296 {'command': 'query-command-line-options',
1297 'data': { '*option': 'str' },
1298 'returns': ['CommandLineOptionInfo'],
1299 'allow-preconfig': true }
1302 # @PCDIMMDeviceInfo:
1304 # PCDIMMDevice state information
1308 # @addr: physical address, where device is mapped
1310 # @size: size of memory that the device provides
1312 # @slot: slot number at which device is plugged in
1314 # @node: NUMA node number where device is plugged in
1316 # @memdev: memory backend linked with device
1318 # @hotplugged: true if device was hotplugged
1320 # @hotpluggable: true if device if could be added/removed while machine is running
1324 { 'struct': 'PCDIMMDeviceInfo',
1325 'data': { '*id': 'str',
1331 'hotplugged': 'bool',
1332 'hotpluggable': 'bool'
1337 # @VirtioPMEMDeviceInfo:
1339 # VirtioPMEM state information
1343 # @memaddr: physical address in memory, where device is mapped
1345 # @size: size of memory that the device provides
1347 # @memdev: memory backend linked with device
1351 { 'struct': 'VirtioPMEMDeviceInfo',
1352 'data': { '*id': 'str',
1360 # @MemoryDeviceInfo:
1362 # Union containing information about a memory device
1364 # nvdimm is included since 2.12. virtio-pmem is included since 4.1.
1368 { 'union': 'MemoryDeviceInfo',
1369 'data': { 'dimm': 'PCDIMMDeviceInfo',
1370 'nvdimm': 'PCDIMMDeviceInfo',
1371 'virtio-pmem': 'VirtioPMEMDeviceInfo'
1376 # @query-memory-devices:
1378 # Lists available memory devices and their state
1384 # -> { "execute": "query-memory-devices" }
1385 # <- { "return": [ { "data":
1386 # { "addr": 5368709120,
1387 # "hotpluggable": true,
1388 # "hotplugged": true,
1390 # "memdev": "/objects/memX",
1392 # "size": 1073741824,
1398 { 'command': 'query-memory-devices', 'returns': ['MemoryDeviceInfo'] }
1401 # @MEM_UNPLUG_ERROR:
1403 # Emitted when memory hot unplug error occurs.
1405 # @device: device name
1407 # @msg: Informative message
1413 # <- { "event": "MEM_UNPLUG_ERROR"
1414 # "data": { "device": "dimm1",
1415 # "msg": "acpi: device unplug for unsupported device"
1417 # "timestamp": { "seconds": 1265044230, "microseconds": 450486 } }
1420 { 'event': 'MEM_UNPLUG_ERROR',
1421 'data': { 'device': 'str', 'msg': 'str' } }
1426 # @DIMM: memory slot
1427 # @CPU: logical CPU slot (since 2.7)
1429 { 'enum': 'ACPISlotType', 'data': [ 'DIMM', 'CPU' ] }
1434 # OSPM Status Indication for a device
1435 # For description of possible values of @source and @status fields
1436 # see "_OST (OSPM Status Indication)" chapter of ACPI5.0 spec.
1438 # @device: device ID associated with slot
1440 # @slot: slot ID, unique per slot of a given @slot-type
1442 # @slot-type: type of the slot
1444 # @source: an integer containing the source event
1446 # @status: an integer containing the status code
1450 { 'struct': 'ACPIOSTInfo',
1451 'data' : { '*device': 'str',
1453 'slot-type': 'ACPISlotType',
1458 # @query-acpi-ospm-status:
1460 # Return a list of ACPIOSTInfo for devices that support status
1461 # reporting via ACPI _OST method.
1467 # -> { "execute": "query-acpi-ospm-status" }
1468 # <- { "return": [ { "device": "d1", "slot": "0", "slot-type": "DIMM", "source": 1, "status": 0},
1469 # { "slot": "1", "slot-type": "DIMM", "source": 0, "status": 0},
1470 # { "slot": "2", "slot-type": "DIMM", "source": 0, "status": 0},
1471 # { "slot": "3", "slot-type": "DIMM", "source": 0, "status": 0}
1475 { 'command': 'query-acpi-ospm-status', 'returns': ['ACPIOSTInfo'] }
1480 # Emitted when guest executes ACPI _OST method.
1482 # @info: OSPM Status Indication
1488 # <- { "event": "ACPI_DEVICE_OST",
1489 # "data": { "device": "d1", "slot": "0",
1490 # "slot-type": "DIMM", "source": 1, "status": 0 } }
1493 { 'event': 'ACPI_DEVICE_OST',
1494 'data': { 'info': 'ACPIOSTInfo' } }
1499 # Mode of the replay subsystem.
1501 # @none: normal execution mode. Replay or record are not enabled.
1503 # @record: record mode. All non-deterministic data is written into the
1506 # @play: replay mode. Non-deterministic data required for system execution
1507 # is read from the log.
1511 { 'enum': 'ReplayMode',
1512 'data': [ 'none', 'record', 'play' ] }
1515 # @xen-load-devices-state:
1517 # Load the state of all devices from file. The RAM and the block devices
1518 # of the VM are not loaded by this command.
1520 # @filename: the file to load the state of the devices from as binary
1521 # data. See xen-save-devices-state.txt for a description of the binary
1528 # -> { "execute": "xen-load-devices-state",
1529 # "arguments": { "filename": "/tmp/resume" } }
1530 # <- { "return": {} }
1533 { 'command': 'xen-load-devices-state', 'data': {'filename': 'str'} }
1540 # @guid: the globally unique identifier
1544 { 'struct': 'GuidInfo', 'data': {'guid': 'str'} }
1547 # @query-vm-generation-id:
1549 # Show Virtual Machine Generation ID
1553 { 'command': 'query-vm-generation-id', 'returns': 'GuidInfo' }