QEMU Guest Agent Protocol Reference¶
This manual describes the commands supported by the QEMU Guest Agent Protocol.
For locating a particular item, please see the QGA Index.
The following notation is used in examples:
Example:
-> ... text sent by client (commands) ...
<- ... text sent by server (command responses and events) ...
Example text is formatted for readability. However, in real protocol usage, its commonly emitted as a single line.
Please refer to the QEMU Machine Protocol Specification for the general format of commands, responses, and events.
-
Command
guest-sync-delimited
(Since: 1.1)¶ Echo back a unique integer value, and prepend to response a leading sentinel byte (0xFF) the client can check scan for.
This is used by clients talking to the guest agent over the wire to ensure the stream is in sync and doesn’t contain stale data from previous client. It must be issued upon initial connection, and after any client-side timeouts (including timeouts on receiving a response to this command).
After issuing this request, all guest agent responses should be ignored until the response containing the unique integer value the client passed in is returned. Receival of the 0xFF sentinel byte must be handled as an indication that the client’s lexer/tokenizer/parser state should be flushed/reset in preparation for reliably receiving the subsequent response. As an optimization, clients may opt to ignore all data until a sentinel value is receiving to avoid unnecessary processing of stale data.
Similarly, clients should also precede this request with a 0xFF byte to make sure the guest agent flushes any partially read JSON data from a previous client connection.
- Arguments
id (
int
) – randomly generated 64-bit integer
- Return
int
– The unique integer id passed in by the client
-
Command
guest-sync
(Since: 0.15.0)¶ Echo back a unique integer value
This is used by clients talking to the guest agent over the wire to ensure the stream is in sync and doesn’t contain stale data from previous client. All guest agent responses should be ignored until the provided unique integer value is returned, and it is up to the client to handle stale whole or partially-delivered JSON text in such a way that this response can be obtained.
In cases where a partial stale response was previously received by the client, this cannot always be done reliably. One particular scenario being if qemu-ga responses are fed character-by-character into a JSON parser. In these situations, using guest-sync-delimited may be optimal.
For clients that fetch responses line by line and convert them to JSON objects, guest-sync should be sufficient, but note that in cases where the channel is dirty some attempts at parsing the response may result in a parser error.
Such clients should also precede this command with a 0xFF byte to make sure the guest agent flushes any partially read JSON data from a previous session.
- Arguments
id (
int
) – randomly generated 64-bit integer
- Return
int
– The unique integer id passed in by the client
-
Command
guest-ping
(Since: 0.15.0)¶ Ping the guest agent, a non-error return implies success
-
Command
guest-get-time
(Since: 1.5)¶ Get the information about guest’s System Time relative to the Epoch of 1970-01-01 in UTC.
- Return
int
– Time in nanoseconds.
-
Command
guest-set-time
(Since: 1.5)¶ Set guest time.
When a guest is paused or migrated to a file then loaded from that file, the guest OS has no idea that there was a big gap in the time. Depending on how long the gap was, NTP might not be able to resynchronize the guest.
This command tries to set guest’s System Time to the given value, then sets the Hardware Clock (RTC) to the current System Time. This will make it easier for a guest to resynchronize without waiting for NTP. If no
time
is specified, then the time to set is read from RTC. However, this may not be supported on all platforms (i.e. Windows). If that’s the case users are advised to always pass a value.- Arguments
time (
int
, optional) – time of nanoseconds, relative to the Epoch of 1970-01-01 in UTC.
-
Object
GuestAgentCommandInfo
(Since: 1.1.0)¶ Information about guest agent commands.
- Members
name (
string
) – name of the commandenabled (
boolean
) – whether command is currently enabled by guest adminsuccess-response (
boolean
) – whether command returns a response on success (since 1.7)
-
Object
GuestAgentInfo
(Since: 0.15.0)¶ Information about guest agent.
- Members
version (
string
) – guest agent versionsupported_commands (
[
GuestAgentCommandInfo
]
) – Information about guest agent commands
-
Command
guest-info
(Since: 0.15.0)¶ Get some information about the guest agent.
- Return
GuestAgentInfo
–GuestAgentInfo
-
Command
guest-shutdown
(Since: 0.15.0)¶ Initiate guest-activated shutdown. Note: this is an asynchronous shutdown request, with no guarantee of successful shutdown.
- Arguments
mode (
string
, optional) – “halt”, “powerdown” (default), or “reboot”
This command does NOT return a response on success. Success condition is indicated by the VM exiting with a zero exit status or, when running with –no-shutdown, by issuing the query-status QMP command to confirm the VM status is “shutdown”.
-
Command
guest-file-open
(Since: 0.15.0)¶ Open a file in the guest and retrieve a file handle for it
- Arguments
path (
string
) – Full path to the file in the guest to open.mode (
string
, optional) – open mode, as per fopen(), “r” is the default.
- Return
int
– Guest file handle
-
Command
guest-file-close
(Since: 0.15.0)¶ Close an open file in the guest
- Arguments
handle (
int
) – filehandle returned by guest-file-open
-
Object
GuestFileRead
(Since: 0.15.0)¶ Result of guest agent file-read operation
- Members
count (
int
) – number of bytes read (note: count is before base64-encoding is applied)buf-b64 (
string
) – base64-encoded bytes readeof (
boolean
) – whether EOF was encountered during read operation.
-
Command
guest-file-read
(Since: 0.15.0)¶ Read from an open file in the guest. Data will be base64-encoded. As this command is just for limited, ad-hoc debugging, such as log file access, the number of bytes to read is limited to 48 MB.
- Arguments
handle (
int
) – filehandle returned by guest-file-opencount (
int
, optional) – maximum number of bytes to read (default is 4KB, maximum is 48MB)
- Return
GuestFileRead
–GuestFileRead
-
Object
GuestFileWrite
(Since: 0.15.0)¶ Result of guest agent file-write operation
- Members
count (
int
) – number of bytes written (note: count is actual bytes written, after base64-decoding of provided buffer)eof (
boolean
) – whether EOF was encountered during write operation.
-
Command
guest-file-write
(Since: 0.15.0)¶ Write to an open file in the guest.
- Arguments
handle (
int
) – filehandle returned by guest-file-openbuf-b64 (
string
) – base64-encoded string representing data to be writtencount (
int
, optional) – bytes to write (actual bytes, after base64-decode), default is all content in buf-b64 buffer after base64 decoding
- Return
GuestFileWrite
–GuestFileWrite
-
Object
GuestFileSeek
(Since: 0.15.0)¶ Result of guest agent file-seek operation
- Members
position (
int
) – current file positioneof (
boolean
) – whether EOF was encountered during file seek
-
Enum
QGASeek
(Since: 2.6)¶ Symbolic names for use in
guest-file-seek
- Values
set – Set to the specified offset (same effect as ‘whence’:0)
cur – Add offset to the current location (same effect as ‘whence’:1)
end – Add offset to the end of the file (same effect as ‘whence’:2)
-
Alternate
GuestFileWhence
(Since: 2.6)¶ Controls the meaning of offset to
guest-file-seek
.- Alternatives
value (
int
) – Integral value (0 for set, 1 for cur, 2 for end), available for historical reasons, and might differ from the host’s or guest’s SEEK_* values (since: 0.15)name (
QGASeek
) – Symbolic name, and preferred interface
-
Command
guest-file-seek
(Since: 0.15.0)¶ Seek to a position in the file, as with fseek(), and return the current file position afterward. Also encapsulates ftell()’s functionality, with offset=0 and whence=1.
- Arguments
handle (
int
) – filehandle returned by guest-file-openoffset (
int
) – bytes to skip over in the file streamwhence (
GuestFileWhence
) – Symbolic or numeric code for interpreting offset
- Return
GuestFileSeek
–GuestFileSeek
-
Command
guest-file-flush
(Since: 0.15.0)¶ Write file changes buffered in userspace to disk/kernel buffers
- Arguments
handle (
int
) – filehandle returned by guest-file-open
-
Enum
GuestFsfreezeStatus
(Since: 0.15.0)¶ - Availability:
CONFIG_WIN32 or CONFIG_FSFREEZE
An enumeration of filesystem freeze states
- Values
thawed – filesystems thawed/unfrozen
frozen – all non-network guest filesystems frozen
-
Command
guest-fsfreeze-status
(Since: 0.15.0)¶ - Availability:
CONFIG_WIN32 or CONFIG_FSFREEZE
Get guest fsfreeze state.
- Return
GuestFsfreezeStatus
– GuestFsfreezeStatus (“thawed”, “frozen”, etc., as defined below)
Note
This may fail to properly report the current state as a result of some other guest processes having issued an fs freeze/thaw.
-
Command
guest-fsfreeze-freeze
(Since: 0.15.0)¶ - Availability:
CONFIG_WIN32 or CONFIG_FSFREEZE
Sync and freeze all freezable, local guest filesystems. If this command succeeded, you may call
guest-fsfreeze-thaw
later to unfreeze.On error, all filesystems will be thawed. If no filesystems are frozen as a result of this call, then
guest-fsfreeze-status
will remain “thawed” and callingguest-fsfreeze-thaw
is not necessary.- Return
int
– Number of file systems currently frozen.
Note
On Windows, the command is implemented with the help of a Volume Shadow-copy Service DLL helper. The frozen state is limited for up to 10 seconds by VSS.
-
Command
guest-fsfreeze-freeze-list
(Since: 2.2)¶ - Availability:
CONFIG_WIN32 or CONFIG_FSFREEZE
Sync and freeze specified guest filesystems. See also
guest-fsfreeze-freeze
.On error, all filesystems will be thawed.
- Arguments
mountpoints (
[
string
]
, optional) – an array of mountpoints of filesystems to be frozen. If omitted, every mounted filesystem is frozen. Invalid mount points are ignored.
- Return
int
– Number of file systems currently frozen.
-
Command
guest-fsfreeze-thaw
(Since: 0.15.0)¶ - Availability:
CONFIG_WIN32 or CONFIG_FSFREEZE
Unfreeze all frozen guest filesystems
- Return
int
– Number of file systems thawed by this call
Note
If the return value does not match the previous call to guest-fsfreeze-freeze, this likely means some freezable filesystems were unfrozen before this call, and that the filesystem state may have changed before issuing this command.
-
Object
GuestFilesystemTrimResult
(Since: 2.4)¶ - Availability:
CONFIG_WIN32 or CONFIG_FSTRIM
- Members
path (
string
) – path that was trimmederror (
string
, optional) – an error message when trim failedtrimmed (
int
, optional) – bytes trimmed for this pathminimum (
int
, optional) – reported effective minimum for this path
-
Object
GuestFilesystemTrimResponse
(Since: 2.4)¶ - Availability:
CONFIG_WIN32 or CONFIG_FSTRIM
- Members
paths (
[
GuestFilesystemTrimResult
]
) – list ofGuestFilesystemTrimResult
per path that was trimmed
-
Command
guest-fstrim
(Since: 1.2)¶ - Availability:
CONFIG_WIN32 or CONFIG_FSTRIM
Discard (or “trim”) blocks which are not in use by the filesystem.
- Arguments
minimum (
int
, optional) – Minimum contiguous free range to discard, in bytes. Free ranges smaller than this may be ignored (this is a hint and the guest may not respect it). By increasing this value, the fstrim operation will complete more quickly for filesystems with badly fragmented free space, although not all blocks will be discarded. The default value is zero, meaning “discard every free block”.
- Return
GuestFilesystemTrimResponse
– AGuestFilesystemTrimResponse
which contains the status of all trimmed paths. (since 2.4)
-
Command
guest-suspend-disk
(Since: 1.1)¶ - Availability:
CONFIG_LINUX or CONFIG_WIN32
Suspend guest to disk.
This command attempts to suspend the guest using three strategies, in this order:
systemd hibernate
pm-utils (via pm-hibernate)
manual write into sysfs
This command does NOT return a response on success. There is a high chance the command succeeded if the VM exits with a zero exit status or, when running with –no-shutdown, by issuing the query-status QMP command to to confirm the VM status is “shutdown”. However, the VM could also exit (or set its status to “shutdown”) due to other reasons.
- Errors
If suspend to disk is not supported, Unsupported
Note
It’s strongly recommended to issue the guest-sync command before sending commands when the guest resumes.
-
Command
guest-suspend-ram
(Since: 1.1)¶ - Availability:
CONFIG_LINUX or CONFIG_WIN32
Suspend guest to ram.
This command attempts to suspend the guest using three strategies, in this order:
systemd hibernate
pm-utils (via pm-hibernate)
manual write into sysfs
IMPORTANT: guest-suspend-ram requires working wakeup support in QEMU. You should check QMP command query-current-machine returns wakeup-suspend-support: true before issuing this command. Failure in doing so can result in a suspended guest that QEMU will not be able to awaken, forcing the user to power cycle the guest to bring it back.
This command does NOT return a response on success. There are two options to check for success:
Wait for the SUSPEND QMP event from QEMU
Issue the query-status QMP command to confirm the VM status is “suspended”
- Errors
If suspend to ram is not supported, Unsupported
Note
It’s strongly recommended to issue the guest-sync command before sending commands when the guest resumes.
-
Command
guest-suspend-hybrid
(Since: 1.1)¶ - Availability:
CONFIG_LINUX
Save guest state to disk and suspend to ram.
This command attempts to suspend the guest by executing, in this order:
systemd hybrid-sleep
pm-utils (via pm-suspend-hybrid)
IMPORTANT: guest-suspend-hybrid requires working wakeup support in QEMU. You should check QMP command query-current-machine returns wakeup-suspend-support: true before issuing this command. Failure in doing so can result in a suspended guest that QEMU will not be able to awaken, forcing the user to power cycle the guest to bring it back.
This command does NOT return a response on success. There are two options to check for success:
Wait for the SUSPEND QMP event from QEMU
Issue the query-status QMP command to confirm the VM status is “suspended”
- Errors
If hybrid suspend is not supported, Unsupported
Note
It’s strongly recommended to issue the guest-sync command before sending commands when the guest resumes.
-
Enum
GuestIpAddressType
(Since: 1.1)¶ - Availability:
CONFIG_WIN32 or HAVE_GETIFADDRS
An enumeration of supported IP address types
- Values
ipv4 – IP version 4
ipv6 – IP version 6
-
Object
GuestIpAddress
(Since: 1.1)¶ - Availability:
CONFIG_WIN32 or HAVE_GETIFADDRS
- Members
ip-address (
string
) – IP addressip-address-type (
GuestIpAddressType
) – Type ofip-address
(e.g. ipv4, ipv6)prefix (
int
) – Network prefix length ofip-address
-
Object
GuestNetworkInterfaceStat
(Since: 2.11)¶ - Availability:
CONFIG_WIN32 or HAVE_GETIFADDRS
- Members
rx-bytes (
int
) – total bytes receivedrx-packets (
int
) – total packets receivedrx-errs (
int
) – bad packets receivedrx-dropped (
int
) – receiver dropped packetstx-bytes (
int
) – total bytes transmittedtx-packets (
int
) – total packets transmittedtx-errs (
int
) – packet transmit problemstx-dropped (
int
) – dropped packets transmitted
-
Object
GuestNetworkInterface
(Since: 1.1)¶ - Availability:
CONFIG_WIN32 or HAVE_GETIFADDRS
- Members
name (
string
) – The name of interface for which info are being deliveredhardware-address (
string
, optional) – Hardware address ofname
ip-addresses (
[
GuestIpAddress
]
, optional) – List of addresses assigned toname
statistics (
GuestNetworkInterfaceStat
, optional) – various statistic counters related toname
(since 2.11)
-
Command
guest-network-get-interfaces
(Since: 1.1)¶ - Availability:
CONFIG_WIN32 or HAVE_GETIFADDRS
Get list of guest IP addresses, MAC addresses and netmasks.
- Return
[
GuestNetworkInterface
]
– List of GuestNetworkInterface
-
Object
GuestLogicalProcessor
(Since: 1.5)¶ - Availability:
CONFIG_LINUX or CONFIG_WIN32
- Members
logical-id (
int
) – Arbitrary guest-specific unique identifier of the VCPU.online (
boolean
) – Whether the VCPU is enabled.can-offline (
boolean
, optional) – Whether offlining the VCPU is possible. This member is always filled in by the guest agent when the structure is returned, and always ignored on input (hence it can be omitted then).
-
Command
guest-get-vcpus
(Since: 1.5)¶ - Availability:
CONFIG_LINUX or CONFIG_WIN32
Retrieve the list of the guest’s logical processors.
This is a read-only operation.
- Return
[
GuestLogicalProcessor
]
– The list of all VCPUs the guest knows about. Each VCPU is put on the list exactly once, but their order is unspecified.
-
Command
guest-set-vcpus
(Since: 1.5)¶ - Availability:
CONFIG_LINUX
Attempt to reconfigure (currently: enable/disable) logical processors inside the guest.
- Arguments
vcpus (
[
GuestLogicalProcessor
]
) – The logical processors to be reconfigured. This list is processed node by node in order. In each nodelogical-id
is used to look up the guest VCPU, for whichonline
specifies the requested state. The set of distinctlogical-id
’s is only required to be a subset of the guest-supported identifiers. There’s no restriction on list length or on repeating the samelogical-id
(with possibly differentonline
field). Preferably the input list should describe a modified subset ofguest-get-vcpus
’ return value.
- Return
int
–The length of the initial sublist that has been successfully processed. The guest agent maximizes this value. Possible cases:
0: if the
vcpus
list was empty on input. Guest state has not been changed. Otherwise,< length(
vcpus
): more than zero initial nodes have been processed, but not the entirevcpus
list. Guest state has changed accordingly. To retrieve the error (assuming it persists), repeat the call with the successfully processed initial sublist removed. Otherwise,length(
vcpus
): call successful.
- Errors
If the reconfiguration of the first node in
vcpus
failed. Guest state has not been changed.
-
Enum
GuestDiskBusType
(Since: 2.2; ‘Unknown’ and all entries below since 2.4)¶ - Availability:
CONFIG_WIN32 or CONFIG_LINUX
An enumeration of bus type of disks
- Values
ide – IDE disks
fdc – floppy disks
scsi – SCSI disks
virtio – virtio disks
xen – Xen disks
usb – USB disks
uml – UML disks
sata – SATA disks
sd – SD cards
unknown – Unknown bus type
ieee1394 – Win IEEE 1394 bus type
ssa – Win SSA bus type
fibre – Win fiber channel bus type
raid – Win RAID bus type
iscsi – Win iScsi bus type
sas – Win serial-attaches SCSI bus type
mmc – Win multimedia card (MMC) bus type
virtual – Win virtual bus type
file-backed-virtual – Win file-backed bus type
nvme – NVMe disks (since 7.1)
-
Object
GuestPCIAddress
(Since: 2.2)¶ - Availability:
CONFIG_WIN32 or CONFIG_LINUX
- Members
domain (
int
) – domain idbus (
int
) – bus idslot (
int
) – slot idfunction (
int
) – function id
-
Object
GuestCCWAddress
(Since: 6.0)¶ - Availability:
CONFIG_WIN32 or CONFIG_LINUX
- Members
cssid (
int
) – channel subsystem image idssid (
int
) – subchannel set idsubchno (
int
) – subchannel numberdevno (
int
) – device number
-
Object
GuestDiskAddress
(Since: 2.2)¶ - Availability:
CONFIG_WIN32 or CONFIG_LINUX
- Members
pci-controller (
GuestPCIAddress
) – controller’s PCI address (fields are set to -1 if invalid)bus-type (
GuestDiskBusType
) – bus typebus (
int
) – bus idtarget (
int
) – target idunit (
int
) – unit idserial (
string
, optional) – serial number (since: 3.1)dev (
string
, optional) – device node (POSIX) or device UNC (Windows) (since: 3.1)ccw-address (
GuestCCWAddress
, optional) – CCW address on s390x (since: 6.0)
-
Object
GuestNVMeSmart
(Since: 7.1)¶ - Availability:
CONFIG_WIN32 or CONFIG_LIBUDEV
NVMe smart information, based on NVMe specification, section <SMART / Health Information (Log Identifier 02h)>
- Members
critical-warning (
int
) – Not documentedtemperature (
int
) – Not documentedavailable-spare (
int
) – Not documentedavailable-spare-threshold (
int
) – Not documentedpercentage-used (
int
) – Not documenteddata-units-read-lo (
int
) – Not documenteddata-units-read-hi (
int
) – Not documenteddata-units-written-lo (
int
) – Not documenteddata-units-written-hi (
int
) – Not documentedhost-read-commands-lo (
int
) – Not documentedhost-read-commands-hi (
int
) – Not documentedhost-write-commands-lo (
int
) – Not documentedhost-write-commands-hi (
int
) – Not documentedcontroller-busy-time-lo (
int
) – Not documentedcontroller-busy-time-hi (
int
) – Not documentedpower-cycles-lo (
int
) – Not documentedpower-cycles-hi (
int
) – Not documentedpower-on-hours-lo (
int
) – Not documentedpower-on-hours-hi (
int
) – Not documentedunsafe-shutdowns-lo (
int
) – Not documentedunsafe-shutdowns-hi (
int
) – Not documentedmedia-errors-lo (
int
) – Not documentedmedia-errors-hi (
int
) – Not documentednumber-of-error-log-entries-lo (
int
) – Not documentednumber-of-error-log-entries-hi (
int
) – Not documented
-
Object
GuestDiskSmart
(Since: 7.1)¶ - Availability:
CONFIG_WIN32 or CONFIG_LIBUDEV
Disk type related smart information.
- Members
type (
GuestDiskBusType
) – disk bus typeWhen
type
isnvme
: The members ofGuestNVMeSmart
.
-
Object
GuestDiskInfo
(Since: 5.2)¶ - Availability:
CONFIG_WIN32 or CONFIG_LIBUDEV
- Members
name (
string
) – device node (Linux) or device UNC (Windows)partition (
boolean
) – whether this is a partition or diskdependencies (
[
string
]
, optional) – list of device dependencies; e.g. for LVs of the LVM this will hold the list of PVs, for LUKS encrypted volume this will contain the disk where the volume is placed. (Linux)address (
GuestDiskAddress
, optional) – disk address information (only for non-virtual devices)alias (
string
, optional) – optional alias assigned to the disk, on Linux this is a name assigned by device mappersmart (
GuestDiskSmart
, optional) – disk smart information (Since 7.1)
-
Command
guest-get-disks
(Since: 5.2)¶ - Availability:
CONFIG_WIN32 or CONFIG_LIBUDEV
- Return
[
GuestDiskInfo
]
– The list of disks in the guest. For Windows these are only the physical disks. On Linux these are all root block devices of non-zero size including e.g. removable devices, loop devices, NBD, etc.
-
Object
GuestFilesystemInfo
(Since: 2.2)¶ - Availability:
CONFIG_WIN32 or CONFIG_LINUX
- Members
name (
string
) – disk namemountpoint (
string
) – mount point pathtype (
string
) – file system type stringused-bytes (
int
, optional) – file system used bytes (since 3.0)total-bytes (
int
, optional) – filesystem capacity in bytes for unprivileged users (since 3.0)total-bytes-privileged (
int
, optional) – filesystem capacity in bytes for privileged users (since 9.1)disk (
[
GuestDiskAddress
]
) – an array of disk hardware information that the volume lies on, which may be empty if the disk type is not supported
-
Command
guest-get-fsinfo
(Since: 2.2)¶ - Availability:
CONFIG_WIN32 or CONFIG_LINUX
- Return
[
GuestFilesystemInfo
]
– The list of filesystems information mounted in the guest. The returned mountpoints may be specified toguest-fsfreeze-freeze-list
. Network filesystems (such as CIFS and NFS) are not listed.
-
Command
guest-set-user-password
(Since: 2.3)¶ - Availability:
CONFIG_WIN32 or CONFIG_LINUX or CONFIG_FREEBSD
- Arguments
username (
string
) – the user account whose password to changepassword (
string
) – the new password entry string, base64 encodedcrypted (
boolean
) – true if password is already crypt()d, false if raw
If the
crypted
flag is true, it is the caller’s responsibility to ensure the correct crypt() encryption scheme is used. This command does not attempt to interpret or report on the encryption scheme. Refer to the documentation of the guest operating system in question to determine what is supported.Not all guest operating systems will support use of the
crypted
flag, as they may require the clear-text passwordThe
password
parameter must always be base64 encoded before transmission, even if already crypt()d, to ensure it is 8-bit safe when passed as JSON.
-
Object
GuestMemoryBlock
(Since: 2.3)¶ - Availability:
CONFIG_LINUX
- Members
phys-index (
int
) – Arbitrary guest-specific unique identifier of the MEMORY BLOCK.online (
boolean
) – Whether the MEMORY BLOCK is enabled in guest.can-offline (
boolean
, optional) – Whether offlining the MEMORY BLOCK is possible. This member is always filled in by the guest agent when the structure is returned, and always ignored on input (hence it can be omitted then).
-
Command
guest-get-memory-blocks
(Since: 2.3)¶ - Availability:
CONFIG_LINUX
Retrieve the list of the guest’s memory blocks.
This is a read-only operation.
- Return
[
GuestMemoryBlock
]
– The list of all memory blocks the guest knows about. Each memory block is put on the list exactly once, but their order is unspecified.
-
Enum
GuestMemoryBlockResponseType
(Since: 2.3)¶ - Availability:
CONFIG_LINUX
An enumeration of memory block operation result.
- Values
success – the operation of online/offline memory block is successful.
not-found – can’t find the corresponding memoryXXX directory in sysfs.
operation-not-supported – for some old kernels, it does not support online or offline memory block.
operation-failed – the operation of online/offline memory block fails, because of some errors happen.
-
Object
GuestMemoryBlockResponse
(Since: 2.3)¶ - Availability:
CONFIG_LINUX
- Members
phys-index (
int
) – same with the ‘phys-index’ member ofGuestMemoryBlock
.response (
GuestMemoryBlockResponseType
) – the result of memory block operation.error-code (
int
, optional) – the error number. When memory block operation fails, we assign the value of ‘errno’ to this member, it indicates what goes wrong. When the operation succeeds, it will be omitted.
-
Command
guest-set-memory-blocks
(Since: 2.3)¶ - Availability:
CONFIG_LINUX
Attempt to reconfigure (currently: enable/disable) state of memory blocks inside the guest.
- Arguments
mem-blks (
[
GuestMemoryBlock
]
) – The memory blocks to be reconfigured. This list is processed node by node in order. In each nodephys-index
is used to look up the guest MEMORY BLOCK, for whichonline
specifies the requested state. The set of distinctphys-index
’s is only required to be a subset of the guest-supported identifiers. There’s no restriction on list length or on repeating the samephys-index
(with possibly differentonline
field). Preferably the input list should describe a modified subset ofguest-get-memory-blocks
’ return value.
- Return
The operation results, it is a list of
GuestMemoryBlockResponse
, which is corresponding to the input list.Note: it will return an empty list if the
mem-blks
list was empty on input, or there is an error, and in this case, guest state will not be changed.
-
Object
GuestMemoryBlockInfo
(Since: 2.3)¶ - Availability:
CONFIG_LINUX
- Members
size (
int
) – the size (in bytes) of the guest memory blocks, which are the minimal units of memory block online/offline operations (also called Logical Memory Hotplug).
-
Command
guest-get-memory-block-info
(Since: 2.3)¶ - Availability:
CONFIG_LINUX
Get information relating to guest memory blocks.
- Return
GuestMemoryBlockInfo
–GuestMemoryBlockInfo
-
Object
GuestExecStatus
(Since: 2.5)¶ - Members
exited (
boolean
) – true if process has already terminated.exitcode (
int
, optional) – process exit code if it was normally terminated.signal (
int
, optional) – signal number (linux) or unhandled exception code (windows) if the process was abnormally terminated.out-data (
string
, optional) – base64-encoded stdout of the process. This field will only be populated after the process exits.err-data (
string
, optional) – base64-encoded stderr of the process. Note:out-data
anderr-data
are present only if ‘capture-output’ was specified for ‘guest-exec’. This field will only be populated after the process exits.out-truncated (
boolean
, optional) – true if stdout was not fully captured due to size limitation.err-truncated (
boolean
, optional) – true if stderr was not fully captured due to size limitation.
-
Command
guest-exec-status
(Since: 2.5)¶ Check status of process associated with PID retrieved via guest-exec. Reap the process and associated metadata if it has exited.
- Arguments
pid (
int
) – pid returned from guest-exec
- Return
GuestExecStatus
– GuestExecStatus
-
Object
GuestExec
(Since: 2.5)¶ - Members
pid (
int
) – pid of child process in guest OS
-
Enum
GuestExecCaptureOutputMode
(Since: 8.0)¶ An enumeration of guest-exec capture modes.
- Values
none – do not capture any output
stdout – only capture stdout
stderr – only capture stderr
separated – capture both stdout and stderr, but separated into GuestExecStatus out-data and err-data, respectively
merged – capture both stdout and stderr, but merge together into out-data. Not effective on windows guests.
-
Alternate
GuestExecCaptureOutput
(Since: 8.0)¶ Controls what guest-exec output gets captures.
- Alternatives
flag (
boolean
) – captures both stdout and stderr if true. Equivalent to GuestExecCaptureOutputMode::all. (since 2.5)mode (
GuestExecCaptureOutputMode
) – capture mode; preferred interface
-
Command
guest-exec
(Since: 2.5)¶ Execute a command in the guest
- Arguments
path (
string
) – path or executable name to executearg (
[
string
]
, optional) – argument list to pass to executableenv (
[
string
]
, optional) – environment variables to pass to executableinput-data (
string
, optional) – data to be passed to process stdin (base64 encoded)capture-output (
GuestExecCaptureOutput
, optional) – bool flag to enable capture of stdout/stderr of running process. Defaults to false.
- Return
GuestExec
– PID
-
Object
GuestHostName
(Since: 2.10)¶ - Members
host-name (
string
) – Fully qualified domain name of the guest OS
-
Command
guest-get-host-name
(Since: 2.10)¶ Return a name for the machine.
The returned name is not necessarily a fully-qualified domain name, or even present in DNS or some other name service at all. It need not even be unique on your local network or site, but usually it is.
- Return
GuestHostName
– the host name of the machine
-
Object
GuestUser
(Since: 2.10)¶ - Availability:
CONFIG_WIN32 or HAVE_UTMPX
- Members
user (
string
) – Usernamedomain (
string
, optional) – Logon domain (windows only)login-time (
number
) – Time of login of this user on the computer. If multiple instances of the user are logged in, the earliest login time is reported. The value is in fractional seconds since epoch time.
-
Command
guest-get-users
(Since: 2.10)¶ - Availability:
CONFIG_WIN32 or HAVE_UTMPX
Retrieves a list of currently active users on the VM.
- Return
[
GuestUser
]
– A unique list of users.
-
Object
GuestTimezone
(Since: 2.10)¶ - Members
zone (
string
, optional) – Timezone name. These values may differ depending on guest/OS and should only be used for informational purposes.offset (
int
) – Offset to UTC in seconds, negative numbers for time zones west of GMT, positive numbers for east
-
Command
guest-get-timezone
(Since: 2.10)¶ Retrieves the timezone information from the guest.
- Return
GuestTimezone
– A GuestTimezone dictionary.
-
Object
GuestOSInfo
(Since: 2.10)¶ - Members
kernel-release (
string
, optional) –POSIX: release field returned by uname(2)
Windows: build number of the OS
kernel-version (
string
, optional) –POSIX: version field returned by uname(2)
Windows: version number of the OS
machine (
string
, optional) –POSIX: machine field returned by uname(2)
Windows: one of x86, x86_64, arm, ia64
id (
string
, optional) –POSIX: as defined by os-release(5)
Windows: contains string “mswindows”
name (
string
, optional) –POSIX: as defined by os-release(5)
Windows: contains string “Microsoft Windows”
pretty-name (
string
, optional) –POSIX: as defined by os-release(5)
Windows: product name, e.g. “Microsoft Windows 10 Enterprise”
version (
string
, optional) –POSIX: as defined by os-release(5)
Windows: long version string, e.g. “Microsoft Windows Server 2008”
version-id (
string
, optional) –POSIX: as defined by os-release(5)
Windows: short version identifier, e.g. “7” or “20012r2”
variant (
string
, optional) –POSIX: as defined by os-release(5)
Windows: contains string “server” or “client”
variant-id (
string
, optional) –POSIX: as defined by os-release(5)
Windows: contains string “server” or “client”
Note
On POSIX systems the fields
id
,name
,pretty-name
,version
,version-id
,variant
andvariant-id
follow the definition specified in os-release(5). Refer to the manual page for exact description of the fields. Their values are taken from the os-release file. If the file is not present in the system, or the values are not present in the file, the fields are not included.On Windows the values are filled from information gathered from the system.
-
Command
guest-get-osinfo
(Since: 2.10)¶ Retrieve guest operating system information
- Return
GuestOSInfo
–GuestOSInfo
-
Enum
GuestDeviceType
¶ - Availability:
CONFIG_WIN32
- Values
pci – PCI device
-
Object
GuestDeviceIdPCI
(Since: 5.2)¶ - Availability:
CONFIG_WIN32
- Members
vendor-id (
int
) – vendor IDdevice-id (
int
) – device ID
-
Object
GuestDeviceId
(Since: 5.2)¶ - Availability:
CONFIG_WIN32
Id of the device
- Members
type (
GuestDeviceType
) – device typeWhen
type
ispci
: The members ofGuestDeviceIdPCI
.
-
Object
GuestDeviceInfo
(Since: 5.2)¶ - Availability:
CONFIG_WIN32
- Members
driver-name (
string
) – name of the associated driverdriver-date (
int
, optional) – driver release date, in nanoseconds since the epochdriver-version (
string
, optional) – driver versionid (
GuestDeviceId
, optional) – device ID
-
Command
guest-get-devices
(Since: 5.2)¶ - Availability:
CONFIG_WIN32
Retrieve information about device drivers in Windows guest
- Return
[
GuestDeviceInfo
]
–GuestDeviceInfo
-
Object
GuestAuthorizedKeys
(Since: 5.2)¶ - Members
keys (
[
string
]
) – public keys (in OpenSSH/sshd(8) authorized_keys format)
Return the public keys from user .ssh/authorized_keys on Unix systems (not implemented for other systems).
- Arguments
username (
string
) – the user account to add the authorized keys
- Return
GuestAuthorizedKeys
–GuestAuthorizedKeys
Append public keys to user .ssh/authorized_keys on Unix systems (not implemented for other systems).
- Arguments
username (
string
) – the user account to add the authorized keyskeys (
[
string
]
) – the public keys to add (in OpenSSH/sshd(8) authorized_keys format)reset (
boolean
, optional) – ignore the existing content, set it with the given keys only
Remove public keys from the user .ssh/authorized_keys on Unix systems (not implemented for other systems). It’s not an error if the key is already missing.
- Arguments
username (
string
) – the user account to remove the authorized keyskeys (
[
string
]
) – the public keys to remove (in OpenSSH/sshd(8) authorized_keys format)
-
Object
GuestDiskStats
(Since: 7.1)¶ - Availability:
CONFIG_LINUX
- Members
read-sectors (
int
, optional) – sectors readread-ios (
int
, optional) – reads completed successfullyread-merges (
int
, optional) – read requests mergedwrite-sectors (
int
, optional) – sectors writtenwrite-ios (
int
, optional) – writes completedwrite-merges (
int
, optional) – write requests mergeddiscard-sectors (
int
, optional) – sectors discardeddiscard-ios (
int
, optional) – discards completed successfullydiscard-merges (
int
, optional) – discard requests mergedflush-ios (
int
, optional) – flush requests completed successfullyread-ticks (
int
, optional) – time spent reading(ms)write-ticks (
int
, optional) – time spent writing(ms)discard-ticks (
int
, optional) – time spent discarding(ms)flush-ticks (
int
, optional) – time spent flushing(ms)ios-pgr (
int
, optional) – number of I/Os currently in flighttotal-ticks (
int
, optional) – time spent doing I/Os (ms)weight-ticks (
int
, optional) – weighted time spent doing I/Os since the last update of this field(ms)
-
Object
GuestDiskStatsInfo
¶ - Availability:
CONFIG_LINUX
- Members
name (
string
) – disk namemajor (
int
) – major device number of diskminor (
int
) – minor device number of diskstats (
GuestDiskStats
) – I/O statistics
-
Command
guest-get-diskstats
(Since: 7.1)¶ - Availability:
CONFIG_LINUX
Retrieve information about disk stats.
- Return
[
GuestDiskStatsInfo
]
– List of disk stats of guest.
-
Enum
GuestCpuStatsType
(Since: 7.1)¶ - Availability:
CONFIG_LINUX
Guest operating systems supporting CPU statistics
- Values
linux – Linux
-
Object
GuestLinuxCpuStats
(Since: 7.1)¶ - Availability:
CONFIG_LINUX
CPU statistics of Linux
- Members
cpu (
int
) – CPU index in guest OSuser (
int
) – Time spent in user modenice (
int
) – Time spent in user mode with low priority (nice)system (
int
) – Time spent in system modeidle (
int
) – Time spent in the idle taskiowait (
int
, optional) – Time waiting for I/O to complete (since Linux 2.5.41)irq (
int
, optional) – Time servicing interrupts (since Linux 2.6.0-test4)softirq (
int
, optional) – Time servicing softirqs (since Linux 2.6.0-test4)steal (
int
, optional) – Stolen time by host (since Linux 2.6.11)guest (
int
, optional) – ime spent running a virtual CPU for guest operating systems under the control of the Linux kernel (since Linux 2.6.24)guestnice (
int
, optional) – Time spent running a niced guest (since Linux 2.6.33)
-
Object
GuestCpuStats
(Since: 7.1)¶ - Availability:
CONFIG_LINUX
Get statistics of each CPU in millisecond.
- Members
type (
GuestCpuStatsType
) – guest operating systemWhen
type
islinux
: The members ofGuestLinuxCpuStats
.
-
Command
guest-get-cpustats
(Since: 7.1)¶ - Availability:
CONFIG_LINUX
Retrieve information about CPU stats.
- Return
[
GuestCpuStats
]
– List of CPU stats of guest.
-
Object
GuestLoadAverage
(Since: 10.0)¶ - Availability:
CONFIG_GETLOADAVG
Statistics about process load information
- Members
load1m (
number
) – 1-minute load avageload5m (
number
) – 5-minute load avageload15m (
number
) – 15-minute load avage
-
Command
guest-get-load
(Since: 10.0)¶ - Availability:
CONFIG_GETLOADAVG
Retrieve CPU process load information
- Return
GuestLoadAverage
– load information
-
Object
GuestNetworkRoute
(Since: 9.1)¶ - Availability:
CONFIG_LINUX
Route information, currently, only linux supported.
- Members
iface (
string
) – The destination network or host’s egress network interface in the routing tabledestination (
string
) – The IP address of the target network or host, The final destination of the packetmetric (
int
) – Route metricgateway (
string
, optional) – The IP address of the next hop routermask (
string
, optional) – Subnet Mask (IPv4 only)irtt (
int
, optional) – Initial round-trip delay (not for windows, IPv4 only)flags (
int
, optional) – Route flags (not for windows)refcnt (
int
, optional) – The route’s reference count (not for windows)use (
int
, optional) – Route usage count (not for windows)window (
int
, optional) – TCP window size, used for flow control (not for windows, IPv4 only)mtu (
int
, optional) – Data link layer maximum packet size (not for windows)desprefixlen (
string
, optional) – Destination prefix length (for IPv6)source (
string
, optional) – Source IP address (for IPv6)srcprefixlen (
string
, optional) – Source prefix length (for IPv6)nexthop (
string
, optional) – Next hop IP address (for IPv6)version (
int
) – IP version (4 or 6)
-
Command
guest-network-get-route
(Since: 9.1)¶ - Availability:
CONFIG_LINUX
Retrieve information about route of network. Returns: List of route info of guest.