is "block-dirty-bitmap-enable"data: BlockDirtyBitmap
when type
is "block-dirty-bitmap-disable"data: BlockDirtyBitmapMerge
when type
is "block-dirty-bitmap-merge"data: BlockdevBackup
when type
is "blockdev-backup"data: BlockdevSnapshot
when type
is "blockdev-snapshot"data: BlockdevSnapshotInternal
when type
is "blockdev-snapshot-internal-sync"data: BlockdevSnapshotSync
when type
is "blockdev-snapshot-sync"data: DriveBackup
when type
is "drive-backup"Since: 1.1
Optional arguments to modify the behavior of a Transaction.
Members:
completion-mode: ActionCompletionMode
(optional)Controls how jobs launched asynchronously by
Actions will complete or fail as a group.
See ActionCompletionMode
for details.
Since: 2.5
Executes a number of transactionable QMP commands atomically. If any operation fails, then the entire set of actions will be abandoned and the appropriate error returned.
For external snapshots, the dictionary contains the device, the file to use for the new snapshot, and the format. The default format, if not specified, is qcow2.
Each new snapshot defaults to being created by QEMU (wiping any contents if the file already exists), but it is also possible to reuse an externally-created file. In the latter case, you should ensure that the new image file has the same contents as the current one; QEMU cannot perform any meaningful check. Typically this is achieved by using the current image file as the backing file for the new image.
On failure, the original disks pre-snapshot attempt will be used.
For internal snapshots, the dictionary contains the device and the snapshot’s name. If an internal snapshot matching name already exists, the request will be rejected. Only some image formats support it, for example, qcow2, rbd, and sheepdog.
On failure, qemu will try delete the newly created internal snapshot in the transaction. When an I/O error occurs during deletion, the user needs to fix it later with qemu-img or other command.
Arguments:
actions: array of TransactionAction
List of TransactionAction
;
information needed for the respective operations.
properties: TransactionProperties
(optional)structure of additional options to control the
execution of the transaction. See TransactionProperties
for additional detail.
Returns: nothing on success
Errors depend on the operations of the transaction
Note: The transaction aborts on the first failure. Therefore, there will be information on only one failed operation returned in an error condition, and subsequent actions will not have been attempted.
Since: 1.1
Example:
-> { "execute": "transaction", "arguments": { "actions": [ { "type": "blockdev-snapshot-sync", "data" : { "device": "ide-hd0", "snapshot-file": "/some/place/my-image", "format": "qcow2" } }, { "type": "blockdev-snapshot-sync", "data" : { "node-name": "myfile", "snapshot-file": "/some/place/my-image2", "snapshot-node-name": "node3432", "mode": "existing", "format": "qcow2" } }, { "type": "blockdev-snapshot-sync", "data" : { "device": "ide-hd1", "snapshot-file": "/some/place/my-image2", "mode": "existing", "format": "qcow2" } }, { "type": "blockdev-snapshot-internal-sync", "data" : { "device": "ide-hd2", "name": "snapshot0" } } ] } } <- { "return": {} }
State of a tracing event.
Values:
unavailable
The event is statically disabled.
disabled
The event is dynamically disabled.
enabled
The event is dynamically enabled.
Since: 2.2
Information of a tracing event.
Members:
name: string
Event name.
state: TraceEventState
Tracing state.
vcpu: boolean
Whether this is a per-vCPU event (since 2.7).
An event is per-vCPU if it has the "vcpu" property in the "trace-events" files.
Since: 2.2
Query the state of events.
Arguments:
name: string
Event name pattern (case-sensitive glob).
vcpu: int
(optional)The vCPU to query (any by default; since 2.7).
Returns:
a list of TraceEventInfo
for the matching events
An event is returned if:
name
pattern, and
vcpu
is given, the event has the "vcpu" property.
Therefore, if vcpu
is given, the operation will only match per-vCPU events,
returning their state on the specified vCPU. Special case: if name
is an
exact match, vcpu
is given and the event does not have the "vcpu" property,
an error is returned.
Since: 2.2
Example:
-> { "execute": "trace-event-get-state", "arguments": { "name": "qemu_memalign" } } <- { "return": [ { "name": "qemu_memalign", "state": "disabled" } ] }
Set the dynamic tracing state of events.
Arguments:
name: string
Event name pattern (case-sensitive glob).
enable: boolean
Whether to enable tracing.
ignore-unavailable: boolean
(optional)Do not match unavailable events with name
.
vcpu: int
(optional)The vCPU to act upon (all by default; since 2.7).
An event’s state is modified if:
name
pattern, and
vcpu
is given, the event has the "vcpu" property.
Therefore, if vcpu
is given, the operation will only match per-vCPU events,
setting their state on the specified vCPU. Special case: if name
is an exact
match, vcpu
is given and the event does not have the "vcpu" property, an
error is returned.
Since: 2.2
Example:
-> { "execute": "trace-event-set-state", "arguments": { "name": "qemu_memalign", "enable": "true" } } <- { "return": {} }
Enable QMP capabilities.
Arguments:
Arguments:
enable: array of QMPCapability
(optional)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
Enumeration of capabilities to be advertised during initial client connection, used for agreeing on particular QMP extension behaviors.
Values:
oob
QMP ability to support out-of-band requests. (Please refer to qmp-spec.txt for more information on OOB)
Since: 2.12
A three-part version number.
Members:
major: int
The major version number.
minor: int
The minor version number.
micro: int
The micro version number.
Since: 2.4
A description of QEMU’s version.
Members:
qemu: VersionTriple
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: string
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
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":"" } }
Information about a QMP command
Members:
name: string
The command name
Since: 0.14.0
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.
Information about a QMP event
Members:
name: string
The event name
Since: 1.2.0
Return information on QMP events.
Features:
deprecated
This command is deprecated, because its output doesn’t reflect compile-time configuration. Use ’query-qmp-schema’ instead.
Returns:
A list of EventInfo
.
Since: 1.2.0
Example:
-> { "execute": "query-events" } <- { "return": [ { "name":"SHUTDOWN" }, { "name":"RESET" } ] }
Note: This example has been shortened as the real response is too long.
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": {} }
An enumeration of monitor modes.
Values:
readline
HMP monitor (human-oriented command line interface)
control
QMP monitor (JSON-based machine interface)
Since: 5.0
Options to be used for adding a new monitor.
Members:
id: string
(optional)Name of the monitor
mode: MonitorMode
(optional)Selects the monitor mode (default: readline in the system emulator, control in qemu-storage-daemon)
pretty: boolean
(optional)Enables pretty printing (QMP only)
chardev: string
Name of a character device to expose the monitor on
Since: 5.0
Command query-qmp-schema exposes the QMP wire ABI as an array of SchemaInfo. This lets QMP clients figure out what commands and events are available in this QEMU, and their parameters and results.
However, the SchemaInfo can’t reflect all the rules and restrictions that apply to QMP. It’s interface introspection (figuring out what’s there), not interface specification. The specification is in the QAPI schema.
Furthermore, while we strive to keep the QMP wire format backwards-compatible across qemu versions, the introspection output is not guaranteed to have the same stability. For example, one version of qemu may list an object member as an optional non-variant, while another lists the same member only through the object’s variants; or the type of a member may change from a generic string into a specific enum or from one specific type into an alternate that includes the original type alongside something else.
Returns:
array of SchemaInfo
, where each element describes an
entity in the ABI: command, event, type, ...
The order of the various SchemaInfo is unspecified; however, all names are guaranteed to be unique (no name will be duplicated with different meta-types).
Note: the QAPI schema is also used to help define internal interfaces, by defining QAPI types. These are not part of the QMP wire ABI, and therefore not returned by this command.
Since: 2.5
This is a SchemaInfo
’s meta type, i.e. the kind of entity it
describes.
Values:
builtin
a predefined type such as ’int’ or ’bool’.
enum
an enumeration type
array
an array type
object
an object type (struct or union)
alternate
an alternate type
command
a QMP command
event
a QMP event
Since: 2.5
Members:
name: string
the entity’s name, inherited from base
.
The SchemaInfo is always referenced by this name.
Commands and events have the name defined in the QAPI schema.
Unlike command and event names, type names are not part of
the wire ABI. Consequently, type names are meaningless
strings here, although they are still guaranteed unique
regardless of meta-type
.
meta-type: SchemaMetaType
the entity’s meta type, inherited from base
.
features: array of string
(optional)names of features associated with the entity, in no particular order. (since 4.1 for object types, 4.2 for commands, 5.0 for the rest)
SchemaInfoBuiltin
when meta-type
is "builtin"SchemaInfoEnum
when meta-type
is "enum"SchemaInfoArray
when meta-type
is "array"SchemaInfoObject
when meta-type
is "object"SchemaInfoAlternate
when meta-type
is "alternate"SchemaInfoCommand
when meta-type
is "command"SchemaInfoEvent
when meta-type
is "event"Additional members depend on the value of meta-type
.
Since: 2.5
Additional SchemaInfo members for meta-type ’builtin’.
Members:
json-type: JSONType
the JSON type used for this type on the wire.
Since: 2.5
The four primitive and two structured types according to RFC 8259 section 1, plus ’int’ (split off ’number’), plus the obvious top type ’value’.
Values:
string
Not documented
number
Not documented
int
Not documented
boolean
Not documented
null
Not documented
object
Not documented
array
Not documented
value
Not documented
Since: 2.5
Additional SchemaInfo members for meta-type ’enum’.
Members:
values: array of string
the enumeration type’s values, in no particular order.
Values of this type are JSON string on the wire.
Since: 2.5
Additional SchemaInfo members for meta-type ’array’.
Members:
element-type: string
the array type’s element type.
Values of this type are JSON array on the wire.
Since: 2.5
Additional SchemaInfo members for meta-type ’object’.
Members:
members: array of SchemaInfoObjectMember
the object type’s (non-variant) members, in no particular order.
tag: string
(optional)the name of the member serving as type tag.
An element of members
with this name must exist.
variants: array of SchemaInfoObjectVariant
(optional)variant members, i.e. additional members that
depend on the type tag’s value. Present exactly when
tag
is present. The variants are in no particular order,
and may even differ from the order of the values of the
enum type of the tag
.
Values of this type are JSON object on the wire.
Since: 2.5
An object member.
Members:
name: string
the member’s name, as defined in the QAPI schema.
type: string
the name of the member’s type.
default: value
(optional)default when used as command parameter. If absent, the parameter is mandatory. If present, the value must be null. The parameter is optional, and behavior when it’s missing is not specified here. Future extension: if present and non-null, the parameter is optional, and defaults to this value.
features: array of string
(optional)names of features associated with the member, in no particular order. (since 5.0)
Since: 2.5
The variant members for a value of the type tag.
Members:
case: string
a value of the type tag.
type: string
the name of the object type that provides the variant members
when the type tag has value case
.
Since: 2.5
Additional SchemaInfo members for meta-type ’alternate’.
Members:
members: array of SchemaInfoAlternateMember
the alternate type’s members, in no particular order. The members’ wire encoding is distinct, see docs/devel/qapi-code-gen.txt section Alternate types.
On the wire, this can be any of the members.
Since: 2.5
An alternate member.
Members:
type: string
the name of the member’s type.
Since: 2.5
Additional SchemaInfo members for meta-type ’command’.
Members:
arg-type: string
the name of the object type that provides the command’s parameters.
ret-type: string
the name of the command’s result type.
allow-oob: boolean
(optional)whether the command allows out-of-band execution, defaults to false (Since: 2.12)
TODO:
success-response
(currently irrelevant, because it’s QGA, not QMP)
Since: 2.5
Additional SchemaInfo members for meta-type ’event’.
Members:
arg-type: string
the name of the object type that provides the event’s parameters.
Since: 2.5
Members:
name: string
the name of the property
type: string
the type of the property. This will typically come in one of four forms:
1) A primitive type such as ’u8’, ’u16’, ’bool’, ’str’, or ’double’. These types are mapped to the appropriate JSON type.
2) A child type in the form ’child<subtype>’ where subtype is a qdev device type name. Child properties create the composition tree.
3) A link type in the form ’link<subtype>’ where subtype is a qdev device type name. Link properties form the device model graph.
description: string
(optional)if specified, the description of the property.
default-value: value
(optional)the default value, if any (since 5.0)
Since: 1.2
This command will list any properties of a object given a path in the object model.
Arguments:
path: string
the path within the object model. See qom-get
for a description of
this parameter.
Returns:
a list of ObjectPropertyInfo
that describe the properties of the
object.
Since: 1.2
Example:
-> { "execute": "qom-list", "arguments": { "path": "/chardevs" } } <- { "return": [ { "name": "type", "type": "string" }, { "name": "parallel0", "type": "child<chardev-vc>" }, { "name": "serial0", "type": "child<chardev-vc>" }, { "name": "mon0", "type": "child<chardev-stdio>" } ] }
This command will get a property from a object model path and return the value.
Arguments:
path: string
The path within the object model. There are two forms of supported paths–absolute and partial paths.
Absolute paths are derived from the root object and can follow child<> or link<> properties. Since they can follow link<> properties, they can be arbitrarily long. Absolute paths look like absolute filenames and are prefixed with a leading slash.
Partial paths look like relative filenames. They do not begin with a prefix. The matching rules for partial paths are subtle but designed to make specifying objects easy. At each level of the composition tree, the partial path is matched as an absolute path. The first match is not returned. At least two matches are searched for. A successful result is only returned if only one match is found. If more than one match is found, a flag is return to indicate that the match was ambiguous.
property: string
The property name to read
Returns: The property value. The type depends on the property type. child<> and link<> properties are returned as #str pathnames. All integer property types (u8, u16, etc) are returned as #int.
Since: 1.2
Example:
1. Use absolute path -> { "execute": "qom-get", "arguments": { "path": "/machine/unattached/device[0]", "property": "hotplugged" } } <- { "return": false } 2. Use partial path -> { "execute": "qom-get", "arguments": { "path": "unattached/sysbus", "property": "type" } } <- { "return": "System" }
This command will set a property from a object model path.
Arguments:
path: string
see qom-get
for a description of this parameter
property: string
the property name to set
value: value
a value who’s type is appropriate for the property type. See qom-get
for a description of type mapping.
Since: 1.2
Example:
-> { "execute": "qom-set", "arguments": { "path": "/machine", "property": "graphics", "value": false } } <- { "return": {} }
This structure describes a search result from qom-list-types
Members:
name: string
the type name found in the search
abstract: boolean
(optional)the type is abstract and can’t be directly instantiated. Omitted if false. (since 2.10)
parent: string
(optional)Name of parent type, if any (since 2.10)
Since: 1.1
This command will return a list of types given search parameters
Arguments:
implements: string
(optional)if specified, only return types that implement this type name
abstract: boolean
(optional)if true, include abstract types in the results
Returns:
a list of ObjectTypeInfo
or an empty list if no results are found
Since: 1.1
List properties associated with a QOM object.
Arguments:
typename: string
the type name of an object
Note: objects can create properties at runtime, for example to describe links between different devices and/or objects. These properties are not included in the output of this command.
Returns: a list of ObjectPropertyInfo describing object properties
Since: 2.12
Create a QOM object.
Arguments:
qom-type: string
the class name for the object to be created
id: string
the name of the new object
props: value
(optional)a dictionary of properties to be passed to the backend. Deprecated
since 5.0, specify the properties on the top level instead. It is an
error to specify the same option both on the top level and in props
.
Additional arguments depend on qom-type and are passed to the backend unchanged.
Returns:
Nothing on success
Error if qom-type
is not a valid class name
Since: 2.0
Example:
-> { "execute": "object-add", "arguments": { "qom-type": "rng-random", "id": "rng1", "filename": "/dev/hwrng" } } <- { "return": {} }
Remove a QOM object.
Arguments:
id: string
the name of the QOM object to remove
Returns:
Nothing on success
Error if id
is not a valid id for a QOM object
Since: 2.0
Example:
-> { "execute": "object-del", "arguments": { "id": "rng1" } } <- { "return": {} }
List properties associated with a device.
Arguments:
typename: string
the type name of a device
Returns: a list of ObjectPropertyInfo describing a devices properties
Note: objects can create properties at runtime, for example to describe links between different devices and/or objects. These properties are not included in the output of this command.
Since: 1.2
Arguments:
driver: string
the name of the new device’s driver
bus: string
(optional)the device’s parent bus (device tree path)
id: string
(optional)the device’s ID, must be unique
Additional arguments depend on the type.
Add a device.
Notes:
Example:
-> { "execute": "device_add", "arguments": { "driver": "e1000", "id": "net1", "bus": "pci.0", "mac": "52:54:00:12:34:56" } } <- { "return": {} }
TODO: This command effectively bypasses QAPI completely due to its "additional arguments" business. It shouldn’t have been added to the schema in this form. It should be qapified properly, or replaced by a properly qapified command.
Since: 0.13
Remove a device from a guest
Arguments:
id: string
the device’s ID or QOM path
Returns:
Nothing on success
If id
is not a valid device, DeviceNotFound
Notes: When this command completes, the device may not be removed from the guest. Hot removal is an operation that requires guest cooperation. This command merely requests that the guest begin the hot removal process. Completion of the device removal process is signaled with a DEVICE_DELETED event. Guest reset will automatically complete removal for all devices.
Since: 0.14.0
Example:
-> { "execute": "device_del", "arguments": { "id": "net1" } } <- { "return": {} } -> { "execute": "device_del", "arguments": { "id": "/machine/peripheral-anon/device[0]" } } <- { "return": {} }
Emitted whenever the device removal completion is acknowledged by the guest. At this point, it’s safe to reuse the specified device ID. Device removal can be initiated by the guest or by HMP/QMP commands.
Arguments:
device: string
(optional)device name
path: string
device path
Since: 1.5
Example:
<- { "event": "DEVICE_DELETED", "data": { "device": "virtio-net-pci-0", "path": "/machine/peripheral/virtio-net-pci-0" }, "timestamp": { "seconds":<PHONE_NUMBER>, "microseconds": 450486 } }
The comprehensive enumeration of QEMU system emulation ("softmmu") targets. Run "./configure –help" in the project root directory, and look for the *-softmmu targets near the "–target-list" option. The individual target constants are not documented here, for the time being.
Values:
rx
since 5.0
avr
since 5.1
aarch64
Not documented
alpha
Not documented
arm
Not documented
cris
Not documented
hppa
Not documented
i386
Not documented
lm32
Not documented
m68k
Not documented
microblaze
Not documented
microblazeel
Not documented
mips
Not documented
mips64
Not documented
mips64el
Not documented
mipsel
Not documented
moxie
Not documented
nios2
Not documented
or1k
Not documented
ppc
Not documented
ppc64
Not documented
riscv32
Not documented
riscv64
Not documented
s390x
Not documented
sh4
Not documented
sh4eb
Not documented
sparc
Not documented
sparc64
Not documented
tricore
Not documented
unicore32
Not documented
x86_64
Not documented
xtensa
Not documented
xtensaeb
Not documented
Notes: The resulting QMP strings can be appended to the "qemu-system-" prefix to produce the corresponding QEMU executable name. This is true even for "qemu-system-x86_64".
Since: 3.0
An enumeration of cpu types that enable additional information during
query-cpus
and query-cpus-fast
.
Values:
s390
since 2.12
riscv
since 2.12
x86
Not documented
sparc
Not documented
ppc
Not documented
mips
Not documented
tricore
Not documented
other
Not documented
Since: 2.6
Information about a virtual CPU
Members:
CPU: int
the index of the virtual CPU
current: boolean
this only exists for backwards compatibility and should be ignored
halted: boolean
true if the virtual CPU is in the halt state. Halt usually refers to a processor specific low power mode.
qom_path: string
path to the CPU object in the QOM tree (since 2.4)
thread_id: int
ID of the underlying host thread
props: CpuInstanceProperties
(optional)properties describing to which node/socket/core/thread virtual CPU belongs to, provided if supported by board (since 2.10)
arch: CpuInfoArch
architecture of the cpu, which determines which additional fields will be listed (since 2.6)
CpuInfoX86
when arch
is "x86"CpuInfoSPARC
when arch
is "sparc"CpuInfoPPC
when arch
is "ppc"CpuInfoMIPS
when arch
is "mips"CpuInfoTricore
when arch
is "tricore"CpuInfoS390
when arch
is "s390"CpuInfoRISCV
when arch
is "riscv"Since: 0.14.0
Notes:
halted
is a transient state that changes frequently. By the time the
data is sent to the client, the guest may no longer be halted.
Additional information about a virtual i386 or x86_64 CPU
Members:
pc: int
the 64-bit instruction pointer
Since: 2.6
Additional information about a virtual SPARC CPU
Members:
pc: int
the PC component of the instruction pointer
npc: int
the NPC component of the instruction pointer
Since: 2.6
Additional information about a virtual PPC CPU
Members:
nip: int
the instruction pointer
Since: 2.6
Additional information about a virtual MIPS CPU
Members:
PC: int
the instruction pointer
Since: 2.6
Additional information about a virtual Tricore CPU
Members:
PC: int
the instruction pointer
Since: 2.6
Additional information about a virtual RISCV CPU
Members:
pc: int
the instruction pointer
Since 2.12
An enumeration of cpu states that can be assumed by a virtual S390 CPU
Values:
uninitialized
Not documented
stopped
Not documented
check-stop
Not documented
operating
Not documented
load
Not documented
Since: 2.12
Additional information about a virtual S390 CPU
Members:
cpu-state: CpuS390State
the virtual CPU’s state
Since: 2.12
Returns a list of information about each virtual CPU.
This command causes vCPU threads to exit to userspace, which causes a small interruption to guest CPU execution. This will have a negative impact on realtime guests and other latency sensitive guest workloads.
Features:
deprecated
This command is deprecated, because it interferes with the guest. Use ’query-cpus-fast’ instead to avoid the vCPU interruption.
Returns:
a list of CpuInfo
for each virtual CPU
Since: 0.14.0
Example:
-> { "execute": "query-cpus" } <- { "return": [ { "CPU":0, "current":true, "halted":false, "qom_path":"/machine/unattached/device[0]", "arch":"x86", "pc":3227107138, "thread_id":3134 }, { "CPU":1, "current":false, "halted":true, "qom_path":"/machine/unattached/device[2]", "arch":"x86", "pc":7108165, "thread_id":3135 } ] }
Information about a virtual CPU
Members:
cpu-index: int
index of the virtual CPU
qom-path: string
path to the CPU object in the QOM tree
thread-id: int
ID of the underlying host thread
props: CpuInstanceProperties
(optional)properties describing to which node/socket/core/thread virtual CPU belongs to, provided if supported by board
arch: CpuInfoArch
base architecture of the cpu
target: SysEmuTarget
the QEMU system emulation target, which determines which additional fields will be listed (since 3.0)
CpuInfoS390
when target
is "s390x"Features:
deprecated
Member arch
is deprecated. Use target
instead.
Since: 2.12
Returns information about all virtual CPUs. This command does not incur a performance penalty and should be used in production instead of query-cpus.
Returns:
list of CpuInfoFast
Since: 2.12
Example:
-> { "execute": "query-cpus-fast" } <- { "return": [ { "thread-id": 25627, "props": { "core-id": 0, "thread-id": 0, "socket-id": 0 }, "qom-path": "/machine/unattached/device[0]", "arch":"x86", "target":"x86_64", "cpu-index": 0 }, { "thread-id": 25628, "props": { "core-id": 0, "thread-id": 0, "socket-id": 1 }, "qom-path": "/machine/unattached/device[2]", "arch":"x86", "target":"x86_64", "cpu-index": 1 } ] }
Adds CPU with specified ID.
Arguments:
id: int
ID of CPU to be created, valid values [0..max_cpus)
Features:
deprecated
This command is deprecated. Use ‘device_add‘ instead. See the ‘query-hotpluggable-cpus‘ command for details.
Returns: Nothing on success
Since: 1.5
Example:
-> { "execute": "cpu-add", "arguments": { "id": 2 } } <- { "return": {} }
Information describing a machine.
Members:
name: string
the name of the machine
alias: string
(optional)an alias for the machine name
is-default: boolean
(optional)whether the machine is default
cpu-max: int
maximum number of CPUs supported by the machine type (since 1.5.0)
hotpluggable-cpus: boolean
cpu hotplug via -device is supported (since 2.7.0)
numa-mem-supported: boolean
true if ’-numa node,mem’ option is supported by the machine type and false otherwise (since 4.1)
deprecated: boolean
if true, the machine type is deprecated and may be removed in future versions of QEMU according to the QEMU deprecation policy (since 4.1.0)
default-cpu-type: string
(optional)default CPU model typename if none is requested via the -cpu argument. (since 4.2)
Since: 1.2.0
Return a list of supported machines
Returns: a list of MachineInfo
Since: 1.2.0
Information describing the running machine parameters.
Members:
wakeup-suspend-support: boolean
true if the machine supports wake up from suspend
Since: 4.0
Return information on the current virtual machine.
Returns: CurrentMachineParams
Since: 4.0
Information describing the QEMU target.
Members:
arch: SysEmuTarget
the target architecture
Since: 1.2.0
Return information about the target for this QEMU
Returns: TargetInfo
Since: 1.2.0
Values:
node
NUMA nodes configuration
dist
NUMA distance configuration (since 2.10)
cpu
property based CPU(s) to node mapping (Since: 2.10)
hmat-lb
memory latency and bandwidth information (Since: 5.0)
hmat-cache
memory side cache information (Since: 5.0)
Since: 2.1
A discriminated record of NUMA options. (for OptsVisitor)
Members:
type: NumaOptionsType
Not documented
NumaNodeOptions
when type
is "node"NumaDistOptions
when type
is "dist"NumaCpuOptions
when type
is "cpu"NumaHmatLBOptions
when type
is "hmat-lb"NumaHmatCacheOptions
when type
is "hmat-cache"Since: 2.1
Create a guest NUMA node. (for OptsVisitor)
Members:
nodeid: int
(optional)NUMA node ID (increase by 1 from 0 if omitted)
cpus: array of int
(optional)VCPUs belonging to this node (assign VCPUS round-robin if omitted)
mem: int
(optional)memory size of this node; mutually exclusive with memdev
.
Equally divide total memory among nodes if both mem
and memdev
are
omitted.
memdev: string
(optional)memory backend object. If specified for one node, it must be specified for all nodes.
initiator: int
(optional)defined in ACPI 6.3 Chapter <IP_ADDRESS> Table 5-145, points to the nodeid which has the memory controller responsible for this NUMA node. This field provides additional information as to the initiator node that is closest (as in directly attached) to this node, and therefore has the best performance (since 5.0)
Since: 2.1
Set the distance between 2 NUMA nodes.
Members:
src: int
source NUMA node.
dst: int
destination NUMA node.
val: int
NUMA distance from source node to destination node. When a node is unreachable from another node, set the distance between them to 255.
Since: 2.10
A X86 32-bit register
Values:
EAX
Not documented
EBX
Not documented
ECX
Not documented
EDX
Not documented
ESP
Not documented
EBP
Not documented
ESI
Not documented
EDI
Not documented
Since: 1.5
Information about a X86 CPU feature word
Members:
cpuid-input-eax: int
Input EAX value for CPUID instruction for that feature word
cpuid-input-ecx: int
(optional)Input ECX value for CPUID instruction for that feature word
cpuid-register: X86CPURegister32
Output register containing the feature bits
features: int
value of output register, containing the feature bits
Since: 1.5
Not used by QMP; hack to let us use X86CPUFeatureWordInfoList internally
Members:
unused: array of X86CPUFeatureWordInfo
Not documented
Since: 2.5
Option "-numa cpu" overrides default cpu to node mapping. It accepts the same set of cpu properties as returned by query-hotpluggable-cpus[].props, where node-id could be used to override default node mapping.
Members:
CpuInstanceProperties
Since: 2.10
The memory hierarchy in the System Locality Latency and Bandwidth Information Structure of HMAT (Heterogeneous Memory Attribute Table)
For more information about HmatLBMemoryHierarchy
, see chapter
<IP_ADDRESS>: Table 5-146: Field "Flags" of ACPI 6.3 spec.
Values:
memory
the structure represents the memory performance
first-level
first level of memory side cache
second-level
second level of memory side cache
third-level
third level of memory side cache
Since: 5.0
Data type in the System Locality Latency and Bandwidth Information Structure of HMAT (Heterogeneous Memory Attribute Table)
For more information about HmatLBDataType
, see chapter
<IP_ADDRESS>: Table 5-146: Field "Data Type" of ACPI 6.3 spec.
Values:
access-latency
access latency (nanoseconds)
read-latency
read latency (nanoseconds)
write-latency
write latency (nanoseconds)
access-bandwidth
access bandwidth (Bytes per second)
read-bandwidth
read bandwidth (Bytes per second)
write-bandwidth
write bandwidth (Bytes per second)
Since: 5.0
Set the system locality latency and bandwidth information between Initiator and Target proximity Domains.
For more information about NumaHmatLBOptions
, see chapter
<IP_ADDRESS>: Table 5-146 of ACPI 6.3 spec.
Members:
initiator: int
the Initiator Proximity Domain.
target: int
the Target Proximity Domain.
hierarchy: HmatLBMemoryHierarchy
the Memory Hierarchy. Indicates the performance of memory or side cache.
data-type: HmatLBDataType
presents the type of data, access/read/write latency or hit latency.
latency: int
(optional)the value of latency from initiator
to target
proximity domain, the latency unit is "ns(nanosecond)".
bandwidth: int
(optional)the value of bandwidth between initiator
and target
proximity domain, the bandwidth unit is
"Bytes per second".
Since: 5.0
Cache associativity in the Memory Side Cache Information Structure of HMAT
For more information of HmatCacheAssociativity
, see chapter
<IP_ADDRESS>: Table 5-147 of ACPI 6.3 spec.
Values:
none
None (no memory side cache in this proximity domain, or cache associativity unknown)
direct
Direct Mapped
complex
Complex Cache Indexing (implementation specific)
Since: 5.0
Cache write policy in the Memory Side Cache Information Structure of HMAT
For more information of HmatCacheWritePolicy
, see chapter
<IP_ADDRESS>: Table 5-147: Field "Cache Attributes" of ACPI 6.3 spec.
Values:
none
None (no memory side cache in this proximity domain, or cache write policy unknown)
write-back
Write Back (WB)
write-through
Write Through (WT)
Since: 5.0
Set the memory side cache information for a given memory domain.
For more information of NumaHmatCacheOptions
, see chapter
<IP_ADDRESS>: Table 5-147: Field "Cache Attributes" of ACPI 6.3 spec.
Members:
node-id: int
the memory proximity domain to which the memory belongs.
size: int
the size of memory side cache in bytes.
level: int
the cache level described in this structure.
associativity: HmatCacheAssociativity
the cache associativity, none/direct-mapped/complex(complex cache indexing).
policy: HmatCacheWritePolicy
the write policy, none/write-back/write-through.
line: int
the cache Line size in bytes.
Since: 5.0
Host memory policy types
Values:
default
restore default policy, remove any nondefault policy
preferred
set the preferred host nodes for allocation
bind
a strict policy that restricts memory allocation to the host nodes specified
interleave
memory allocations are interleaved across the set of host nodes specified
Since: 2.1
Information about memory backend
Members:
id: string
(optional)backend’s ID if backend has ’id’ property (since 2.9)
size: int
memory backend size
merge: boolean
enables or disables memory merge support
dump: boolean
includes memory backend’s memory in a core dump or not
prealloc: boolean
enables or disables memory preallocation
host-nodes: array of int
host nodes for its memory policy
policy: HostMemPolicy
memory policy of memory backend
Since: 2.1
Returns information for all memory backends.
Returns:
a list of Memdev
.
Since: 2.1
Example:
-> { "execute": "query-memdev" } <- { "return": [ { "id": "mem1", "size": 536870912, "merge": false, "dump": true, "prealloc": false, "host-nodes": [0, 1], "policy": "bind" }, { "size": 536870912, "merge": false, "dump": true, "prealloc": true, "host-nodes": [2, 3], "policy": "preferred" } ] }
List of properties to be used for hotplugging a CPU instance, it should be passed by management with device_add command when a CPU is being hotplugged.
Members:
node-id: int
(optional)NUMA node ID the CPU belongs to
socket-id: int
(optional)socket number within node/board the CPU belongs to
die-id: int
(optional)die number within node/board the CPU belongs to (Since 4.1)
core-id: int
(optional)core number within die the CPU belongs to
thread-id: int
(optional)thread number within core the CPU belongs to
Note: currently there are 5 properties that could be present but management should be prepared to pass through other properties with device_add command to allow for future interface extension. This also requires the filed names to be kept in sync with the properties passed to -device/device_add.
Since: 2.7
Members:
type: string
CPU object type for usage with device_add command
props: CpuInstanceProperties
list of properties to be used for hotplugging CPU
vcpus-count: int
number of logical VCPU threads HotpluggableCPU
provides
qom-path: string
(optional)link to existing CPU object if CPU is present or omitted if CPU is not present.
Since: 2.7
TODO: Better documentation; currently there is none.
Returns: a list of HotpluggableCPU objects.
Since: 2.7
Example:
For pseries machine type started with -smp 2,cores=2,maxcpus=4 -cpu POWER8: -> { "execute": "query-hotpluggable-cpus" } <- {"return": [ { "props": { "core": 8 }, "type": "POWER8-spapr-cpu-core", "vcpus-count": 1 }, { "props": { "core": 0 }, "type": "POWER8-spapr-cpu-core", "vcpus-count": 1, "qom-path": "/machine/unattached/device[0]"} ]}' For pc machine type started with -smp 1,maxcpus=2: -> { "execute": "query-hotpluggable-cpus" } <- {"return": [ { "type": "qemu64-x86_64-cpu", "vcpus-count": 1, "props": {"core-id": 0, "socket-id": 1, "thread-id": 0} }, { "qom-path": "/machine/unattached/device[0]", "type": "qemu64-x86_64-cpu", "vcpus-count": 1, "props": {"core-id": 0, "socket-id": 0, "thread-id": 0} } ]} For s390x-virtio-ccw machine type started with -smp 1,maxcpus=2 -cpu qemu (Since: 2.11): -> { "execute": "query-hotpluggable-cpus" } <- {"return": [ { "type": "qemu-s390x-cpu", "vcpus-count": 1, "props": { "core-id": 1 } }, { "qom-path": "/machine/unattached/device[0]", "type": "qemu-s390x-cpu", "vcpus-count": 1, "props": { "core-id": 0 } } ]}
Runtime equivalent of ’-numa’ CLI option, available at preconfigure stage to configure numa mapping before initializing machine.
Since 3.0
Arguments: the members of NumaOptions
Virtual CPU model.
A CPU model consists of the name of a CPU definition, to which delta changes are applied (e.g. features added/removed). Most magic values that an architecture might require should be hidden behind the name. However, if required, architectures can expose relevant properties.
Members:
name: string
the name of the CPU definition the model is based on
props: value
(optional)a dictionary of QOM properties to be applied
Since: 2.8.0
An enumeration of CPU model expansion types.
Values:
static
Expand to a static CPU model, a combination of a static base
model name and property delta changes. As the static base model will
never change, the expanded CPU model will be the same, independent of
QEMU version, machine type, machine options, and accelerator options.
Therefore, the resulting model can be used by tooling without having
to specify a compatibility machine - e.g. when displaying the "host"
model. The static
CPU models are migration-safe.
full
Expand all properties. The produced model is not guaranteed to be migration-safe, but allows tooling to get an insight and work with model details.
Note:
When a non-migration-safe CPU model is expanded in static mode, some
features enabled by the CPU model may be omitted, because they can’t be
implemented by a static CPU model definition (e.g. cache info passthrough and
PMU passthrough in x86). If you need an accurate representation of the
features enabled by a non-migration-safe CPU model, use full
. If you need a
static representation that will keep ABI compatibility even when changing QEMU
version or machine-type, use static
(but keep in mind that some features may
be omitted).
Since: 2.8.0
An enumeration of CPU model comparison results. The result is usually calculated using e.g. CPU features or CPU generations.
Values:
incompatible
If model A is incompatible to model B, model A is not guaranteed to run where model B runs and the other way around.
identical
If model A is identical to model B, model A is guaranteed to run where model B runs and the other way around.
superset
If model A is a superset of model B, model B is guaranteed to run where model A runs. There are no guarantees about the other way.
subset
If model A is a subset of model B, model A is guaranteed to run where model B runs. There are no guarantees about the other way.
Since: 2.8.0
The result of a CPU model baseline.
Members:
model: CpuModelInfo
the baselined CpuModelInfo.
Since: 2.8.0
If: defined(TARGET_S390X)
The result of a CPU model comparison.
Members:
result: CpuModelCompareResult
The result of the compare operation.
responsible-properties: array of string
List of properties that led to the comparison result not being identical.
responsible-properties
is a list of QOM property names that led to
both CPUs not being detected as identical. For identical models, this
list is empty.
If a QOM property is read-only, that means there’s no known way to make the
CPU models identical. If the special property name "type" is included, the
models are by definition not identical and cannot be made identical.
Since: 2.8.0
If: defined(TARGET_S390X)
Compares two CPU models, returning how they compare in a specific configuration. The results indicates how both models compare regarding runnability. This result can be used by tooling to make decisions if a certain CPU model will run in a certain configuration or if a compatible CPU model has to be created by baselining.
Usually, a CPU model is compared against the maximum possible CPU model of a certain configuration (e.g. the "host" model for KVM). If that CPU model is identical or a subset, it will run in that configuration.
The result returned by this command may be affected by:
Some architectures may not support comparing CPU models. s390x supports comparing CPU models.
Arguments:
modela: CpuModelInfo
Not documented
modelb: CpuModelInfo
Not documented
Returns: a CpuModelBaselineInfo. Returns an error if comparing CPU models is not supported, if a model cannot be used, if a model contains an unknown cpu definition name, unknown properties or properties with wrong types.
Note: this command isn’t specific to s390x, but is only implemented on this architecture currently.
Since: 2.8.0
If: defined(TARGET_S390X)
Baseline two CPU models, creating a compatible third model. The created model will always be a static, migration-safe CPU model (see "static" CPU model expansion for details).
This interface can be used by tooling to create a compatible CPU model out two CPU models. The created CPU model will be identical to or a subset of both CPU models when comparing them. Therefore, the created CPU model is guaranteed to run where the given CPU models run.
The result returned by this command may be affected by:
Some architectures may not support baselining CPU models. s390x supports baselining CPU models.
Arguments:
modela: CpuModelInfo
Not documented
modelb: CpuModelInfo
Not documented
Returns: a CpuModelBaselineInfo. Returns an error if baselining CPU models is not supported, if a model cannot be used, if a model contains an unknown cpu definition name, unknown properties or properties with wrong types.
Note: this command isn’t specific to s390x, but is only implemented on this architecture currently.
Since: 2.8.0
If: defined(TARGET_S390X)
The result of a cpu model expansion.
Members:
model: CpuModelInfo
the expanded CpuModelInfo.
Since: 2.8.0
If: defined(TARGET_S390X) || defined(TARGET_I386) || defined(TARGET_ARM)
Expands a given CPU model (or a combination of CPU model + additional options) to different granularities, allowing tooling to get an understanding what a specific CPU model looks like in QEMU under a certain configuration.
This interface can be used to query the "host" CPU model.
The data returned by this command may be affected by:
Some architectures may not support all expansion types. s390x supports "full" and "static". Arm only supports "full".
Arguments:
type: CpuModelExpansionType
Not documented
model: CpuModelInfo
Not documented
Returns: a CpuModelExpansionInfo. Returns an error if expanding CPU models is not supported, if the model cannot be expanded, if the model contains an unknown CPU definition name, unknown properties or properties with a wrong type. Also returns an error if an expansion type is not supported.
Since: 2.8.0
If: defined(TARGET_S390X) || defined(TARGET_I386) || defined(TARGET_ARM)
Virtual CPU definition.
Members:
name: string
the name of the CPU definition
migration-safe: boolean
(optional)whether a CPU definition can be safely used for migration in combination with a QEMU compatibility machine when migrating between different QEMU versions and between hosts with different sets of (hardware or software) capabilities. If not provided, information is not available and callers should not assume the CPU definition to be migration-safe. (since 2.8)
static: boolean
whether a CPU definition is static and will not change depending on QEMU version, machine type, machine options and accelerator options. A static model is always migration-safe. (since 2.8)
unavailable-features: array of string
(optional)List of properties that prevent the CPU model from running in the current host. (since 2.8)
typename: string
Type name that can be used as argument to device-list-properties
,
to introspect properties configurable using -cpu or -global.
(since 2.9)
alias-of: string
(optional)Name of CPU model this model is an alias for. The target of the CPU model alias may change depending on the machine type. Management software is supposed to translate CPU model aliases in the VM configuration, because aliases may stop being migration-safe in the future (since 4.1)
unavailable-features
is a list of QOM property names that
represent CPU model attributes that prevent the CPU from running.
If the QOM property is read-only, that means there’s no known
way to make the CPU model run in the current host. Implementations
that choose not to provide specific information return the
property name "type".
If the property is read-write, it means that it MAY be possible
to run the CPU model in the current host if that property is
changed. Management software can use it as hints to suggest or
choose an alternative for the user, or just to generate meaningful
error messages explaining why the CPU model can’t be used.
If unavailable-features
is an empty list, the CPU model is
runnable using the current host and machine-type.
If unavailable-features
is not present, runnability
information for the CPU is not available.
Since: 1.2.0
If: defined(TARGET_PPC) || defined(TARGET_ARM) || defined(TARGET_I386) || defined(TARGET_S390X) || defined(TARGET_MIPS)
Return a list of supported virtual CPU definitions
Returns: a list of CpuDefInfo
Since: 1.2.0
If: defined(TARGET_PPC) || defined(TARGET_ARM) || defined(TARGET_I386) || defined(TARGET_S390X) || defined(TARGET_MIPS)
Policy for handling lost ticks in timer devices. Ticks end up getting lost when, for example, the guest is paused.
Values:
discard
throw away the missed ticks and continue with future injection normally. The guest OS will see the timer jump ahead by a potentially quite significant amount all at once, as if the intervening chunk of time had simply not existed; needless to say, such a sudden jump can easily confuse a guest OS which is not specifically prepared to deal with it. Assuming the guest OS can deal correctly with the time jump, the time in the guest and in the host should now match.
delay
continue to deliver ticks at the normal rate. The guest OS will not notice anything is amiss, as from its point of view time will have continued to flow normally. The time in the guest should now be behind the time in the host by exactly the amount of time during which ticks have been missed.
slew
deliver ticks at a higher rate to catch up with the missed ticks. The guest OS will not notice anything is amiss, as from its point of view time will have continued to flow normally. Once the timer has managed to catch up with all the missing ticks, the time in the guest and in the host should match.
Since: 2.0
Allow client connections for VNC, Spice and socket based character devices to be passed in to QEMU via SCM_RIGHTS.
Arguments:
protocol: string
protocol name. Valid names are "vnc", "spice" or the name of a character device (eg. from -chardev id=XXXX)
fdname: string
file descriptor name previously passed via ’getfd’ command
skipauth: boolean
(optional)whether to skip authentication. Only applies to "vnc" and "spice" protocols
tls: boolean
(optional)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": {} }
Guest name information.
Members:
name: string
(optional)The name of the guest
Since: 0.14.0
Return the name information of a guest.
Returns:
NameInfo
of the guest
Since: 0.14.0
Example:
-> { "execute": "query-name" } <- { "return": { "name": "qemu-name" } }
Information about support for KVM acceleration
Members:
enabled: boolean
true if KVM acceleration is active
present: boolean
true if KVM acceleration is built into this executable
Since: 0.14.0
Returns information about KVM acceleration
Returns:
KvmInfo
Since: 0.14.0
Example:
-> { "execute": "query-kvm" } <- { "return": { "enabled": true, "present": true } }
Guest UUID information (Universally Unique Identifier).
Members:
UUID: string
the UUID of the guest
Since: 0.14.0
Notes: If no UUID was specified for the guest, a null UUID is returned.
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" } }
Information about an iothread
Members:
id: string
the identifier of the iothread
thread-id: int
ID of the underlying host thread
poll-max-ns: int
maximum polling time in ns, 0 means polling is disabled (since 2.9)
poll-grow: int
how many ns will be added to polling time, 0 means that it’s not configured (since 2.9)
poll-shrink: int
how many ns will be removed from polling time, 0 means that it’s not configured (since 2.9)
Since: 2.0
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 } ] }
Information about the guest balloon device.
Members:
actual: int
the number of bytes the balloon currently contains
Since: 0.14.0
Return information about the balloon device.
Returns:
BalloonInfo
on success
Since: 0.14.0
Example:
-> { "execute": "query-balloon" } <- { "return": { "actual":<PHONE_NUMBER>, } }
Emitted when the guest changes the actual BALLOON level. This value is
equivalent to the actual
field return by the ’query-balloon’ command
Arguments:
actual: int
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":<PHONE_NUMBER>, "microseconds": 435656 } }
A PCI device memory region
Members:
base: int
the starting address (guest physical)
limit: int
the ending address (guest physical)
Since: 0.14.0
Information about a PCI device I/O region.
Members:
bar: int
the index of the Base Address Register for this region
type: string
size: int
memory size
prefetch: boolean
(optional)if type
is ’memory’, true if the memory is prefetchable
mem_type_64: boolean
(optional)if type
is ’memory’, true if the BAR is 64-bit
address: int
Not documented
Since: 0.14.0
Information about a bus of a PCI Bridge device
Members:
number: int
primary bus interface number. This should be the number of the bus the device resides on.
secondary: int
secondary bus interface number. This is the number of the main bus for the bridge
subordinate: int
This is the highest number bus that resides below the bridge.
io_range: PciMemoryRange
The PIO range for all devices on this bridge
memory_range: PciMemoryRange
The MMIO range for all devices on this bridge
prefetchable_range: PciMemoryRange
The range of prefetchable MMIO for all devices on this bridge
Since: 2.4
Information about a PCI Bridge device
Members:
bus: PciBusInfo
information about the bus the device resides on
devices: array of PciDeviceInfo
(optional)a list of PciDeviceInfo
for each device on this bridge
Since: 0.14.0
Information about the Class of a PCI device
Members:
desc: string
(optional)a string description of the device’s class
class: int
the class code of the device
Since: 2.4
Information about the Id of a PCI device
Members:
device: int
the PCI device id
vendor: int
the PCI vendor id
subsystem: int
(optional)the PCI subsystem id (since 3.1)
subsystem-vendor: int
(optional)the PCI subsystem vendor id (since 3.1)
Since: 2.4
Information about a PCI device
Members:
bus: int
the bus number of the device
slot: int
the slot the device is located in
function: int
the function of the slot used by the device
class_info: PciDeviceClass
the class of the device
id: PciDeviceId
the PCI device id
irq: int
(optional)if an IRQ is assigned to the device, the IRQ number
irq_pin: int
the IRQ pin, zero means no IRQ (since 5.1)
qdev_id: string
the device name of the PCI device
pci_bridge: PciBridgeInfo
(optional)if the device is a PCI bridge, the bridge information
regions: array of PciMemoryRegion
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
Information about a PCI bus
Members:
bus: int
the bus index
devices: array of PciDeviceInfo
a list of devices on this bus
Since: 0.14.0
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":<PHONE_NUMBER>, "type": "memory" }, { "prefetch": false, "mem_type_64": false, "bar": 1, "size": 4096, "address":<PHONE_NUMBER>, "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.
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": {} }
Performs a hard reset of a guest.
Since: 0.14.0
Example:
-> { "execute": "system_reset" } <- { "return": {} }
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": {} }
Save a portion of guest memory to a file.
Arguments:
val: int
the virtual address of the guest to start from
size: int
the size of memory region to save
filename: string
the file to save the memory to as binary data
cpu-index: int
(optional)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": {} }
Save a portion of guest physical memory to a file.
Arguments:
val: int
the physical address of the guest to start from
size: int
the size of memory region to save
filename: string
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": {} }
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": {} }
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": {} }
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": {} }
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": {} }
Request the balloon driver to change its balloon size.
Arguments:
value: int
the target size of the balloon in bytes
Returns:
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": {} }
Execute a command on the human monitor and return the output.
Arguments:
command-line: string
the command to execute in the human monitor
cpu-index: int
(optional)The CPU to use for commands that require an implicit CPU
Features:
savevm-monitor-nodes
If present, HMP command savevm only snapshots monitor-owned nodes if they have no parents. This allows the use of ’savevm’ with -blockdev. (since 4.2)
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:
Example:
-> { "execute": "human-monitor-command", "arguments": { "command-line": "info kvm" } } <- { "return": "kvm support: enabled\r\n" }
This command is multiple commands multiplexed together.
Arguments:
device: string
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: string
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: string
(optional)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.
Features:
deprecated
This command is deprecated. For changing block devices, use ’blockdev-change-medium’ instead; for changing VNC parameters, use ’change-vnc-password’ instead.
Returns:
device
is not a valid block device, DeviceNotFound
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": {} }
Enable or disable the global dirty log mode.
Arguments:
enable: boolean
true to enable, false to disable.
Returns: nothing
Since: 1.3
Example:
-> { "execute": "xen-set-global-dirty-log", "arguments": { "enable": true } } <- { "return": {} }
Receive a file descriptor via SCM rights and assign it a name
Arguments:
fdname: string
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": {} }
Close a file descriptor previously passed via SCM rights
Arguments:
fdname: string
file descriptor name
Returns: Nothing on success
Since: 0.14.0
Example:
-> { "execute": "closefd", "arguments": { "fdname": "fd1" } } <- { "return": {} }
Actual memory information in bytes.
Members:
base-memory: int
size of "base" memory specified with command line option -m.
plugged-memory: int
(optional)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
Return the amount of initially allocated and present hotpluggable (if enabled) memory in bytes.
Example:
-> { "execute": "query-memory-size-summary" } <- { "return": { "base-memory":<PHONE_NUMBER>, "plugged-memory": 0 } }
Since: 2.11.0
Information about a file descriptor that was added to an fd set.
Members:
fdset-id: int
The ID of the fd set that fd
was added to.
fd: int
The file descriptor that was received via SCM rights and added to the fd set.
Since: 1.2.0
Add a file descriptor, that was passed via SCM rights, to an fd set.
Arguments:
fdset-id: int
(optional)The ID of the fd set to add the file descriptor to.
opaque: string
(optional)A free-form string that can be used to describe the fd.
Returns:
AddfdInfo
on success
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 } }
Remove a file descriptor from an fd set.
Arguments:
fdset-id: int
The ID of the fd set that the file descriptor belongs to.
fd: int
(optional)The file descriptor that is to be removed.
Returns:
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": {} }
Information about a file descriptor that belongs to an fd set.
Members:
fd: int
The file descriptor value.
opaque: string
(optional)A free-form string that can be used to describe the fd.
Since: 1.2.0
Information about an fd set.
Members:
fdset-id: int
The ID of the fd set.
fds: array of FdsetFdInfo
A list of file descriptors that belong to this fd set.
Since: 1.2.0
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 } ] }
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.
Members:
sig: string
(optional)table signature / identifier (4 bytes)
rev: int
(optional)table revision number (dependent on signature, 1 byte)
oem_id: string
(optional)OEM identifier (6 bytes)
oem_table_id: string
(optional)OEM table identifier (8 bytes)
oem_rev: int
(optional)OEM-supplied revision number (4 bytes)
asl_compiler_id: string
(optional)identifier of the utility that created the table (4 bytes)
asl_compiler_rev: int
(optional)revision number of the utility that created the table (4 bytes)
file: string
(optional)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: string
(optional)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
Possible types for an option parameter.
Values:
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
Details about a single parameter of a command line option.
Members:
name: string
parameter name
type: CommandLineParameterType
parameter CommandLineParameterType
help: string
(optional)human readable text string, not suitable for parsing.
default: string
(optional)default value string (since 2.1)
Since: 1.5
Details about a command line option, including its list of parameter details
Members:
option: string
option name
parameters: array of CommandLineParameterInfo
an array of CommandLineParameterInfo
Since: 1.5
Query command line option schema.
Arguments:
option: string
(optional)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" } ] }
PCDIMMDevice state information
Members:
id: string
(optional)device’s ID
addr: int
physical address, where device is mapped
size: int
size of memory that the device provides
slot: int
slot number at which device is plugged in
node: int
NUMA node number where device is plugged in
memdev: string
memory backend linked with device
hotplugged: boolean
true if device was hotplugged
hotpluggable: boolean
true if device if could be added/removed while machine is running
Since: 2.1
VirtioPMEM state information
Members:
id: string
(optional)device’s ID
memaddr: int
physical address in memory, where device is mapped
size: int
size of memory that the device provides
memdev: string
memory backend linked with device
Since: 4.1
VirtioMEMDevice state information
Members:
id: string
(optional)device’s ID
memaddr: int
physical address in memory, where device is mapped
requested-size: int
the user requested size of the device
size: int
the (current) size of memory that the device provides
max-size: int
the maximum size of memory that the device can provide
block-size: int
the block size of memory that the device provides
node: int
NUMA node number where device is assigned to
memdev: string
memory backend linked with the region
Since: 5.1
Union containing information about a memory device
nvdimm is included since 2.12. virtio-pmem is included since 4.1. virtio-mem is included since 5.1.
Members:
type
One of "dimm", "nvdimm", "virtio-pmem", "virtio-mem"
data: PCDIMMDeviceInfo
when type
is "dimm"data: PCDIMMDeviceInfo
when type
is "nvdimm"data: VirtioPMEMDeviceInfo
when type
is "virtio-pmem"data: VirtioMEMDeviceInfo
when type
is "virtio-mem"Since: 2.1
Lists available memory devices and their state
Since: 2.1
Example:
-> { "execute": "query-memory-devices" } <- { "return": [ { "data": { "addr":<PHONE_NUMBER>, "hotpluggable": true, "hotplugged": true, "id": "d1", "memdev": "/objects/memX", "node": 0, "size":<PHONE_NUMBER>, "slot": 0}, "type": "dimm" } ] }
Emitted when the size of a memory device changes. Only emitted for memory devices that can actually change the size (e.g., virtio-mem due to guest action).
Arguments:
id: string
(optional)device’s ID
size: int
the new size of memory that the device provides
Note: this event is rate-limited.
Since: 5.1
Example:
<- { "event": "MEMORY_DEVICE_SIZE_CHANGE", "data": { "id": "vm0", "size":<PHONE_NUMBER>}, "timestamp": { "seconds":<PHONE_NUMBER>, "microseconds": 201316 } }
Emitted when memory hot unplug error occurs.
Arguments:
device: string
device name
msg: string
Informative message
Since: 2.4
Example:
<- { "event": "MEM_UNPLUG_ERROR" "data": { "device": "dimm1", "msg": "acpi: device unplug for unsupported device" }, "timestamp": { "seconds":<PHONE_NUMBER>, "microseconds": 450486 } }
Values:
DIMM
memory slot
CPU
logical CPU slot (since 2.7)
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.
Members:
device: string
(optional)device ID associated with slot
slot: string
slot ID, unique per slot of a given slot-type
slot-type: ACPISlotType
type of the slot
source: int
an integer containing the source event
status: int
an integer containing the status code
Since: 2.1
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} ]}
Emitted when guest executes ACPI _OST method.
Arguments:
info: ACPIOSTInfo
OSPM Status Indication
Since: 2.1
Example:
<- { "event": "ACPI_DEVICE_OST", "data": { "device": "d1", "slot": "0", "slot-type": "DIMM", "source": 1, "status": 0 } }
Mode of the replay subsystem.
Values:
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
Load the state of all devices from file. The RAM and the block devices of the VM are not loaded by this command.
Arguments:
filename: string
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": {} }
GUID information.
Members:
guid: string
the globally unique identifier
Since: 2.9
Show Virtual Machine Generation ID
Since: 2.9
Emitted when the guest changes the RTC time.
Arguments:
offset: int
offset between base RTC clock (as specified by -rtc base), and new RTC clock value
Note: This event is rate-limited.
Since: 0.13.0
Example:
<- { "event": "RTC_CHANGE", "data": { "offset": 78 }, "timestamp": { "seconds":<PHONE_NUMBER>, "microseconds": 435656 } }
If: defined(TARGET_ALPHA) || defined(TARGET_ARM) || defined(TARGET_HPPA) || defined(TARGET_I386) || defined(TARGET_MIPS) || defined(TARGET_MIPS64) || defined(TARGET_MOXIE) || defined(TARGET_PPC) || defined(TARGET_PPC64) || defined(TARGET_S390X) || defined(TARGET_SH4) || defined(TARGET_SPARC)
This command will reset the RTC interrupt reinjection backlog. Can be used if another mechanism to synchronize guest time is in effect, for example QEMU guest agent’s guest-set-time command.
Since: 2.1
Example:
-> { "execute": "rtc-reset-reinjection" } <- { "return": {} }
If: defined(TARGET_I386)
An enumeration of SEV state information used during query-sev
.
Values:
uninit
The guest is uninitialized.
launch-update
The guest is currently being launched; plaintext data and register state is being imported.
launch-secret
The guest is currently being launched; ciphertext data is being imported.
running
The guest is fully launched or migrated in.
send-update
The guest is currently being migrated out to another machine.
receive-update
The guest is currently being migrated from another machine.
Since: 2.12
If: defined(TARGET_I386)
Information about Secure Encrypted Virtualization (SEV) support
Members:
enabled: boolean
true if SEV is active
api-major: int
SEV API major version
api-minor: int
SEV API minor version
build-id: int
SEV FW build id
policy: int
SEV policy value
state: SevState
SEV guest state
handle: int
SEV firmware handle
Since: 2.12
If: defined(TARGET_I386)
Returns information about SEV
Returns:
SevInfo
Since: 2.12
Example:
-> { "execute": "query-sev" } <- { "return": { "enabled": true, "api-major" : 0, "api-minor" : 0, "build-id" : 0, "policy" : 0, "state" : "running", "handle" : 1 } }
If: defined(TARGET_I386)
SEV Guest Launch measurement information
Members:
data: string
the measurement value encoded in base64
Since: 2.12
If: defined(TARGET_I386)
Query the SEV guest launch information.
Returns:
The SevLaunchMeasureInfo
for the guest
Since: 2.12
Example:
-> { "execute": "query-sev-launch-measure" } <- { "return": { "data": "4l8LXeNlSPUDlXPJG5966/8%YZ" } }
If: defined(TARGET_I386)
The struct describes capability for a Secure Encrypted Virtualization feature.
Members:
pdh: string
Platform Diffie-Hellman key (base64 encoded)
cert-chain: string
PDH certificate chain (base64 encoded)
cbitpos: int
C-bit location in page table entry
reduced-phys-bits: int
Number of physical Address bit reduction when SEV is enabled
Since: 2.12
If: defined(TARGET_I386)
This command is used to get the SEV capabilities, and is supported on AMD X86 platforms only.
Returns: SevCapability objects.
Since: 2.12
Example:
-> { "execute": "query-sev-capabilities" } <- { "return": { "pdh": "8CCDD8DDD", "cert-chain": "888CCCDDDEE", "cbitpos": 47, "reduced-phys-bits": 5}}
If: defined(TARGET_I386)
Dump guest’s storage keys
Arguments:
filename: string
the path to the file to dump to
This command is only supported on s390 architecture.
Since: 2.5
Example:
-> { "execute": "dump-skeys", "arguments": { "filename": "/tmp/skeys" } } <- { "return": {} }
If: defined(TARGET_S390X)
The struct describes capability for a specific GIC (Generic Interrupt Controller) version. These bits are not only decided by QEMU/KVM software version, but also decided by the hardware that the program is running upon.
Members:
version: int
version of GIC to be described. Currently, only 2 and 3 are supported.
emulated: boolean
whether current QEMU/hardware supports emulated GIC device in user space.
kernel: boolean
whether current QEMU/hardware supports hardware accelerated GIC device in kernel.
Since: 2.6
If: defined(TARGET_ARM)
This command is ARM-only. It will return a list of GICCapability objects that describe its capability bits.
Returns: a list of GICCapability objects.
Since: 2.6
Example:
-> { "execute": "query-gic-capabilities" } <- { "return": [{ "version": 2, "emulated": true, "kernel": false }, { "version": 3, "emulated": false, "kernel": true } ] }
If: defined(TARGET_ARM)
General audio backend options that are used for both playback and recording.
Members:
mixing-engine: boolean
(optional)use QEMU’s mixing engine to mix all streams inside QEMU and convert audio formats when not supported by the backend. When set to off, fixed-settings must be also off (default on, since 4.2)
fixed-settings: boolean
(optional)use fixed settings for host input/output. When off, frequency, channels and format must not be specified (default true)
frequency: int
(optional)frequency to use when using fixed settings (default 44100)
channels: int
(optional)number of channels when using fixed settings (default 2)
voices: int
(optional)number of voices to use (default 1)
format: AudioFormat
(optional)sample format to use when using fixed settings (default s16)
buffer-length: int
(optional)the buffer length in microseconds
Since: 4.0
Generic driver-specific options.
Members:
in: AudiodevPerDirectionOptions
(optional)options of the capture stream
out: AudiodevPerDirectionOptions
(optional)options of the playback stream
Since: 4.0
Options of the ALSA backend that are used for both playback and recording.
Members:
dev: string
(optional)the name of the ALSA device to use (default ’default’)
period-length: int
(optional)the period length in microseconds
try-poll: boolean
(optional)attempt to use poll mode, falling back to non-polling access on failure (default true)
AudiodevPerDirectionOptions
Since: 4.0
Options of the ALSA audio backend.
Members:
in: AudiodevAlsaPerDirectionOptions
(optional)options of the capture stream
out: AudiodevAlsaPerDirectionOptions
(optional)options of the playback stream
threshold: int
(optional)set the threshold (in microseconds) when playback starts
Since: 4.0
Options of the Core Audio backend that are used for both playback and recording.
Members:
buffer-count: int
(optional)number of buffers
AudiodevPerDirectionOptions
Since: 4.0
Options of the coreaudio audio backend.
Members:
in: AudiodevCoreaudioPerDirectionOptions
(optional)options of the capture stream
out: AudiodevCoreaudioPerDirectionOptions
(optional)options of the playback stream
Since: 4.0
Options of the DirectSound audio backend.
Members:
in: AudiodevPerDirectionOptions
(optional)options of the capture stream
out: AudiodevPerDirectionOptions
(optional)options of the playback stream
latency: int
(optional)add extra latency to playback in microseconds (default 10000)
Since: 4.0
Options of the JACK backend that are used for both playback and recording.
Members:
server-name: string
(optional)select from among several possible concurrent server instances (default: environment variable $JACK_DEFAULT_SERVER if set, else "default")
client-name: string
(optional)the client name to use. The server will modify this name to
create a unique variant, if needed unless exact-name
is true (default: the
guest’s name)
connect-ports: string
(optional)if set, a regular expression of JACK client port name(s) to monitor for and automatically connect to
start-server: boolean
(optional)start a jack server process if one is not already present (default: false)
exact-name: boolean
(optional)use the exact name requested otherwise JACK automatically generates a unique one, if needed (default: false)
AudiodevPerDirectionOptions
Since: 5.1
Options of the JACK audio backend.
Members:
in: AudiodevJackPerDirectionOptions
(optional)options of the capture stream
out: AudiodevJackPerDirectionOptions
(optional)options of the playback stream
Since: 5.1
Options of the OSS backend that are used for both playback and recording.
Members:
dev: string
(optional)file name of the OSS device (default ’/dev/dsp’)
buffer-count: int
(optional)number of buffers
try-poll: boolean
(optional)attempt to use poll mode, falling back to non-polling access on failure (default true)
AudiodevPerDirectionOptions
Since: 4.0
Options of the OSS audio backend.
Members:
in: AudiodevOssPerDirectionOptions
(optional)options of the capture stream
out: AudiodevOssPerDirectionOptions
(optional)options of the playback stream
try-mmap: boolean
(optional)try using memory-mapped access, falling back to non-memory-mapped access on failure (default true)
exclusive: boolean
(optional)open device in exclusive mode (vmix won’t work) (default false)
dsp-policy: int
(optional)set the timing policy of the device (between 0 and 10, where smaller number means smaller latency but higher CPU usage) or -1 to use fragment mode (option ignored on some platforms) (default 5)
Since: 4.0
Options of the Pulseaudio backend that are used for both playback and recording.
Members:
name: string
(optional)name of the sink/source to use
stream-name: string
(optional)name of the PulseAudio stream created by qemu. Can be used to identify the stream in PulseAudio when you create multiple PulseAudio devices or run multiple qemu instances (default: audiodev’s id, since 4.2)
latency: int
(optional)latency you want PulseAudio to achieve in microseconds (default 15000)
AudiodevPerDirectionOptions
Since: 4.0
Options of the PulseAudio audio backend.
Members:
in: AudiodevPaPerDirectionOptions
(optional)options of the capture stream
out: AudiodevPaPerDirectionOptions
(optional)options of the playback stream
server: string
(optional)PulseAudio server address (default: let PulseAudio choose)
Since: 4.0
Options of the wav audio backend.
Members:
in: AudiodevPerDirectionOptions
(optional)options of the capture stream
out: AudiodevPerDirectionOptions
(optional)options of the playback stream
path: string
(optional)name of the wav file to record (default ’qemu.wav’)
Since: 4.0
An enumeration of possible audio formats.
Values:
u8
unsigned 8 bit integer
s8
signed 8 bit integer
u16
unsigned 16 bit integer
s16
signed 16 bit integer
u32
unsigned 32 bit integer
s32
signed 32 bit integer
f32
single precision floating-point (since 5.0)
Since: 4.0
An enumeration of possible audio backend drivers.
Values:
jack
JACK audio backend (since 5.1)
none
Not documented
alsa
Not documented
coreaudio
Not documented
dsound
Not documented
oss
Not documented
pa
Not documented
sdl
Not documented
spice
Not documented
wav
Not documented
Since: 4.0
Options of an audio backend.
Members:
id: string
identifier of the backend
driver: AudiodevDriver
the backend driver to use
timer-period: int
(optional)timer period (in microseconds, 0: use lowest possible)
AudiodevGenericOptions
when driver
is "none"AudiodevAlsaOptions
when driver
is "alsa"AudiodevCoreaudioOptions
when driver
is "coreaudio"AudiodevDsoundOptions
when driver
is "dsound"AudiodevJackOptions
when driver
is "jack"AudiodevOssOptions
when driver
is "oss"AudiodevPaOptions
when driver
is "pa"AudiodevGenericOptions
when driver
is "sdl"AudiodevGenericOptions
when driver
is "spice"AudiodevWavOptions
when driver
is "wav"Since: 4.0
| Jump to: | A B C D E F G H I J M N O P Q R S T U V W X |
|---|
| Jump to: | A B C D E F G H I J M N O P Q R S T U V W X |
|---|
| Jump to: | A B C D E F G H I J K L M N O P Q R S T U V W X |
|---|
| Jump to: | A B C D E F G H I J K L M N O P Q R S T U V W X |
|---|


Device information coming from the NSG
This object has no children.
This object has no members.
Release Date of the AAR Application
Format: free
SDK attribute: AARApplicationReleaseDate
The AAR Application Version
Format: free
SDK attribute: AARApplicationVersion
Object type of the associated entity.
Format: free
SDK attribute: associatedEntityType
The ID of the NSG from which the infomation was collected.
Format: free
SDK attribute: associatedNSGatewayID
Release Date of the NSG BiOS
Format: free
SDK attribute: BIOSReleaseDate
NSG BIOS Version as received from the NSG during bootstrap or a reboot. If the information exeeds 255 characters, the extra characters will be truncated.
Format: free
Max length: 255
SDK attribute: BIOSVersion
The NSG Processor Type based on information extracted during bootstrapping. This may refer to a type of processor manufactured by Intel, ARM, AMD, Cyrix, VIA, or others.
Format: free
SDK attribute: CPUType
Specify if scope of entity is Data center or Enterprise level
Allowed values: ENTERPRISE, GLOBAL
SDK attribute: entityScope
External object ID. Used for integration with third party systems
Format: free
SDK attribute: externalID
The NSG Family type as it was returned by the NSG during bootstrapping.
Allowed values: ANY, NSG_AMI, NSG_AZ, NSG_C, NSG_DOCKER, NSG_E, NSG_E200, NSG_E300, NSG_V, NSG_X, NSG_X200
SDK attribute: family
Tracks RPM package installed for some libraries installed on the NSG.
Format: free
SDK attribute: libraries
MAC Address of the NSG. May represent the MAC address of the first uplink that came operational during bootstrapping.
Format: free
SDK attribute: MACAddress
The NSG Version as reported during a bootstrap or a reboot of the NSG.
Format: free
SDK attribute: NSGVersion
Base64 Encoded JSON String of the extra details pertaining to each successfully installed patch
Format: free
SDK attribute: patchesDetail
NSG Product Name as reported when the device bootstraps.
Format: free
SDK attribute: productName
The NSG's serial number as it is stored in the system's CMOS (Motherboard)
Format: free
SDK attribute: serialNumber
The part number of the NSG
Format: free
SDK attribute: SKU
TPM status code as reported by the NSG during bootstrapping. This informate indicates if TPM is being used in securing the private key/certificate of an NSG. Possible values are 0(Unknown), 1(Enabled_Not_Operational), 2(Enabled_Operational), 3(Disabled).
SDK attribute: TPMStatus
TPM (Trusted Platform Module) version as reported by the NSG.
Format: free
Max length: 255
SDK attribute: TPMVersion
The Redhat/CentOS UUID of the NSG
Format: free
SDK attribute: UUID


GCP Initial Setup & First Steps🔗
Abstract
In this hands on you will configure your GCP account, the google cloud SDK and access the cloud console using Google Cloud Shell, You will also discover a very useful tool, a managed jupyter notebook service from google named Google Colab which may be very important for your future developments this year
1. Create your GCP Account🔗
- Create an account within Google cloud Platform using your ISAE e-mail
- Use the code given by Dennis to get your free credits
- You should have 300$ + a "free tier" available to you
- From the interface you should create a project with a name of your choice
2. Install Google Cloud SDK & Configure the shell🔗
If you want to interact with GCP from your computer, you will need to install the Google Cloud SDK, which will also install a shell if you are on windows
If you don't, you will have to do everything from google cloud shell (it's not as easy), so I recommend installing the SDK.
The best ways to interact with google cloud SDK is with a terminal so in that order:
- Linux (either VM or native): https://cloud.google.com/sdk/docs/install#linux
- MacOS: https://cloud.google.com/sdk/docs/install#mac
- Windows Subsystem for Linux: see Linux
- Windows: https://cloud.google.com/sdk/docs/install#windows
If you are on windows, you should launch the google cloud sdk shell now,
Then you can configure the google cloud sdk with your account
3. My first "VM", Google Cloud Shell🔗
Intro to Google Cloud Shell🔗
- Google Cloud Shell is a "managed VM" made available to interact with the GCP platform without needing to configure locally the google cloud sdk. It is useful if you only have a web browser, but it may not work and it's not as easy as using a local terminal
- Compared to configured a VM by yourself, this one comes loaded with developer tools and gcp authentification correctly set up, and thus is faster to use,
- However the main drawback to using it as a development machine is the available disk space limited to 5 Gb (not enough to build docker images for example)
- Here is the description of Google Cloud Shell
- Look at the documentation
Question
- Can you describe it with your own words ?
- What would be the closest service that you can find on GCP that is similar to cloud shell ?
Connect to google cloud shell🔗
- Follow this guide for connecting to google cloud shell using the browser
- If this doesn't work on your machine for whichever reason, there is a workaround which requires having installed the
google-cloud-sdOther references:k
Explore google cloud shell🔗
- Check available disk space
Bash command to run
df -h
- Check the OS name
Bash command to run
cat /etc/os-release
- Check the CPU model
Bash command to run
cat /proc/cpuinfo
- This is the hardware model... how many cores do you have available ? Which amount of RAM ?
Help
htop
will give you your current usage and available cores, or you can do nproc
A demo of cloud shell web preview🔗
We will install Visual Studio Code Server, which is a cloud-based text editor, on Cloud Shell and preview it from your browser.
There is already a code editor in Google Cloud Shell (based on Theia) but we want to showcase the web preview as well, so we will do it manually,
- You may enable boost mode
- Run
curl -fsSL https://code-server.dev/install.sh | sh
in your terminal to download & install code server - Run
code-server --port=8080
to start code server - Shut it down (
CTRL+C
) then - Fetch your password using
cat ~/.config/code-server/config.yaml
- Re-run it
- Open web preview on port 8080 and log in
- You should be able to open files, get a terminal from inside a vscode inside your browser inside a VM ... Magic isn't it ?
Warning
It is possible that the browser-based method does not work on your machine, there is a troubleshooting guide on this (mainly it doesn't like too much privacy on your browser)
The alternative solution would be to connect to it from your terminal / local shell using the google cloud sdk,
Here is the documentation for this
Command to run in this case: gcloud alpha cloud-shell ssh -- -L 8080:localhost:8080
4. Google Colaboratory🔗
Here, you will look at Google Colaboratory, which is a very handy tool for doing data science work (based on jupyter notebooks) on the cloud, using a preconfigured instance (which can access a GPU). You will be able to store data on Google Drive and to share
I highly recommend using this for Jupyter based AML BE, but I invite you to discover google colab at home, or during AML BE because it's a useful tool but mastering it is not relevant for our cloud class
Intro & Description of Google Colaboratory🔗
Question
- Can you describe what it is ?
- Is it IaaS ? PaaS ? SaaS ? why exactly ?
Info
Colaboratory, or "Colab" for short, allows you to write and execute Python in your browser, with
- Zero configuration required
- Free access to GPUs
- Easy sharing
It offers a "jupyter notebook - like" interface, and allows to install your own dependencies by running bash commands inside the VM, with connection to google drive, google sheets
You can manipulate the notebooks from your Google Drive and share it like it was a GDoc document
It's essentially between SaaS and PaaS, it offers you a development platform without you having to manage anything except your code and your data (which are both data from the cloud provider point of view)
Loading jupyter notebooks, interacting with google drive🔗
- Open a notebook you previously ran on your computer (from AML class), you can run a notebook on github directly in google colab
- Try to run it inside google colab
- Link google colab and google drive and upload something on google drive (like an image) and display in on google colab


The default market of the TDAmeritradeBrokerageModel is Market.USA.
TDAmeritradeBrokerageModel
Market.USA


Rating
Byline
Publication Date
Short Summary
The NYTimes Developer API allows you to search for key information about movie reviews.


The observatory is published under a Creative Commons Attribution-Sharealike 3.0 Unported License, so feel free to share the site and embed the apps anywhere on the internet. When doing so, please remember to attribute the site and its creators.
When refering to the site in publications please use the following citation:
AJG Simoes, CA Hidalgo. The Economic Complexity Observatory: An Analytical Tool for Understanding the Dynamics of Economic Development. Workshops at the Twenty-Fifth AAAI Conference on Artificial Intelligence. (2011)
For more information, please contact<EMAIL_ADDRESS>The Observatory website is an open source platform built as part of the lead developer, Alexander Simoes' Master's Thesis at the MIT Media Lab. In being an open source project and leveraging the many technologies also available for fair use we welcome any and all collaborators to the project. Feel free to fork the site at: github.com/alexandersimoes/atlas_economic_complexity
We also provide an API for the casual user interested in embedding their own Observatory app on any webpage.
If you would like more info on the OEC or to create a similar site for your country, state, or city, get in touch with us at oec@media.mit.edu.


I know this is very basic but serves the need for the above question.
Content only displays on large and medium screens. Content hidden on small and extra small screens
Bootstrap also has classess to display only for the different screen sizes.


Dear Dry,
The Feminist Majority is thrilled to announce two more amazing speakers for this year’s 2013 Women, Money, Power Summit: Tina Tchen, chief of staff to First Lady Michelle Obama, and Dolores Huerta, co-founder of the United Farm Workers for America.
Make sure you register today for this amazing event on October 8 at the Capitol Hilton hotel in Washington, DC! [ http://feministmajority.org/women-money-power/2013WomenMoneyPower/registration.htm ]
Tchen, who also serves as the executive director of the White House Council on Women and Girls, will be leading our afternoon town hall discussion on the Affordable Care Act and what women need to know and do.
Huerta will speak at our luncheon honoring three fearless trailblazing feminists: Congresswoman Rosa DeLauro, a champion for equal pay for women; Texas state Sen. Leticia Van de Putte, a courageous fighter for reproductive rights; and Barbara Arnwine, executive director of the Lawyer’s Committee for Civil Rights Under Law who is leading the charge for voters’ rights.
Our other General Assembly Sessions throughout the day will focus on improving global reproductive family planning practices, ending violence against women and stopping the War on Women once and for all! We’ll also discuss new strategies to ratify both CEDAW and the Equal Rights Amendment.
For the full Summit agenda and registration information, visit the Women, Money, Power website [ http://feministmajority.org/women-money-power/2013WomenMoneyPower/registration.htm ]. Dry, please register today [ http://feministmajority.org/women-money-power/2013WomenMoneyPower/registration.htm ] for what I know will be an exciting and informative event! Space is filling up fast and I don’t want you to miss out.
For Equality,
Ellie Smeal
Eleanor Smeal
President
Feminist Majority
You have received this e-mail because of your interest in women’s issues. To unsubscribe, please go to: http://www.feministmajority.org/email/unsubscribeallc4.asp [ http://salsa.wiredforchange.com/o/1269/p/salsa/supporter/unsubscribe/public/index.sjs?unsubscribe_page_KEY=391 ]
“1600 Wilson Boulevard, Suite 801, Arlington, VA, 22209 |<PHONE_NUMBER> | webmaster@feminist.org”


Zindagi is a library to easily program and render life-like cellular automatas including but not limited to Highlife and Conway's Game of Life.
Usage
import { Zindagi } from 'zindagi'; // use ES modules
// const { Zindagi } = require('zindagi); // or CommonJS
const life = new Zindagi({
// Life-like rule
rules: 'S23/B3',
// Flag to enable alive cells to re-appear on
// the other side of the board in case of overflow
stitchedEdges: true,
// Symbols to represent alive and dead cells in initState param
symbols: {
alive: '0',
dead: '.'
},
// Initial state of the automata
initState: `..........
.0........
..00......
.00.......
..........
..........
..........
..........`
});
// play for 1000 generations
const generations = life.live(1000);
// in built method to render the automata to console/terminal
life.render(generations, {
alive: '⬛', // represent alive cells with black block
dead: '⬜', // represent dead cells with white block
timePerGeneration: 0.5, // 0.5 seconds per generation
});
Output
Install
npm install zindagi
Documentation
This is a list of the methods supproted. A detailed documentation is available in the documentation section of the homepage.
| Method | Description |
|---|---|
.live(n) |
Returns an iterator of the current state plus n subsequent states |
.skip(n) |
Returns the current state after moving ahead n states |
.reset() |
Resets the current state to the initState |
.toString(opts) |
Returns the current state represented as a formatted string |
.render(iterator, opts) |
Renders a cellular automata in console using options |
TODO
- [x] Documentation
- [x] Tests
- [ ] Optimizations
- [ ] HashLife implementation
Contributions are welcome!


Use the ngSpotify app to browse new releases and find your favorite songs All you get this text and a mostly barebones HTML document.


Work Day Scheduler
A simple calendar app for scheduling your work day
9AM
+
10AM
+
11AM
+
12AM
+
1PM
+
2PM
+
3PM
+
4PM
+
5PM
+