# -*- Mode: Python -*- # ## # = Miscellanea ## { 'include': 'common.json' } ## # @qmp_capabilities: # # Enable QMP capabilities. # # Arguments: # # @enable: An optional list of QMPCapability values to enable. The # client must not enable any capability that is not # mentioned in the QMP greeting message. If the field is not # provided, it means no QMP capabilities will be enabled. # (since 2.12) # # Example: # # -> { "execute": "qmp_capabilities", # "arguments": { "enable": [ "oob" ] } } # <- { "return": {} } # # Notes: This command is valid exactly when first connecting: it must be # issued before any other command will be accepted, and will fail once the # monitor is accepting other commands. (see qemu docs/interop/qmp-spec.txt) # # The QMP client needs to explicitly enable QMP capabilities, otherwise # all the QMP capabilities will be turned off by default. # # Since: 0.13 # ## { 'command': 'qmp_capabilities', 'data': { '*enable': [ 'QMPCapability' ] }, 'allow-preconfig': true } ## # @QMPCapability: # # Enumeration of capabilities to be advertised during initial client # connection, used for agreeing on particular QMP extension behaviors. # # @oob: QMP ability to support out-of-band requests. # (Please refer to qmp-spec.txt for more information on OOB) # # Since: 2.12 # ## { 'enum': 'QMPCapability', 'data': [ 'oob' ] } ## # @VersionTriple: # # A three-part version number. # # @major: The major version number. # # @minor: The minor version number. # # @micro: The micro version number. # # Since: 2.4 ## { 'struct': 'VersionTriple', 'data': {'major': 'int', 'minor': 'int', 'micro': 'int'} } ## # @VersionInfo: # # A description of QEMU's version. # # @qemu: The version of QEMU. By current convention, a micro # version of 50 signifies a development branch. A micro version # greater than or equal to 90 signifies a release candidate for # the next minor version. A micro version of less than 50 # signifies a stable release. # # @package: QEMU will always set this field to an empty string. Downstream # versions of QEMU should set this to a non-empty string. The # exact format depends on the downstream however it highly # recommended that a unique name is used. # # Since: 0.14.0 ## { 'struct': 'VersionInfo', 'data': {'qemu': 'VersionTriple', 'package': 'str'} } ## # @query-version: # # Returns the current version of QEMU. # # Returns: A @VersionInfo object describing the current version of QEMU. # # Since: 0.14.0 # # Example: # # -> { "execute": "query-version" } # <- { # "return":{ # "qemu":{ # "major":0, # "minor":11, # "micro":5 # }, # "package":"" # } # } # ## { 'command': 'query-version', 'returns': 'VersionInfo', 'allow-preconfig': true } ## # @CommandInfo: # # Information about a QMP command # # @name: The command name # # Since: 0.14.0 ## { 'struct': 'CommandInfo', 'data': {'name': 'str'} } ## # @query-commands: # # Return a list of supported QMP commands by this server # # Returns: A list of @CommandInfo for all supported commands # # Since: 0.14.0 # # Example: # # -> { "execute": "query-commands" } # <- { # "return":[ # { # "name":"query-balloon" # }, # { # "name":"system_powerdown" # } # ] # } # # Note: This example has been shortened as the real response is too long. # ## { 'command': 'query-commands', 'returns': ['CommandInfo'], 'allow-preconfig': true } ## # @LostTickPolicy: # # Policy for handling lost ticks in timer devices. # # @discard: throw away the missed tick(s) and continue with future injection # normally. Guest time may be delayed, unless the OS has explicit # handling of lost ticks # # @delay: continue to deliver ticks at the normal rate. Guest time will be # delayed due to the late tick # # @slew: deliver ticks at a higher rate to catch up with the missed tick. The # guest time should not be delayed once catchup is complete. # # Since: 2.0 ## { 'enum': 'LostTickPolicy', 'data': ['discard', 'delay', 'slew' ] } ## # @add_client: # # Allow client connections for VNC, Spice and socket based # character devices to be passed in to QEMU via SCM_RIGHTS. # # @protocol: protocol name. Valid names are "vnc", "spice" or the # name of a character device (eg. from -chardev id=XXXX) # # @fdname: file descriptor name previously passed via 'getfd' command # # @skipauth: whether to skip authentication. Only applies # to "vnc" and "spice" protocols # # @tls: whether to perform TLS. Only applies to the "spice" # protocol # # Returns: nothing on success. # # Since: 0.14.0 # # Example: # # -> { "execute": "add_client", "arguments": { "protocol": "vnc", # "fdname": "myclient" } } # <- { "return": {} } # ## { 'command': 'add_client', 'data': { 'protocol': 'str', 'fdname': 'str', '*skipauth': 'bool', '*tls': 'bool' } } ## # @NameInfo: # # Guest name information. # # @name: The name of the guest # # Since: 0.14.0 ## { 'struct': 'NameInfo', 'data': {'*name': 'str'} } ## # @query-name: # # Return the name information of a guest. # # Returns: @NameInfo of the guest # # Since: 0.14.0 # # Example: # # -> { "execute": "query-name" } # <- { "return": { "name": "qemu-name" } } # ## { 'command': 'query-name', 'returns': 'NameInfo', 'allow-preconfig': true } ## # @KvmInfo: # # Information about support for KVM acceleration # # @enabled: true if KVM acceleration is active # # @present: true if KVM acceleration is built into this executable # # Since: 0.14.0 ## { 'struct': 'KvmInfo', 'data': {'enabled': 'bool', 'present': 'bool'} } ## # @query-kvm: # # Returns information about KVM acceleration # # Returns: @KvmInfo # # Since: 0.14.0 # # Example: # # -> { "execute": "query-kvm" } # <- { "return": { "enabled": true, "present": true } } # ## { 'command': 'query-kvm', 'returns': 'KvmInfo' } ## # @UuidInfo: # # Guest UUID information (Universally Unique Identifier). # # @UUID: the UUID of the guest # # Since: 0.14.0 # # Notes: If no UUID was specified for the guest, a null UUID is returned. ## { 'struct': 'UuidInfo', 'data': {'UUID': 'str'} } ## # @query-uuid: # # Query the guest UUID information. # # Returns: The @UuidInfo for the guest # # Since: 0.14.0 # # Example: # # -> { "execute": "query-uuid" } # <- { "return": { "UUID": "550e8400-e29b-41d4-a716-446655440000" } } # ## { 'command': 'query-uuid', 'returns': 'UuidInfo', 'allow-preconfig': true } ## # @EventInfo: # # Information about a QMP event # # @name: The event name # # Since: 1.2.0 ## { 'struct': 'EventInfo', 'data': {'name': 'str'} } ## # @query-events: # # Return information on QMP events. # # Returns: A list of @EventInfo. # # Since: 1.2.0 # # Note: This command is deprecated, because its output doesn't reflect # compile-time configuration. Use query-qmp-schema instead. # # Example: # # -> { "execute": "query-events" } # <- { # "return": [ # { # "name":"SHUTDOWN" # }, # { # "name":"RESET" # } # ] # } # # Note: This example has been shortened as the real response is too long. # ## { 'command': 'query-events', 'returns': ['EventInfo'] } ## # @IOThreadInfo: # # Information about an iothread # # @id: the identifier of the iothread # # @thread-id: ID of the underlying host thread # # @poll-max-ns: maximum polling time in ns, 0 means polling is disabled # (since 2.9) # # @poll-grow: how many ns will be added to polling time, 0 means that it's not # configured (since 2.9) # # @poll-shrink: how many ns will be removed from polling time, 0 means that # it's not configured (since 2.9) # # Since: 2.0 ## { 'struct': 'IOThreadInfo', 'data': {'id': 'str', 'thread-id': 'int', 'poll-max-ns': 'int', 'poll-grow': 'int', 'poll-shrink': 'int' } } ## # @query-iothreads: # # Returns a list of information about each iothread. # # Note: this list excludes the QEMU main loop thread, which is not declared # using the -object iothread command-line option. It is always the main thread # of the process. # # Returns: a list of @IOThreadInfo for each iothread # # Since: 2.0 # # Example: # # -> { "execute": "query-iothreads" } # <- { "return": [ # { # "id":"iothread0", # "thread-id":3134 # }, # { # "id":"iothread1", # "thread-id":3135 # } # ] # } # ## { 'command': 'query-iothreads', 'returns': ['IOThreadInfo'], 'allow-preconfig': true } ## # @BalloonInfo: # # Information about the guest balloon device. # # @actual: the number of bytes the balloon currently contains # # Since: 0.14.0 # ## { 'struct': 'BalloonInfo', 'data': {'actual': 'int' } } ## # @query-balloon: # # Return information about the balloon device. # # Returns: @BalloonInfo on success # # If the balloon driver is enabled but not functional because the KVM # kernel module cannot support it, KvmMissingCap # # If no balloon device is present, DeviceNotActive # # Since: 0.14.0 # # Example: # # -> { "execute": "query-balloon" } # <- { "return": { # "actual": 1073741824, # } # } # ## { 'command': 'query-balloon', 'returns': 'BalloonInfo' } ## # @BALLOON_CHANGE: # # Emitted when the guest changes the actual BALLOON level. This value is # equivalent to the @actual field return by the 'query-balloon' command # # @actual: actual level of the guest memory balloon in bytes # # Note: this event is rate-limited. # # Since: 1.2 # # Example: # # <- { "event": "BALLOON_CHANGE", # "data": { "actual": 944766976 }, # "timestamp": { "seconds": 1267020223, "microseconds": 435656 } } # ## { 'event': 'BALLOON_CHANGE', 'data': { 'actual': 'int' } } ## # @PciMemoryRange: # # A PCI device memory region # # @base: the starting address (guest physical) # # @limit: the ending address (guest physical) # # Since: 0.14.0 ## { 'struct': 'PciMemoryRange', 'data': {'base': 'int', 'limit': 'int'} } ## # @PciMemoryRegion: # # Information about a PCI device I/O region. # # @bar: the index of the Base Address Register for this region # # @type: 'io' if the region is a PIO region # 'memory' if the region is a MMIO region # # @size: memory size # # @prefetch: if @type is 'memory', true if the memory is prefetchable # # @mem_type_64: if @type is 'memory', true if the BAR is 64-bit # # Since: 0.14.0 ## { 'struct': 'PciMemoryRegion', 'data': {'bar': 'int', 'type': 'str', 'address': 'int', 'size': 'int', '*prefetch': 'bool', '*mem_type_64': 'bool' } } ## # @PciBusInfo: # # Information about a bus of a PCI Bridge device # # @number: primary bus interface number. This should be the number of the # bus the device resides on. # # @secondary: secondary bus interface number. This is the number of the # main bus for the bridge # # @subordinate: This is the highest number bus that resides below the # bridge. # # @io_range: The PIO range for all devices on this bridge # # @memory_range: The MMIO range for all devices on this bridge # # @prefetchable_range: The range of prefetchable MMIO for all devices on # this bridge # # Since: 2.4 ## { 'struct': 'PciBusInfo', 'data': {'number': 'int', 'secondary': 'int', 'subordinate': 'int', 'io_range': 'PciMemoryRange', 'memory_range': 'PciMemoryRange', 'prefetchable_range': 'PciMemoryRange' } } ## # @PciBridgeInfo: # # Information about a PCI Bridge device # # @bus: information about the bus the device resides on # # @devices: a list of @PciDeviceInfo for each device on this bridge # # Since: 0.14.0 ## { 'struct': 'PciBridgeInfo', 'data': {'bus': 'PciBusInfo', '*devices': ['PciDeviceInfo']} } ## # @PciDeviceClass: # # Information about the Class of a PCI device # # @desc: a string description of the device's class # # @class: the class code of the device # # Since: 2.4 ## { 'struct': 'PciDeviceClass', 'data': {'*desc': 'str', 'class': 'int'} } ## # @PciDeviceId: # # Information about the Id of a PCI device # # @device: the PCI device id # # @vendor: the PCI vendor id # # @subsystem: the PCI subsystem id (since 3.1) # # @subsystem-vendor: the PCI subsystem vendor id (since 3.1) # # Since: 2.4 ## { 'struct': 'PciDeviceId', 'data': {'device': 'int', 'vendor': 'int', '*subsystem': 'int', '*subsystem-vendor': 'int'} } ## # @PciDeviceInfo: # # Information about a PCI device # # @bus: the bus number of the device # # @slot: the slot the device is located in # # @function: the function of the slot used by the device # # @class_info: the class of the device # # @id: the PCI device id # # @irq: if an IRQ is assigned to the device, the IRQ number # # @qdev_id: the device name of the PCI device # # @pci_bridge: if the device is a PCI bridge, the bridge information # # @regions: a list of the PCI I/O regions associated with the device # # Notes: the contents of @class_info.desc are not stable and should only be # treated as informational. # # Since: 0.14.0 ## { 'struct': 'PciDeviceInfo', 'data': {'bus': 'int', 'slot': 'int', 'function': 'int', 'class_info': 'PciDeviceClass', 'id': 'PciDeviceId', '*irq': 'int', 'qdev_id': 'str', '*pci_bridge': 'PciBridgeInfo', 'regions': ['PciMemoryRegion']} } ## # @PciInfo: # # Information about a PCI bus # # @bus: the bus index # # @devices: a list of devices on this bus # # Since: 0.14.0 ## { 'struct': 'PciInfo', 'data': {'bus': 'int', 'devices': ['PciDeviceInfo']} } ## # @query-pci: # # Return information about the PCI bus topology of the guest. # # Returns: a list of @PciInfo for each PCI bus. Each bus is # represented by a json-object, which has a key with a json-array of # all PCI devices attached to it. Each device is represented by a # json-object. # # Since: 0.14.0 # # Example: # # -> { "execute": "query-pci" } # <- { "return": [ # { # "bus": 0, # "devices": [ # { # "bus": 0, # "qdev_id": "", # "slot": 0, # "class_info": { # "class": 1536, # "desc": "Host bridge" # }, # "id": { # "device": 32902, # "vendor": 4663 # }, # "function": 0, # "regions": [ # ] # }, # { # "bus": 0, # "qdev_id": "", # "slot": 1, # "class_info": { # "class": 1537, # "desc": "ISA bridge" # }, # "id": { # "device": 32902, # "vendor": 28672 # }, # "function": 0, # "regions": [ # ] # }, # { # "bus": 0, # "qdev_id": "", # "slot": 1, # "class_info": { # "class": 257, # "desc": "IDE controller" # }, # "id": { # "device": 32902, # "vendor": 28688 # }, # "function": 1, # "regions": [ # { # "bar": 4, # "size": 16, # "address": 49152, # "type": "io" # } # ] # }, # { # "bus": 0, # "qdev_id": "", # "slot": 2, # "class_info": { # "class": 768, # "desc": "VGA controller" # }, # "id": { # "device": 4115, # "vendor": 184 # }, # "function": 0, # "regions": [ # { # "prefetch": true, # "mem_type_64": false, # "bar": 0, # "size": 33554432, # "address": 4026531840, # "type": "memory" # }, # { # "prefetch": false, # "mem_type_64": false, # "bar": 1, # "size": 4096, # "address": 4060086272, # "type": "memory" # }, # { # "prefetch": false, # "mem_type_64": false, # "bar": 6, # "size": 65536, # "address": -1, # "type": "memory" # } # ] # }, # { # "bus": 0, # "qdev_id": "", # "irq": 11, # "slot": 4, # "class_info": { # "class": 1280, # "desc": "RAM controller" # }, # "id": { # "device": 6900, # "vendor": 4098 # }, # "function": 0, # "regions": [ # { # "bar": 0, # "size": 32, # "address": 49280, # "type": "io" # } # ] # } # ] # } # ] # } # # Note: This example has been shortened as the real response is too long. # ## { 'command': 'query-pci', 'returns': ['PciInfo'] } ## # @quit: # # This command will cause the QEMU process to exit gracefully. While every # attempt is made to send the QMP response before terminating, this is not # guaranteed. When using this interface, a premature EOF would not be # unexpected. # # Since: 0.14.0 # # Example: # # -> { "execute": "quit" } # <- { "return": {} } ## { 'command': 'quit' } ## # @stop: # # Stop all guest VCPU execution. # # Since: 0.14.0 # # Notes: This function will succeed even if the guest is already in the stopped # state. In "inmigrate" state, it will ensure that the guest # remains paused once migration finishes, as if the -S option was # passed on the command line. # # Example: # # -> { "execute": "stop" } # <- { "return": {} } # ## { 'command': 'stop' } ## # @system_reset: # # Performs a hard reset of a guest. # # Since: 0.14.0 # # Example: # # -> { "execute": "system_reset" } # <- { "return": {} } # ## { 'command': 'system_reset' } ## # @system_powerdown: # # Requests that a guest perform a powerdown operation. # # Since: 0.14.0 # # Notes: A guest may or may not respond to this command. This command # returning does not indicate that a guest has accepted the request or # that it has shut down. Many guests will respond to this command by # prompting the user in some way. # Example: # # -> { "execute": "system_powerdown" } # <- { "return": {} } # ## { 'command': 'system_powerdown' } ## # @memsave: # # Save a portion of guest memory to a file. # # @val: the virtual address of the guest to start from # # @size: the size of memory region to save # # @filename: the file to save the memory to as binary data # # @cpu-index: the index of the virtual CPU to use for translating the # virtual address (defaults to CPU 0) # # Returns: Nothing on success # # Since: 0.14.0 # # Notes: Errors were not reliably returned until 1.1 # # Example: # # -> { "execute": "memsave", # "arguments": { "val": 10, # "size": 100, # "filename": "/tmp/virtual-mem-dump" } } # <- { "return": {} } # ## { 'command': 'memsave', 'data': {'val': 'int', 'size': 'int', 'filename': 'str', '*cpu-index': 'int'} } ## # @pmemsave: # # Save a portion of guest physical memory to a file. # # @val: the physical address of the guest to start from # # @size: the size of memory region to save # # @filename: the file to save the memory to as binary data # # Returns: Nothing on success # # Since: 0.14.0 # # Notes: Errors were not reliably returned until 1.1 # # Example: # # -> { "execute": "pmemsave", # "arguments": { "val": 10, # "size": 100, # "filename": "/tmp/physical-mem-dump" } } # <- { "return": {} } # ## { 'command': 'pmemsave', 'data': {'val': 'int', 'size': 'int', 'filename': 'str'} } ## # @cont: # # Resume guest VCPU execution. # # Since: 0.14.0 # # Returns: If successful, nothing # # Notes: This command will succeed if the guest is currently running. It # will also succeed if the guest is in the "inmigrate" state; in # this case, the effect of the command is to make sure the guest # starts once migration finishes, removing the effect of the -S # command line option if it was passed. # # Example: # # -> { "execute": "cont" } # <- { "return": {} } # ## { 'command': 'cont' } ## # @x-exit-preconfig: # # Exit from "preconfig" state # # This command makes QEMU exit the preconfig state and proceed with # VM initialization using configuration data provided on the command line # and via the QMP monitor during the preconfig state. The command is only # available during the preconfig state (i.e. when the --preconfig command # line option was in use). # # Since 3.0 # # Returns: nothing # # Example: # # -> { "execute": "x-exit-preconfig" } # <- { "return": {} } # ## { 'command': 'x-exit-preconfig', 'allow-preconfig': true } ## # @system_wakeup: # # Wake up guest from suspend. If the guest has wake-up from suspend # support enabled (wakeup-suspend-support flag from # query-current-machine), wake-up guest from suspend if the guest is # in SUSPENDED state. Return an error otherwise. # # Since: 1.1 # # Returns: nothing. # # Note: prior to 4.0, this command does nothing in case the guest # isn't suspended. # # Example: # # -> { "execute": "system_wakeup" } # <- { "return": {} } # ## { 'command': 'system_wakeup' } ## # @inject-nmi: # # Injects a Non-Maskable Interrupt into the default CPU (x86/s390) or all CPUs (ppc64). # The command fails when the guest doesn't support injecting. # # Returns: If successful, nothing # # Since: 0.14.0 # # Note: prior to 2.1, this command was only supported for x86 and s390 VMs # # Example: # # -> { "execute": "inject-nmi" } # <- { "return": {} } # ## { 'command': 'inject-nmi' } ## # @balloon: # # Request the balloon driver to change its balloon size. # # @value: the target size of the balloon in bytes # # Returns: Nothing on success # If the balloon driver is enabled but not functional because the KVM # kernel module cannot support it, KvmMissingCap # If no balloon device is present, DeviceNotActive # # Notes: This command just issues a request to the guest. When it returns, # the balloon size may not have changed. A guest can change the balloon # size independent of this command. # # Since: 0.14.0 # # Example: # # -> { "execute": "balloon", "arguments": { "value": 536870912 } } # <- { "return": {} } # ## { 'command': 'balloon', 'data': {'value': 'int'} } ## # @human-monitor-command: # # Execute a command on the human monitor and return the output. # # @command-line: the command to execute in the human monitor # # @cpu-index: The CPU to use for commands that require an implicit CPU # # Returns: the output of the command as a string # # Since: 0.14.0 # # Notes: This command only exists as a stop-gap. Its use is highly # discouraged. The semantics of this command are not # guaranteed: this means that command names, arguments and # responses can change or be removed at ANY time. Applications # that rely on long term stability guarantees should NOT # use this command. # # Known limitations: # # * This command is stateless, this means that commands that depend # on state information (such as getfd) might not work # # * Commands that prompt the user for data don't currently work # # Example: # # -> { "execute": "human-monitor-command", # "arguments": { "command-line": "info kvm" } } # <- { "return": "kvm support: enabled\r\n" } # ## { 'command': 'human-monitor-command', 'data': {'command-line': 'str', '*cpu-index': 'int'}, 'returns': 'str' } ## # @change: # # This command is multiple commands multiplexed together. # # @device: This is normally the name of a block device but it may also be 'vnc'. # when it's 'vnc', then sub command depends on @target # # @target: If @device is a block device, then this is the new filename. # If @device is 'vnc', then if the value 'password' selects the vnc # change password command. Otherwise, this specifies a new server URI # address to listen to for VNC connections. # # @arg: If @device is a block device, then this is an optional format to open # the device with. # If @device is 'vnc' and @target is 'password', this is the new VNC # password to set. See change-vnc-password for additional notes. # # Returns: Nothing on success. # If @device is not a valid block device, DeviceNotFound # # Notes: This interface is deprecated, and it is strongly recommended that you # avoid using it. For changing block devices, use # blockdev-change-medium; for changing VNC parameters, use # change-vnc-password. # # Since: 0.14.0 # # Example: # # 1. Change a removable medium # # -> { "execute": "change", # "arguments": { "device": "ide1-cd0", # "target": "/srv/images/Fedora-12-x86_64-DVD.iso" } } # <- { "return": {} } # # 2. Change VNC password # # -> { "execute": "change", # "arguments": { "device": "vnc", "target": "password", # "arg": "foobar1" } } # <- { "return": {} } # ## { 'command': 'change', 'data': {'device': 'str', 'target': 'str', '*arg': 'str'} } ## # @xen-set-global-dirty-log: # # Enable or disable the global dirty log mode. # # @enable: true to enable, false to disable. # # Returns: nothing # # Since: 1.3 # # Example: # # -> { "execute": "xen-set-global-dirty-log", # "arguments": { "enable": true } } # <- { "return": {} } # ## { 'command': 'xen-set-global-dirty-log', 'data': { 'enable': 'bool' } } ## # @DumpGuestMemoryFormat: # # An enumeration of guest-memory-dump's format. # # @elf: elf format # # @kdump-zlib: kdump-compressed format with zlib-compressed # # @kdump-lzo: kdump-compressed format with lzo-compressed # # @kdump-snappy: kdump-compressed format with snappy-compressed # # @win-dmp: Windows full crashdump format, # can be used instead of ELF converting (since 2.13) # # Since: 2.0 ## { 'enum': 'DumpGuestMemoryFormat', 'data': [ 'elf', 'kdump-zlib', 'kdump-lzo', 'kdump-snappy', 'win-dmp' ] } ## # @dump-guest-memory: # # Dump guest's memory to vmcore. It is a synchronous operation that can take # very long depending on the amount of guest memory. # # @paging: if true, do paging to get guest's memory mapping. This allows # using gdb to process the core file. # # IMPORTANT: this option can make QEMU allocate several gigabytes # of RAM. This can happen for a large guest, or a # malicious guest pretending to be large. # # Also, paging=true has the following limitations: # # 1. The guest may be in a catastrophic state or can have corrupted # memory, which cannot be trusted # 2. The guest can be in real-mode even if paging is enabled. For # example, the guest uses ACPI to sleep, and ACPI sleep state # goes in real-mode # 3. Currently only supported on i386 and x86_64. # # @protocol: the filename or file descriptor of the vmcore. The supported # protocols are: # # 1. file: the protocol starts with "file:", and the following # string is the file's path. # 2. fd: the protocol starts with "fd:", and the following string # is the fd's name. # # @detach: if true, QMP will return immediately rather than # waiting for the dump to finish. The user can track progress # using "query-dump". (since 2.6). # # @begin: if specified, the starting physical address. # # @length: if specified, the memory size, in bytes. If you don't # want to dump all guest's memory, please specify the start @begin # and @length # # @format: if specified, the format of guest memory dump. But non-elf # format is conflict with paging and filter, ie. @paging, @begin and # @length is not allowed to be specified with non-elf @format at the # same time (since 2.0) # # Note: All boolean arguments default to false # # Returns: nothing on success # # Since: 1.2 # # Example: # # -> { "execute": "dump-guest-memory", # "arguments": { "protocol": "fd:dump" } } # <- { "return": {} } # ## { 'command': 'dump-guest-memory', 'data': { 'paging': 'bool', 'protocol': 'str', '*detach': 'bool', '*begin': 'int', '*length': 'int', '*format': 'DumpGuestMemoryFormat'} } ## # @DumpStatus: # # Describe the status of a long-running background guest memory dump. # # @none: no dump-guest-memory has started yet. # # @active: there is one dump running in background. # # @completed: the last dump has finished successfully. # # @failed: the last dump has failed. # # Since: 2.6 ## { 'enum': 'DumpStatus', 'data': [ 'none', 'active', 'completed', 'failed' ] } ## # @DumpQueryResult: # # The result format for 'query-dump'. # # @status: enum of @DumpStatus, which shows current dump status # # @completed: bytes written in latest dump (uncompressed) # # @total: total bytes to be written in latest dump (uncompressed) # # Since: 2.6 ## { 'struct': 'DumpQueryResult', 'data': { 'status': 'DumpStatus', 'completed': 'int', 'total': 'int' } } ## # @query-dump: # # Query latest dump status. # # Returns: A @DumpStatus object showing the dump status. # # Since: 2.6 # # Example: # # -> { "execute": "query-dump" } # <- { "return": { "status": "active", "completed": 1024000, # "total": 2048000 } } # ## { 'command': 'query-dump', 'returns': 'DumpQueryResult' } ## # @DUMP_COMPLETED: # # Emitted when background dump has completed # # @result: final dump status # # @error: human-readable error string that provides # hint on why dump failed. Only presents on failure. The # user should not try to interpret the error string. # # Since: 2.6 # # Example: # # { "event": "DUMP_COMPLETED", # "data": {"result": {"total": 1090650112, "status": "completed", # "completed": 1090650112} } } # ## { 'event': 'DUMP_COMPLETED' , 'data': { 'result': 'DumpQueryResult', '*error': 'str' } } ## # @DumpGuestMemoryCapability: # # A list of the available formats for dump-guest-memory # # Since: 2.0 ## { 'struct': 'DumpGuestMemoryCapability', 'data': { 'formats': ['DumpGuestMemoryFormat'] } } ## # @query-dump-guest-memory-capability: # # Returns the available formats for dump-guest-memory # # Returns: A @DumpGuestMemoryCapability object listing available formats for # dump-guest-memory # # Since: 2.0 # # Example: # # -> { "execute": "query-dump-guest-memory-capability" } # <- { "return": { "formats": # ["elf", "kdump-zlib", "kdump-lzo", "kdump-snappy"] } # ## { 'command': 'query-dump-guest-memory-capability', 'returns': 'DumpGuestMemoryCapability' } ## # @getfd: # # Receive a file descriptor via SCM rights and assign it a name # # @fdname: file descriptor name # # Returns: Nothing on success # # Since: 0.14.0 # # Notes: If @fdname already exists, the file descriptor assigned to # it will be closed and replaced by the received file # descriptor. # # The 'closefd' command can be used to explicitly close the # file descriptor when it is no longer needed. # # Example: # # -> { "execute": "getfd", "arguments": { "fdname": "fd1" } } # <- { "return": {} } # ## { 'command': 'getfd', 'data': {'fdname': 'str'} } ## # @closefd: # # Close a file descriptor previously passed via SCM rights # # @fdname: file descriptor name # # Returns: Nothing on success # # Since: 0.14.0 # # Example: # # -> { "execute": "closefd", "arguments": { "fdname": "fd1" } } # <- { "return": {} } # ## { 'command': 'closefd', 'data': {'fdname': 'str'} } ## # @MemoryInfo: # # Actual memory information in bytes. # # @base-memory: size of "base" memory specified with command line # option -m. # # @plugged-memory: size of memory that can be hot-unplugged. This field # is omitted if target doesn't support memory hotplug # (i.e. CONFIG_MEM_DEVICE not defined at build time). # # Since: 2.11.0 ## { 'struct': 'MemoryInfo', 'data' : { 'base-memory': 'size', '*plugged-memory': 'size' } } ## # @query-memory-size-summary: # # Return the amount of initially allocated and present hotpluggable (if # enabled) memory in bytes. # # Example: # # -> { "execute": "query-memory-size-summary" } # <- { "return": { "base-memory": 4294967296, "plugged-memory": 0 } } # # Since: 2.11.0 ## { 'command': 'query-memory-size-summary', 'returns': 'MemoryInfo' } ## # @AddfdInfo: # # Information about a file descriptor that was added to an fd set. # # @fdset-id: The ID of the fd set that @fd was added to. # # @fd: The file descriptor that was received via SCM rights and # added to the fd set. # # Since: 1.2.0 ## { 'struct': 'AddfdInfo', 'data': {'fdset-id': 'int', 'fd': 'int'} } ## # @add-fd: # # Add a file descriptor, that was passed via SCM rights, to an fd set. # # @fdset-id: The ID of the fd set to add the file descriptor to. # # @opaque: A free-form string that can be used to describe the fd. # # Returns: @AddfdInfo on success # # If file descriptor was not received, FdNotSupplied # # If @fdset-id is a negative value, InvalidParameterValue # # Notes: The list of fd sets is shared by all monitor connections. # # If @fdset-id is not specified, a new fd set will be created. # # Since: 1.2.0 # # Example: # # -> { "execute": "add-fd", "arguments": { "fdset-id": 1 } } # <- { "return": { "fdset-id": 1, "fd": 3 } } # ## { 'command': 'add-fd', 'data': { '*fdset-id': 'int', '*opaque': 'str' }, 'returns': 'AddfdInfo' } ## # @remove-fd: # # Remove a file descriptor from an fd set. # # @fdset-id: The ID of the fd set that the file descriptor belongs to. # # @fd: The file descriptor that is to be removed. # # Returns: Nothing on success # If @fdset-id or @fd is not found, FdNotFound # # Since: 1.2.0 # # Notes: The list of fd sets is shared by all monitor connections. # # If @fd is not specified, all file descriptors in @fdset-id # will be removed. # # Example: # # -> { "execute": "remove-fd", "arguments": { "fdset-id": 1, "fd": 3 } } # <- { "return": {} } # ## { 'command': 'remove-fd', 'data': {'fdset-id': 'int', '*fd': 'int'} } ## # @FdsetFdInfo: # # Information about a file descriptor that belongs to an fd set. # # @fd: The file descriptor value. # # @opaque: A free-form string that can be used to describe the fd. # # Since: 1.2.0 ## { 'struct': 'FdsetFdInfo', 'data': {'fd': 'int', '*opaque': 'str'} } ## # @FdsetInfo: # # Information about an fd set. # # @fdset-id: The ID of the fd set. # # @fds: A list of file descriptors that belong to this fd set. # # Since: 1.2.0 ## { 'struct': 'FdsetInfo', 'data': {'fdset-id': 'int', 'fds': ['FdsetFdInfo']} } ## # @query-fdsets: # # Return information describing all fd sets. # # Returns: A list of @FdsetInfo # # Since: 1.2.0 # # Note: The list of fd sets is shared by all monitor connections. # # Example: # # -> { "execute": "query-fdsets" } # <- { "return": [ # { # "fds": [ # { # "fd": 30, # "opaque": "rdonly:/path/to/file" # }, # { # "fd": 24, # "opaque": "rdwr:/path/to/file" # } # ], # "fdset-id": 1 # }, # { # "fds": [ # { # "fd": 28 # }, # { # "fd": 29 # } # ], # "fdset-id": 0 # } # ] # } # ## { 'command': 'query-fdsets', 'returns': ['FdsetInfo'] } ## # @TargetInfo: # # Information describing the QEMU target. # # @arch: the target architecture # # Since: 1.2.0 ## { 'struct': 'TargetInfo', 'data': { 'arch': 'SysEmuTarget' } } ## # @query-target: # # Return information about the target for this QEMU # # Returns: TargetInfo # # Since: 1.2.0 ## { 'command': 'query-target', 'returns': 'TargetInfo' } ## # @AcpiTableOptions: # # Specify an ACPI table on the command line to load. # # At most one of @file and @data can be specified. The list of files specified # by any one of them is loaded and concatenated in order. If both are omitted, # @data is implied. # # Other fields / optargs can be used to override fields of the generic ACPI # table header; refer to the ACPI specification 5.0, section 5.2.6 System # Description Table Header. If a header field is not overridden, then the # corresponding value from the concatenated blob is used (in case of @file), or # it is filled in with a hard-coded value (in case of @data). # # String fields are copied into the matching ACPI member from lowest address # upwards, and silently truncated / NUL-padded to length. # # @sig: table signature / identifier (4 bytes) # # @rev: table revision number (dependent on signature, 1 byte) # # @oem_id: OEM identifier (6 bytes) # # @oem_table_id: OEM table identifier (8 bytes) # # @oem_rev: OEM-supplied revision number (4 bytes) # # @asl_compiler_id: identifier of the utility that created the table # (4 bytes) # # @asl_compiler_rev: revision number of the utility that created the # table (4 bytes) # # @file: colon (:) separated list of pathnames to load and # concatenate as table data. The resultant binary blob is expected to # have an ACPI table header. At least one file is required. This field # excludes @data. # # @data: colon (:) separated list of pathnames to load and # concatenate as table data. The resultant binary blob must not have an # ACPI table header. At least one file is required. This field excludes # @file. # # Since: 1.5 ## { 'struct': 'AcpiTableOptions', 'data': { '*sig': 'str', '*rev': 'uint8', '*oem_id': 'str', '*oem_table_id': 'str', '*oem_rev': 'uint32', '*asl_compiler_id': 'str', '*asl_compiler_rev': 'uint32', '*file': 'str', '*data': 'str' }} ## # @CommandLineParameterType: # # Possible types for an option parameter. # # @string: accepts a character string # # @boolean: accepts "on" or "off" # # @number: accepts a number # # @size: accepts a number followed by an optional suffix (K)ilo, # (M)ega, (G)iga, (T)era # # Since: 1.5 ## { 'enum': 'CommandLineParameterType', 'data': ['string', 'boolean', 'number', 'size'] } ## # @CommandLineParameterInfo: # # Details about a single parameter of a command line option. # # @name: parameter name # # @type: parameter @CommandLineParameterType # # @help: human readable text string, not suitable for parsing. # # @default: default value string (since 2.1) # # Since: 1.5 ## { 'struct': 'CommandLineParameterInfo', 'data': { 'name': 'str', 'type': 'CommandLineParameterType', '*help': 'str', '*default': 'str' } } ## # @CommandLineOptionInfo: # # Details about a command line option, including its list of parameter details # # @option: option name # # @parameters: an array of @CommandLineParameterInfo # # Since: 1.5 ## { 'struct': 'CommandLineOptionInfo', 'data': { 'option': 'str', 'parameters': ['CommandLineParameterInfo'] } } ## # @query-command-line-options: # # Query command line option schema. # # @option: option name # # Returns: list of @CommandLineOptionInfo for all options (or for the given # @option). Returns an error if the given @option doesn't exist. # # Since: 1.5 # # Example: # # -> { "execute": "query-command-line-options", # "arguments": { "option": "option-rom" } } # <- { "return": [ # { # "parameters": [ # { # "name": "romfile", # "type": "string" # }, # { # "name": "bootindex", # "type": "number" # } # ], # "option": "option-rom" # } # ] # } # ## {'command': 'query-command-line-options', 'data': { '*option': 'str' }, 'returns': ['CommandLineOptionInfo'], 'allow-preconfig': true } ## # @PCDIMMDeviceInfo: # # PCDIMMDevice state information # # @id: device's ID # # @addr: physical address, where device is mapped # # @size: size of memory that the device provides # # @slot: slot number at which device is plugged in # # @node: NUMA node number where device is plugged in # # @memdev: memory backend linked with device # # @hotplugged: true if device was hotplugged # # @hotpluggable: true if device if could be added/removed while machine is running # # Since: 2.1 ## { 'struct': 'PCDIMMDeviceInfo', 'data': { '*id': 'str', 'addr': 'int', 'size': 'int', 'slot': 'int', 'node': 'int', 'memdev': 'str', 'hotplugged': 'bool', 'hotpluggable': 'bool' } } ## # @MemoryDeviceInfo: # # Union containing information about a memory device # # Since: 2.1 ## { 'union': 'MemoryDeviceInfo', 'data': { 'dimm': 'PCDIMMDeviceInfo', 'nvdimm': 'PCDIMMDeviceInfo' } } ## # @query-memory-devices: # # Lists available memory devices and their state # # Since: 2.1 # # Example: # # -> { "execute": "query-memory-devices" } # <- { "return": [ { "data": # { "addr": 5368709120, # "hotpluggable": true, # "hotplugged": true, # "id": "d1", # "memdev": "/objects/memX", # "node": 0, # "size": 1073741824, # "slot": 0}, # "type": "dimm" # } ] } # ## { 'command': 'query-memory-devices', 'returns': ['MemoryDeviceInfo'] } ## # @MEM_UNPLUG_ERROR: # # Emitted when memory hot unplug error occurs. # # @device: device name # # @msg: Informative message # # Since: 2.4 # # Example: # # <- { "event": "MEM_UNPLUG_ERROR" # "data": { "device": "dimm1", # "msg": "acpi: device unplug for unsupported device" # }, # "timestamp": { "seconds": 1265044230, "microseconds": 450486 } } # ## { 'event': 'MEM_UNPLUG_ERROR', 'data': { 'device': 'str', 'msg': 'str' } } ## # @ACPISlotType: # # @DIMM: memory slot # @CPU: logical CPU slot (since 2.7) ## { 'enum': 'ACPISlotType', 'data': [ 'DIMM', 'CPU' ] } ## # @ACPIOSTInfo: # # OSPM Status Indication for a device # For description of possible values of @source and @status fields # see "_OST (OSPM Status Indication)" chapter of ACPI5.0 spec. # # @device: device ID associated with slot # # @slot: slot ID, unique per slot of a given @slot-type # # @slot-type: type of the slot # # @source: an integer containing the source event # # @status: an integer containing the status code # # Since: 2.1 ## { 'struct': 'ACPIOSTInfo', 'data' : { '*device': 'str', 'slot': 'str', 'slot-type': 'ACPISlotType', 'source': 'int', 'status': 'int' } } ## # @query-acpi-ospm-status: # # Return a list of ACPIOSTInfo for devices that support status # reporting via ACPI _OST method. # # Since: 2.1 # # Example: # # -> { "execute": "query-acpi-ospm-status" } # <- { "return": [ { "device": "d1", "slot": "0", "slot-type": "DIMM", "source": 1, "status": 0}, # { "slot": "1", "slot-type": "DIMM", "source": 0, "status": 0}, # { "slot": "2", "slot-type": "DIMM", "source": 0, "status": 0}, # { "slot": "3", "slot-type": "DIMM", "source": 0, "status": 0} # ]} # ## { 'command': 'query-acpi-ospm-status', 'returns': ['ACPIOSTInfo'] } ## # @ACPI_DEVICE_OST: # # Emitted when guest executes ACPI _OST method. # # @info: OSPM Status Indication # # Since: 2.1 # # Example: # # <- { "event": "ACPI_DEVICE_OST", # "data": { "device": "d1", "slot": "0", # "slot-type": "DIMM", "source": 1, "status": 0 } } # ## { 'event': 'ACPI_DEVICE_OST', 'data': { 'info': 'ACPIOSTInfo' } } ## # @ReplayMode: # # Mode of the replay subsystem. # # @none: normal execution mode. Replay or record are not enabled. # # @record: record mode. All non-deterministic data is written into the # replay log. # # @play: replay mode. Non-deterministic data required for system execution # is read from the log. # # Since: 2.5 ## { 'enum': 'ReplayMode', 'data': [ 'none', 'record', 'play' ] } ## # @xen-load-devices-state: # # Load the state of all devices from file. The RAM and the block devices # of the VM are not loaded by this command. # # @filename: the file to load the state of the devices from as binary # data. See xen-save-devices-state.txt for a description of the binary # format. # # Since: 2.7 # # Example: # # -> { "execute": "xen-load-devices-state", # "arguments": { "filename": "/tmp/resume" } } # <- { "return": {} } # ## { 'command': 'xen-load-devices-state', 'data': {'filename': 'str'} } ## # @GuidInfo: # # GUID information. # # @guid: the globally unique identifier # # Since: 2.9 ## { 'struct': 'GuidInfo', 'data': {'guid': 'str'} } ## # @query-vm-generation-id: # # Show Virtual Machine Generation ID # # Since: 2.9 ## { 'command': 'query-vm-generation-id', 'returns': 'GuidInfo' }