ConnectionRefs.acquire:
Acquire one or more new storage connection references.
Since: 4.10.0
ConnectionRefs.release:
Release one or more storage connection references.
Arguments
| refIDs | UUID | A list of @UUID values |
Since: 4.10.0
ConnectionRefs.statuses:
Get information about all registered storage connection references.
Returns
| ConnectionRefMap | A dictionary of @ConnectionRef objects indexed by @UUID |
Since: 4.10.0
Host.addNetwork:
Add a new network to this host.
Arguments
| bridge | str | The name of the bridge device |
| vlan | str | #optional The name of a VLAN to create on the device |
| bond | str | #optional The name of a bond device to create from @nics |
| nics | str | #optional A list of network device names |
| options | NetworkOptions | #optional A @NetworkOptions structure |
Since: 4.10.0
Host.delNetwork:
Remove a network from this host.
Arguments
| bridge | str | The name of the bridge device |
| vlan | str | #optional The name of an associated vlan to remove |
| bond | str | #optional The name of an associated bond device to remove |
| nics | str | #optional A list of associated network devices to remove |
| options | NetworkOptions | #optional A @NetworkOptions structure |
Since: 4.10.0
Host.editNetwork:
Add a new network to the host by replacing it with a new one.
Arguments
| oldBridge | str | The name of the old bridge device to remove |
| newBridge | str | The name of the new bridge device to create |
| vlan | str | #optional The name of a VLAN to create on the new network |
| bond | str | #optional The name of a bond device to create from @nics |
| nics | str | #optional A list of network device names |
| options | NetworkOptions | #optional A @NetworkOptions structure |
Since: 4.10.0
Host.fenceNode:
Send a fencing command to a remote host.
Arguments
| addr | str | The IP address of the remote fence agent |
| port | int | The port number of the remote fence agent |
| agent | str | The type of agent being connected to (For example: rsa, ilo, drac5, ipmilan, etc) |
| username | str | The username used to login to the remote fence agent |
| password | str | The password for @username |
| action | FenceNodeAction | The type of fencing operation to perform (from @FenceNodeAction) |
| secure | bool | #optional Enable SSL communication |
| options | str | #optional Additional agent-specific parameters in space-separated <var>=<val> pairs |
| policy | FencingPolicy | #optional Additional options needed in fenceNode logic (new in version 4.16.0) |
Since: 4.10.0
Host.getAllTasks:
Get all information about all tasks.
Notes:
- This API corrects the issues noted in @Global.getAllTasksStatuses and @Host.getAllTasksInfo
Since: 4.10.0
Host.getAllTasksInfo:
Get extra information about all tasks.
Returns
| TasksInfo | A mapping of Task information |
Notes:
- Currently this API only returns tasks that are tagged with 'spm'.
Since: 4.10.0
Host.getAllTasksStatuses:
Get status information for all tasks.
Notes:
- Currently this API only returns tasks that are tagged with 'spm'.
Since: 4.10.0
Host.getAllVmStats:
Get statistics for all virtual machines.
Returns
| VmStats | A list of stats for all VMs |
Since: 4.10.0
Host.getCapabilities:
Get host capabilities.
Since: 4.10.0
Host.getConnectedStoragePools:
Get a list of all Storage Pools that are connected to this host.
Returns
| UUID | A list of Storage Pool UUIDs |
Since: 4.10.0
Host.getDeviceList:
Get information about all block devices.
Arguments
| storageType | BlockDeviceType | #optional Only return devices of this type |
Since: 4.10.0
Host.getDevicesVisibility:
Check if the host has access to block storage devices.
Arguments
| guidList | UUID | A list of block device GUIDs |
Since: 4.10.0
Host.getHardwareInfo:
Get host hardware information.
Since: 4.10.3
Host.getLVMVolumeGroups:
Get information about Volume Groups in this host.
Arguments
| storageType | BlockDeviceType | #optional Limit results to Volume Groups of a specific storage type |
Since: 4.10.0
Host.getStats:
Get host statistics.
Since: 4.10.0
Host.getStorageDomains:
Get a list of known Storage Domains.
Arguments
| storagepoolID | UUID | #optional Limit to Domains belonging to this Storage Pool |
| domainClass | StorageDomainImageClass | #optional Limit to Domains of this @StorageDomainImageClass |
| storageType | StorageDomainType | #optional Limit to Domains of this @StorageDomainType |
| remotePath | str | #optional Limit to Domains having this remotePath |
Returns
| UUID | A list of Storage Domain UUIDs |
Since: 4.10.0
Host.getStorageRepoStats:
Get statistics and liveness of currently monitored Storage Domains.
Since: 4.10.0
Host.getVMFullList:
Get full information about the current virtual machines.
Arguments
| vmList | UUID | #optional Filter the results by a list of UUIDs |
Returns
| VMFullInfo | A list of full information about current VMs |
Since: 4.14.1
Host.getVMList:
Get information about the current virtual machines.
Arguments
| vmList | UUID | #optional Filter the results by a list of UUIDs |
Returns
| UUID | A list of VM UUIDs |
Since: 4.10.0
Host.ping:
Test connectivity to vdsm.
Since: 4.10.0
Host.setHaMaintenanceMode:
Configure maintenance for Hosted Engine subsystem.
Arguments
| mode | HaMaintenanceMode | Type of maintenance to configure |
| enabled | bool | Whether to enable or disable maintenance |
Since: 4.14.0
Host.setLogLevel:
Set the vdsm logging verbosity level.
Since: 4.10.0
Host.setMOMPolicy:
Set MOM policy for different level of overcommitments.
Arguments
| policy | str | MOM policy string. |
Since: 4.10.0
Host.setMOMPolicyParameters:
Set variables for MOM policy fine tuning.
Arguments
| key_value_store | dict | This argument contains a dictionary where keys represent policy variable names and values contain the values. |
Since: 4.11.0
Host.setSafeNetworkConfig:
Mark the current network configuration good and persist any changes.
Since: 4.10.0
Host.setupNetworks:
Reconfigure host networking by adding, removing, and editing multiple bridgeand bond devices in a single call.
Since: 4.10.0
Host.startMonitoringDomain:
Start SD monitoring with hostID
Arguments
| SdUUID | UUID | The Storage Domain UUID |
| HostID | int | A host ID number in the Storage Domain Lockspace |
Since: 4.14.0
Host.stopMonitoringDomain:
Stop SD monitoring with hostID
Arguments
| SdUUID | UUID | The Storage Domain UUID |
Since: 4.14.0
ISCSIConnection.discoverSendTargets:
Discover available targets for this @ISCSIConnection.
Arguments
| host | str | A fully-qualified domain name (FQDN) or IP address |
| port | int | A port number |
| user | str | #optional The username used for authentication to an ISCI target |
| password | str | #optional The password associated with the given username |
Returns
| str | A list of discovered targets in the form: '<host>:<port>,<tpgt> <iqn>' |
Since: 4.10.0
Image.cloneStructure:
Clone an image structure from a source domain to a destination domainwithin the same Storage Pool.
Arguments
| imageID | UUID | The UUID of the Image |
| storagepoolID | UUID | The UUID of the Storage Pool associated with the Image |
| storagedomainID | UUID | The UUID of the Storage Domain associated with the Image |
| dstSdUUID | UUID | The destination Storage Domain UUID |
Since: 4.11.0
Image.delete:
Delete the Image and all of its Volumes.
Arguments
| imageID | UUID | The UUID of the Image |
| storagepoolID | UUID | The UUID of the Storage Pool associated with the Image |
| storagedomainID | UUID | The UUID of the Storage Domain associated with the Image |
| postZero | bool | If True, overwrite Volume data with zeroes after deletion |
| force | bool | 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
| imageID | UUID | The UUID of the Image |
| storagepoolID | UUID | The UUID of the Storage Pool associated with the Image |
| storagedomainID | UUID | The UUID of the Storage Domain associated with the Image |
| volumeList | UUID | A list of Volume UUIDs |
| postZero | bool | #optional If True, overwrite Volume data with zeroes after deletion |
| force | bool | #optional Force the operation and do not perform any validation |
Since: 4.10.0
Image.download:
Download an image to a remote endpoint using the specified methodand methodArgs.
Arguments
| methodArgs | ImageSharingMethodArgs | Download method and map of arguments |
| storagepoolID | UUID | The UUID of the Storage Pool associated with the Image |
| storagedomainID | UUID | The UUID of the Storage Domain associated with the Image |
| imageID | UUID | The UUID of the Image |
| volumeID | UUID | #optional The UUID of the Volume |
Since: 4.12.0
Image.getVolumes:
Get a list of Volumes associated with this Image.
Arguments
| imageID | UUID | The UUID of the Image |
| storagepoolID | UUID | The UUID of the Storage Pool associated with the Image |
| storagedomainID | UUID | The UUID of the Storage Domain associated with the Image |
Returns
| UUID | A list of Volume UUIDs |
Since: 4.10.0
Image.mergeSnapshots:
Merge snapshot @successor into @ancestor.
Arguments
| imageID | UUID | The UUID of the Image |
| storagepoolID | UUID | The UUID of the Storage Pool associated with the Image |
| storagedomainID | UUID | The UUID of the Storage Domain associated with the Image |
| ancestor | UUID | A Volume UUID representing the parent snapshot |
| successor | UUID | A Volume UUID representing the child snapshot |
| postZero | bool | 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
| imageID | UUID | The UUID of the Image |
| storagepoolID | UUID | The UUID of the Storage Pool associated with the Image |
| storagedomainID | UUID | The UUID of the Storage Domain associated with the Image |
| dstSdUUID | UUID | The destination Storage Domain UUID |
| operation | ImageMoveOperation | The operation to perform |
| postZero | bool | If True, overwrite Volume data with zeroes after deletion |
| force | bool | Force the operation and do not perform any validation |
Since: 4.10.0
Image.prepare:
Prepare an image, making the needed volumes available.
Arguments
| storagepoolID | UUID | The UUID of the Storage Pool associated with the Image |
| storagedomainID | UUID | The UUID of the Storage Domain associated with the Image |
| imageID | UUID | The UUID of the Image |
| volumeID | UUID | #optional The UUID of the Volume (optional) |
Since: 4.15.0
Image.reconcileVolumeChain:
Reconcile an image volume chain and return the current chain.
Arguments
| storagepoolID | UUID | The UUID of the Storage Pool associated with the Image |
| storagedomainID | UUID | The UUID of the Storage Domain associated with the Image |
| imageID | UUID | The UUID of the Image |
| leafVolID | UUID | The UUID of the original leaf volume |
Returns
| UUID | A list of volume UUIDs representing the current volume chain |
Since: 4.16.0
Image.syncData:
Synchronize image data between storage domains within same Storage Pool.
Arguments
| imageID | UUID | The UUID of the Image |
| storagepoolID | UUID | The UUID of the Storage Pool associated with the Image |
| storagedomainID | UUID | The UUID of the Storage Domain associated with the Image |
| dstSdUUID | UUID | The destination Storage Domain UUID |
| syncType | syncType | The type of synchronization to perform |
Since: 4.11.0
Image.teardown:
Teardown an image, releasing the prepared volumes.
Arguments
| storagepoolID | UUID | The UUID of the Storage Pool associated with the Image |
| storagedomainID | UUID | The UUID of the Storage Domain associated with the Image |
| imageID | UUID | The UUID of the Image |
| volumeID | UUID | #optional The UUID of the Volume (optional) |
Since: 4.15.0
Image.upload:
Upload an image to a remote endpoint using the specified method andmethodArgs.
Arguments
| methodArgs | ImageSharingMethodArgs | Upload method and map of arguments |
| storagepoolID | UUID | The UUID of the Storage Pool associated with the Image |
| storagedomainID | UUID | The UUID of the Storage Domain associated with the Image |
| imageID | UUID | The UUID of the Image |
| volumeID | UUID | #optional The UUID of the Volume (optional) |
Since: 4.12.0
LVMVolumeGroup.create:
Create a new Volume Group.
Arguments
| name | UUID | The new Volume Group UUID |
| devlist | str | An array of device names to include in the Volume Group |
| force | bool | #optional Force the operation and do not perform any validation |
Returns
| UUID | The uuid of the created Volume Group |
Notes:
- @name must match the UUID of any Storage Domain to be created on this Volume Group.
Since: 4.10.0
LVMVolumeGroup.getInfo:
Get information about a Volume Group.
Arguments
| lvmvolumegroupID | UUID | The UUID of the LVM Volume Group |
Since: 4.10.0
LVMVolumeGroup.remove:
Remove this Volume Group.
Arguments
| lvmvolumegroupID | UUID | The UUID of the LVM Volume Group |
Since: 4.10.0
StorageDomain.activate:
Activate an attached but inactive Storage Domain.
Arguments
| storagedomainID | UUID | The UUID of the Storage Domain |
| storagepoolID | UUID | The UUID of the Storage Pool to which the Storage Domain is attached |
Since: 4.10.0
StorageDomain.attach:
Attach a Storage Domain to a Storage Pool.
Arguments
| storagedomainID | UUID | The UUID of the Storage Domain |
| storagepoolID | UUID | The UUID of the Storage Pool |
Since: 4.10.0
StorageDomain.create:
Create a new Storage Domain.
Since: 4.10.0
StorageDomain.deactivate:
Deactivate an active, attached Storage Domain.
Arguments
| storagedomainID | UUID | The UUID of the Storage Domain |
| storagepoolID | UUID | The UUID of the Storage Pool |
| masterSdUUID | UUID | 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 | int | 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
| storagedomainID | UUID | The UUID of the Storage Domain |
| storagepoolID | UUID | The UUID of the Storage Pool |
| masterSdUUID | UUID | #optional 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 | int | #optional The Storage Domain version of the new master domain |
| force | bool | #optional Force operation -- do not perform validation |
Since: 4.10.0
StorageDomain.extend:
Extend a block-based Storage Domain onto more block devices.
Arguments
| storagedomainID | UUID | The UUID of the Storage Domain |
| storagepoolID | UUID | The UUID of the Storage Pool |
| devlist | str | An array of block device names to add to the domain |
| force | bool | #optional Try to extend a domain with LUN even if it is not empty (e.g. already marked as part of a VG). |
Since: 4.10.0
StorageDomain.format:
Format a storage domain and erase all of its data.
Arguments
| storagedomainID | UUID | The UUID of the Storage Domain |
| autoDetach | bool | Detach the Storage Domain before formatting. Useful when formatting the master domain. |
Since: 4.10.0
StorageDomain.getFileStats:
Get a list of files in an ISO domain.
Arguments
| storagedomainID | UUID | The UUID of the Storage Domain |
| pattern | str | Filter results by this glob pattern |
| caseSensitive | bool | Enables case-sensitive matching |
Since: 4.15.0
StorageDomain.getImages:
Get a list of Images associated with this Storage Domain.
Arguments
| storagedomainID | UUID | The UUID of the Storage Domain |
Returns
| UUID | A list of Image UUIDs |
Since: 4.10.0
StorageDomain.getInfo:
Get information about a Storage Domain.
Arguments
| storagedomainID | UUID | The UUID of the Storage Domain |
Since: 4.10.0
StorageDomain.getStats:
Get Storage Domain statistics.
Arguments
| storagedomainID | UUID | The UUID of the Storage Domain |
Since: 4.10.0
StorageDomain.getVolumes:
Get a list of Volumes contained within a Storage Domain.
Arguments
| storagedomainID | UUID | The UUID of the Storage Domain |
| storagepoolID | UUID | The UUID of the Storage Pool |
| imageID | UUID | Limit results to Volumes associated with a single Image |
Returns
| UUID | A list of Volume UUIDs |
Since: 4.10.0
StorageDomain.setDescription:
Set the Storage Domain description.
Arguments
| storagedomainID | UUID | The UUID of the Storage Domain |
| description | str | A human-readable description |
Since: 4.10.0
StorageDomain.validate:
Check that the Storage Domain is accessible.
Arguments
| storagedomainID | UUID | The UUID of the Storage Domain |
Since: 4.10.0
StoragePool.connect:
Connect to an existing Storage Pool.
Arguments
| storagepoolID | UUID | The UUID of the Storage Pool |
| hostID | int | A host ID number unique across all hosts in the same cluster |
| scsiKey | str | Deprecated. Retained here to support older versions |
| masterSdUUID | UUID | The UUID of a Storage Domain to use as the master domain |
| masterVersion | int | The Storage Domain version of the master domain |
| domainDict | StorageDomainStatusMap | #optional The Storage Domain statuses (added in cluster level 3.4). If this argument is present the Storage Pool will use the memory backend (no metadata). |
Notes:
- Only one Storage pool may be connected at a time
Since: 4.10.0
StoragePool.connectStorageServer:
Establish a connection to backing storage.
Since: 4.10.0
StoragePool.create:
Create a new Storage Pool.
Arguments
| storagepoolID | UUID | The UUID of the Storage Pool |
| name | str | A human-readable name for the Storage Pool |
| masterSdUUID | UUID | The UUID of the Storage Domain that will be used as the master domain |
| masterVersion | int | The Storage Domain version of the master domain |
| domainList | UUID | A list of Storage Domain UUIDs that should be attached to the Storage Pool |
| lockRenewalIntervalSec | int | The number of seconds to wait before renewing lease (Should be less than @leaseTimeSec). 0 selects the default value. |
| leaseTimeSec | int | The maximum number of seconds that the leaseholder may retain the lease without renewing it. 0 selects the default value. |
| ioOpTimeoutSec | int | The maximum number of seconds that an I/O operation may take to complete. 0 selects the default value. |
| leaseRetries | int | 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
| storagepoolID | UUID | The UUID of the Storage Pool |
| hostID | int | A host ID number unique across all hosts in the same cluster |
| scsiKey | str | Deprecated. Retained here to support older versions |
Since: 4.10.0
StoragePool.disconnect:
Disconnect and optionally remove a Storage Pool.
Arguments
| storagepoolID | UUID | The UUID of the Storage Pool |
| hostID | int | A host ID number unique across all hosts in the same cluster |
| scsiKey | str | Deprecated. Retained here to support older versions |
| remove | bool | #optional If True, remove the Storage Pool after it is disconnected Not used by vdsm and set to false |
Since: 4.10.0
StoragePool.disconnectStorageServer:
Remove backing storage connections.
Since: 4.10.0
StoragePool.fence:
Fence the SPM host via the storage.
Arguments
| storagepoolID | UUID | The UUID of the Storage Pool |
Returns
| SpmStatus | SPM status information for the Storage Pool |
Notes:
Since: 4.10.0
StoragePool.getBackedUpVmsInfo:
Get information about backed-up virtual machines from a Backup Storage Domain.
Arguments
| storagepoolID | UUID | The UUID of the Storage Pool |
| storagedomainID | UUID | The UUID of the Backup Storage Domain to check |
| vmList | UUID | Limit results to a list of VM UUIDs |
Returns
| OVFMap | 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
| storagepoolID | UUID | The UUID of the Storage Pool |
| storagedomainID | UUID | The UUID of the Backup Storage Domain to check |
Returns
| UUID | A list of VM UUIDs |
Since: 4.10.0
StoragePool.getDomainsContainingImage:
Get a list of Data Storage Domains that contain an Image.
Arguments
| storagepoolID | UUID | The UUID of the Storage Pool |
| imageID | UUID | The UUID of the Image to search for |
Returns
| UUID | A list of UUIDs of Data Storage Domains that contain the Image |
Since: 4.10.0
StoragePool.getFloppyList:
Get a list of all floppy disk images associated with a Storage Pool.
Arguments
| storagepoolID | UUID | The UUID of the Storage Pool |
Returns
| str | A list of floppy disk file names |
Since: 4.10.0
StoragePool.getInfo:
Get information about a Storage Pool and its Active Storage Domains.
Arguments
| storagepoolID | UUID | The UUID of the Storage Pool |
Since: 4.10.0
StoragePool.getIsoList:
Get a list of all ISO images associated with a Storage Pool.
Arguments
| storagepoolID | UUID | The UUID of the Storage Pool |
| filenameExtension | str | #optional Specify an alternate file extension (the default extension used is 'iso') |
Returns
| str | A list of available files |
Since: 4.10.0
StoragePool.getSpmStatus:
Get the status of the Storage Pool Manager role.
Arguments
| storagepoolID | UUID | The UUID of the Storage Pool |
Since: 4.10.0
StoragePool.moveMultipleImages:
Move images from one Storage Domain to another within the same Storage Pool.
Arguments
| storagepoolID | UUID | The UUID of the Storage Pool |
| srcSdUUID | UUID | The source Storage Domain |
| dstSdUUID | UUID | The destination Storage Domain |
| imgDict | ImagePostZeroMap | A mapping keyed by Image UUID where the values indicate if the source Image should be zeroed after the data has been moved |
| force | bool | 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
| storagepoolID | UUID | The UUID of the Storage Pool |
| hostId | int | Host Id used by San lock. |
| name | str | A human-readable name for the Storage Pool |
| masterSdUUID | UUID | The UUID of the Storage Domain that will be used as the master domain |
| masterVersion | int | The Storage Domain version of the master domain |
| domainDict | StorageDomainStatusMap | Storage Domain statuses to be restored |
| lockRenewalIntervalSec | int | The number of seconds to wait before renewing lease (Should be less than @leaseTimeSec). 0 selects the default value. |
| leaseTimeSec | int | The maximum number of seconds that the leaseholder may retain the lease without renewing it. 0 selects the default value. |
| ioOpTimeoutSec | int | The maximum number of seconds that an I/O operation may take to complete. 0 selects the default value. |
| leaseRetries | int | 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.
Arguments
| storagepoolID | UUID | The UUID of the Storage Pool |
| masterSdUUID | UUID | The UUID of the master Storage Domain |
| masterVersion | int | The Storage Domain version of the master domain |
Since: 4.10.0
StoragePool.removeVM:
Remove a previously saved virtual machine definition.
Arguments
| storagepoolID | UUID | The UUID of the Storage Pool |
| vmUUID | UUID | Remove the saved definition of the VM with this UUID |
| storagedomainID | UUID | #optional The Storage Domain where the VM is stored |
Since: 4.10.0
StoragePool.setDescription:
Set the Storage Pool description
Arguments
| storagepoolID | UUID | The UUID of the Storage Pool |
| description | str | 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
| storagepoolID | UUID | The UUID of the Storage Pool |
| prevID | int | Deprecated. The Host ID of the previous SPM |
| prevLver | int | Deprecated. The lver of the previous SPM |
| enableScsiFencing | bool | This parameter is not used |
| maxHostID | int | #optional The maximum number of hosts that could be in the cluster |
| domVersion | int | #optional 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.
Arguments
| storagepoolID | UUID | The UUID of the Storage Pool |
Since: 4.10.0
StoragePool.updateVMs:
Store virtual machine OVF files on a Storage Domain in the Storage Pool.
Arguments
| storagepoolID | UUID | The UUID of the Storage Pool |
| vmList | UpdateVmDefinition | A list of virtual machine definitions to store |
| storagedomainID | UUID | #optional 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.
Arguments
| storagepoolID | UUID | The UUID of the Storage Pool |
| targetDomVersion | int | The version to upgrade to |
Since: 4.10.0
StoragePool.validateStorageServerConnection:
Validate storage server connection parameters.
Notes:
- Deprecated since 4.10.0. Returns 0 for all connections.
Since: 4.10.0
Task.clear:
Discard information about a finished Task.
Arguments
| taskID | UUID | The UUID of the Task |
Since: 4.10.0
Task.getInfo:
Get information about a Task.
Arguments
| taskID | UUID | The UUID of the Task |
Returns
| TaskInfo | General Task information |
Since: 4.10.0
Task.getStatus:
Get Task status information.
Arguments
| taskID | UUID | The UUID of the Task |
Since: 4.10.0
Task.revert:
Rollback a Task to restore the previous system state.
Arguments
| taskID | UUID | The UUID of the Task |
Since: 4.10.0
Task.stop:
Stop a currently running Task.
Arguments
| taskID | UUID | The UUID of the Task |
Since: 4.10.0
VM.changeCD:
Change the CD in the VM's CD-ROM device.
Arguments
| vmID | UUID | The UUID of the VM |
| driveSpec | DriveSpec | The specification of the new CD |
Since: 4.10.0
VM.changeFloppy:
Change the disk in the VM's floppy device.
Arguments
| vmID | UUID | The UUID of the VM |
| driveSpec | DriveSpec | The specification of the new floppy disk |
Since: 4.10.0
VM.cont:
Resume a paused VM.
Arguments
| vmID | UUID | The UUID of the VM |
Since: 4.10.0
VM.create:
Create a new virtual machine.
Since: 4.10.0
VM.desktopLock:
Lock the active user session in the guest operating system.
Arguments
| vmID | UUID | The UUID of the VM |
Since: 4.10.0
VM.desktopLogin:
Log a user into the guest operating system.
Arguments
| vmID | UUID | The UUID of the VM |
| domain | str | The Active Directory domain (if applicable) |
| username | str | The username to use |
| password | str | The password corresponding to @username |
Since: 4.10.0
VM.desktopLogoff:
Logoff the active user of the guest operating system.
Arguments
| vmID | UUID | The UUID of the VM |
| force | bool | Force the operation (unused) |
Since: 4.10.0
VM.desktopSendHcCommand:
Send an arbitrary command to the guest agent.
Arguments
| vmID | UUID | The UUID of the VM |
| message | str | The message to send |
Notes:
Since: 4.10.0
VM.destroy:
Forcibly stop a running VM.
Arguments
| vmID | UUID | The UUID of the VM |
Since: 4.10.0
VM.diskReplicateFinish:
Stop the replication of a disk switching to a destination.
Arguments
| vmID | UUID | The UUID of the VM |
| srcDisk | DriveSpecVolume | A @DriveSpecVolume structure rapresenting the source disk |
| dstDisk | DriveSpecVolume | A @DriveSpecVolume structure rapresenting the destination disk |
Since: 4.11.0
VM.diskReplicateStart:
Start the replication of a disk to a destination.
Arguments
| vmID | UUID | The UUID of the VM |
| srcDisk | DriveSpecVolume | A @DriveSpecVolume structure rapresenting the source disk |
| dstDisk | DriveSpecVolume | A @DriveSpecVolume structure rapresenting the destination disk |
Since: 4.11.0
VM.diskSizeExtend:
Extends the virtual size of a disk through the running VM.
Arguments
| vmID | UUID | The UUID of the VM |
| driveSpecs | DriveSpecVolume | A @DriveSpecVolume structure rapresenting the disk |
| newSize | str | The new desired size (in bytes) |
Returns
| str | The new size of the disk (might have been rounded) |
Since: 4.12.0
VM.getDiskAlignment:
Returns the alignment of the disk partitions.
Arguments
| vmID | UUID | The UUID of the VM |
| disk | DriveSpecVolume | A @DriveSpecVolume structure rapresenting the disk |
Since: 4.11.0
VM.getInfo:
Get detailed information about a VM.
Arguments
| vmID | UUID | The UUID of the VM |
Since: 4.10.0
VM.getIoTunePolicy:
Gets the ioTune policy settings for block devices
Arguments
| vmID | UUID | The UUID of the VM |
Since: 4.15.0
VM.getMigrationStatus:
Report status of a currently outgoing migration.
Arguments
| vmID | UUID | The UUID of the VM |
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.
Arguments
| vmID | UUID | The UUID of the VM |
Returns
| VmStats | 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.
Notes:
Since: 4.10.0
VM.hotplugNic:
Add a new network device to a running VM.
Notes:
Since: 4.10.0
VM.hotunplugDisk:
Remove a disk device from a running VM.
Notes:
Since: 4.10.0
VM.hotunplugNic:
Remove a network device from a running VM.
Notes:
Since: 4.10.0
VM.merge:
Perform a live merge of a VM disk to remove an unwanted snapshot. All databetween @baseVolUUID and @topVolUUID will be merged into @baseVolUUID andany snapshots which depended on @topVolUUID will now depend on @baseVolUUID.
Arguments
| vmID | UUID | The UUID of the VM |
| drive | DriveSpecVolume | A @DriveSpecVolume structure rapresenting the disk |
| baseVolUUID | UUID | The UUID of the base volume |
| topVolUUID | UUID | The UUID of the top volume |
| bandwidth | int | #optional Limit I/O for the merge (in MB/s) |
| jobUUID | UUID | #optional Assign a UUID to this operation which can be used to identify it in @VmStats |
Since: 4.15.0
VM.migrate:
Migrate a VM to a remote host.
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.
Arguments
| vmID | UUID | The UUID of the VM |
Since: 4.10.0
VM.migrationCreate:
Start a migrating VM on a destination host.
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
| vmID | UUID | The UUID of the VM |
| command | str | The command string |
Notes:
- This function is not implemented.
Since: 4.10.0
VM.pause:
Pause the CPUs of a running VM.
Arguments
| vmID | UUID | The UUID of the VM |
Since: 4.10.0
VM.reset:
Reset a virtual machine.
Arguments
| vmID | UUID | The UUID of the VM |
Notes:
- This function is not implemented.
Since: 4.10.0
VM.sendKeys:
Send a string of keys to a guest's keyboard.
Arguments
| vmID | UUID | The UUID of the VM |
| keySequence | str | A sequence of keystrokes to send |
Notes:
- This function is not implemented.
Since: 4.10.0
VM.setBalloonTarget:
Dynamically change the target amount of physical memory allocated to a guest.
Arguments
| vmID | UUID | The UUID of the VM |
| target | uint | The target of guest's physical memory size in kibibytes |
Since: 4.10.0
VM.setCpuTunePeriod:
Set the vCpu period tune parameter to the VM
Arguments
| vmID | UUID | The UUID of the VM |
| period | int | a number representing the period to be set |
Since: 4.15.0
VM.setCpuTuneQuota:
Set the vCpu quota tune parameter to the VM
Arguments
| vmID | UUID | The UUID of the VM |
| quota | int | a number representing the quota to be set |
Since: 4.15.0
VM.setIoTune:
Sets the ioTune parameters for block devices
Arguments
| vmID | UUID | The UUID of the VM |
| tunables | VmDiskDeviceTuneParams | list of VmDiskDeviceTuneParams objects describing the new settings |
Since: 4.15.0
VM.setNumberOfCpus:
Set the number CPUs for a VM
Arguments
| vmID | UUID | The UUID of the VM |
| numberOfCpus | int | The new number of cpus |
Since: 4.15.0
VM.setTicket:
Set the password to be used to connect to a VM display.
Arguments
| vmID | UUID | The UUID of the VM |
| password | str | The desired connection password |
| ttl | int | The number of seconds before the password expires |
| existingConnAction | VmTicketConflictAction | Indicate what to do with any existing connections |
| params | StringMap | Arbitrary key:val pairs that will be passed to hooks |
Since: 4.10.0
VM.shutdown:
Request a graceful shutdown of a VM.
Arguments
| vmID | UUID | The UUID of the VM |
| delay | int | #optional Wait a number of seconds before shutting down |
| message | str | #optional Message to display to VM users before shutting down |
| reboot | bool | #optional True if reboot is desired, False for shutdown |
| timeout | int | #optional Number of seconds to wait before trying next shutdown/reboot method. (new in version 4.15.0) |
| force | bool | #optional True if shutdown/reboot desired by any means necessary (forceful reboot/shutdown if all graceful methods fail) Default is False (i.e. graceful only). (new in version 4.15.0) |
Since: 4.10.0
VM.snapshot:
Create a live snapshot of a VM's disks.
Arguments
| vmID | UUID | The UUID of the VM |
| snapDrives | SnapshotDriveInfo | A list of disk snapshot creation instructions |
| snapMemory | str | #optional str representation of the volumes in which the memory dump and vm configuration should be saved |
Since: 4.10.0
VM.updateDevice:
Update the status of a VM's device.
Since: 4.10.3
VM.updateVmPolicy:
Set VM SLA parameters
Arguments
| vmID | UUID | The UUID of the VM |
| params | UpdateVmPolicyParams | The UpdateVmPolicyParams structure that defines the changes that are to be applied to the current QoS policy. |
Since: 4.15.0
Volume.copy:
Duplicate a volume to produce a new template image.
Arguments
| volumeID | UUID | The UUID of the Volume |
| storagepoolID | UUID | The Storage Pool associated with the Volume |
| storagedomainID | UUID | The Storage Domain associated with the Volume |
| imageID | UUID | The Image associated with the Volume |
| dstSdUUID | UUID | The UUID of the destination Storage Domain |
| dstImgUUID | UUID | The UUID of the destination Image |
| dstVolUUID | UUID | The UUID of the destination Volume |
| desc | str | Set the destination Volume description |
| volType | VolumeRole | (Unused) The role of the destination Volume |
| volFormat | VolumeFormat | The data format to use for the destination Volume |
| preallocate | VolumeAllocation | The Volume allocation mode |
| postZero | bool | If @force is set and @dstVolUUID exists, zero the destination Volume before copying new data |
| force | bool | 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
| volumeID | UUID | The UUID of the Volume |
| storagepoolID | UUID | The Storage Pool associated with the Volume |
| storagedomainID | UUID | The Storage Domain associated with the Volume |
| imageID | UUID | The Image associated with the Volume |
| size | int | The Volume size in sectors |
| volFormat | VolumeFormat | The data format to use for the destination Volume |
| preallocate | VolumeAllocation | The Volume allocation mode |
| diskType | DiskType | An advisory disk usage type |
| desc | str | The Volume description |
| srcImgUUID | UUID | If specified, create a snapshot from this Image |
| srcVolUUID | UUID | If specified, create a snapshot from this Volume |
Since: 4.10.0
Volume.delete:
Delete a Volume.
Arguments
| volumeID | UUID | The UUID of the Volume |
| storagepoolID | UUID | The Storage Pool associated with the Volume |
| storagedomainID | UUID | The Storage Domain associated with the Volume |
| imageID | UUID | The Image associated with the Volume |
| postZero | bool | Zero Volume data before deletion |
| force | bool | Remove even if @VolumeRole is SHARED or INTERNAL |
Since: 4.10.0
Volume.extendSize:
Extends the virtual size of a volume.
Arguments
| storagepoolID | UUID | The Storage Pool associated with the Volume |
| storagedomainID | UUID | The Storage Domain associated with the Volume |
| imageID | UUID | The Image associated with the Volume |
| volumeID | UUID | The UUID of the Volume |
| newSize | str | The new desired size (in bytes) |
Since: 4.12.0
Volume.getInfo:
Get information about a Volume.
Arguments
| volumeID | UUID | The UUID of the Volume |
| storagepoolID | UUID | The Storage Pool associated with the Volume |
| storagedomainID | UUID | The Storage Domain associated with the Volume |
| imageID | UUID | The Image associated with the Volume |
Since: 4.10.0
Volume.getPath:
Get the path to the Volume in the host's storage repository.
Arguments
| volumeID | UUID | The UUID of the Volume |
| storagepoolID | UUID | The Storage Pool associated with the Volume |
| storagedomainID | UUID | The Storage Domain associated with the Volume |
| imageID | UUID | The Image associated with the Volume |
Returns
| str | The Volume's storage repository path |
Since: 4.10.0
Volume.getSize:
Get Volume size information.
Arguments
| volumeID | UUID | The UUID of the Volume |
| storagepoolID | UUID | The Storage Pool associated with the Volume |
| storagedomainID | UUID | The Storage Domain associated with the Volume |
| imageID | UUID | The Image associated with the Volume |
Since: 4.10.0
Volume.refresh:
Refresh Volume to synchronize changes made by a remote host.
Arguments
| volumeID | UUID | The UUID of the Volume |
| storagepoolID | UUID | The Storage Pool associated with the Volume |
| storagedomainID | UUID | The Storage Domain associated with the Volume |
| imageID | UUID | The Image associated with the Volume |
Since: 4.10.0
Volume.setDescription:
Set the Volume description field.
Arguments
| volumeID | UUID | The UUID of the Volume |
| storagepoolID | UUID | The Storage Pool associated with the Volume |
| storagedomainID | UUID | The Storage Domain associated with the Volume |
| imageID | UUID | The Image associated with the Volume |
| description | str | A human-readable Volume description |
Since: 4.10.0
Volume.setLegality:
Set the legality of a Volume.
Arguments
| volumeID | UUID | The UUID of the Volume |
| storagepoolID | UUID | The Storage Pool associated with the Volume |
| storagedomainID | UUID | The Storage Domain associated with the Volume |
| imageID | UUID | The Image associated with the Volume |
| legality | VolumeLegality | The new Volume legality |
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
UUID:
A universally unique identifier in RFC 4122 format.eg. "407cb255-34be-432c-be7c-eb43b8de82be"
Since: 4.10.0
BalloonInfo:
Guest memory balloon information. Values are present only when theballoon is enabled and ready.
Members
| balloon_max | str | #optional The maximum amount of memory available to the guest (in KiB) |
| balloon_cur | str | #optional The current amount of memory available to the guest (in KiB) |
| balloon_min | str | #optional The minimum amount of memory guaranteed to the guest (in KiB) |
| balloon_target | str | #optional The amount of memory requested (in KiB) |
Since: 4.10.0
BandwidthParams:
Bandwidth traffic shape parameters for VM Interface device expressed as integers.
Members
| average | uint | Average bit rate of the interface being shaped in kB/sec. |
| burst | uint | #optional Amount of data that can be burst at peak speed in kB. |
| peak | uint | #optional Maximum rate at which interface can send data in kB/sec. |
Since: 4.12.0
BlockDeviceInfo:
Block device information.
Members
| GUID | UUID | The globally unique identifier of the block device |
| pvUUID | UUID | The LVM physical volume associated with this device |
| vendorID | str | A string identifying the device manufacturer |
| productID | str | A string identifying the device model |
| fwrev | str | Firmware version information |
| serial | str | The device serial number (if available) |
| capacity | uint | The device logical size (in bytes) |
| devtype | BlockDeviceType | The type of storage device (@BlockDeviceType) |
| pathstatus | BlockDevicePathInfo | Multipath information |
| pathlist | IscsiSessionInfo | iSCSI session information |
| logicalblocksize | uint | The logical block size of the device (in bytes) |
| physicalblocksize | uint | The physical block size of the device (in bytes) |
| partitioned | bool | Reports whether the device has been split into partitions |
Notes:
- The value of @serial may be dependent on the current host so this field should not be used to compare devices if the hosts are different.
- If @partitioned is True, the device is not usable by Vdsm. If the device has a partition table but no partitions, @partitioned is False.
Since: 4.10.0
BlockDevicePathInfo:
Information about a single block device path.
Members
| physdev | str | The physical device name |
| state | BlockDevicePathState | The current state of this path |
| lun | uint | The SCSI Logical Unit Number associated with this path |
| deviceType | BlockDeviceType | The type of path (@BlockDeviceType) |
Since: 4.10.0
BlockJobInfo:
Information about a currently active block job.
Members
| id | UUID | An ID that was associated with the job when it was started |
| jobType | JobType | The general job type (always block) |
| blockJobType | BlockJobType | The specific type of block operation underway |
| cur | int | Indicates progress of the job relative to @end |
| end | int | Indicates the value of @cur that will signify job completion |
| bandwidth | int | I/O limit in MB/s (zero means no limit) |
| imgUUID | UUID | The UUID of the image on which this job is operating |
Since: 4.15.0
ConnectStorageServerStatus:
Status of a single storage server connection attempt.
Members
| id | UUID | Connection UUID |
| status | int | Status code |
Since: 4.10.0
ConnectionError:
A tuple containing @ConnectionRef error information.
Members
| code | int | The error code |
| message | str | The error message |
Since: 4.10.0
ConnectionRef:
Contains the details of a registered storage connection.
Members
| connected | bool | Indicates whether the storage is connected |
| lastError | ConnectionError | The most recent error information (@ConnectionError) |
| connectionInfo | ConnectionRefParameters | Type-specific connection details (@ConnectionRefParameters) |
Since: 4.10.0
ConnectionRefArgs:
Structure to store @ConnectionRef arguments.
Since: 4.10.0
ConnectionRefParameters:
A discriminated record of parameters used to establish a ConnectionRef.
Since: 4.10.0
CpuCoreStats:
Statistics about a cpu core.
Members
| numaNodeIndex | uint | Which numa node this cpu core belongs to |
| cpuSys | float | Ratio of CPU time spent in kernel |
| cpuIdle | float | Ratio of CPU time spent idle |
| cpuUser | float | Ratio of CPU time spent in userspace |
Since: 4.15.0
DrivePayload:
The detailed specification of the image contents
Members
| vmPayload | DriveVmPayload | Specifies data to be inserted into the VM Disk |
Since: 4.10.0
DriveSpec:
A discriminated record containing a VM drive specification
Since: 4.10.0
DriveSpecGUID:
A drive specification using a device mapper GUID.
Members
| GUID | str | The devmapper device GUID |
Since: 4.10.0
DriveSpecPath:
A drive specification using a filesystem path to an image file.
Members
| path | str | The full filesystem path to the image file |
Since: 4.10.0
DriveSpecPayload:
A drive specification that describes the exact image contents.
Members
| device | VmDiskDeviceType | The type of disk device being created |
| specParams | DrivePayload | Additional drive parameters (including the payload information) |
Since: 4.10.0
DriveSpecUUID:
A drive specification using a blkid UUID.
Members
| UUID | UUID | The device blkid |
Since: 4.10.0
DriveSpecVolume:
A drive specification that refers to a Volume managed by Vdsm.
Members
| device | VmDiskDeviceType | The disk device type (should be @disk) |
| domainID | UUID | The Storage Domain containing the Volume |
| poolID | UUID | The Storage Pool containing the Volume |
| imageID | UUID | The Image associated with the Volume |
| volumeID | UUID | The UUID of the target Volume |
Since: 4.10.0
DriveVmPayload:
Directly specified data to be inserted into a VM.
Members
| file | StringMap | A dictionary of file contents indexed by filename |
Since: 4.10.0
ExitedVmStats:
Statistics about a VM that no longer running.
Members
| exitCode | VmExitCode | Code indicating whether the VM exit was normal or in error |
| status | VmStatus | The current VM status |
| exitMessage | str | Detailed reason for the virtual machine exit |
| exitReason | VmExitReason | The specific exit reason code (new in version 4.15.0) |
| timeOffset | int | #optional The time difference from host to the VM in seconds |
Since: 4.10.0
FcHba:
Information about a FibreChannel host bus adapter.
Members
| wwpn | str | World-wide port name |
| wwnn | str | World-wide node name |
| model | str | Model of installed FibreChannel card |
Since: 4.10.0
FenceNodeResult:
Result of fenceNode command.
Since: 4.16.0
FencingPolicy:
Additional options for fenceNode logic.
Members
| storageDomainHostIdMap | HostIdMap | #optional map of storage domains and host ids. It is used to check status of host lease on specified storage. If host has live lease on at least one storage domain, then fence actions 'on', 'off' and 'reboot' will not be executed. The 'status' action execution is unaffected by content of the map. |
Since: 4.16.0
GuestDiskMappingInfo:
disk mapping information indexed by property name.
Members
| name | str | device logical name within the guest. |
Since: 4.16.8
GuestMemoryStats:
Memory statistics as reported by the guest agent.
Members
| mem_total | str | The total amount of memory available to the OS (in KiB) |
| mem_unused | str | The amount of memory that is completely unused (in KiB) |
| mem_free | str | The amount of memory available for allocation in KiB (includes easily reclaimable memory) |
| swap_in | uint | The number of memory pages swapped in since the last collection |
| swap_out | uint | The number of memory pages swapped out since the last collection |
| pageflt | uint | The number of page faults since the last collection |
| majflt | uint | The number of major page faults since the last collection |
| swap_total | str | #optional The total amount of swap space available to the OS (in KiB) |
| swap_usage | str | #optional The amount of swap space used by the OS (in KiB) |
| mem_buffers | str | #optional The amount of temporary raw disk block storage used by the OS (in KiB) |
| mem_cached | str | #optional The amount of pagecache used by the OS (in KiB) |
Since: 4.10.0
GuestMountInfo:
Information about a mounted filesystem as reported by the guest agent.
Members
| path | str | The filesystem mount point |
| fs | str | The filesystem type |
| total | uint | The total amount of space on the filesystem in bytes |
| used | uint | 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 | str | The network device name |
| hw | str | The MAC address |
| inet | str | The IPv4 addresses |
| inet6 | str | The IPv6 addresses |
Since: 4.10.0
GuestNumaNode:
Information about a guest numa node(also known as cell)
Members
| cpus | str | The guest cpu ids in this guest numa node. Refer to http://libvirt.org/formatdomain.html#elementsCPU for the format details. |
| memory | int | The total memory of this guest numa node in MiB. |
Since: 4.15.0
HardwareInformation:
Host hardware fields.
Members
| systemManufacturer | str | #optional Host manufacturer's name |
| systemProductName | str | #optional Host's hardware module |
| systemVersion | str | #optional Host's hardware version |
| systemSerialNumber | str | #optional Hardware serial number |
| systemUUID | str | #optional Host's hardware UUID |
| systemFamily | str | #optional Processor type |
Since: 4.10.3
HbaInventory:
Information about all available host bus adapters.
Members
| iSCSI | IscsiHba | List of iSCSI HBAs |
| FC | FcHba | List of FibreChannel HBAs |
Since: 4.10.0
HookScriptInfo:
Information about one script within a hook.
Members
| md5 | str | The md5 sum of the script |
Since: 4.10.0
HostNetworkInterfaceStats:
Statistics about a single host network interface.
Members
| name | str | The network device name |
| speed | uint | The interface speed (in Megabits/s) |
| rxDropped | uint | The number of incoming packets that have been dropped |
| txDropped | uint | The number of outgoing packets that have been dropped |
| rxErrors | uint | The number of incoming packets that have contained errors |
| txErrors | uint | The number of outgoing packets that have contained errors |
| state | NetworkInterfaceState | Indicates whether the interface is currently active |
| rxRate | float | The rate of incoming packets (as a percentage of @speed) |
| txRate | float | The rate of outgoing packets (as a percentage of @speed) |
Since: 4.11.1
HostStats:
Statistics about this host.
Members
| cpuUser | float | Ratio of CPU time spent in userspace |
| cpuSys | float | Ratio of CPU time spent in kernel |
| cpuIdle | float | Ratio of CPU time spent idle |
| rxRate | float | Incoming packet rate (as a percentage of total capacity) |
| txRate | float | Outgoing packet rate (as a percentage of total capacity) |
| statsAge | uint | Seconds elapsed since the stats were last sampled |
| network | HostNetworkInterfaceStatsMap | Per-interface network statistics |
| rxDropped | uint | The number of incoming packets dropped |
| txDropped | uint | The number of outgoing packets dropped |
| cpuSysVdsmd | float | Ratio of CPU time spent in kernel by vdsm |
| cpuUserVdsmd | float | Ratio of CPU time spent in userspace by vdsm |
| storageDomains | StorageDomainVitalsMap | Storage Domain vital statistics |
| elapsedTime | uint | The number of seconds that vdsm has been running |
| memUsed | uint | The percentage of memory used (not including caches) |
| anonHugePages | uint | The amount of anonymous memory in huge pages (in MB) |
| cpuLoad | float | The 5 minute CPU load average |
| diskStats | PathStatsMap | Statistics about paths on the host filesystem |
| thpState | THPStates | Current mode of the Transparent Huge Pages feature |
| memAvailable | int | Amount of memory available to run virtual machines (in MB) |
| memFree | int | Amount of free memory on host (in MB) |
| memShared | int | Approximate amount of memory that is shared by VMs due to the KSM feature (in bytes) |
| memCommitted | int | Amount of memory committed to running VMs (in MB) |
| swapTotal | int | The total amount of swap space (in MB) |
| swapFree | int | The amount of free swap space remaining (in MB) |
| vmCount | int | The number of VMs present on this host |
| vmActive | int | The number of VMs active on this host |
| vmMigrating | int | The number of VMs migrating away from this host |
| dateTime | str | The current date and time according to this host |
| ksmState | bool | Indicates if KSM is enabled or disabled |
| ksmPages | int | The number of memory pages KSM will scan at each interval |
| ksmCpu | float | The amount of CPU being used by the KSM thread |
| netConfigDirty | bool | Indicates if there are uncommitted changes to the network configuration |
| generationID | UUID | A @UUID that is refreshed each time vdsm starts |
| momStatus | MOMStatus | The current status of the MOM policy engine |
| haScore | int | #optional The host score according to the HA agent, if installed (new in version 4.13.0) |
| haStatus | HostedEngineStatus | The current status of the Hosted Engine HA system (new in version 4.14.0) |
| bootTime | uint | #optional The boot time of the system in seconds since epoch (new in 4.15.0) |
| numaNodeMemFree | NumaNodeMemoryStatsMap | Statistics about the memory of numa nodes (new in version 4.15.0) |
| cpuStatistics | CpuCoreStatsMap | Statistics about each cpu core (new in version 4.15.0) |
Since: 4.10.0
HostedEngineStatus:
Hosted Engine subsystem status, according to each host.
Members
| configured | bool | Indicates if Hosted Engine is configured on this host |
| active | bool | Indicates if the HA agent is alive and updating data |
| globalMaintenance | bool | Indicates if cluster is in global maintenance mode |
| localMaintenance | bool | Indicates if host is in local HA maintenance mode |
| score | uint | Numeric host score |
Since: 4.14.0
HotplugDiskParams:
Parameters for @VM.hotplugDisk.
Members
| vmId | UUID | The UUID of the VM to modify |
| drive | VmDiskDevice | The disk device specification |
Since: 4.10.0
HotplugNicParams:
Parameters for @VM.hotplugNic.
Since: 4.10.0
ImageSharingMethodArgs:
A discriminated record to store the arguments used by the sharing method.
Since: 4.12.0
ImageSharingMethodArgsHttp:
Specific arguments used to to share (upload/download) an image using http.
Members
| url | str | Url where upload or download the image |
| headers | StringMap | Additional http headers to be used in the request |
Since: 4.12.0
IscsiConnectionParameters:
Parameters for initiating a new ISCSI connection.
Members
| portal | IscsiPortal | An @IscsiPortal to identify the requested target |
| iqn | str | The ISCSI Qualified Name |
| tpgt | int | #optional The Target Portal Group Tag to use |
| iface | str | #optional The ISCSI interface name |
| credentials | IscsiCredentials | #optional An @IscsiCredentials containing the required authentication information |
Since: 4.10.0
IscsiCredentials:
This structure stores ISCSI credentials.
Since: 4.10.0
IscsiCredentialsLogin:
Login credentials for an ISCI target.
Members
| username | str | The username used for authentication to an ISCI target |
| password | str | The password associated with the given username |
Since: 4.10.0
IscsiHba:
Information about an iSCSI host bus adapter.
Members
| InitiatorName | str | iSCSI initiator |
Since: 4.10.0
IscsiPortal:
A host/port pair that identifies an ISCSI target.
Members
| host | str | A fully-qualified domain name (FQDN) or IP address |
| port | int | #optional A port number |
Since: 4.10.0
IscsiSessionInfo:
Information about a single, active iSCSI session.
Members
| connection | str | The hostname of the iSCSI target |
| port | str | The port number of the iSCSI target |
| iqn | str | The ISCSI Qualified Name |
| portal | str | The Target Portal Group Tag |
| initiatorname | str | iSCSI initiator |
| username | str | #optional A login name on the iSCSI target |
| password | str | #optional The password corresponding to @username |
Since: 4.10.0
LocalFsConnectionParameters:
Parameters for initiating a connection to local storage.
Members
| path | str | The local filesystem path |
Since: 4.10.0
MigrateParams:
Parameters for @VM.migrate.
Members
| vmId | UUID | The UUID of the virtual machine to migrate |
| dst | str | The destination host in <host>[:<port>] format. The port is optional and should usually be omitted. |
| dstparams | str | Used only by the hibernate API. Ignored for @remote migration |
| mode | MigrateMode | #optional The migration mode. Callers of this API should use @remote. For @file migration use @VM.hibernate. |
| method | MigrateMethod | #optional |
| tunneled | bool | #optional use libvirt's tunneled migration. default it False. |
| abortOnError | bool | #optional Abort migration on I/O errors and refuse to migrate VMs, paused due to EIO |
| dstqemu | str | #optional The destination's host address dedicated for migration. |
Since: 4.10.0
MigrationCreateState:
Reports the state of a VM creation on the destination host.
Members
| migrationPort | int | The port used for migration (currently always 0) |
| params | VmDefinition | The VM status |
Since: 4.10.0
NetInfoBond:
Information about a ethernet bond device
Members
| slaves | str | A list of devices that are enslaved to the bond device |
| addr | str | The primary IPv4 address assigned to the bond device |
| netmask | str | The primary IPv4 netmask of the defined subnet |
| ipv4addrs | str | A list of IPv4 addresses in the format of 'address/prefixlen' that are assigned to the vlan device (new in version 4.15.0) |
| ipv6addrs | str | A list of IPv6 addresses in the format of 'address/prefixlen' that are assigned to the bond device |
| hwaddr | str | The Media Access Control address being used by the bond device |
| cfg | StringMap | Raw device configuration parameters |
| mtu | uint | The Maximum Transmission Unit size for the nic |
| opts | StringMap | A map of options; the values are numeric, but reported as strings (new in version 4.16.0) |
Since: 4.10.0
NetInfoBridgedNetwork:
Information about a VDSM bridged network.
Members
| ports | str | A list of nic device names that are bridged |
| stp | bool | Whether Spanning Tree Protocol status for the bridge device should be turned on |
| addr | str | The primary IPv4 address assigned to the bridge device |
| netmask | str | The primary IPv4 netmask of the defined subnet |
| gateway | str | The IP address of the subnet's gateway |
| ipv4addrs | str | A list of IPv4 addresses in the format of 'address/prefixlen' that are assigned to the vlan device (new in version 4.15.0) |
| ipv6addrs | str | A list of IPv6 addresses in the format of 'address/prefixlen' that are assigned to the bridge device |
| ipv6gateway | str | The default IPv6 gateway for the bridge device |
| mtu | uint | The Maximum Transmission Unit size for the bridge device |
| cfg | StringMap | A map containing network interface parameters from ifcfg-* files. It is indexed by parameter name and stores the parameter value. |
| bridged | bool | Always True to distinguish this type from @NetInfoBridgelessNetwork |
| qosOutbound | BandwidthParams | #optional BandwidthParams for outgoing traffic. |
| opts | StringMap | A map containing information about the bridge specific options. (new in version 4.15.0) |
Since: 4.10.0
NetInfoBridgelessNetwork:
Information about a VDSM bridgeless network.
Members
| interface | str | The network device name associated with the network |
| bridged | bool | Always False to distinguish this type from @NetInfoBridgedNetwork |
Since: 4.10.0
NetInfoNetwork:
A discriminated record to store information about a VDSM network.
Members
| bridged | bool | If True, the union is a 'NetInfoBridgedNetwork' If False, the union is a 'NetInfoBridgelessNetwork' |
Since: 4.10.0
NetInfoNic:
Information about a network interface card.
Members
| speed | int | The reported speed of the nic |
| addr | str | The primary IPv4 address assigned to the nic device |
| netmask | str | The primary IPv4 netmask of the defined subnet |
| ipv4addrs | str | A list of IPv4 addresses in the format of 'address/prefixlen' that are assigned to the vlan device (new in version 4.15.0) |
| ipv6addrs | str | A list of IPv6 addresses in the format of 'address/prefixlen' that are assigned to the nic |
| hwaddr | str | The Media Access Control address being used by the nic |
| mtu | uint | The Maximum Transmission Unit size for the nic |
| permhwaddr | str | #optional For bonded nics: the real MAC address which will be used if the card is freed from the bond. |
Since: 4.10.0
NetInfoVlan:
Information about a Virtual Local Area Network
Members
| iface | str | The network device associated with the vlan |
| addr | str | The primary IPv4 address assigned to the vlan device |
| netmask | str | The primary IPv4 netmask of the defined subnet |
| ipv4addrs | str | A list of IPv4 addresses in the format of 'address/prefixlen' that are assigned to the vlan device (new in version 4.15.0) |
| ipv6addrs | str | A list of IPv6 addresses in the format of 'address/prefixlen' that are assigned to the vlan device |
| mtu | uint | The Maximum Transmission Unit size for the vlan |
| vlanid | uint | The vlan ID assigned to the vlan device |
Since: 4.10.0
NetworkInterfaceStats:
Statistics about a single network interface.
Members
| name | str | The network device name |
| speed | uint | The interface speed (in Megabits/s) |
| rxDropped | uint | The number of incoming packets that have been dropped |
| txDropped | uint | The number of outgoing packets that have been dropped |
| rxErrors | uint | The number of incoming packets that have contained errors |
| txErrors | uint | The number of outgoing packets that have contained errors |
| state | NetworkInterfaceState | Indicates whether the interface is currently active |
| rxRate | float | The rate of incoming packets (as a percentage of @speed) |
| txRate | float | The rate of outgoing packets (as a percentage of @speed) |
| macAddr | str | The hardware address |
Since: 4.10.0
NetworkOptions:
Detailed network configuration options.
Members
| ipaddr | str | #optional Assign this static IP address to the interface |
| netmask | str | #optional The netmask of this subnet |
| gateway | str | #optional IP address of the network gateway |
| bootproto | str | #optional Interface autoconfiguration protocol (typically 'dhcp' or 'static') |
| bondingOptions | str | #optional A string of space-separated <option>=<value> pairs |
| blockingdhcp | bool | #optional whether ifaces that have 'dhcp' as bootproto should wait to get an address before returning creation success. If not set, the default is False. |
| qosOutbound | BandwidthParams | #optional BandwidthParams for outgoing traffic. |
Since: 4.10.0
NfsConnectionParameters:
Parameters for initiating a new NFS connection.
Members
| export | str | The remote target in <host>:<path> format |
| retrans | int | #optional The number of retry attempts for failing operations |
| timeout | int | #optional The time to wait before retrying a request (specified in tenths of one second). |
| version | str | #optional Set the NFS protocol version |
Since: 4.10.0
NumaNode:
Information about a host numa cell
Members
| cpus | uint | The cpu ids in this numa node. The cpu id is described in libvirt's capabilities api. When hyper-thread is enabled, one cpu core id will correspond to two sibling cpu ids. |
| totalMemory | uint | The total memory of this numa node in MiB. |
Since: 4.15.0
NumaNodeMemoryStats:
Statistics about the memory of a numa node.
Members
| memFree | uint | The amount of free memory (in MB) |
| memPercent | uint | The ratio of used memory |
Since: 4.15.0
NumaTune:
Information about a vm numatune configuration
Members
| mode | str | The numatune mode. Either 'interleave', 'strict', or 'preferred', defaults to 'strict'. |
| nodeset | str | Specify the numa nodes that the vm will use. Refer to http://libvirt.org/formatdomain.html#elementsNUMATuning for the format details. |
Since: 4.15.0
OsVersion:
Host operating system version information.
Members
| release | str | The release number for this @version |
| version | str | The OS version (eg. 17 for Fedora 17) |
| name | OSName | The name of the OS |
Since: 4.10.0
PathStats:
Statistics about a host filesystem path.
Members
| free | uint | The amount of free space remaining (in MB) |
Since: 4.10.0
PosixFsConnectionParameters:
Parameters for initiating a new POSIX FS connection.
Members
| spec | str | A string identifying the location of the target filesystem |
| vfstype | str | The Linux VFS filesystem type |
| options | str | #optional A comma-separated list of mount options |
Since: 4.10.0
RunningVmStats:
Statistics for a running virtual machine.
Members
| displayPort | uint | The port in use for unencrypted display data |
| displaySecurePort | uint | The port in use for encrypted display data |
| displayType | VmDisplayType | The type of display in use |
| displayIp | str | The IP address to use for accessing the VM display |
| pid | uint | The process ID of the underlying qemu process |
| vmType | VmType | The type of VM |
| kvmEnable | bool | Indicates if KVM hardware acceleration is enabled |
| network | NetworkInterfaceStatsMap | Network bandwidth/utilization statistics |
| disks | VmDiskStatsMap | Disk bandwidth/utilization statistics |
| monitorResponse | int | Indicates if the qemu monitor is responsive |
| elapsedTime | uint | The number of seconds that the VM has been running |
| cdrom | str | #optional The path to an ISO image used in the VM's CD-ROM device |
| boot | VmBootMode | #optional An alias for the type of device used to boot the VM |
| statsAge | float | The age of these statistics in seconds |
| cpuSys | float | Ratio of CPU time spent by qemu on other than guest time |
| cpuUser | float | Ratio of CPU time spent by the guest VM |
| acpiEnable | bool | Indicates if ACPI is enabled inside the VM |
| timeOffset | uint | The time difference from host to the VM in seconds |
| clientIp | str | The IP address of the client connected to the display |
| pauseCode | str | Indicates the reason a VM has been paused |
| memUsage | uint | The percent of memory in use by the guest |
| username | str | The username associated with the current session |
| session | GuestSessionState | The current state of user interaction with the VM |
| appsList | str | A list of installed applications with their versions |
| guestIPs | str | A space separated string of assigned IPv4 addresses |
| memoryStats | GuestMemoryStats | Memory statistics as reported by the guest agent |
| balloonInfo | BalloonInfo | Guest memory balloon information |
| disksUsage | GuestMountInfo | Info about mounted filesystems as reported by the agent |
| netIfaces | GuestNetworkDeviceInfo | Network device address info as reported by the agent |
| watchdogEvent | WatchdogEvent | #optional Information about the most recent watchdog event |
| guestFQDN | str | Fully qualified domain name of the guest OS. (Reported by the guest agent) |
| migrationProgress | uint | #optional Indicates the percentage progress of a Migration, when there is one active. (new in version 4.15.0) |
| guestCPUCount | int | The number of CPU cores are visible as online on the guest OS. This value is -1 if not supported to report |
| displayInfo | VmDisplayInfo | Display and graphics device informations. (new in version 4.15.0) |
| vmJobs | VmJobsMap | #optional Info about active vm jobs (new in version 4.15.0) |
| vNodeRuntimeInfo | VmNumaNodeRuntimeInfoMap | #optional Information about the vm numa node runtime pinning to host numa node. (new in version 4.15.0) |
| vcpuQuota | int | #optional Setting for libvirt cpu_quota. (new in version 4.15.0) |
| vcpuPeriod | int | #optional Setting for libvirt cpu_period. (new in version 4.15.0) |
| vcpuCount | int | #optional Number of vCPUs assigned to the VM (new in version 4.15.0) |
| vcpuUserLimit | int | #optional Cpu usage hard limit in percents. (new in version 4.15.0) |
| ioTune | VmDiskDeviceTuneParams | #optional Current QoS settings for IO devices (new in version 4.15.0) |
Since: 4.10.0
SELinuxStatus:
Information about host SELinux.
Members
| mode | int | The policy enforcement mode. Values are (from SELinux documentation): 1 = enforcing, 0 = permissive, -1 = disabled. |
Since: 4.15.0
SetupNetworkBondAttributes:
Configuration attributes for a single bonded network interface device.
Members
| nics | str | An array of network device names to include in the bond |
| options | str | #optional A string of space-separated <option>=<value> pairs |
| remove | bool | #optional If True, remove existing bond only |
Since: 4.10.0
SetupNetworkNetAttributes:
Configuration attributes for a single host network.
Members
| vlan | str | #optional The name of an associated vlan |
| bonding | str | #optional If the network is bonded, the name of the bond device |
| nic | str | #optional If the network is not bonded, an array containing a single network device name |
| ipaddr | str | #optional Assign this static IP address to the network |
| netmask | str | #optional Assign this netmask to the network |
| gateway | str | #optional Assign this gateway to the network |
| bootproto | str | #optional Interface autoconfiguration protocol (typically 'dhcp' or 'static') |
| remove | bool | #optional If True, remove existing network only |
| qosOutbound | BandwidthParams | #optional BandwidthParams for outgoing traffic. |
| defaultRoute | bool | #optional boolean - Is this network's gateway the host's default gateway? |
| custom | StringMap | #optional A dictionary of custom, free-form properties for network. (new in version 4.15.0) |
Since: 4.10.0
SetupNetworkOptions:
Additional options for setupNetworks.
Members
| force | int | #optional If True, skip validation of the configuration |
| connectivityCheck | int | #optional After reconfiguration, check for network connectivity and roll back if necessary |
| connectivityTimeout | int | #optional The amount of time to wait before failing the connectivity check in seconds |
Since: 4.10.0
SnapshotDriveInfo:
A discriminated record of snapshot information for a VM disk.
Since: 4.10.0
SnapshotGUIDDriveInfo:
Snapshot information for a VM disk that is identified by a devmapper GUID.
Members
| baseGUID | UUID | The devmapper device GUID associated with the VM disk |
| GUID | UUID | The devmapper device GUID in which to create the snapshot |
Since: 4.10.0
SnapshotUUIDDriveInfo:
Snapshot information for a VM disk that is identified by a block device UUID.
Members
| baseUUID | UUID | The block device ID associated with the VM disk |
| UUID | UUID | The block device ID in which to create the snapshot |
Since: 4.10.0
SnapshotVolumeDriveInfo:
Snapshot information for a Volume-based VM disk.
Members
| domainID | UUID | The Storage Domain associated with the VM disk |
| imageID | UUID | The Image associated with the VM disk |
| baseVolumeID | UUID | The Volume associated with the VM disk |
| volumeID | UUID | The Volume in which to create the snapshot |
Since: 4.10.0
SoftwarePackageInfo:
Information about an installed piece of software.
Members
| version | str | The software version |
| release | str | The release number for this @version |
| buildtime | str | The time and date the software was built |
Since: 4.10.0
SpmStatus:
Storage Pool Manager status information.
Members
| spmStatus | SpmRole | The SPM role for this host |
| spmLver | int | The lock version of the Storage Pool |
| spmId | int | The Host ID of the Storage Pool Manager |
Since: 4.10.0
StorageDomainCreateArguments:
A discriminated record of Storage Domain creation parameters.
Since: 4.10.0
StorageDomainCreateArgumentsBlock:
Creation argument for Block-based Storage Domains.
Members
| vgUUID | UUID | The UUID of a Volume Group to use as backing storage |
Since: 4.10.0
StorageDomainCreateArgumentsLocal:
Creation argument for local filesystem Storage Domains.
Members
| remotePath | str | A path on the local filesystem |
Since: 4.10.0
StorageDomainCreateArgumentsNfs:
Creation argument for NFS-based Storage Domains.
Members
| remotePath | str | An export path in the form: <host>:<path> |
Since: 4.10.0
StorageDomainFileStats:
Information about files contained within a Storage Domain.
Members
| size | uint | Size of the file in bytes |
| ctime | uint | Time the file was last changed in seconds since the epoch |
| status | int | Indicates if the file is accessible |
Since: 4.10.0
StorageDomainInfo:
Information about a Storage Domain.
Members
| uuid | UUID | The Storage Domain UUID |
| domainType | StorageDomainType | The type of backing storage used by this domain |
| domainClass | StorageDomainImageClass | The Storage Domain class |
| name | str | The human-readable name for this Storage Domain |
| role | StorageDomainRole | The Storage Domain role |
| pool | UUID | The Storage Pool associated with this Storage Domain |
| version | int | The version of this Storage Domain |
| lver | int | The lock version of the associated Storage Pool |
| spm_id | int | Contains the Host ID of the Storage Pool Manager |
| master_ver | int | The version of the master Storage Domain |
Since: 4.10.0
StorageDomainStats:
Storage Domain statistics.
Members
| disktotal | int | The amount of total storage space in bytes |
| diskfree | int | The amount of free storage space in bytes |
| mdasize | int | The size of the metadata area in bytes |
| mdafree | int | The amount of free space in the metadata area in bytes |
| mdavalid | bool | Indicates if the metadata area is large enough |
| mdathreshold | bool | Indicates if the metadata has exceeded its size threshold |
Since: 4.10.0
StorageDomainVitals:
Regularly collected Storage Domain vital statistics.
Members
| code | int | Storage Domain status code |
| delay | float | The amount of time it takes to read a small amount of data from the storage. |
| lastCheck | float | Elapsed time since the Storage Domain was last checked |
| valid | bool | Indicates if the Storage Domain is functioning properly |
| version | int | Indicates the Storage Domain version |
| acquired | bool | Indicates if the lockspace on the Storage Domain has been acquired and therefore if it's possible to run (sanlock) protected VMs |
Since: 4.10.0
StoragePoolDomainAlert:
Alert information for a Storage Domain attached to this Storage Pool.
Members
| code | int | The alert code |
| message | str | A detailed alert string |
Since: 4.10.0
StoragePoolDomainInfo:
Information about a Storage Domain that is attached to a Storage Pool.
Members
| disktotal | int | The total amount of disk space in the Storage Domain in bytes |
| diskfree | int | The remaining free disk space in bytes |
| alerts | StoragePoolDomainAlert | A list of alerts for this Storage Domain |
| status | StorageDomainStatus | Current Storage Domain status |
| version | int | Indicates the Storage Domain version |
Since: 4.10.0
StoragePoolFullInfo:
Storage Pool and Storage Domain information.
Since: 4.10.0
StoragePoolInfo:
Information about a Storage Pool.
Members
| domainType | StorageDomainType | The type of storage managed by this Storage Pool |
| name | str | The Storage Pool name |
| domains | str | All associated Storage Domains (the string has the following format: '<uuid>:<status>,<uuid>:<status>...' |
| master_uuid | UUID | The UUID of the Storage Domain serving as the master domain |
| master_ver | int | The Storage Domain version of the master domain |
| lver | int | The Storage Pool lock version |
| spm_id | int | The Host ID of the host that is acting Storage Pool Manager |
| isoprefix | str | The filesystem path from where ISO images may be referenced |
| pool_status | StoragePoolStatus | The current status of the Storage Pool |
| version | int | The Storage Pool version |
Since: 4.10.0
StorageServerConnectionValidateParams:
Validation parameters for a connection to backing storage.
Members
| id | UUID | A UUID to identify this set of parameters in the return value |
Notes:
Since: 4.10.0
StorageServerConnectionValidateStatus:
indicates validity of backing storage connection parameters.
Members
| id | UUID | A UUID to identify this set of parameters |
| status | int | Code indicating the validity of the parameters |
Notes:
Since: 4.10.0
TaskDetails:
A collection of information about a task.
Members
| id | UUID | The task @UUID |
| verb | str | The underlying operation to be performed by the task |
| state | TaskState | Current task state (@TaskState) |
| code | int | Return code from the underlying task verb |
| message | str | Detailed error message from the underlying task verb |
| taskResult | TaskResult | Final task result (@TaskResult) |
| tag | str | The tag assigned to the task |
Since: 4.10.0
TaskInfo:
Extra information about a task.
Members
| id | UUID | The @UUID of the task |
| verb | str | The underlying operation to be performed by the task |
Since: 4.10.0
TaskStatus:
A collection of status information about a task.
Members
| taskID | UUID | The task @UUID |
| taskState | TaskState | Current task state (@TaskState) |
| taskResult | TaskResult | Final task result (@TaskResult) |
| message | str | Detailed error message from the underlying task verb |
| code | int | Return code from the underlying task verb |
Since: 4.10.0
UpdateVmDefinition:
Virtual machine definition data suitable for saving to a Storage Domain.
Members
| vm | UUID | The VM UUID |
| ovf | str | The VM definition in OVF format |
| imglist | str | The Images this VM depends on (a comma-separated string of UUIDs) |
Since: 4.10.0
UpdateVmPolicyParams:
QoS policy update data
Members
| vcpuLimit | int | #optional vcpu limit to set - the value is a percentage representation of the amount of cpu from the Host that the VM can consume |
| ioTune | VmDiskDeviceTuneLimits | #optional list of ioTune limits to set |
Since: 4.15.0
VMFullInfo:
Full information about VM.
Members
| acpiEnable | bool | Indicates if ACPI is enabled inside the VM |
| custom | StringMap | A dictionary of custom, free-form properties |
| devices | VmDevice | An array of VM devices requested |
| display | VmDisplayType | The type of display |
| kvmEnable | bool | Indicates if KVM hardware acceleration is enabled |
| memSize | uint | The amount of memory assigned to the VM in MB |
| nice | int | The host scheduling priority |
| smp | uint | The number of CPUs presented to the VM |
| smpCoresPerSocket | uint | Indicates the number of CPU cores per socket |
| timeOffset | uint | The time difference from host to the VM in seconds |
| transparentHugePages | bool | Indicates if the Transparent Huge Pages feature is enabled for this virtual machine |
| vmId | UUID | The VM UUID |
| vmName | str | The VM name |
| vmType | VmType | The type of VM |
| memGuaranteedSize | uint | The amount of memory guaranteed to the VM in MB |
| displaySecurePort | uint | The port in use for encrypted display data |
| spiceSecureChannels | str | Secure space channels comma separated |
| username | str | The username associated with the current session |
| emulatedMachine | str | The machine specification being emulated |
| pid | uint | The process ID of the underlying qemu process |
| spiceSslCipherSuite | str | |
| cpuType | str | The type of CPU being emulated special values 'hostPassthrough' and 'hostModel' are reserved for host-passthrough and host-mode cpu mode |
| pauseCode | str | Indicates the reason a VM has been paused |
| guestFQDN | str | Fully qualified domain name of the guest OS. (Reported by the guest agent) |
| displayIp | str | The IP address to use for accessing the VM display |
| keyboardLayout | str | The keyboard layout string (eg. 'en-us') |
| displayPort | uint | The port in use for unencrypted display data |
| guestIPs | str | A space separated string of assigned IPv4 addresses |
| guestDiskMapping | GuestDisksMappingMap | A dictionary containing information about the disk mapping within the guest. The key is the device serial and the value is the mapping information. (New in version 4.16.8.) |
| smartcardEnable | bool | Info whether smartcard is enabled. |
| nicModel | VmInterfaceDeviceModel | The type of device that is exposed to the VM operating system |
| pitReinjection | bool | |
| status | str | State of the VM |
| clientIp | str | The IP address of the client connected to the display |
Since: 4.14.1
VdsmCapabilities:
Host information and capabilities.
Members
| kvmEnabled | bool | KVM is enabled on the host |
| cpuThreads | uint | The number of CPU threads present |
| cpuCores | uint | The number of CPU cores present |
| cpuSockets | uint | The number of CPU sockets |
| onlineCpus | str | The list of online logical CPUs (new in version 4.16.7) |
| cpuSpeed | float | The speed of each CPU (in MHz) |
| cpuModel | str | The CPU model |
| cpuFlags | str | CPU feature flags (a comma-separated string) |
| version_name | str | The name given to this version of VDSM |
| software_version | str | VDSM version (x.y.z) |
| software_revision | str | Extra VDSM version information |
| supportedENGINEs | str | A list of supported ovirt-engine versions |
| supportedProtocols | str | A list of supported xmlrpc protocol versions |
| clusterLevels | str | A list of supported cluster versions |
| networks | NetInfoNetworkMap | Information about configured VDSM networks |
| bridges | NetInfoBridgeMap | Information about the network bridges on the host |
| nics | NetInfoNicMap | Information about the network cards on the host |
| bondings | NetInfoBondMap | Information about configured bonding devices |
| vlans | NetInfoVlanMap | Information about configured vlans |
| hooks | HookScriptInfoMap | #optional Information about installed hooks |
| operatingSystem | OsVersion | Operating system version information |
| uuid | str | A unique host ID |
| packages2 | SoftwarePackageInfoMap | Version information of important software packages |
| emulatedMachines | str | A list of supported emulated machines |
| ISCSIInitiatorName | str | The iSCSI initiator name for this host |
| HBAInventory | HbaInventory | Information about available host bus adapters |
| vmTypes | VmType | A list of supported virtual machine types |
| memSize | uint | The amount of total memory installed in the host |
| reservedMem | uint | The amount of memory reserved for hypervisor overhead |
| guestOverhead | uint | The amount of memory reserved for per-guest overhead |
| netConfigDirty | bool | Indicates if there are uncommitted changes to the network configuration |
| rngSources | VmRngDeviceSource | Sources of entropy available at this host |
| numaNodes | NumaNodeMap | Information about host numa topology |
| numaNodeDistance | NumaNodeDistanceMap | Distance information between each two numa nodes |
| autoNumaBalancing | AutoNumaBalancingStatus | The status of auto numa balancing function |
| selinux | SELinuxStatus | The status and configuration of SELinux on the host. |
| liveSnapshot | bool | #optional Indicates if the host supports live snapshotting (new in version 4.15.0) |
| kdumpStatus | int | The current status of kdump configuration for the host: enabled (1), disabled(0), unknown(-1) (new in version 4.15.0) |
| liveMerge | bool | #optional Indicates if live merge is supported on this host. (new in version 4.15.0) |
Notes:
- Since ovirt-engine cannot parse software versions in 'x.y.z' format, the current API truncates @software_version to 'x.y'.
Since: 4.15.0
VmBalloonDevice:
Properties of a VM balloon device.
Since: 4.10.0
VmBalloonDeviceSpecParams:
Additional parameters for VM balloon devices.
Since: 4.10.0
VmChannelDevice:
Properties of a VM channel device.
Members
| deviceType | VmDeviceType | The device type (always @channel) |
| device | VmChannelDeviceType | The specific type of channel device |
| address | VmDeviceAddress | Device hardware address |
| alias | str | Alias used to identify this device in commands |
| deviceId | UUID | A unique ID for this device |
Since: 4.10.0
VmConsoleDevice:
Properties of a VM console device.
Members
| deviceType | VmDeviceType | The device type (always @console) |
| deviceId | UUID | A unique ID for this device |
Since: 4.10.0
VmControllerDevice:
Properties of a VM controller device.
Members
| deviceType | VmDeviceType | The device type (always @controller) |
| device | VmControllerDeviceType | The specific type of controller device |
| address | VmDeviceAddress | Device hardware address |
| alias | str | Alias used to identify this device in commands |
| deviceId | UUID | A unique ID for this device |
| model | str | The controller device model in use |
Since: 4.10.0
VmDefinition:
Full virtual machine status and properties.
Members
| acpiEnable | bool | Indicates if ACPI is enabled inside the VM |
| clientIp | str | The IP address of the client connected to the display |
| copyPasteEnable | bool | #optional Specify if copy and paste is enabled. Currently relevant for @qxl devices only. (new in version 4.15.0) |
| cpuShares | str | #optional The host scheduling priority (relative to other VMs). In case both cpuShares and nice are present, cpuShares will be used. |
| cpuType | str | #optional The type of CPU being emulated special values 'hostPassthrough' and 'hostModel' are reserved for host-passthrough and host-mode cpu mode |
| custom | StringMap | #optional A dictionary of custom, free-form properties |
| devices | VmDevice | #optional An array of VM devices present |
| display | VmDisplayType | The type of display |
| displayIp | str | The IP address to use for accessing the VM display |
| displayPort | int | The port in use for unencrypted display data |
| displaySecurePort | int | The port in use for encrypted display data |
| emulatedMachine | str | #optional The machine specification being emulated |
| hypervEnable | bool | #optional Enables hyperv specific optimizations for the Guest OS (new in version 4.16.0) |
| keyboardLayout | str | #optional The keyboard layout string (eg. 'en-us') |
| kvmEnable | bool | Indicates if KVM hardware acceleration is enabled |
| maxVCpus | uint | #optional Maximum number of CPU available for the guest It is the upper boundry for hot plug CPU action |
| memSize | uint | The amount of memory assigned to the VM in MB |
| memGuaranteedSize | uint | The amount of memory guaranteed to the VM in MB |
| nicModel | str | A comma-separated list of NIC models in use by the VM |
| nice | int | The host scheduling priority |
| pauseCode | str | #optional Indicates the reason a VM has been paused |
| pid | uint | The process ID of the underlying qemu process |
| smp | uint | The number of CPUs presented to the VM |
| smpCoresPerSocket | uint | #optional Indicates the number of CPU cores per socket |
| smpThreadsPerCore | uint | #optional Indicates the number of CPU threads per core |
| status | VmStatus | The current VM status |
| timeOffset | uint | The time difference from host to the VM in seconds |
| transparentHugePages | bool | Indicates if the Transparent Huge Pages feature is enabled for this virtual machine |
| vmId | UUID | The VM UUID |
| vmName | str | The VM name |
| vmType | VmType | The type of VM |
| exitCode | int | #optional The exit code f the VM process has ended |
| exitMessage | str | #optional Explains the reason that the VM process has exited |
| serial | str | #optional Serial number for the VM. |
Since: 4.10.0
VmDevice:
A discriminated record containing VM device properties.
Members
| deviceType | VmDeviceType | Indicates the specific device type |
Since: 4.10.0
VmDeviceAddress:
A discriminated record of device address information.
Since: 4.10.0
VmDeviceIdeAddress:
Device address for an IDE device.
Members
| addressType | VmDeviceAddressType | The device address type (always @drive) |
| controller | uint | The IDE controller number |
| bus | uint | The IDE bus number |
| unit | uint | The unit number on the IDE bus |
Since: 4.10.0
VmDevicePciAddress:
Device address for a PCI device.
Members
| addressType | VmDeviceAddressType | The device address type (always @pci) |
| slot | uint | The slot number on the PCI bus |
| bus | uint | The PCI bus number |
| domain | uint | The PCI domain |
| function | uint | Function number on the PCI card that implements the device |
Since: 4.10.0
VmDeviceVirtioSerialAddress:
Device address for a virtio-serial port.
Members
| addressType | VmDeviceAddressType | The device address type (always @virtio-serial) |
| controller | uint | The virtio-serial controller number |
| bus | uint | The virtio-serial bus number |
| port | uint | The port number on the virtio-serial bus |
Since: 4.10.0
VmDiskDevice:
Properties of a VM disk device.
Members
| deviceType | VmDeviceType | The device type (always @disk) |
| device | VmDiskDeviceType | The disk device type (eg. @cdrom or @disk) |
| iface | VmDiskDeviceInterface | #optional Indicates the device connection method exposed to the guest |
| path | str | #optional The filesystem path to the drive's volume |
| readonly | bool | Indicates if writes are prohibited for the device |
| bootOrder | uint | #optional If specified, this device is part of the boot sequence at the specified position |
| domainID | UUID | #optional The UUID of the underlying Storage Domain object |
| poolID | UUID | #optional The UUID of the underlying Storage Pool object |
| imageID | UUID | #optional The UUID of the underlying Image object |
| volumeID | UUID | #optional The UUID of the underlying Volume object |
| format | VmDiskDeviceFormat | The format used to store data on the backing storage |
| propagateErrors | bool | If enabled, disk I/O errors will be reported to vdsm for possible resolution (eg. allocating more space) |
| address | VmDeviceAddress | Device hardware address |
| alias | str | Alias used to identify this device in commands |
| deviceId | UUID | A unique ID for this device |
| specParams | VmDiskDeviceSpecParams | #optional Additional device parameters |
| apparentsize | uint | The size of the disk (in bytes) |
| index | int | The drive index |
| name | str | A user-friendly device name for display only |
| optional | bool | States if the VM may start if the disk is not present |
| shared | VmSharedDriveType | Indicates if this disk is intended to be shared by multiple virtual machines |
| truesize | uint | The amount of underlying storage allocated (in bytes) |
| volumeChain | VmDiskDeviceVolumeChainEntry | The sequence of Volume objects needed to construct the disk |
| baseVolumeID | UUID | #optional When used as a parameter to @VM.merge, indicates the Volume that should become the new base volume |
Since: 4.10.0
VmDiskDeviceIoTuneParams:
I/O tune parameters for the VM disk device.
Members
| total_bytes_sec | uint | #optional Total throughput limit in bytes per second. |
| read_bytes_sec | uint | #optional Read throughput limit in bytes per second. |
| write_bytes_sec | uint | #optional Write throughput limit in bytes per second. |
| total_iops_sec | uint | #optional Total I/O operations limit per second. |
| read_iops_sec | uint | #optional Read I/O operations limit per second. |
| write_iops_sec | uint | #optional Write I/O operations limit per second. |
Since: 4.10.0
VmDiskDeviceSpecParams:
Extra parameters for VM disk devices.
Since: 4.10.0
VmDiskDeviceTuneLimits:
Extra parameters for VM disk devices.
Since: 4.15.0
VmDiskDeviceTuneParams:
Extra parameters for VM disk devices. At least onedevice identifier (name/path) is needed.
Since: 4.15.0
VmDiskDeviceVolumeChainEntry:
Identifies one volume in a VM disk device volume chain.
Members
| domainID | UUID | The UUID of the storage domain that contains the volume |
| imageID | UUID | The UUID of the image that contains the volume |
| path | str | The filesystem path to the volume |
| volumeID | UUID | The UUID of the volume itself |
Since: 4.10.0
VmDiskStats:
Statistics about a virtual machine disk device.
Members
| truesize | uint | The amount of underlying storage allocated (in bytes) |
| apparentsize | uint | The size of the disk (in bytes) |
| imageID | UUID | The UUID of the Image associated with this disk |
| readRate | uint | The read activity in bytes per second |
| writeRate | uint | The write activity in bytes per second |
| readLatency | uint | The latency of read operations in nanoseconds |
| writeLatency | uint | The latency of write operations in nanoseconds |
| flushLatency | uint | The latency of flush operations in nanoseconds |
Since: 4.10.0
VmDisplayInfo:
Display and graphics device information.
Members
| port | uint | The port in use for unencrypted display data |
| tlsPort | uint | The port in use for encrypted display data |
| type | VmGraphicsDeviceType | The type of display in use |
| ipAddress | str | The IP address to use for accessing the VM display |
Since: 4.15.0
VmGraphicsDevice:
Properties of a VM graphics device.
Since: 4.15.0
VmGraphicsDeviceSpecParams:
Additional parameters for VM graphics devices.
Members
| keyMap | str | #optional The keyboard layout string (eg. 'en-us') |
| disableTicketing | bool | #optional disable security ticketing |
| displayNetwork | str | #optional Address of the display network |
| spiceSecureChannels | str | #optional Secure space channels, comma separated |
| copyPasteEnable | bool | #optional Specify if copy and paste is enabled. Currently relevant for @spice devices only. |
Since: 4.15.0
VmInfo:
A discriminated record of VM status information.
Since: 4.10.0
VmInterfaceDevice:
Properties of a VM network interface device.
Members
| deviceType | VmDeviceType | The device type (always @interface) |
| device | VmInterfaceDeviceType | The host network device type used to create the connection |
| nicModel | VmInterfaceDeviceModel | The type of device that is exposed to the VM operating system |
| macAddr | str | The unique ethernet hardware address of the device |
| network | str | The name of the attached host bridge device |
| bootOrder | uint | #optional If specified, this device is part of the boot sequence at the specified position |
| address | VmDeviceAddress | Device hardware address |
| alias | str | Alias used to identify this device in commands |
| deviceId | UUID | A unique ID for this device |
| specParams | VmInterfaceDeviceSpecParams | #optional Additional device parameters |
| linkActive | bool | #optional Whether the VM network card has its link active (up) or not (down). If omitted, the link will be active |
| portMirroring | str | #optional If present, indicates the traffic of which networks should be mirrored to the interface. |
| custom | StringMap | #optional A dictionary of custom, free-form properties for device. |
Since: 4.10.0
VmInterfaceDeviceSpecParams:
Additional VM interface device parameters.
Members
| inbound | BandwidthParams | #optional Bandwidth parameters for shaping incoming traffic. |
| outbound | BandwidthParams | #optional Bandwidth parameters for shaping outgoing traffic. |
Since: 4.10.0
VmJobInfo:
Information about a currently active block job.
Members
| id | UUID | An ID that was associated with the job when it was started |
| jobType | JobType | The general job type |
Since: 4.15.0
VmParameters:
Parameters for creating a new virtual machine
Members
| acpiEnable | bool | Indicates if ACPI is enabled inside the VM |
| bootMenuEnable | bool | #optional enable the BIOS boot menu (new in version 4.15.0) |
| cpuShares | str | #optional The host scheduling priority (relative to other VMs). In case both cpuShares and nice are present, cpuShares will be used. |
| custom | StringMap | #optional A dictionary of custom, free-form properties |
| devices | VmDevice | #optional An array of VM devices requested |
| display | VmDisplayType | The type of display |
| hypervEnable | bool | #optional Enables hyperv specific optimizations for the Guest OS. (new in version 4.16.0) |
| kvmEnable | bool | Indicates if KVM hardware acceleration is enabled |
| memSize | uint | The amount of memory assigned to the VM in MB |
| nice | int | The host scheduling priority |
| smp | uint | The number of CPUs presented to the VM |
| smpCoresPerSocket | uint | #optional Indicates the number of CPU cores per socket |
| smpThreadsPerCore | uint | #optional Indicates the number of CPU threads per core |
| timeOffset | uint | The time difference from host to the VM in seconds |
| transparentHugePages | bool | Indicates if the Transparent Huge Pages feature is enabled for this virtual machine |
| vmId | UUID | The VM UUID |
| vmName | str | The VM name |
| vmType | VmType | The type of VM |
| launchPaused | bool | #optional If present, launch the VM in pause mode. |
| numaTune | NumaTune | #optional Indicates the numatune configuration. |
| guestNumaNodes | GuestNumaNode | #optional Indicates the guest numa topology. |
Since: 4.10.0
VmRngDevice:
Properties of a VM rng device.
Since: 4.14.0
VmRngDeviceSpecParams:
An enumeration of VM rng device models
Members
| bytes | int | #optional Maximum number of bytes consumed per period |
| period | int | #optional Required if @bytes are set Limits the rate of entropy consumption from source |
| source | VmRngDeviceSource | Entropy source |
Since: 4.14.0
VmSharedDriveType:
Specifies the share policy for a VM disk drive.
Since: 4.12.0
VmShortStatus:
Abbreviated virtual machine status.
Members
| vmId | UUID | The UUID of the VM |
| status | VmStatus | The current status of the VM |
Since: 4.10.0
VmSmartcardDevice:
Properties of a VM smartcard device.
Since: 4.10.3
VmSmartcardDeviceSpecParams:
Additional VM smartcard device parameters.
Since: 4.10.3
VmSoundDevice:
Properties of a VM sound device.
Since: 4.10.0
VmSoundDeviceSpecParams:
Additional parameters for VM sound devices.
Since: 4.10.0
VmStats:
A discriminated record containing virtual machine statistics.
Since: 4.10.0
VmTpmDevice:
Properties of a VM tpm device.
Since: 4.15.0
VmTpmDeviceSpecParams:
Additional VM tpm device parameters.
Since: 4.15.0
VmVideoDevice:
Properties of a VM video device.
Since: 4.10.0
VmVideoDeviceSpecParams:
Additional parameters for VM video devices.
Members
| vram | uint | value of virtual ram in KB, for 'cirrus' the default is '9216' for @qxl is the size of the secondary bar, |
| ram | uint | #optional size of the primary bar for @qxl in KB, not supported for 'cirrus' |
| heads | uint | #optional Specify the amount of monitors that will use single pci device. Currently relevant for @qxl devices only |
Since: 4.10.0
VmWatchdogDevice:
Properties of a VM watchdog device.
Since: 4.10.1
VmWatchdogDeviceSpecParams:
Additional parameters for VM watchdog devices.
Since: 4.10.1
VolumeGroupAttributes:
A collection of Volume Group attributes.
Since: 4.10.0
VolumeGroupInfo:
Information about a Volume Group.
Members
| name | str | The Volume Group name |
| vgUUID | UUID | The uuid of the Volume Group |
| vgsize | uint | The total capacity (in bytes) |
| vgfree | uint | The amount of currently unassigned capacity (in bytes) |
| deviceType | BlockDeviceType | The storage type of this Volume Group's Physical Volumes |
| attr | VolumeGroupAttributes | Additional attributes |
| state | VolumeGroupState | The state of this Volume Group's underlying storage |
Since: 4.10.0
VolumeInfo:
Information about a Volume.
Members
| uuid | UUID | The Volume UUID |
| allocType | VolumeAllocation | The Volume allocation policy |
| format | VolumeFormat | The format used to write data to the Volume |
| disktype | DiskType | An advisory code indicating the Volume's planned usage |
| voltype | VolumeRole | The Volume role |
| capacity | uint | The size of the Volume (in bytes) |
| parent | UUID | The direct ancestor of this Volume if it exists |
| description | str | A human-readable description of the Volume |
| pool | UUID | The Storage Pool associated with the Volume |
| domain | UUID | The Storage Domain associated with the Volume |
| image | UUID | The Image associated with the Volume |
| ctime | int | The Volume creation time in seconds since the epoch |
| mtime | uint | The Volume modification time (deprecated) |
| legality | VolumeLegality | Indicates whether the volume is legal to use |
| apparentsize | uint | The size of the Volume (in bytes) |
| truesize | uint | The amount of underlying storage allocated (in bytes) |
| status | VolumeStatus | Indicates whether the Volume and metadata are valid |
| children | UUID | A list of decendent Volumes that depend on this Volume |
Since: 4.10.0
VolumeSizeInfo:
Volume size information:
Members
| apparentsize | uint | The size of the Volume (in bytes) |
| truesize | uint | The amount of underlying storage allocated (in bytes) |
Since: 4.10.0
WatchdogEvent:
The message of watchdog event when it is triggered
Members
| time | float | Time the whatchdog event is triggered in seconds since the epoch |
| action | WatchdogEventAction | Action whatchdog takes when event is triggered |
Since: 4.10.1
vmUpdateDeviceParams:
A discriminated record of update parameters for a VM device.
Members
| deviceType | VmDeviceType | The VM device type to update. For example 'interface' for network devices or 'disk' for disk storage devices. |
Since: 4.10.3
vmUpdateGraphicsDeviceParams:
Parameters for @VM.updateDevice
Members
| graphicsType | VmGraphicsDeviceType | The type of the device to update |
| password | str | The desired connection password |
| ttl | int | The number of seconds before the password expires |
| existingConnAction | VmTicketConflictAction | Indicate what to do with any existing connections |
| params | StringMap | Arbitrary key:val pairs that will be passed to hooks |
Since: 4.15.0
vmUpdateInterfaceDeviceParams:
Parameters for @VM.updateDevice
Members
| network | str | #optional Name of the bridge the interface will be added to. If omitted it keeps the interface on the previous network. If the network name is an empty string, it deactivates the link and disassociates the vnic from its current network. |
| linkActive | bool | #optional Whether the VM network card has its link active (up) or not (down). If omitted, keeps the previous link state. |
| alias | str | Alias used to identify this device in commands. |
| portMirroring | str | #optional If present, indicates the traffic of the only networks which should be mirrored to the interface identified by alias. If omitted, it keeps the current mirroring configuration. |
Since: 4.10.3
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
CpuCoreStatsMap:
A mapping of cpu core stats indexed by cpu core id.
Since: 4.15.0
DeviceVisibilityMap:
A mapping of boolean values indexed by block device GUID.
Since: 4.10.0
GuestDisksMappingMap:
guest disks mapping information indexed by serial.
Since: 4.16.8
HookScriptInfoMap:
A mapping of hook script information indexed by script name.
Since: 4.10.0
HostIdMap:
A mapping of hostId indexed by domain UUID.
Since: 4.16.0
HostNetworkInterfaceStatsMap:
A mapping of host interface stats indexed by device name.
Since: 4.11.1
ImagePostZeroMap:
A mapping of postZero selectors indexed by Image UUID.
Since: 4.10.0
NetInfoBondMap:
A mapping of bond information indexed by device name.
Since: 4.10.0
NetInfoBridgeMap:
A mapping of NIC information indexed by device name.
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
NetInfoVlanMap:
A mapping of vlan information indexed by vlan tag.
Since: 4.10.0
NetworkInterfaceStatsMap:
A mapping of interface stats indexed by device name.
Since: 4.10.0
NumaNodeDistanceMap:
A mapping of distance information between each two numa nodeskey -- The numa node indexvalue -- Distance list from self to other nodes in sequence,including self to self
Since: 4.15.0
NumaNodeMap:
A mapping of numa node(cell) information indexed by numa cell id.
Since: 4.15.0
NumaNodeMemoryStatsMap:
A mapping of numa node memory stats indexed by node index.
Since: 4.15.0
OVFMap:
A mapping of OVF data indexed by VM UUID.
Since: 4.10.0
PathStatsMap:
A mapping of filesystem statistics indexed by mount point.
Since: 4.10.0
SetupNetworkBondConfig:
A mapping of bond device configuration attributes indexed by bond name.
Since: 4.10.0
SetupNetworkNetConfig:
A mapping of network bridge configuration attributes indexed by bridge name.
Since: 4.10.0
SoftwarePackageInfoMap:
A mapping of information indexed by software package name.
Since: 4.10.0
StorageDomainFileStatsMap:
A mapping of Storage Domain file statistics indexed by filename.
Since: 4.10.0
StorageDomainStatusMap:
A mapping of Storage Domain statuses indexed by Storage Domain UUID.
Since: 4.10.0
StorageDomainVitalsMap:
A mapping of Storage Domain vital statistics indexed by Storage Domain UUID.
Since: 4.10.0
StoragePoolDomainInfoMap:
A mapping of active Storage Domain information indexed by Storage Domain UUID.
Since: 4.10.0
StringMap:
A mapping between arbitrary strings.
Since: 4.10.0
TasksDetails:
A mapping of Task details indexed by Task UUID.
Since: 4.10.0
TasksInfo:
A mapping of Task information indexed by Task UUID.
Since: 4.10.0
TasksStatus:
A mapping of Task statuses indexed by Task UUID.
Since: 4.10.0
VmDiskStatsMap:
A mapping of VM disk statistics indexed by device name.
Since: 4.10.0
VmJobsMap:
A mapping of VM job information indexed by job UUID.
Since: 4.15.0
VmNumaNodeRuntimeInfoMap:
A mapping of vm numa node runtime pinning to host numa node informationindexed by node index.
Since: 4.15.0
AutoNumaBalancingStatus:
An enumeration of the status of auto numa balancing function in kernel.
Values
| DISABLE | | Auto numa balancing is not active |
| ENABLE | | Auto numa balancing is active |
| UNKNOWN | | Can't get the status(maybe not support in this kernel version) |
Since: 4.15.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
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
BlockJobType:
An enumeration of block job types
Values
| unknown | | The block job type is not known or supported |
| pull | | A blockPull operation (forward merge) |
| copy | | A blockCopy operation |
| commit | | A blockCommit operation (backward merge) |
Since: 4.15.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
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
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
FenceNodeOperationStatusResult:
Status of fence script execution as a result of 'on', 'off' and 'reboot'actions.
Values
| initiated | | Fence script was executed |
| skipped | | Fence script was not executed due to entered fencing policy |
Since: 4.16.0
FenceNodePowerStatusResult:
The host power status as a result of 'status' action.
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
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
HaMaintenanceMode:
An enumeration of recognized Hosted Engine maintenance modes.
Values
| GLOBAL | | Suspend Hosted Engine agent actions on all hosts |
| LOCAL | | Suspend Hosted Engine agent on this host, after migrating engine VM, if necessary. |
Since: 4.14.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
ImageSharingMethod:
Specifies the method used to share (upload/download) an image.
Values
| http | | Upload or download an image using http |
Since: 4.12.0
IscsiCredentialsType:
An enumeration of ISCSI login credentials types.
Values
| chap | | Challenge-Handshake Authentication Protocol |
Since: 4.10.0
JobType:
An enumeration of job types
Values
| unknown | | An unrecognized or unsupported job |
| block | | A block job |
Since: 4.15.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
MOMStatus:
An enumeration of possible MOM statuses.
Values
| disabled | | MOM is not enabled on this host |
| active | | MOM is enabled and running |
| inactive | | MOM has terminated |
Since: 4.10.1
MigrateMethod:
An enumeration of VM migration methods.
Values
| online | | Migrate while the VM continues to run |
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
NetworkInterfaceState:
An enumeration of possible network interface states.
Values
| up | | The interface is active |
| down | | The interface is not active |
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
SharedDriveType:
Specifies the share policy for a VM disk drive.
Values
| shared | | The disk is shared between multiple VMs |
| exclusive | | The disk is used exclusively by this VM |
| none | | Same as exclusive but no locking mechanism is used |
Since: 4.12.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 |
| mom | | Dynamically manage system resources on virtualization hosts |
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
StorageDomainImageClass:
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
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
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
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
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
StoragePoolUpgradeStatus:
An enumeration of Storage Pool upgrade job statuses.
Values
| started | | The upgrade process has started |
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
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
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
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
VmBalloonDeviceType:
An enumeration of VM balloon device types.
Values
| memballoon | | A memory balloon |
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
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 |
| virtio-serial | | This channel supports a virtio-serial connection |
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
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
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 |
| console | | A console device |
| smartcard | | A smartcard device |
| rng | | A rng device |
| graphics | | The graphics device (new in version 4.15.0) |
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
VmDiskDeviceInterface:
An enumeration of VM disk device interfaces.
Values
| ide | | The device is connected via an emulated IDE bus |
| scsi | | The device uses a virtio-scsi para-virtualized interconnect |
| virtio | | The device uses a virtio para-virtualized interconnect |
| fdc | | The device is connected to an emulated floppy disk controller |
Since: 4.10.0
VmDiskDeviceType:
An enumeration of VM disk device types.
Values
| disk | | A hard disk drive |
| lun | | A LUN device (required for LUN passthrough) |
| cdrom | | A CD-ROM drive (always readonly) |
| floppy | | A floppy disk drive |
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
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
VmExitReason:
An enumeration of VM exit reason, explaining why the VMhas gone down, either succesfully on in error.
Values
| success | | The VM has exited gracefully |
| generic error | | Unspecified error code. |
| lost qemu connection | | The VM has lost the connection with QEMU |
| libvirt start failed | | The VM failed to start thorugh libvirt |
| migration succeeded | | The VM was succesfully migrated |
| save state succeeded | | The VM state was succesfully saved |
| admin shutdown | | The VM was shut down by the admin from the engine UI |
| user shutdown | | The VM was shut down by an user from within the guest |
| migration failed | | The VM failed to migrate, and do not moved from the source host |
| libvirt domain missing | | Failed to find the libvirt domain for the VM |
Since: 4.15.0
VmGraphicsDeviceType:
An enumeration of VM graphics device types.
Values
| spice | | SPICE graphics device |
| vnc | | VNC graphics device |
Since: 4.15.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
VmInterfaceDeviceType:
An enumeration of VM network device types.
Values
| bridge | | The device is connected via a host bridge device |
Since: 4.10.0
VmRngDeviceModel:
An enumeration of VM rng device models
Values
| virtio | | supported by qemu and virtio-rng kernel module |
Since: 4.14.0
VmRngDeviceSource:
An enumeration of VM rng device models
Values
| random | | Host standard software+hardware based /dev/random |
| hwrng | | Host hardware entropy source |
Since: 4.14.0
VmSmartcardDeviceMode:
An enumeration of VM smartcard device modes.
Values
| host | | Direct request to host |
| passthrough | | Third party provider (requires @spicevmc) |
Since: 4.10.3
VmSmartcardDeviceProtocol:
An enumeration of VM smartcard device protocols.
Values
| spicevmc | | Use smartcard channel of SPICE |
Since: 4.10.3
VmSmartcardDeviceType:
An enumeration of VM smartcard device types.
Values
| smartcard | | A smartcard |
Since: 4.10.3
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
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 |
| Powering up | | The VM is booting |
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
VmTpmDeviceMode:
An enumeration of VM tpm device types.
Values
| passthrough | | use hosts TPM |
Since: 4.15.0
VmTpmDeviceModel:
An enumeration of VM tpm device modes.
Values
| tpm-tis | | TPM Interface Standard |
Since: 4.15.0
VmTpmDeviceType:
An enumeration of VM tpm device types.
Since: 4.15.0
VmType:
Enumeration of supported virtual machine types.
Values
| kvm | | VM runs on Linux Kernel Virtual Machine |
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
VmWatchdogDeviceAction:
An enumeration of VM watchdog device actions.
Values
| reset | | default, forcefully reset the guest |
| shutdown | | gracefully shutdown the guest (not recommended) |
| poweroff | | forcefully power off the guest |
| pause | | pause the guest |
| none | | do nothing |
| dump | | automatically dump the guest |
Since: 4.10.1
VmWatchdogDeviceModel:
An enumeration of VM watchdog device models.
Values
| i6300esb | | the recommended device, emulating a PCI Intel 6300ESB |
| IB700 | | emulating an ISA iBase IB700 as watchdog |
Since: 4.10.1
VmWatchdogDeviceType:
An enumeration of VM watchdog device types.
Values
| watchdog | | Device type watchdog |
Since: 4.10.1
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
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
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
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
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
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
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
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
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
WatchdogEventAction:
An enumeration of action that watchdog takes when it is triggered.
Values
| ignore | | No action, watchdog ignored |
| pause | | Guest CPUs are paused |
| reset | | Guest CPUs are reset |
| destroy | | Guest is forcibly powered off |
| shutdown | | Guest is requested to gracefully shutdown |
| log | | No action, a debug message logged |
Since: 4.10.1
syncType:
An enumeration of possible Image synchronization types.
Values
| ALL | | Sync all volumes |
| INTERNAL | | Sync internal volumes only |
| LEAF | | Sync leaf volumes only |
Since: 4.11.0