ConnectionRefs.acquire:
Acquire one or more new storage connection references.
Returns
results | A dictionary of status codes indexed by the same @UUID values in @conRefArgs. |
Since: 4.10.0
ConnectionRefs.release:
Release one or more storage connection references.
Arguments
refIDs | A list of @UUID values |
Returns
results | A dictionary of status codes indexed by the same @UUID values that were passed in @0. |
Since: 4.10.0
ConnectionRefs.statuses:
Get information about all registered storage connection references.
Returns
connectionslist | A dictionary of @ConnectionRef objects indexed by @UUID |
Since: 4.10.0
Global.addNetwork:
Add a new network to this host.
Arguments
bridge | The name of the bridge device |
vlan | #optional The name of a VLAN to create on the device |
bond | #optional The name of a bond device to create from @nics |
nics | #optional A list of network device names |
options | #optional A @NetworkOptions structure |
Since: 4.10.0
Global.delNetwork:
Remove a network from this host.
Arguments
bridge | The name of the bridge device |
vlan | #optional The name of an associated vlan to remove |
bond | #optional The name of an associated bond device to remove |
nics | #optional A list of associated network devices to remove |
options | #optional A @NetworkOptions structure |
Since: 4.10.0
Global.editNetwork:
Add a new network to the host by replacing it with a new one.
Arguments
oldBridge | The name of the old bridge device to remove |
newBridge | The name of the new bridge device to create |
vlan | #optional The name of a VLAN to create on the new network |
bond | #optional The name of a bond device to create from @nics |
nics | #optional A list of network device names |
options | #optional A @NetworkOptions structure |
Since: 4.10.0
Global.fenceNode:
Send a fencing command to a remote host.
Arguments
addr | The IP address of the remote fence agent |
port | The port number of the remote fence agent |
agent | The type of agent being connected to (For example: rsa, ilo, drac5, ipmilan, etc) |
username | The username used to login to the remote fence agent |
password | The password for @username |
action | The type of fencing operation to perform (from @FenceNodeAction) |
secure | Enable SSL communication |
options | Additional agent-specific parameters in space-separated <var>=<val> pairs |
Returns
power | #optional The new power status of the remote node |
Since: 4.10.0
Global.getAllTasksInfo:
Get extra information about all tasks.
Notes:
Currently this API only returns tasks that are tagged with 'spm'.
Since: 4.10.0
Global.getAllTasksStatuses:
Get status information for all tasks.
Notes:
Currently this API only returns tasks that are tagged with 'spm'.
Since: 4.10.0
Global.getCapabilities:
Get host capabilities.
Returns
info | Host capabilities information |
netConfigDirty | Indicates if there are uncommitted changes to the network configuration |
Since: 4.10.0
Global.getConnectedStoragePools:
Get a list of all Storage Pools that are connected to this host.
Returns
poollist | A list of Storage Pool UUIDs |
Since: 4.10.0
Global.getDeviceInfo:
Get information about a block device.
Arguments
guid | The globally unique identifier of the block device |
Returns
info | Block device information |
Since: 4.10.0
Global.getDeviceList:
Get information about all block devices.
Arguments
storageType | #optional Only return devices of this type |
Returns
devList | An array of @BlockDeviceInfo |
Since: 4.10.0
Global.getDevicesVisibility:
Check the visibility of block storage devices.
Arguments
guidList | A list of block device GUIDs |
Returns
visibility | Visibility status for each device |
Since: 4.10.0
Global.getLVMVolumeGroups:
Get information about Volume Groups in this host.
Arguments
storageType | #optional Limit results to Volume Groups of a specific storage type |
Returns
vglist | A list of @VolumeGroupInfo items |
Since: 4.10.0
Global.getStats:
Get host statistics.
Returns
info | The set of host statistics |
Since: 4.10.0
Global.getStorageDomains:
Get a list of known Storage Domain UUIDs.
Arguments
spUUID | #optional Limit to Domains belonging to this Storage Pool |
domainClass | #optional Limit to Domains of this @StorageDomainClass |
storageType | #optional Limit to Domains of this @StorageDomainType |
remotePath | #optional Limit to Domains having this remotePath |
Returns
domlist | A list of known Storage Domains |
Since: 4.10.0
Global.getStorageRepoStats:
Get statistics about currently attached storage.
Returns
XXX | A dictionary of @StorageDomainStats indexed by Storage Domain @UUID |
Since: 4.10.0
Global.getVMList:
Get information about the current virtual machines.
Arguments
fullStatus | #optional Set to request complete VM information |
vmList | #optional Filter the results by a list of UUIDs |
Returns
vmList | A list of VM definitions |
Since: 4.10.0
Global.ping:
Test connectivity to vdsm.
Since: 4.10.0
Global.setLogLevel:
Set the vdsm logging verbosity level.
Arguments
level | The new verosity level desired |
Since: 4.10.0
Global.setSafeNetworkConfig:
Mark the current network configuration good and persist any changes.
Since: 4.10.0
Global.setupNetworks:
Reconfigure host networking by adding, removing, and editing multiple bridgeand bond devices in a single call.
Arguments
networks | Configuration information for the network bridges |
bondings | Configuration information for the bond devices |
options | Additional options to control configuration behavior |
Since: 4.10.0
ISCSIConnection.discoverSendTargets:
Discover available targets for this @ISCSIConnection.
Returns
targets | A list of discovered target iqns |
fullTargets | A list of discovered targets in the form: '<host>:<port>,<tpgt> <iqn>' |
Since: 4.10.0
Image.delete:
Delete the Image and all of its Volumes.
Arguments
postZero | If True, overwrite Volume data with zeroes after deletion |
force | Force the operation and do not perform any validation |
Since: 4.10.0
Image.deleteVolumes:
Delete one or more Volumes associated with this image.
Arguments
volumeList | A list of Volume UUIDs |
postZero | If True, overwrite Volume data with zeroes after deletion |
force | Force the operation and do not perform any validation |
Since: 4.10.0
Image.getVolumes:
Get a list of Volumes associated with this Image.
Since: 4.10.0
Image.mergeSnapshots:
Merge snapshot @successor into @ancestor.
Arguments
ancestor | A Volume UUID representing the parent snapshot |
successor | A Volume UUID representing the child snapshot |
postZero | If True, overwrite @successor with zeroes after conversion |
Since: 4.10.0
Image.move:
Move or copy an image to another Storage Domain within the same Storage Pool.
Arguments
dstSdUUID | The destination Storage Domain UUID |
operation | The operation to perform |
postZero | If True, overwrite Volume data with zeroes after deletion |
force | Force the operation and do not perform any validation |
Since: 4.10.0
LVMVolumeGroup.create:
Create a new Volume Group.
Arguments
name | The desired name for the new Volume Group |
devlist | An array of device names to include in the Volume Group |
force | #optional Force the operation and do not perform any validation |
Returns
uuid | The uuid of the created Volume Group |
Since: 4.10.0
LVMVolumeGroup.getInfo:
Get information about a Volume Group.
Returns
info | Volume Group information |
Since: 4.10.0
LVMVolumeGroup.remove:
Remove this Volume Group.
Since: 4.10.0
StorageDomain.activate:
Activate an attached but inactive Storage Domain.
Since: 4.10.0
StorageDomain.attach:
Attach a Storage Domain to a Storage Pool.
Arguments
spUUID | The Storage Pool to which the Storage Domain should be attached |
Since: 4.10.0
StorageDomain.create:
Create a new Storage Domain.
Arguments
type | The type of backing storage used by the Storage Domain |
typeArgs | Type specific backing storage specifier |
name | A human-readable name |
domainClass | The Storage Domain Class |
version | #optional The Storage Domain version that should be used |
Since: 4.10.0
StorageDomain.deactivate:
Deactivate an active, attached Storage Domain.
Arguments
masterSdUUID | The UUID of a Storage Domain that should become master after this domain has been deactivated. If this domain was not the master domain, then the current master's UUID may be used. |
masterVersion | The Storage Domain version of the new master domain |
Since: 4.10.0
StorageDomain.detach:
Detach an inactive Storage Domain from its Storage Pool.
Arguments
masterSdUUID | The UUID of a Storage Domain that should become master after this domain has been deactivated. If this domain was not the master domain, then the current master's UUID may be used. |
masterVersion | The Storage Domain version of the new master domain |
force | Force operation -- do not perform validation |
Since: 4.10.0
StorageDomain.extend:
Extend a block-based Storage Domain onto more block devices.
Arguments
devlist | An array of block device names to add to the domain |
Since: 4.10.0
StorageDomain.format:
Format a storage domain and erase all of its data.
Arguments
autoDetach | Detach the Storage Domain before formatting. Useful when formatting the master domain. |
Since: 4.10.0
StorageDomain.getFileList:
Get a list of files in an ISO domain.
Arguments
pattern | Filter results by this glob pattern |
Returns
files | A dictionary of file information indexed by file name |
Since: 4.10.0
StorageDomain.getImages:
Get a list of Images associated with this Storage Domain.
Since: 4.10.0
StorageDomain.getInfo:
Get information about a Storage Domain.
Returns
info | Storage domain information |
Since: 4.10.0
StorageDomain.getStats:
Get Storage Domain statistics.
Returns
stats | Storage Domain statistics |
Since: 4.10.0
StorageDomain.getVolumes:
Get a list of Volumes contained within a Storage Domain.
Arguments
imgUUID | Limit results to Volumes associated with a single Image |
Since: 4.10.0
StorageDomain.setDescription:
Set the Storage Domain description.
Since: 4.10.0
StorageDomain.uploadVolume:
Upload a Volume into a Storage Domain from a remote location.
Arguments
imgUUID | The UUID of the image that is associated with the Volume |
volUUID | The UUID of an existing Volume where the data will be uploaded |
srcPath | The remote location of the Volume data. Must be in a format that can be understood by the command indicated in @method. |
size | The size of the volume data in blocks |
method | The method (command) to use to upload the data |
Since: 4.10.0
StorageDomain.validate:
Check that the Storage Domain is accessible.
Since: 4.10.0
StoragePool.connect:
Connect to an existing Storage Pool.
Arguments
hostID | A host ID number unique across all hosts in the same cluster |
scsiKey | A key that will be used to validate other API calls related to this Storage Pool |
masterSdUUID | The UUID of a Storage Domain to use as the master domain |
masterVersion | The Storage Domain version of the master domain |
Notes:
Only one Storage pool may be connected at a time
Since: 4.10.0
StoragePool.connectStorageServer:
Establish a connection to backing storage.
Returns
statuslist | The status of each connection attempt |
Since: 4.10.0
StoragePool.create:
Create a new Storage Pool.
Arguments
name | A human-readable name for the Storage Pool |
masterSdUUID | The UUID of the Storage Domain that will be used as the master domain |
masterVersion | The Storage Domain version of the master domain |
domainList | A list of Storage Domain UUIDs that should be attached to the Storage Pool |
lockRenewalIntervalSec | The number of seconds to wait before renewing lease (Should be less than @leaseTimeSec). 0 selects the default value. |
leaseTimeSec | The maximum number of seconds that the leaseholder may retain the lease without renewing it. 0 selects the default value. |
ioOpTimeoutSec | The maximum number of seconds that an I/O operation may take to complete. 0 selects the default value. |
leaseRetries | The number of times to attempt lease renewal before failure. 0 selects the default value. |
Since: 4.10.0
StoragePool.destroy:
Destroy a Storage Pool.
Arguments
hostID | A host ID number unique across all hosts in the same cluster |
scsiKey | The key that was passed into @StoragePool.connect |
Since: 4.10.0
StoragePool.disconnect:
Disconnect and optionally remove a Storage Pool.
Arguments
hostID | A host ID number unique across all hosts in the same cluster |
scsiKey | The key that was passed into @StoragePool.connect |
remove | If True, remove the Storage Pool after it is disconnected |
Since: 4.10.0
StoragePool.disconnectStorageServer:
Remove backing storage connections.
Returns
statuslist | The status of each connection attempt |
Since: 4.10.0
StoragePool.fence:
Fence the SPM host via the storage.
Returns
spm_st | SPM status information for the Storage Pool |
Notes:
Deprecated
Since: 4.10.0
StoragePool.getBackedUpVmsInfo:
Get information about backed-up virtual machines from a Backup Storage Domain.
Arguments
sdUUID | The UUID of the Backup Storage Domain to check |
vmList | Limit results to a list of VM UUIDs |
Returns
vmlist | A dictionary of OVF information indexed by VM UUID |
Notes:
Vdsm does not create the OVF data but assumes that ovirt-engine has
previously injected it into the Backup Storage Domain.
Since: 4.10.0
StoragePool.getBackedUpVmsList:
Get a list of backed up virtual machines from a Backup Storage Domain.
Arguments
sdUUID | The UUID of the Backup Storage Domain to check |
Returns
vmlist | A list of VM UUIDs |
Since: 4.10.0
StoragePool.getDomainsContainingImage:
Get a list of Storage Domains that contain an Image.
Arguments
imgUUID | The UUID of the Image to search for |
onlyDataDomains | #optional Only include Data Storage Domains |
Returns
domainslist | A list of Storage Domain UUIDs that contain the Image |
Since: 4.10.0
StoragePool.getFloppyList:
Get a list of all floppy disk images associated with a Storage Pool.
Returns
isolist | A list of floppy disk file names |
Since: 4.10.0
StoragePool.getInfo:
Get information about a Storage Pool and its Active Storage Domains.
Returns
info | Storage Pool information |
dominfo | Information about active Storage Domains |
Since: 4.10.0
StoragePool.getIsoList:
Get a list of all ISO images associated with a Storage Pool.
Arguments
filenameExtension | #optional Specify an alternate file extension (the default extension used is 'iso') |
Returns
isolist | A list of available files |
Since: 4.10.0
StoragePool.getSpmStatus:
Get the status of the Storage Pool Manager role.
Returns
spm_st | SPM status information |
Since: 4.10.0
StoragePool.moveMultipleImages:
Move images from one Storage Domain to another within the same Storage Pool.
Arguments
srcSdUUID | The source Storage Domain |
dstSdUUID | The destination Storage Domain |
imgDict | A mapping keyed by Image UUID where the values indicate if the source Image should be zeroed after the data has been moved |
force | Move Images even if it would overwrite data on the destination |
Since: 4.10.0
StoragePool.reconstructMaster:
Recover a Storage Pool by reconstructing its Storage Domains.
Arguments
name | A human-readable name for the Storage Pool |
masterSdUUID | The UUID of the Storage Domain that will be used as the master domain |
masterVersion | The Storage Domain version of the master domain |
domainDict | Storage Domain statuses to be restored |
lockRenewalIntervalSec | The number of seconds to wait before renewing lease (Should be less than @leaseTimeSec). 0 selects the default value. |
leaseTimeSec | The maximum number of seconds that the leaseholder may retain the lease without renewing it. 0 selects the default value. |
ioOpTimeoutSec | The maximum number of seconds that an I/O operation may take to complete. 0 selects the default value. |
leaseRetries | The number of times to attempt lease renewal before failure. 0 selects the default value. |
Since: 4.10.0
StoragePool.refresh:
Refresh Storage Pool information.
Since: 4.10.0
StoragePool.removeVM:
Remove a previously saved virtual machine definition.
Arguments
vmUUID | Remove the saved definition of the VM with this UUID |
sdUUID | The Storage Domain where the VM is stored |
Since: 4.10.0
StoragePool.setDescription:
Set the Storage Pool description
Arguments
description | A human-readable string describing the Storage Pool |
Since: 4.10.0
StoragePool.spmStart:
Instruct this host to acquire the Storage Pool Manager role for this pool.
Arguments
prevID | Deprecated. The Host ID of the previous SPM |
prevLver | Deprecated. The lver of the previous SPM |
enableScsiFencing | This parameter is not used |
maxHostID | The maximum number of hosts that could be in the cluster |
domVersion | The expected Storage Domain version of the master domain |
Since: 4.10.0
StoragePool.spmStop:
Instruct this host to release the Storage Pool Manager role for this pool.
Since: 4.10.0
StoragePool.updateVMs:
Store virtual machine OVF files on a Storage Domain in the Storage Pool.
Arguments
vmList | A list of virtual machine definitions to store |
sdUUID | The Storage Domain to use for storing the VM definitions |
Since: 4.10.0
StoragePool.upgrade:
Upgrade all Storage Domains in this Storage Pool to a new version.
Since: 4.10.0
StoragePool.validateStorageServerConnection:
Validate storage server connection parameters.
Returns
statuslist | A list of connection parameter statuses |
Notes:
Deprecated since 4.10.0. Returns 0 for all connections.
Since: 4.10.0
Task.clear:
Discard information about a finished Task.
Since: 4.10.0
Task.getInfo:
Get information about a Task.
Returns
TaskInfo | General Task information |
Since: 4.10.0
Task.getStatus:
Get Task status information.
Since: 4.10.0
Task.revert:
Rollback a Task to restore the previous system state.
Since: 4.10.0
Task.stop:
Stop a currently running Task.
Since: 4.10.0
VM.changeCD:
Change the CD in the VM's CD-ROM device.
Arguments
driveSpec | The specification of the new CD |
Returns
vmList | The VM definition, as updated |
Since: 4.10.0
VM.changeFloppy:
Change the disk in the VM's floppy device.
Arguments
driveSpec | The specification of the new floppy disk |
Returns
vmList | The VM definition, as updated |
Since: 4.10.0
VM.cont:
Resume a paused VM.
Since: 4.10.0
VM.create:
Create a new virtual machine.
Returns
vmList | The VM definition, as created |
Since: 4.10.0
VM.desktopLock:
Lock the active user session in the guest operating system.
Since: 4.10.0
VM.desktopLogin:
Log a user into the guest operating system.
Arguments
domain | The Active Directory domain (if applicable) |
username | The username to use |
password | The password corresponding to @username |
Since: 4.10.0
VM.desktopLogoff:
Logoff the active user of the guest operating system.
Arguments
force | Force the operation (unused) |
Since: 4.10.0
VM.desktopSendHcCommand:
Send an arbitrary command to the guest agent.
Arguments
message | The message to send |
Notes:
Deprecated since 4.10.0
Since: 4.10.0
VM.destroy:
Forcibly stop a running VM.
Since: 4.10.0
VM.getMigrationStatus:
Report status of a currently outgoing migration.
Notes:
Migration status is returned as the command status ('code' and
'message')
Since: 4.10.0
VM.getStats:
Get statistics about a running virtual machine.
Returns
statsList | An array containing a single VmStats record |
Since: 4.10.0
VM.hibernate:
Save the live state of the VM to disk and stop it.
Notes:
This is a host-initiated hibernation and does not make use of any
guest operating system suspend to disk functionality.
Since: 4.10.0
VM.hotplugDisk:
Add a new disk device to a running VM.
Arguments
params | The VM UUID and device information |
Returns
vmList | The VM definition, as updated |
Notes:
Since: 4.10.0
VM.hotplugNic:
Add a new network device to a running VM.
Arguments
params | The VM UUID and device information |
Returns
vmList | The VM definition, as updated |
Notes:
Since: 4.10.0
VM.hotunplugDisk:
Remove a disk device from a running VM.
Arguments
params | The VM UUID and device information |
Returns
vmList | The VM definition, as updated |
Notes:
Since: 4.10.0
VM.hotunplugNic:
Remove a network device from a running VM.
Arguments
params | The VM UUID and device information |
Returns
vmList | The VM definition, as updated |
Notes:
Since: 4.10.0
VM.merge:
Merge VM disk snapshots.
Arguments
mergeDrives | A list of drives on which to perform merge operations. Each entry must have @baseVolumeID set to indicate the new desired base volume. |
Since: 4.10.0
VM.mergeStatus:
Check the status of an ongoing snapshot merge operation.
Since: 4.10.0
VM.migrate:
Migrate a VM to a remote host.
Arguments
params | Migration parameters |
Notes:
This function allows you to migrate to a file but this mode should be
selected by using the hibernate command.
Since: 4.10.0
VM.migrateCancel:
Cancel a currently outgoing migration process.
Since: 4.10.0
VM.migrationCreate:
Start a migrating VM on a destination host.
Arguments
params | The VM definition |
Returns
migrationPort | This value is always 0 |
params | The definition of the created virtual machine |
Notes:
This API is used internally by @VM.migrate and is not intended to be
called directly.
Since: 4.10.0
VM.monitorCommand:
Send a command to the qemu monitor.
Arguments
command | The command string |
Notes:
This function is not implemented.
Since: 4.10.0
VM.pause:
Pause the CPUs of a running VM.
Since: 4.10.0
VM.reset:
Reset a virtual machine.
Notes:
This function is not implemented.
Since: 4.10.0
VM.sendKeys:
Send a string of keys to a guest's keyboard.
Notes:
This function is not implemented.
Since: 4.10.0
VM.setTicket:
Set the password to be used to connect to a VM display.
Arguments
password | The desired connection password |
ttl | The number of seconds before the password expires |
existingConnAction | Indicate what to do with any existing connections |
params | Arbitrary key:val pairs that will be passed to hooks |
Since: 4.10.0
VM.shutdown:
Request a graceful shutdown of a VM.
Arguments
delay | #optional Wait a number of seconds before shutting down |
message | #optional Message to display to VM users before shutting down |
Since: 4.10.0
VM.snapshot:
Create a live snapshot of a VM's disks.
Arguments
snapDrives | A list of disk snapshot creation instructions |
Since: 4.10.0
Volume.copy:
Duplicate a volume to produce a new template image.
Arguments
dstSdUUID | The UUID of the destination Storage Domain |
dstImgUUID | The UUID of the destination Image |
dstVolUUID | The UUID of the destination Volume |
desc | Set the destination Volume description |
volType | (Unused) The role of the destination Volume |
volFormat | The data format to use for the destination Volume |
preallocate | The Volume allocation mode |
postZero | If @force is set and @dstVolUUID exists, zero the destination Volume before copying new data |
force | If @dstVolUUID already exists, overwrite it |
Notes:
If the source Volume has ancestors they will be collapsed in the
destination to form a standalone template Volume.
Since: 4.10.0
Volume.create:
Create a new Volume.
Arguments
size | The Volume size in sectors |
volFormat | The data format to use for the destination Volume |
preallocate | The Volume allocation mode |
diskType | An advisory disk usage type |
desc | The Volume description |
srcImgUUID | If specified, create a snapshot from this Image |
srcVolUUID | If specified, create a snapshot from this Volume |
Since: 4.10.0
Volume.delete:
Delete a Volume.
Arguments
postZero | Zero Volume data before deletion |
force | Remove even if @VolumeRole is SHARED or INTERNAL |
Since: 4.10.0
Volume.extend:
Increase the size of a Volume.
Notes:
Valid for block-based Volumes only
Since: 4.10.0
Volume.getInfo:
Get information about a Volume.
Returns
info | Volume information |
Since: 4.10.0
Volume.getPath:
Get the path to the Volume in the host's storage repository.
Returns
path | The Volume's storage repository path |
Since: 4.10.0
Volume.getSize:
Get Volume size information.
Returns
apparentsize | The size of the Volume (in bytes) |
truesize | The amount of underlying storage allocated (in bytes) |
Since: 4.10.0
Volume.prepare:
Make a Volume accessible.
Arguments
rw | If True, the Volume should be made writeable, otherwise read-only |
Since: 4.10.0
Volume.refresh:
Refresh Volume to synchronize changes made by a remote host.
Since: 4.10.0
Volume.setDescription:
Set the Volume description field.
Arguments
description | A human-readable Volume description |
Since: 4.10.0
Volume.setLegality:
Set the legality of a Volume.
Arguments
legality | The new Volume legality |
Since: 4.10.0
Volume.tearDown:
Deactivate the Volume and release resources.
Since: 4.10.0
Global.init:
Initialize a Global API object.
Since: 4.10.0
UUID:
A universally unique identifier in RFC 4122 format.eg. "407cb255-34be-432c-be7c-eb43b8de82be"
Since: 4.10.0
NetworkOptions:
Detailed network configuration options.
Members
ipaddr | #optional Assign this static IP address to the interface |
netmask | #optional The netmask of this subnet |
gateway | #optional IP address of the network gateway |
bootproto | #optional Interface autoconfiguration protocol (typically 'dhcp' or 'static') |
delay | #optional The time to wait before starting the interface |
onboot | #optional Start the interface automatically during boot |
bondingOptions | #optional A string of space-separated <option>=<value> pairs |
skipLibvirt | #optional Do not use libvirt to gather network information |
Since: 4.10.0
SetupNetworkNetAttributes:
Configuration attributes for a single host network.
Members
vlan | #optional The name of an associated vlan |
bonding | #optional If the network is bonded, the name of the bond device |
nic | #optional If the network is not bonded, an array containing a single network device name |
ipaddr | #optional Assign this static IP address to the network |
netmask | #optional Assign this netmask to the network |
gateway | #optional Assign this gateway to the network |
bootproto | #optional Interface autoconfiguration protocol (typically 'dhcp' or 'static') |
delay | #optional The time to wait before starting the network device |
onboot | #optional Start the network device automatically during boot |
remove | #optional If True, remove existing network only |
Since: 4.10.0
SetupNetworkBondAttributes:
Configuration attributes for a single bonded network interface device.
Members
nics | An array of network device names to include in the bond |
options | #optional A string of space-separated <option>=<value> pairs |
remove | #optional If True, remove existing bond only |
Since: 4.10.0
SetupNetworkOptions:
Additional options for setupNetworks.
Members
force | #optional If True, skip validation of the configuration |
connectivityCheck | #optional After reconfiguration, check for network connectivity and roll back if necessary |
connectivityTimeout | #optional The amount of time to wait before failing the connectivity check in seconds |
Since: 4.10.0
SetupNetworkNetConfig:
A mapping of network bridge configuration attributes indexed by bridge name.
Since: 4.10.0
SetupNetworkBondConfig:
A mapping of bond device configuration attributes indexed by bond name.
Since: 4.10.0
FenceNodeAction:
Specifies the type of fencing operation to perform.
Values
status | Just fetch the current power status |
on | Turn on the remote host |
off | Shut down the remote host |
reboot | Reboot the remote host |
Since: 4.10.0
FenceNodePowerStatus:
Indicates the power state of a remote host.
Values
on | The remote host is powered on |
off | The remote host is powered off |
unknown | The power status is not known |
Since: 4.10.0
TaskInfo:
Extra information about a task.
Members
id | The @UUID of the task |
verb | The underlying operation to be performed by the task |
Since: 4.10.0
TasksInfo:
A mapping of Task information indexed by Task UUID.
Since: 4.10.0
TaskState:
An enumeration of possible task states.
Values
unknown | The state of the task is not known |
init | The task is initializing |
running | The task is currently executing |
finished | The task has finished executing |
aborting | The task has been interrupted by a user has encountered an error |
cleaning | The task has failed and recovery actions are underway |
Since: 4.10.0
TaskResult:
An enumeration of the possible final task results.
Values
success | The task was successful |
cleanSuccess | The task failed but was successfully recovered |
cleanFailure | The task failed and recovery also failed |
Since: 4.10.0
TaskStatus:
A collection of status information about a task.
Members
taskID | The task @UUID |
taskState | Current task state (@TaskState) |
taskResult | Final task result (@TaskResult) |
message | Detailed error message from the underlying task verb |
code | Return code from the underlying task verb |
Since: 4.10.0
TasksStatus:
A mapping of Task statuses indexed by Task UUID.
Since: 4.10.0
BoolStr:
A string that can be interpreted as a boolean value.
Values
True | True |
False | False |
Since: 4.10.0
BoolStrLower:
A string that can be interpreted as a boolean value. This value conforms toJSON and XML which require lowercase names.
Values
true | True |
false | False |
Since: 4.10.0
BoolOnOff:
A string that can be interpreted as a boolean value.
Since: 4.10.0
IntStr:
A string that can be converted into an integer.
Since: 4.10.0
FloatStr:
A string that can be converted into an float.
Since: 4.10.0
HexStr:
A string in hexidecimal format.
Since: 4.10.0
StringMap:
A mapping between arbitrary strings.
Since: 4.10.0
NetInfoBridgedNetwork:
Information about a VDSM bridged network.
Members
ports | A list of nic device names that are bridged |
stp | Spanning Tree Protocol status for the bridge device |
addr | The IP address assigned to the bridge device |
netmask | The netmask of the defined subnet |
gateway | The IP address of the subnet's gateway |
mtu | The Maximum Transmission Unit size for the bridge device |
cfg | A map containing network interface parameters from ifcfg-* files. It is indexed by parameter name and stores the parameter value. |
bridged | Always True to distinguish this type from @NetInfoBridgelessNetwork |
Since: 4.10.0
NetInfoBridgelessNetwork:
Information about a VDSM bridgeless network.
Members
interface | The network device name associated with the network |
bridged | Always False to distinguish this type from @NetInfoBridgedNetwork |
Since: 4.10.0
NetInfoNetwork:
A discriminated record to store information about a VDSM network.
Since: 4.10.0
NetInfoNic:
Information about a network interface card.
Members
speed | The reported speed of the nic |
addr | The IP address assigned to the nic |
netmask | The netmask of the defined subnet |
hwaddr | The Media Access Control address being used by the nic |
mtu | The Maximum Transmission Unit size for the nic |
permhwaddr | #optional For bonded nics: the real MAC address which will be used if the card is freed from the bond. |
Since: 4.10.0
NetInfoBond:
Information about a ethernet bond device
Members
slaves | A list of devices that are enslaved to the bond device |
addr | The IP address assigned to the bond |
netmask | The netmask of the defined subnet |
hwaddr | The Media Access Control address being used by the bond device |
cfg | Raw device configuration parameters (@NetInfoIfaceCfg) |
mtu | The Maximum Transmission Unit size for the nic |
Since: 4.10.0
NetInfoVlan:
Information about a Virtual Local Area Network
Members
iface | The network device associated with the vlan |
addr | The IP address assigned to the vlan device |
netmask | The netmask of the defined subnet |
mtu | The Maximum Transmission Unit size for the vlan |
Since: 4.10.0
HookScriptInfo:
Information about one script within a hook.
Members
md5 | The md5 sum of the script |
Since: 4.10.0
OSName:
An enumeration of recognized operating system names.
Values
unknown | The operating system could not be detected |
oVirt Node | oVirt Node standalone hypervisor |
RHEL | Red Hat Enterprise Linux |
Fedora | Fedora Linux |
RHEV Hypervisor | Red Hat Enterprise Virtualization Hypervisor |
Debian | A Debian-based distribution (including Ubuntu) |
Since: 4.10.0
OsVersion:
Host operating system version information.
Members
release | The release number for this @version |
version | The OS version (eg. 17 for Fedora 17) |
name | The name of the OS |
Since: 4.10.0
SoftwarePackage:
An enumeration of aliases for important software components.
Values
kernel | The Linux kernel |
qemu-kvm | Qemu virtual machine emulator |
qemu-img | Qemu VM disk image manipulation utility |
vdsm | Virtual Desktop and Server Manager (this software) |
spice-server | The server for SPICE protocol |
libvirt | Low level virtualization API |
Since: 4.10.0
SoftwarePackageInfo:
Information about an installed piece of software.
Members
version | The software version |
release | The release number for this @version |
buildtime | The time and date the software was built |
Since: 4.10.0
IscsiHba:
Information about an iSCSI host bus adapter.
Since: 4.10.0
FcHba:
Information about a FibreChannel host bus adapter.
Members
wwpn | World-wide port name |
wwnn | World-wide node name |
model | Model of installed FibreChannel card |
Since: 4.10.0
HbaInventory:
Information about all available host bus adapters.
Members
iSCSI | List of iSCSI HBAs |
FC | List of FibreChannel HBAs |
Since: 4.10.0
VmType:
Enumeration of supported virtual machine types.
Values
kvm | VM runs on Linux Kernel Virtual Machine |
Since: 4.10.0
NetInfoNetworkMap:
A mapping of vdsm Network information indexed by network name.
Since: 4.10.0
NetInfoNicMap:
A mapping of NIC information indexed by device name.
Since: 4.10.0
NetInfoBondMap:
A mapping of bond information indexed by device name.
Since: 4.10.0
NetInfoVlanMap:
A mapping of vlan information indexed by vlan tag.
Since: 4.10.0
HookScriptInfoMap:
A mapping of hook script information indexed by script name.
Since: 4.10.0
SoftwarePackageInfoMap:
A mapping of information indexed by software package name.
Since: 4.10.0
VdsmCapabilities:
Host information and capabilities.
Notes:
Since ovirt-engine cannot parse software versions in 'x.y.z' format,
the current API truncates @software_version to 'x.y'.
Since: 4.10.0
BlockDeviceType:
Enumeration of possible block device types.
Values
iSCSI | The device is pure iSCSI |
FCP | The device is purely FibreChannel |
MIXED | The device consists of a mix of iSCSI and FibreChannel paths |
Since: 4.10.0
BlockDevicePathState:
Enumeration of possible states for a block device path.
Values
active | The path is active |
failed | The path has failed |
Since: 4.10.0
BlockDevicePathInfo:
Information about a single block device path.
Members
physdev | The physical device name |
state | The current state of this path |
lun | The SCSI Logical Unit Number associated with this path |
type | The type of path (@BlockDeviceType) |
Since: 4.10.0
IscsiSessionInfo:
Information about a single, active iSCSI session.
Members
connection | The hostname of the iSCSI target |
port | The port number of the iSCSI target |
iqn | The ISCSI Qualified Name |
portal | The Target Portal Group Tag |
initiatorname | iSCSI initiator |
username | #optional A login name on the iSCSI target |
password | #optional The password corresponding to @username |
Since: 4.10.0
BlockDeviceInfo:
Block device information.
Members
GUID | The globally unique identifier of the block device |
pvUUID | The LVM physical volume associated with this device |
vendorID | A string identifying the device manufacturer |
productID | A string identifying the device model |
fwrev | Firmware version information |
serial | The device serial number |
capacity | The device size (in bytes) |
devtype | The type of storage device (@BlockDeviceType) |
pathstatus | Multipath information |
pathlist | iSCSI session information |
logicalblocksize | The logical block size of the device (in bytes) |
physicalblocksize | The physical block size of the device (in bytes) |
partitioned | Reports whether the device has been split into partitions |
Since: 4.10.0
DeviceVisibilityMap:
A mapping of boolean values indexed by block device GUID.
Since: 4.10.0
VolumeGroupState:
An enumeration of possible Volume Group states.
Values
OK | All Physical Volumes are online |
PARTIAL | One or more Physical Volumes are not available |
Since: 4.10.0
VolumeGroupAttributePermission:
An enumeration of possible values for the permission attribute.
Values
w | The Volume Group is writable |
r | The Volume Group is read-only |
Since: 4.10.0
VolumeGroupAttributeResizeable:
An enumeration of possible values for the resizeable attribute.
Values
- | The Volume Group is not resizeable |
z | The Volume Group is resizeable |
Since: 4.10.0
VolumeGroupAttributeExported:
An enumeration of possible values for the exported attribute.
Values
- | The Volume Group has not been exported |
x | The Volume Group has been exported |
Since: 4.10.0
VolumeGroupAttributePartial:
An enumeration of possible values for the partial status attribute.
Values
- | The Volume Group can access all of its Physical Volumes |
p | The Volume Group cannot access some Physical Volumes |
Since: 4.10.0
VolumeGroupAttributeAllocation:
An enumeration of possible values for the allocation policy attribute.
Values
c | Indicates a contiguous allocation policy |
n | Indicates a normal allocation policy |
i | Indicates that the allocation policy is inherited |
l | Indicates a cling allocation policy |
a | Indicates an anywhere allocation policy |
Since: 4.10.0
VolumeGroupAttributeClustered:
An enumeration of possible values for the clustered attribute.
Values
- | Indicates that clustered locking is disabled |
c | Indicates that clustered locking is enabled |
Since: 4.10.0
VolumeGroupAttributes:
A collection of Volume Group attributes.
Since: 4.10.0
VolumeGroupInfo:
Information about a Volume Group.
Members
name | The Volume Group name |
vgUUID | The uuid of the Volume Group |
vgsize | The total capacity (in bytes) |
vgfree | The amount of currently unassigned capacity (in bytes) |
type | The storage type of this Volume Group's Physical Volumes |
attr | Additional attributes |
state | The state of this Volume Group's underlying storage |
Since: 4.10.0
NetworkInterfaceState:
An enumeration of possible network interface states.
Values
up | The interface is active |
down | The interface is not active |
Since: 4.10.0
NetworkInterfaceStats:
Statistics about a single network interface.
Members
name | The network device name |
speed | The interface speed (in Megabits/s) |
rxDropped | The number of incoming packets that have been dropped |
txDropped | The number of outgoing packets that have been dropped |
rxErrors | The number of incoming packets that have contained errors |
txErrors | The number of outgoing packets that have contained errors |
state | Indicates whether the interface is currently active |
rxRate | The rate of incoming packets (as a percentage of @speed) |
txRate | The rate of outgoing packets (as a percentage of @speed) |
macAddr | The hardware address |
Since: 4.10.0
StorageDomainVitals:
Regularly collected Storage Domain vital statistics.
Members
code | Storage Domain status code |
delay | The amount of time it takes to read a small amount of data from the storage. |
lastCheck | Elapsed time since the Storage Domain was last checked |
valid | Indicates if the Storage Domain is functioning properly |
Since: 4.10.0
PathStats:
Statistics about a host filesystem path.
Members
free | The amount of free space remaining (in MB) |
Since: 4.10.0
THPStates:
An enumeration of possible states for the Transparent Huge Pages feature.
Values
always | All memory regions will be scanned |
madvise | Only memory regions indicated by a call to madvise will be scanned |
never | No memory regions will be scanned |
Since: 4.10.0
NetworkInterfaceStatsMap:
A mapping of interface stats indexed by device name.
Since: 4.10.0
StorageDomainVitalsMap:
A mapping of Storage Domain vital statistics indexed by Storage Domain UUID.
Since: 4.10.0
PathStatsMap:
A mapping of filesystem statistics indexed by mount point.
Since: 4.10.0
HostStats:
Statistics about this host.
Members
cpuUser | Ratio of CPU time spent in userspace |
cpuSys | Ratio of CPU time spent in kernel |
cpuIdle | Ratio of CPU time spent idle |
rxRate | Incoming packet rate (as a percentage of total capacity) |
txRate | Outgoing packet rate (as a percentage of total capacity) |
statsAge | Seconds elapsed since the stats were last sampled |
network | Per-interface network statistics |
rxDropped | The number of incoming packets dropped |
txDropped | The number of outgoing packets dropped |
cpuSysVdsmd | Ratio of CPU time spent in kernel by vdsm |
cpuUserVdsmd | Ratio of CPU time spent in userspace by vdsm |
storageDomains | Storage Domain vital statistics |
elapsedTime | The number of seconds that vdsm has been running |
memUsed | The percentage of memory used (not including caches) |
anonHugePages | The amount of anonymous memory in huge pages (in MB) |
cpuLoad | The 5 minute CPU load average |
diskStats | Statistics about paths on the host filesystem |
thpState | Current mode of the Transparent Huge Pages feature |
Since: 4.10.0
StorageDomainClass:
An enumeration of Storage Domain classes.
Values
Unknown | The class is not known |
Data | The Storage Domain is used for virtual machine disk images |
Iso | The Storage Domain is used for storing ISO images |
Backup | The Storage Domain is used for import and export of disk images |
Since: 4.10.0
StorageDomainType:
An enumeration of Storage Domain types.
Values
UNKNOWN | The type is not known |
NFS | The Storage Domain uses Network File System based storage |
FCP | The Storage Domain uses FibreChannel based storage |
ISCSI | The Storage Domain uses iSCSI based storage |
LOCALFS | The Storage Domain uses storage on the local file system |
CIFS | The Storage Domain uses CIFS/SMB based storage |
SHAREDFS | The Storage Domain uses storage from a Linux VFS file system |
Since: 4.10.0
VmStatus:
An enumeration of possible virtual machine statuses.
Values
Down | The VM is powered off |
Migration Destination | The VM is migrating to this host |
Migration Source | The VM is migrating away from this host |
Paused | The VM is paused |
Powering down | A shutdown command has been sent to the VM |
RebootInProgress | The VM is currently rebooting |
Restoring state | The VM is waking from hibernation |
Saving State | The VM is preparing for hibernation |
Up | The VM is running |
WaitForLaunch | The VM is being created |
Since: 4.10.0
VmDisplayType:
An enumeration of VM display modes.
Values
vnc | Graphical VM interaction is available via the VNC protocol |
qxl | Graphical VM interaction is available via SPICE |
Since: 4.10.0
VmDeviceType:
An enumeration of VM device types.
Values
disk | A hard disk, floppy, or cdrom device |
interface | A network interface |
video | A video card |
sound | A sound card or PC speaker |
controller | An internal controller that usually provides a bus |
balloon | A memory balloon device |
channel | A host-guest communication channel |
Since: 4.10.0
VmDiskDeviceType:
An enumeration of VM disk device types.
Values
disk | A hard disk drive |
cdrom | A CD-ROM drive (always readonly) |
floppy | A floppy disk drive |
Since: 4.10.0
VmDiskDeviceInterface:
An enumeration of VM disk device interfaces.
Values
ide | The device is connected via an emulated IDE bus |
virtio | The device uses a virtio para-virtualized interconnect |
fdc | The device is connected to an emulated floppy disk controller |
Since: 4.10.0
VmDiskDeviceFormat:
An enumeration of VM disk device formats.
Values
raw | Raw data is written directly to backing storage |
cow | Data is written using the Qemu qcow format |
Since: 4.10.0
VmDeviceAddressType:
An enumeration of VM device address types.
Values
pci | The address describes a location on an PCI bus |
drive | The address describes a location on an IDE bus |
virtio-serial | Describes a location on a virtio-serial controller |
Since: 4.10.0
VmDevicePciAddress:
Device address for a PCI device.
Members
type | The device type (always @pci) |
slot | The slot number on the PCI bus |
bus | The PCI bus number |
domain | The PCI domain |
function | Function number on the PCI card that implements the device |
Since: 4.10.0
VmDeviceIdeAddress:
Device address for an IDE device.
Members
type | The device type (always @drive) |
controller | The IDE controller number |
bus | The IDE bus number |
unit | The unit number on the IDE bus |
Since: 4.10.0
VmDeviceVirtioSerialAddress:
Device address for a virtio-serial port.
Members
type | The device type (always @virtio-serial) |
controller | The virtio-serial controller number |
bus | The virtio-serial bus number |
port | The port number on the virtio-serial bus |
Since: 4.10.0
VmDeviceAddress:
A discriminated record of device address information.
Since: 4.10.0
VmDiskDeviceSpecParams:
Extra parameters for VM disk devices.
Members
path | #optional The filesystem path to the disk image |
Since: 4.10.0
VmDiskDeviceVolumeChainEntry:
Identifies one volume in a VM disk device volume chain.
Members
domainID | The UUID of the storage domain that contains the volume |
imageID | The UUID of the image that contains the volume |
path | The filesystem path to the volume |
volumeID | The UUID of the volume itself |
Since: 4.10.0
VmDiskDevice:
Properties of a VM disk device.
Members
type | The device type (always @disk) |
device | The disk device type (eg. @cdrom or @disk) |
iface | #optional Indicates the device connection method exposed to the guest |
path | #optional The filesystem path to the drive's volume |
readonly | Indicates if writes are prohibited for the device |
bootOrder | #optional If specified, this device is part of the boot sequence at the specified position |
domainID | #optional The UUID of the underlying Storage Domain object |
poolID | #optional The UUID of the underlying Storage Pool object |
imageID | #optional The UUID of the underlying Image object |
volumeID | #optional The UUID of the underlying Volume object |
format | The format used to store data on the backing storage |
propagateErrors | If enabled, disk I/O errors will be reported to vdsm for possible resolution (eg. allocating more space) |
address | Device hardware address |
alias | Alias used to identify this device in commands |
deviceId | A unique ID for this device |
specParams | #optional Additional device parameters |
apparentsize | The size of the disk (in bytes) |
index | The drive index |
name | A user-friendly device name for display only |
needExtend | Indicates whether an underlying block device needs to be expanded to accomodate growing disk allocation |
optional | States if the VM may start if the disk is not present |
reqsize | The most recently requested drive size (in bytes) |
shared | Indicates if this disk is intended to be shared by multiple virtual machines |
truesize | The amount of underlying storage allocated (in bytes) |
volumeChain | The sequence of Volume objects needed to construct the disk |
baseVolumeID | #optional When used as a parameter to @VM.merge, indicates the Volume that should become the new base volume |
Since: 4.10.0
VmInterfaceDeviceType:
An enumeration of VM network device types.
Values
bridge | The device is connected via a host bridge device |
Since: 4.10.0
VmInterfaceDeviceModel:
An enumeration of VM network device models.
Values
pv | Alias for @virtio |
virtio | Paravirtual network interface |
ne2k_pci | Emulated Realtek(R) PCI NIC |
i82551 | Emulated Intel(R) 82551ER NIC |
i82557b | Emulated Intel i82557B NIC |
i82559er | Emulated Intel i82559ER NIC |
rtl8139 | Emulated rtl8139 NIC |
e1000 | Emulated Intel(R) Gigabit Ethernet NIC |
pcnet | Emulated AMD(R) PC-Net II NIC |
Since: 4.10.0
VmInterfaceDeviceSpecParams:
Additional VM interface device parameters.
Since: 4.10.0
VmInterfaceDevice:
Properties of a VM network interface device.
Members
type | The device type (always @interface) |
device | The host network device type used to create the connection |
nicModel | The type of device that is exposed to the VM operating system |
macAddr | The unique ethernet hardware address of the device |
network | The name of the attached host bridge device |
bootOrder | #optional If specified, this device is part of the boot sequence at the specified position |
address | Device hardware address |
alias | Alias used to identify this device in commands |
deviceId | A unique ID for this device |
specParams | #optional Additional device parameters |
Since: 4.10.0
VmVideoDeviceType:
An enumeration of VM video device types.
Values
cirrus | An emulated Cirrus Logic GD5446 video card |
std | An emulated standard VESA 2.0 VBE video card |
vmware | A paravirtualized VGA video device from VMWare(R) |
qxl | A paravirtualized video device meant for use with SPICE |
none | No video device is emulated |
Since: 4.10.0
VmVideoDeviceSpecParams:
Additional parameters for VM video devices.
Members
vram | #optional Specify the amount of video RAM available to the device in KB. Currently relevant for @qxl devices only |
Since: 4.10.0
VmVideoDevice:
Properties of a VM video device.
Members
type | The device type (always @video) |
device | The type of video device exposed to the VM operating system |
address | Device hardware address |
alias | Alias used to identify this device in commands |
deviceId | A unique ID for this device |
specParams | #optional Additional device parameters |
Since: 4.10.0
VmSoundDeviceType:
An enumeration of VM sound device types.
Values
ac97 | An emulated Intel 82801AA AC97 Audio card |
pcspk | An emulated PC speaker |
sb16 | An emulated Creative Labs Sound Blaster 16 card |
es1370 | An emulated ENSONIQ AudioPCI ES1370 card |
hda | An emulated Intel High-Definition Audio card |
ich6 | An emulated Intel ICH6 card |
Since: 4.10.0
VmSoundDeviceSpecParams:
Additional parameters for VM sound devices.
Since: 4.10.0
VmSoundDevice:
Properties of a VM sound device.
Members
type | The device type (always @sound) |
device | The type of sound hardware exposed to the VM operating system |
address | Device hardware address |
alias | Alias used to identify this device in commands |
deviceId | A unique ID for this device |
specParams | #optional Additional device parameters |
Since: 4.10.0
VmControllerDeviceType:
An enumeration of VM controller device types.
Values
ide | An IDE controller |
fdc | A floppy disk controller |
scsi | A SCSI controller |
sata | A Serial ATA controller |
usb | A USB controller |
ccid | A ccid (smart card) controller |
virtio-serial | A virtio-serial controller |
Since: 4.10.0
VmControllerDevice:
Properties of a VM controller device.
Members
type | The device type (always @controller) |
device | The specific type of controller device |
address | Device hardware address |
alias | Alias used to identify this device in commands |
deviceId | A unique ID for this device |
Since: 4.10.0
VmBalloonDeviceType:
An enumeration of VM balloon device types.
Values
memballoon | A memory balloon |
Since: 4.10.0
VmBalloonDeviceModel:
An enumeration of VM balloon device models.
Values
none | Indicates that no device is present |
virtio | A balloon implemented using the virtio specification |
Since: 4.10.0
VmBalloonDeviceSpecParams:
Additional parameters for VM balloon devices.
Members
model | The balloon device model in use |
Since: 4.10.0
VmBalloonDevice:
Properties of a VM balloon device.
Members
type | The device type (always @balloon) |
device | The the type of balloon device |
address | Device hardware address |
alias | Alias used to identify this device in commands |
specParams | #optional Additional device parameters |
deviceId | A unique ID for this device |
Since: 4.10.0
VmChannelDeviceType:
An enumeration of VM channel device types.
Values
unix | The host end of the channel is a unix socket |
spicevmc | This channel is used for SPICE communication |
Since: 4.10.0
VmChannelDevice:
Properties of a VM channel device.
Members
type | The device type (always @channel) |
device | The specific type of channel device |
address | Device hardware address |
alias | Alias used to identify this device in commands |
deviceId | A unique ID for this device |
Since: 4.10.0
VmDevice:
A discriminated record containing VM device properties.
Since: 4.10.0
VmShortStatus:
Abbreviated virtual machine status.
Members
vmId | The UUID of the VM |
status | The current status of the VM |
Since: 4.10.0
VmFullStatus:
Full virtual machine status and properties.
Members
acpiEnable | Indicates if ACPI is enabled inside the VM |
clientIp | The IP address of the client connected to the display |
cpuType | The type of CPU being emulated |
custom | A dictionary of custom, free-form properties |
devices | An array of VM devices present |
display | The type of display |
displayIp | The IP address to use for accessing the VM display |
displayPort | The port in use for unencrypted display data |
displaySecurePort | The port in use for encrypted display data |
emulatedMachine | The specific machine specification being emulated |
keyboardLayout | The keyboard layout string (eg. 'en-us') |
kvmEnable | Indicates if KVM hardware acceleration is enabled |
memSize | The amount of memory assigned to the VM in MB |
nicModel | A comma-separated list of NIC models in use by the VM |
nice | The host scheduling priority |
pauseCode | Indicates the reason a VM has been paused |
pid | The process ID of the underlying qemu process |
smp | The number of CPUs presented to the VM |
smpCoresPerSocket | #optional Indicates the number of CPU cores per socket |
smpThreadsPerCore | #optional Indicates the number of CPU threads per core |
status | The current VM status |
timeOffset | The time difference from host to the VM in seconds |
transparentHugePages | Indicates if the Transparent Huge Pages feature is enabled for this virtual machine |
vmId | The VM UUID |
vmName | The VM name |
vmType | The type of VM |
Since: 4.10.0
VmDefinition:
A discriminated record containing virtual machine status information.
Since: 4.10.0
LoggingLevel:
An enumeration of logging verbosity levels.
Values
DEBUG | Log everything (including debugging messages) |
INFO | Log informational messages and anything more severe |
WARNING | Log warning messages and anything more severe |
ERROR | Log error messages and anything more severe |
CRITICAL | Log only critical messages |
Since: 4.10.0
ConnectionRefs.init:
Initialize a ConnectionRefs API object.
Since: 4.10.0
IscsiPortal:
A host/port pair that identifies an ISCSI target.
Members
host | A fully-qualified domain name (FQDN) or IP address |
port | #optional A port number |
Since: 4.10.0
IscsiCredentialsLogin:
Login credentials for an ISCI target.
Members
username | The username used for authentication to an ISCI target |
password | The password associated with the given username |
Since: 4.10.0
IscsiCredentialsType:
An enumeration of ISCSI login credentials types.
Values
chap | Challenge-Handshake Authentication Protocol |
Since: 4.10.0
IscsiCredentials:
This structure stores ISCSI credentials.
Members
type | #optional The type of authentication to be used |
params | Type-specific authentication credentials |
Since: 4.10.0
IscsiConnectionParameters:
Parameters for initiating a new ISCSI connection.
Members
portal | An @IscsiPortal to identify the requested target |
iqn | The ISCSI Qualified Name |
tpgt | #optional The Target Portal Group Tag to use |
iface | #optional The ISCSI interface name |
credentials | #optional An @IscsiCredentials containing the required authentication information |
Since: 4.10.0
PosixFsConnectionParameters:
Parameters for initiating a new POSIX FS connection.
Members
spec | A string identifying the location of the target filesystem |
vfstype | The Linux VFS filesystem type |
options | #optional A comma-separated list of mount options |
Since: 4.10.0
NfsConnectionParameters:
Parameters for initiating a new NFS connection.
Members
export | The remote target in <host>:<path> format |
retrans | #optional The number of retry attempts for failing operations |
timeout | #optional The time to wait before retrying a request (specified in tenths of one second). |
version | #optional Set the NFS protocol version |
Since: 4.10.0
LocalFsConnectionParameters:
Parameters for initiating a connection to local storage.
Members
path | The local filesystem path |
Since: 4.10.0
ConnectionRefParameters:
A discriminated record of parameters used to establish a ConnectionRef.
Since: 4.10.0
ConnectionRefType:
An enumeration of @ConnectionRef types.
Values
iscsi | Storage exported by a remote ISCSI target |
posixfs | Storage available through use of the 'mount' command |
nfs | Storage exported by a remote NFS server |
localfs | Storage available in the host's local file hierarchy |
Since: 4.10.0
ConnectionRefArgs:
Structure to store @ConnectionRef arguments.
Members
type | The type of connection (one of @ConnectionRefType) |
params | An @ConnectionRefParameters structure appropriate for @type |
Since: 4.10.0
ConnectionError:
A tuple containing @ConnectionRef error information.
Members
0 | The error code |
1 | The error message |
Since: 4.10.0
ConnectionRef:
Contains the details of a registered storage connection.
Members
connected | Indicates whether the storage is connected |
lastError | The most recent error information (@ConnectionError) |
connectionInfo | Type-specific connection details (@ConnectionRefParameters) |
Since: 4.10.0
ConnectionRefArgsMap:
A mapping of connection arguments indexed by ConnectionRef UUID.
Since: 4.10.0
ConnectionRefArgsStatusMap:
A mapping of status codes indexed by ConnectionRef UUID.
Since: 4.10.0
ConnectionRefMap:
A mapping of ConnectionRef information indexed by UUID.
Since: 4.10.0
ISCSIConnection.init:
Initialize a ISCSIConnection API object.
Since: 4.10.0
Image.init:
Initialize an Image API object.
Since: 4.10.0
ImageMoveOperation:
An enumeration of Image move operations.
Values
UNKNOWN | This operation is invalid |
COPY | The Image is copied to the destination |
MOVE | The Image is copied to the destination and removed from the source |
Since: 4.10.0
LVMVolumeGroup.init:
Initialize an LVMVolumeGroup API object.
Since: 4.10.0
StorageDomain.init:
Initialize a StorageDomain API object.
Since: 4.10.0
StorageDomainCreateArgumentsBlock:
Creation argument for Block-based Storage Domains.
Members
vgUUID | The UUID of a Volume Group to use as backing storage |
Since: 4.10.0
StorageDomainCreateArgumentsLocal:
Creation argument for local filesystem Storage Domains.
Since: 4.10.0
StorageDomainCreateArgumentsNfs:
Creation argument for NFS-based Storage Domains.
Members
remotePath | An export path in the form: <host>:<path> |
Since: 4.10.0
StorageDomainCreateArguments:
A discriminated record of Storage Domain creation parameters.
Since: 4.10.0
StorageDomainFileStats:
Information about files contained within a Storage Domain.
Members
size | Size of the file in bytes |
ctime | Time the file was last changed in seconds since the epoch |
status | Indicates if the file is accessible |
Since: 4.10.0
StorageDomainFileStatsMap:
A mapping of Storage Domain file statistics indexed by filename.
Since: 4.10.0
StorageDomainRole:
An enumeration of possible Storage Domain roles.
Values
Master | The Storage Domain contains Storage Pool metadata |
Regular | The Storage Domain is not a Master domain |
Since: 4.10.0
StorageDomainInfo:
Information about a Storage Domain.
Members
uuid | The Storage Domain UUID |
type | The type of backing storage used by this domain |
class | The Storage Domain class |
name | The human-readable name for this Storage Domain |
role | The Storage Domain role |
pool | The Storage Pool associated with this Storage Domain |
version | The version of this Storage Domain |
lver | The lock version of the associated Storage Pool |
spm_id | Contains the Host ID of the Storage Pool Manager |
master_ver | The version of the master Storage Domain |
Since: 4.10.0
StorageDomainStats:
Storage Domain statistics.
Members
disktotal | The amount of total storage space in bytes |
diskfree | The amount of free storage space in bytes |
mdasize | The size of the metadata area in bytes |
mdafree | The amount of free space in the metadata area in bytes |
mdavalid | Indicates if the metadata area is large enough |
mdathreshold | Indicates if the metadata has exceeded its size threshold |
Since: 4.10.0
UploadVolumeMethod:
An enumeration of uploadVolume methods.
Values
wget | Fetch data using the wget command |
rsync | Fetch data using the rsync command |
Since: 4.10.0
StoragePool.init:
Initialize a StoragePool API object.
Since: 4.10.0
ConnectStorageServerStatus:
Status of a single storage server connection attempt.
Members
id | Connection UUID |
status | Status code |
Since: 4.10.0
SpmRole:
An enumeration of Storage Pool Manager roles that are valid for a host.
Values
SPM | The host has the SPM role |
Contend | The host is contending for the SPM role |
Free | The host does not have the SPM role |
Since: 4.10.0
SpmStatus:
Storage Pool Manager status information.
Members
spmStatus | The SPM role for this host |
spmLver | The lock version of the Storage Pool |
spmId | The Host ID of the Storage Pool Manager |
Since: 4.10.0
OVFMap:
A mapping of OVF data indexed by VM UUID.
Since: 4.10.0
StoragePoolStatus:
An enumeration of Storage Pool statuses.
Values
uninitialized | The Storage Pool has not been initialized |
connected | Vdsm is connected to the Storage Pool |
Since: 4.10.0
StoragePoolInfo:
Information about a Storage Pool.
Members
type | The type of storage managed by this Storage Pool |
name | The Storage Pool name |
domains | All associated Storage Domains (the string has the following format: '<uuid>:<status>,<uuid>:<status>...' |
master_uuid | The UUID of the Storage Domain serving as the master domain |
master_ver | The Storage Domain version of the master domain |
lver | The Storage Pool lock version |
spm_id | The Host ID of the host that is acting Storage Pool Manager |
isoprefix | The filesystem path from where ISO images may be referenced |
pool_status | The current status of the Storage Pool |
version | The Storage Pool version |
Since: 4.10.0
StoragePoolDomainAlert:
Alert information for a Storage Domain attached to this Storage Pool.
Members
code | The alert code |
message | A detailed alert string |
Since: 4.10.0
StorageDomainStatus:
An enumeration of Storage Domain statuses.
Values
Unknown | The status of the Storage Domain is not known |
Attached | The domain is attached to a Storage Pool but is deactivated |
Unattached | The domain is not attached to a Storage Pool |
Active | The domain is attached to a Storage Pool and is activated |
Since: 4.10.0
StoragePoolDomainInfo:
Information about a Storage Domain that is attached to a Storage Pool.
Members
disktotal | The total amount of disk space in the Storage Domain in bytes |
diskfree | The remaining free disk space in bytes |
alerts | A list of alerts for this Storage Domain |
status | Current Storage Domain status |
Since: 4.10.0
StoragePoolDomainInfoMap:
A mapping of active Storage Domain information indexed by Storage Domain UUID.
Since: 4.10.0
ImagePostZeroMap:
A mapping of postZero selectors indexed by Image UUID.
Since: 4.10.0
StorageDomainStatusMap:
A mapping of Storage Domain statuses indexed by Storage Domain UUID.
Since: 4.10.0
StoragePoolUpgradeStatus:
An enumeration of Storage Pool upgrade job statuses.
Values
started | The upgrade process has started |
Since: 4.10.0
StorageServerConnectionValidateParams:
Validation parameters for a connection to backing storage.
Members
id | A UUID to identify this set of parameters in the return value |
Notes:
Deprecated since 4.10.0
Since: 4.10.0
StorageServerConnectionValidateStatus:
indicates validity of backing storage connection parameters.
Members
id | A UUID to identify this set of parameters |
status | Code indicating the validity of the parameters |
Notes:
Deprecated since 4.10.0
Since: 4.10.0
UpdateVmDefinition:
Virtual machine definition data suitable for saving to a Storage Domain.
Members
vm | The VM UUID |
ovf | The VM definition in OVF format |
imglist | The Images this VM depends on (a comma-separated string of UUIDs) |
Since: 4.10.0
Task.init:
Initialize a Task API object.
Since: 4.10.0
VM.init:
Initialize a VM API object.
Since: 4.10.0
DriveSpecVolume:
A drive specification that refers to a Volume managed by Vdsm.
Members
device | The disk device type (should be @disk) |
domainID | The Storage Domain containing the Volume |
poolID | The Storage Pool containing the Volume |
imageID | The Image associated with the Volume |
volumeID | The UUID of the target Volume |
Since: 4.10.0
DriveSpecGUID:
A drive specification using a device mapper GUID.
Members
GUID | The devmapper device GUID |
Since: 4.10.0
DriveSpecUUID:
A drive specification using a blkid UUID.
Members
UUID | The device blkid |
Since: 4.10.0
DriveVmPayload:
Directly specified data to be inserted into a VM.
Members
file | A dictionary of file contents indexed by filename |
Since: 4.10.0
DrivePayload:
The detailed specification of the image contents
Members
vmPayload | Specifies data to be inserted into the VM Disk |
Since: 4.10.0
DriveSpecPayload:
A drive specification that describes the exact image contents.
Members
device | The type of disk device being created |
specParams | Additional drive parameters (including the payload information) |
Since: 4.10.0
DriveSpecPath:
A drive specification using a filesystem path to an image file.
Members
path | The full filesystem path to the image file |
Since: 4.10.0
DriveSpec:
A discriminated record containing a VM drive specification
Since: 4.10.0
VmExitCode:
An enumeration of final VM exit status codes.
Values
NORMAL | The VM has exited gracefully |
ERROR | The VM has terminated with errors |
Since: 4.10.0
ExitedVmStats:
Statistics about a VM that no longer running.
Members
exitCode | Code indicating whether the VM exit was normal or in error |
status | The current VM status |
exitMessage | Detailed reason for the virtual machine exit |
timeOffset | #optional The time difference from host to the VM in seconds |
Since: 4.10.0
VmDiskStats:
Statistics about a virtual machine disk device.
Members
truesize | The amount of underlying storage allocated (in bytes) |
apparentsize | The size of the disk (in bytes) |
imageID | The UUID of the Image associated with this disk |
readRate | The read activity in bytes per second |
writeRate | The write activity in bytes per second |
readLatency | The latency of read operations in nanoseconds |
writeLatency | The latency of write operations in nanoseconds |
flushLatency | The latency of flush operations in nanoseconds |
Since: 4.10.0
VmBootMode:
An enumeration of VM boot modes.
Values
a | Boot from the first floppy device |
c | Boot from the first hard disk |
d | Boot from the first cdrom device |
n | Boot from the network |
Since: 4.10.0
GuestMemoryStats:
Memory statistics as reported by the guest agent.
Members
mem_total | The total amount of memory available to the OS (in KB) |
mem_unused | The amount of memory that is completely unused (in KB) |
mem_free | The amount of memory available for allocation in KB (includes easily reclaimable memory) |
swap_in | The number of memory pages swapped in since the last collection |
swap_out | The number of memory pages swapped out since the last collection |
pageflt | The number of page faults since the last collection |
majflt | The number of major page faults since the last collection |
Since: 4.10.0
GuestMountInfo:
Information about a mounted filesystem as reported by the guest agent.
Members
path | The filesystem mount point |
fs | The filesystem type |
total | The total amount of space on the filesystem in bytes |
used | The amount of free space on the filesystem in bytes |
Since: 4.10.0
GuestNetworkDeviceInfo:
Information about a VM network device as reported by the guest agent.
Members
name | The network device name |
hw | The MAC address |
inet | The IPv4 address |
inet6 | The IPv6 address |
Since: 4.10.0
GuestSessionState:
An enumeration of user session states.
Values
Unknown | The session state is not known |
UserLoggedOn | A user has logged in |
Locked | The display is locked |
Active | The display has been unlocked |
LoggedOff | A user has logged off |
Since: 4.10.0
VmDiskStatsMap:
A mapping of VM disk statistics indexed by device name.
Since: 4.10.0
RunningVmStats:
Statistics for a running virtual machine.
Members
displayPort | The port in use for unencrypted display data |
displaySecurePort | The port in use for encrypted display data |
displayType | The type of display in use |
displayIp | The IP address to use for accessing the VM display |
pid | The process ID of the underlying qemu process |
vmType | The type of VM |
kvmEnable | Indicates if KVM hardware acceleration is enabled |
network | Network bandwidth/utilization statistics |
disks | Disk bandwidth/utilization statistics |
monitorResponse | Indicates if the qemu monitor is responsive |
nice | The host scheduling priority |
elapsedTime | The number of seconds that the VM has been running |
cdrom | #optional The path to an ISO image used in the VM's CD-ROM device |
boot | #optional An alias for the type of device used to boot the VM |
statsAge | The age of these statistics in seconds |
cpuSys | Ratio of CPU time spent in kernel by the qemu process |
cpuUser | Ratio of CPU time spent in userspace by the qemu process |
cpuIdle | Ratio of CPU time spent idle by the qemu process |
acpiEnable | Indicates if ACPI is enabled inside the VM |
timeOffset | The time difference from host to the VM in seconds |
clientIp | The IP address of the client connected to the display |
pauseCode | Indicates the reason a VM has been paused |
memUsage | The percent of memory in use by the guest |
username | The username associated with the current session |
session | The current state of user interaction with the VM |
appsList | A list of installed applications with their versions |
guestIPs | A space separated string of assigned IPv4 addresses |
memoryStats | Memory statistics as reported by the guest agent |
disksUsage | Info about mounted filesystems as reported by the agent |
netIfaces | Network device address info as reported by the agent |
Since: 4.10.0
VmStats:
A discriminated record containing virtual machine statistics.
Since: 4.10.0
HibernationVolumeHandle:
Indicates where VM hibernation state and metadata should be stored.The format is:<domainUUID>,<poolUUID>,<stateImageUUID>,<stateVolumeUUID>,<metaImageUUID>,<metaVolumeUUID>
Since: 4.10.0
HotplugNicParams:
Parameters for @VM.hotplugNic.
Members
vmId | The UUID of the VM to modify |
nic | The network device specification |
Since: 4.10.0
HotplugDiskParams:
Parameters for @VM.hotplugDisk.
Members
vmId | The UUID of the VM to modify |
drive | The disk device specification |
Since: 4.10.0
MigrateMode:
An enumeration of VM migration modes.
Values
remote | Migrate to a remote host |
file | Save the VM state to storage |
Since: 4.10.0
MigrateMethod:
An enumeration of VM migration methods.
Values
online | Migrate while the VM continues to run |
Since: 4.10.0
MigrateParams:
Parameters for @VM.migrate.
Members
vmId | The UUID of the virtual machine to migrate |
dst | The destination host in <host>[:<port>] format. The port is optional and should usually be omitted. |
dstparams | Used only by the hibernate API. Ignored for @remote migration |
mode | The migration mode. Callers of this API should use @remote. For @file migration use @VM.hibernate. |
method |
Since: 4.10.0
VmTicketConflictAction:
An enumeration of consequences if another user is connected to a display.
Values
disconnect | Disconnect the current user |
keep | Change the password but keep the current user connected |
fail | Fail the operation and do not change the password |
Since: 4.10.0
SnapshotVolumeDriveInfo:
Snapshot information for a Volume-based VM disk.
Members
domainID | The Storage Domain associated with the VM disk |
imageID | The Image associated with the VM disk |
baseVolumeID | The Volume associated with the VM disk |
volumeID | The Volume in which to create the snapshot |
mirrorDomainID | #optional The Storage Domain to use for snapshot mirroring |
mirrorImageID | #optional The Image to use for snapshot mirroring |
mirrorVolumeID | #optional The Volume to use for snapshot mirroring |
Since: 4.10.0
SnapshotGUIDDriveInfo:
Snapshot information for a VM disk that is identified by a devmapper GUID.
Members
baseGUID | The devmapper device GUID associated with the VM disk |
GUID | The devmapper device GUID in which to create the snapshot |
mirrorDomainID | #optional The Storage Domain to use for snapshot mirroring |
mirrorImageID | #optional The Image to use for snapshot mirroring |
mirrorVolumeID | #optional The Volume to use for snapshot mirroring |
Since: 4.10.0
SnapshotUUIDDriveInfo:
Snapshot information for a VM disk that is identified by a block device UUID.
Members
baseUUID | The block device ID associated with the VM disk |
UUID | The block device ID in which to create the snapshot |
mirrorDomainID | #optional The Storage Domain to use for snapshot mirroring |
mirrorImageID | #optional The Image to use for snapshot mirroring |
mirrorVolumeID | #optional The Volume to use for snapshot mirroring |
Since: 4.10.0
SnapshotDriveInfo:
A discriminated record of snapshot information for a VM disk.
Since: 4.10.0
MergeStatusCode:
An enumeration of possible merge statuses.
Values
Not Started | The merge operation has not yet started |
In Progress | The operation is ongoing |
Failed | The merge operation failed |
Completed | The merge operation is finished |
Unknown | The status cannot be determined |
Drive Not Found | The specified drive could not be found |
Base Not Found | The indicated base volume is not in the volume chain |
Since: 4.10.0
MergeStatus:
Status of a merge operation on a single disk.
Members
disk | The name of the disk |
status | The current status of the operation |
Notes:
Since: 4.10.0
Volume.init:
Initialize a Volume API object.
Since: 4.10.0
VolumeRole:
An enumeration of Volume Roles.
Values
SHARED | The Volume is a shared template |
INTERNAL | The Volume is being used internally by vdsm |
LEAF | The Volume is a writable leaf |
Since: 4.10.0
VolumeFormat:
An enumeration of Volume data formats.
Values
COW | The Volume uses the Qemu Qcow image format |
RAW | The Volume writes raw data directly to the backing image |
Since: 4.10.0
VolumeAllocation:
An enumeration of Volume allocation modes.
Values
PREALLOCATED | All necessary storage is allocated at Volume creation time |
SPARSE | Storage is allocated as needed |
Since: 4.10.0
DiskType:
An enumeration of disk usage types.
Values
UNKNOWN | The type is not specified |
SYSTEM | The disk contains the operating system |
DATA | The disk is for data |
SHARED | The disk is shared among multiple VMs |
SWAP | The disk is used for swap space |
TEMP | The disk is used for temporary storage space |
Since: 4.10.0
VolumeLegality:
An enumeration of Volume Legality indicators.
Values
ILLEGAL | The Volume should no longer be used (because it is being deleted) |
LEGAL | The Volume is legal |
FAKE | The Volume is a fake template on a backup domain |
Since: 4.10.0
VolumeStatus:
An enumeration of Volume statuses.
Values
OK | There are no problems with the Volume or metadata |
INVALID | The Volume and metadata are not valid |
ILLEGAL | The Volume is not legal |
Since: 4.10.0
VolumeInfo:
Information about a Volume.
Members
uuid | The Volume UUID |
type | The Volume allocation policy |
format | The format used to write data to the Volume |
disktype | An advisory code indicating the Volume's planned usage |
voltype | The Volume role |
capacity | The size of the Volume (in bytes) |
parent | The direct ancestor of this Volume if it exists |
description | A human-readable description of the Volume |
pool | The Storage Pool associated with the Volume |
domain | The Storage Domain associated with the Volume |
image | The Image associated with the Volume |
ctime | The Volume creation time in seconds since the epoch |
mtime | The Volume modification time in seconds since the epoch |
legality | Indicates whether the volume is legal to use |
apparentsize | The size of the Volume (in bytes) |
truesize | The amount of underlying storage allocated (in bytes) |
status | Indicates whether the Volume and metadata are valid |
children | A list of decendent Volumes that depend on this Volume |
Since: 4.10.0