ConnectionRefs.acquire:
Acquire one or more new storage connection references.
Arguments
conRefArgsConnection parameters
Returns
resultsA dictionary of status codes indexed by the same @UUID values in @conRefArgs.
Since: 4.10.0


ConnectionRefs.release:
Release one or more storage connection references.
Arguments
refIDsA list of @UUID values
Returns
resultsA dictionary of status codes indexed by the same @UUID values that were passed in @0.
Since: 4.10.0


ConnectionRefs.statuses:
Get information about all registered storage connection references.
Returns
connectionslistA dictionary of @ConnectionRef objects indexed by @UUID
Since: 4.10.0


Global.addNetwork:
Add a new network to this host.
Arguments
bridgeThe name of the bridge device
vlan#optional The name of a VLAN to create on the device
bond#optional The name of a bond device to create from @nics
nics#optional A list of network device names
options#optional A @NetworkOptions structure
Since: 4.10.0


Global.delNetwork:
Remove a network from this host.
Arguments
bridgeThe name of the bridge device
vlan#optional The name of an associated vlan to remove
bond#optional The name of an associated bond device to remove
nics#optional A list of associated network devices to remove
options#optional A @NetworkOptions structure
Since: 4.10.0


Global.editNetwork:
Add a new network to the host by replacing it with a new one.
Arguments
oldBridgeThe name of the old bridge device to remove
newBridgeThe name of the new bridge device to create
vlan#optional The name of a VLAN to create on the new network
bond#optional The name of a bond device to create from @nics
nics#optional A list of network device names
options#optional A @NetworkOptions structure
Since: 4.10.0


Global.fenceNode:
Send a fencing command to a remote host.
Arguments
addrThe IP address of the remote fence agent
portThe port number of the remote fence agent
agentThe type of agent being connected to (For example: rsa, ilo, drac5, ipmilan, etc)
usernameThe username used to login to the remote fence agent
passwordThe password for @username
actionThe type of fencing operation to perform (from @FenceNodeAction)
secureEnable SSL communication
optionsAdditional agent-specific parameters in space-separated <var>=<val> pairs
Returns
power#optional The new power status of the remote node
Since: 4.10.0


Global.getAllTasksInfo:
Get extra information about all tasks.
Returns
allTasksInfoA mapping of Task information
Notes:
Currently this API only returns tasks that are tagged with 'spm'.
Since: 4.10.0


Global.getAllTasksStatuses:
Get status information for all tasks.
Returns
allTasksStatusA mapping of Task statuses
Notes:
Currently this API only returns tasks that are tagged with 'spm'.
Since: 4.10.0


Global.getCapabilities:
Get host capabilities.
Returns
infoHost capabilities information
netConfigDirtyIndicates if there are uncommitted changes to the network configuration
Since: 4.10.0


Global.getConnectedStoragePools:
Get a list of all Storage Pools that are connected to this host.
Returns
poollistA list of Storage Pool UUIDs
Since: 4.10.0


Global.getDeviceInfo:
Get information about a block device.
Arguments
guidThe globally unique identifier of the block device
Returns
infoBlock device information
Since: 4.10.0


Global.getDeviceList:
Get information about all block devices.
Arguments
storageType#optional Only return devices of this type
Returns
devListAn array of @BlockDeviceInfo
Since: 4.10.0


Global.getDevicesVisibility:
Check the visibility of block storage devices.
Arguments
guidListA list of block device GUIDs
Returns
visibilityVisibility status for each device
Since: 4.10.0


Global.getLVMVolumeGroups:
Get information about Volume Groups in this host.
Arguments
storageType#optional Limit results to Volume Groups of a specific storage type
Returns
vglistA list of @VolumeGroupInfo items
Since: 4.10.0


Global.getStats:
Get host statistics.
Returns
infoThe set of host statistics
Since: 4.10.0


Global.getStorageDomains:
Get a list of known Storage Domain UUIDs.
Arguments
spUUID#optional Limit to Domains belonging to this Storage Pool
domainClass#optional Limit to Domains of this @StorageDomainClass
storageType#optional Limit to Domains of this @StorageDomainType
remotePath#optional Limit to Domains having this remotePath
Returns
domlistA list of known Storage Domains
Since: 4.10.0


Global.getStorageRepoStats:
Get statistics about currently attached storage.
Returns
XXXA dictionary of @StorageDomainStats indexed by Storage Domain @UUID
Since: 4.10.0


Global.getVMList:
Get information about the current virtual machines.
Arguments
fullStatus#optional Set to request complete VM information
vmList#optional Filter the results by a list of UUIDs
Returns
vmListA list of VM definitions
Since: 4.10.0


Global.ping:
Test connectivity to vdsm.
Since: 4.10.0


Global.setLogLevel:
Set the vdsm logging verbosity level.
Arguments
levelThe new verosity level desired
Since: 4.10.0


Global.setSafeNetworkConfig:
Mark the current network configuration good and persist any changes.
Since: 4.10.0


Global.setupNetworks:
Reconfigure host networking by adding, removing, and editing multiple bridgeand bond devices in a single call.
Arguments
networksConfiguration information for the network bridges
bondingsConfiguration information for the bond devices
optionsAdditional options to control configuration behavior
Since: 4.10.0


ISCSIConnection.discoverSendTargets:
Discover available targets for this @ISCSIConnection.
Returns
targetsA list of discovered target iqns
fullTargetsA list of discovered targets in the form: '<host>:<port>,<tpgt> <iqn>'
Since: 4.10.0


Image.delete:
Delete the Image and all of its Volumes.
Arguments
postZeroIf True, overwrite Volume data with zeroes after deletion
forceForce the operation and do not perform any validation
Returns
uuidA task UUID
Since: 4.10.0


Image.deleteVolumes:
Delete one or more Volumes associated with this image.
Arguments
volumeListA list of Volume UUIDs
postZeroIf True, overwrite Volume data with zeroes after deletion
forceForce the operation and do not perform any validation
Returns
uuidA task UUID
Since: 4.10.0


Image.getVolumes:
Get a list of Volumes associated with this Image.
Returns
uuidlistA list of Image UUIDs
Since: 4.10.0


Image.mergeSnapshots:
Merge snapshot @successor into @ancestor.
Arguments
ancestorA Volume UUID representing the parent snapshot
successorA Volume UUID representing the child snapshot
postZeroIf True, overwrite @successor with zeroes after conversion
Returns
uuidA task UUID
Since: 4.10.0


Image.move:
Move or copy an image to another Storage Domain within the same Storage Pool.
Arguments
dstSdUUIDThe destination Storage Domain UUID
operationThe operation to perform
postZeroIf True, overwrite Volume data with zeroes after deletion
forceForce the operation and do not perform any validation
Returns
uuidA task UUID
Since: 4.10.0


LVMVolumeGroup.create:
Create a new Volume Group.
Arguments
nameThe desired name for the new Volume Group
devlistAn array of device names to include in the Volume Group
force#optional Force the operation and do not perform any validation
Returns
uuidThe uuid of the created Volume Group
Since: 4.10.0


LVMVolumeGroup.getInfo:
Get information about a Volume Group.
Returns
infoVolume Group information
Since: 4.10.0


LVMVolumeGroup.remove:
Remove this Volume Group.
Since: 4.10.0


StorageDomain.activate:
Activate an attached but inactive Storage Domain.
Since: 4.10.0


StorageDomain.attach:
Attach a Storage Domain to a Storage Pool.
Arguments
spUUIDThe Storage Pool to which the Storage Domain should be attached
Since: 4.10.0


StorageDomain.create:
Create a new Storage Domain.
Arguments
typeThe type of backing storage used by the Storage Domain
typeArgsType specific backing storage specifier
nameA human-readable name
domainClassThe Storage Domain Class
version#optional The Storage Domain version that should be used
Since: 4.10.0


StorageDomain.deactivate:
Deactivate an active, attached Storage Domain.
Arguments
masterSdUUIDThe 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.
masterVersionThe Storage Domain version of the new master domain
Since: 4.10.0


StorageDomain.detach:
Detach an inactive Storage Domain from its Storage Pool.
Arguments
masterSdUUIDThe 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.
masterVersionThe Storage Domain version of the new master domain
forceForce operation -- do not perform validation
Since: 4.10.0


StorageDomain.extend:
Extend a block-based Storage Domain onto more block devices.
Arguments
devlistAn array of block device names to add to the domain
Since: 4.10.0


StorageDomain.format:
Format a storage domain and erase all of its data.
Arguments
autoDetachDetach the Storage Domain before formatting. Useful when formatting the master domain.
Since: 4.10.0


StorageDomain.getFileList:
Get a list of files in an ISO domain.
Arguments
patternFilter results by this glob pattern
Returns
filesA dictionary of file information indexed by file name
Since: 4.10.0


StorageDomain.getImages:
Get a list of Images associated with this Storage Domain.
Returns
imageslistAn array of Image UUIDs
Since: 4.10.0


StorageDomain.getInfo:
Get information about a Storage Domain.
Returns
infoStorage domain information
Since: 4.10.0


StorageDomain.getStats:
Get Storage Domain statistics.
Returns
statsStorage Domain statistics
Since: 4.10.0


StorageDomain.getVolumes:
Get a list of Volumes contained within a Storage Domain.
Arguments
imgUUIDLimit results to Volumes associated with a single Image
Returns
uuidlistA list of Volume UUIDs
Since: 4.10.0


StorageDomain.setDescription:
Set the Storage Domain description.
Arguments
descriptionA human-readable description
Since: 4.10.0


StorageDomain.uploadVolume:
Upload a Volume into a Storage Domain from a remote location.
Arguments
imgUUIDThe UUID of the image that is associated with the Volume
volUUIDThe UUID of an existing Volume where the data will be uploaded
srcPathThe remote location of the Volume data. Must be in a format that can be understood by the command indicated in @method.
sizeThe size of the volume data in blocks
methodThe method (command) to use to upload the data
Since: 4.10.0


StorageDomain.validate:
Check that the Storage Domain is accessible.
Since: 4.10.0


StoragePool.connect:
Connect to an existing Storage Pool.
Arguments
hostIDA host ID number unique across all hosts in the same cluster
scsiKeyA key that will be used to validate other API calls related to this Storage Pool
masterSdUUIDThe UUID of a Storage Domain to use as the master domain
masterVersionThe Storage Domain version of the master domain
Notes:
Only one Storage pool may be connected at a time
Since: 4.10.0


StoragePool.connectStorageServer:
Establish a connection to backing storage.
Arguments
domainTypeThe type of storage to connect
connectionParamsAn array of connection information
Returns
statuslistThe status of each connection attempt
Since: 4.10.0


StoragePool.create:
Create a new Storage Pool.
Arguments
nameA human-readable name for the Storage Pool
masterSdUUIDThe UUID of the Storage Domain that will be used as the master domain
masterVersionThe Storage Domain version of the master domain
domainListA list of Storage Domain UUIDs that should be attached to the Storage Pool
lockRenewalIntervalSecThe number of seconds to wait before renewing lease (Should be less than @leaseTimeSec). 0 selects the default value.
leaseTimeSecThe maximum number of seconds that the leaseholder may retain the lease without renewing it. 0 selects the default value.
ioOpTimeoutSecThe maximum number of seconds that an I/O operation may take to complete. 0 selects the default value.
leaseRetriesThe 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
hostIDA host ID number unique across all hosts in the same cluster
scsiKeyThe key that was passed into @StoragePool.connect
Since: 4.10.0


StoragePool.disconnect:
Disconnect and optionally remove a Storage Pool.
Arguments
hostIDA host ID number unique across all hosts in the same cluster
scsiKeyThe key that was passed into @StoragePool.connect
removeIf True, remove the Storage Pool after it is disconnected
Since: 4.10.0


StoragePool.disconnectStorageServer:
Remove backing storage connections.
Arguments
domainTypeThe type of backing storage
connectionParamsAn array of connection information
Returns
statuslistThe status of each connection attempt
Since: 4.10.0


StoragePool.fence:
Fence the SPM host via the storage.
Returns
spm_stSPM status information for the Storage Pool
Notes:
Deprecated
Since: 4.10.0


StoragePool.getBackedUpVmsInfo:
Get information about backed-up virtual machines from a Backup Storage Domain.
Arguments
sdUUIDThe UUID of the Backup Storage Domain to check
vmListLimit results to a list of VM UUIDs
Returns
vmlistA 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
sdUUIDThe UUID of the Backup Storage Domain to check
Returns
vmlistA list of VM UUIDs
Since: 4.10.0


StoragePool.getDomainsContainingImage:
Get a list of Storage Domains that contain an Image.
Arguments
imgUUIDThe UUID of the Image to search for
onlyDataDomains#optional Only include Data Storage Domains
Returns
domainslistA list of Storage Domain UUIDs that contain the Image
Since: 4.10.0


StoragePool.getFloppyList:
Get a list of all floppy disk images associated with a Storage Pool.
Returns
isolistA list of floppy disk file names
Since: 4.10.0


StoragePool.getInfo:
Get information about a Storage Pool and its Active Storage Domains.
Returns
infoStorage Pool information
dominfoInformation about active Storage Domains
Since: 4.10.0


StoragePool.getIsoList:
Get a list of all ISO images associated with a Storage Pool.
Arguments
filenameExtension#optional Specify an alternate file extension (the default extension used is 'iso')
Returns
isolistA list of available files
Since: 4.10.0


StoragePool.getSpmStatus:
Get the status of the Storage Pool Manager role.
Returns
spm_stSPM status information
Since: 4.10.0


StoragePool.moveMultipleImages:
Move images from one Storage Domain to another within the same Storage Pool.
Arguments
srcSdUUIDThe source Storage Domain
dstSdUUIDThe destination Storage Domain
imgDictA mapping keyed by Image UUID where the values indicate if the source Image should be zeroed after the data has been moved
forceMove 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
nameA human-readable name for the Storage Pool
masterSdUUIDThe UUID of the Storage Domain that will be used as the master domain
masterVersionThe Storage Domain version of the master domain
domainDictStorage Domain statuses to be restored
lockRenewalIntervalSecThe number of seconds to wait before renewing lease (Should be less than @leaseTimeSec). 0 selects the default value.
leaseTimeSecThe maximum number of seconds that the leaseholder may retain the lease without renewing it. 0 selects the default value.
ioOpTimeoutSecThe maximum number of seconds that an I/O operation may take to complete. 0 selects the default value.
leaseRetriesThe 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
masterSdUUIDThe UUID of the master Storage Domain
masterVersionThe Storage Domain version of the master domain
Since: 4.10.0


StoragePool.removeVM:
Remove a previously saved virtual machine definition.
Arguments
vmUUIDRemove the saved definition of the VM with this UUID
sdUUIDThe Storage Domain where the VM is stored
Since: 4.10.0


StoragePool.setDescription:
Set the Storage Pool description
Arguments
descriptionA 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
prevIDDeprecated. The Host ID of the previous SPM
prevLverDeprecated. The lver of the previous SPM
enableScsiFencingThis parameter is not used
maxHostIDThe maximum number of hosts that could be in the cluster
domVersionThe expected Storage Domain version of the master domain
Returns
uuidA task UUID
Since: 4.10.0


StoragePool.spmStop:
Instruct this host to release the Storage Pool Manager role for this pool.
Since: 4.10.0


StoragePool.updateVMs:
Store virtual machine OVF files on a Storage Domain in the Storage Pool.
Arguments
vmListA list of virtual machine definitions to store
sdUUIDThe 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
targetDomVersionThe version to upgrade to
Returns
upgradeStatusThe status of the upgrade operation
Since: 4.10.0


StoragePool.validateStorageServerConnection:
Validate storage server connection parameters.
Arguments
domainTypeThe type of backing storage being validated
connectionParamsA list of connection parameter dictionaries
Returns
statuslistA list of connection parameter statuses
Notes:
Deprecated since 4.10.0. Returns 0 for all connections.
Since: 4.10.0


Task.clear:
Discard information about a finished Task.
Since: 4.10.0


Task.getInfo:
Get information about a Task.
Returns
TaskInfoGeneral Task information
Since: 4.10.0


Task.getStatus:
Get Task status information.
Returns
taskStatusStatus infomation
Since: 4.10.0


Task.revert:
Rollback a Task to restore the previous system state.
Since: 4.10.0


Task.stop:
Stop a currently running Task.
Since: 4.10.0


VM.changeCD:
Change the CD in the VM's CD-ROM device.
Arguments
driveSpecThe specification of the new CD
Returns
vmListThe VM definition, as updated
Since: 4.10.0


VM.changeFloppy:
Change the disk in the VM's floppy device.
Arguments
driveSpecThe specification of the new floppy disk
Returns
vmListThe VM definition, as updated
Since: 4.10.0


VM.cont:
Resume a paused VM.
Since: 4.10.0


VM.create:
Create a new virtual machine.
Arguments
vmParamsThe VM definition
Returns
vmListThe VM definition, as created
Since: 4.10.0


VM.desktopLock:
Lock the active user session in the guest operating system.
Since: 4.10.0


VM.desktopLogin:
Log a user into the guest operating system.
Arguments
domainThe Active Directory domain (if applicable)
usernameThe username to use
passwordThe password corresponding to @username
Since: 4.10.0


VM.desktopLogoff:
Logoff the active user of the guest operating system.
Arguments
forceForce the operation (unused)
Since: 4.10.0


VM.desktopSendHcCommand:
Send an arbitrary command to the guest agent.
Arguments
messageThe message to send
Notes:
Deprecated since 4.10.0
Since: 4.10.0


VM.destroy:
Forcibly stop a running VM.
Since: 4.10.0


VM.getMigrationStatus:
Report status of a currently outgoing migration.
Returns
codeA status code
messageA status message
Notes:
Migration status is returned as the command status ('code' and 'message')
Since: 4.10.0


VM.getStats:
Get statistics about a running virtual machine.
Returns
statsListAn array containing a single VmStats record
Since: 4.10.0


VM.hibernate:
Save the live state of the VM to disk and stop it.
Arguments
hibernationVolHandleVolumes to use for storing VM state and metadata
Notes:
This is a host-initiated hibernation and does not make use of any guest operating system suspend to disk functionality.
Since: 4.10.0


VM.hotplugDisk:
Add a new disk device to a running VM.
Arguments
paramsThe VM UUID and device information
Returns
vmListThe VM definition, as updated
Notes:

Since: 4.10.0


VM.hotplugNic:
Add a new network device to a running VM.
Arguments
paramsThe VM UUID and device information
Returns
vmListThe VM definition, as updated
Notes:

Since: 4.10.0


VM.hotunplugDisk:
Remove a disk device from a running VM.
Arguments
paramsThe VM UUID and device information
Returns
vmListThe VM definition, as updated
Notes:

Since: 4.10.0


VM.hotunplugNic:
Remove a network device from a running VM.
Arguments
paramsThe VM UUID and device information
Returns
vmListThe VM definition, as updated
Notes:

Since: 4.10.0


VM.merge:
Merge VM disk snapshots.
Arguments
mergeDrivesA list of drives on which to perform merge operations. Each entry must have @baseVolumeID set to indicate the new desired base volume.
Since: 4.10.0


VM.mergeStatus:
Check the status of an ongoing snapshot merge operation.
Returns
mergeStatusStatus information for each VM disk
Since: 4.10.0


VM.migrate:
Migrate a VM to a remote host.
Arguments
paramsMigration parameters
Notes:
This function allows you to migrate to a file but this mode should be selected by using the hibernate command.
Since: 4.10.0


VM.migrateCancel:
Cancel a currently outgoing migration process.
Since: 4.10.0


VM.migrationCreate:
Start a migrating VM on a destination host.
Arguments
paramsThe VM definition
Returns
migrationPortThis value is always 0
paramsThe definition of the created virtual machine
Notes:
This API is used internally by @VM.migrate and is not intended to be called directly.
Since: 4.10.0


VM.monitorCommand:
Send a command to the qemu monitor.
Arguments
commandThe command string
Notes:
This function is not implemented.
Since: 4.10.0


VM.pause:
Pause the CPUs of a running VM.
Since: 4.10.0


VM.reset:
Reset a virtual machine.
Notes:
This function is not implemented.
Since: 4.10.0


VM.sendKeys:
Send a string of keys to a guest's keyboard.
Arguments
keySequenceA sequence of keystrokes to send
Notes:
This function is not implemented.
Since: 4.10.0


VM.setTicket:
Set the password to be used to connect to a VM display.
Arguments
passwordThe desired connection password
ttlThe number of seconds before the password expires
existingConnActionIndicate what to do with any existing connections
paramsArbitrary key:val pairs that will be passed to hooks
Since: 4.10.0


VM.shutdown:
Request a graceful shutdown of a VM.
Arguments
delay#optional Wait a number of seconds before shutting down
message#optional Message to display to VM users before shutting down
Since: 4.10.0


VM.snapshot:
Create a live snapshot of a VM's disks.
Arguments
snapDrivesA list of disk snapshot creation instructions
Since: 4.10.0


Volume.copy:
Duplicate a volume to produce a new template image.
Arguments
dstSdUUIDThe UUID of the destination Storage Domain
dstImgUUIDThe UUID of the destination Image
dstVolUUIDThe UUID of the destination Volume
descSet the destination Volume description
volType(Unused) The role of the destination Volume
volFormatThe data format to use for the destination Volume
preallocateThe Volume allocation mode
postZeroIf @force is set and @dstVolUUID exists, zero the destination Volume before copying new data
forceIf @dstVolUUID already exists, overwrite it
Returns
uuidA task UUID
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
sizeThe Volume size in sectors
volFormatThe data format to use for the destination Volume
preallocateThe Volume allocation mode
diskTypeAn advisory disk usage type
descThe Volume description
srcImgUUIDIf specified, create a snapshot from this Image
srcVolUUIDIf specified, create a snapshot from this Volume
Returns
uuidA task UUID
Since: 4.10.0


Volume.delete:
Delete a Volume.
Arguments
postZeroZero Volume data before deletion
forceRemove even if @VolumeRole is SHARED or INTERNAL
Returns
uuidA task UUID
Since: 4.10.0


Volume.extend:
Increase the size of a Volume.
Arguments
sizeThe new desired size (in sectors)
isShuttingDown(Unused)
Notes:
Valid for block-based Volumes only
Since: 4.10.0


Volume.getInfo:
Get information about a Volume.
Returns
infoVolume information
Since: 4.10.0


Volume.getPath:
Get the path to the Volume in the host's storage repository.
Returns
pathThe Volume's storage repository path
Since: 4.10.0


Volume.getSize:
Get Volume size information.
Returns
apparentsizeThe size of the Volume (in bytes)
truesizeThe amount of underlying storage allocated (in bytes)
Since: 4.10.0


Volume.prepare:
Make a Volume accessible.
Arguments
rwIf True, the Volume should be made writeable, otherwise read-only
Since: 4.10.0


Volume.refresh:
Refresh Volume to synchronize changes made by a remote host.
Since: 4.10.0


Volume.setDescription:
Set the Volume description field.
Arguments
descriptionA human-readable Volume description
Since: 4.10.0


Volume.setLegality:
Set the legality of a Volume.
Arguments
legalityThe new Volume legality
Since: 4.10.0


Volume.tearDown:
Deactivate the Volume and release resources.
Since: 4.10.0


Global.init:
Initialize a Global API object.
Since: 4.10.0


UUID:
A universally unique identifier in RFC 4122 format.eg. "407cb255-34be-432c-be7c-eb43b8de82be"
Type
str
Since: 4.10.0


NetworkOptions:
Detailed network configuration options.
Members
ipaddr#optional Assign this static IP address to the interface
netmask#optional The netmask of this subnet
gateway#optional IP address of the network gateway
bootproto#optional Interface autoconfiguration protocol (typically 'dhcp' or 'static')
delay#optional The time to wait before starting the interface
onboot#optional Start the interface automatically during boot
bondingOptions#optional A string of space-separated <option>=<value> pairs
skipLibvirt#optional Do not use libvirt to gather network information
Since: 4.10.0


SetupNetworkNetAttributes:
Configuration attributes for a single host network.
Members
vlan#optional The name of an associated vlan
bonding#optional If the network is bonded, the name of the bond device
nic#optional If the network is not bonded, an array containing a single network device name
ipaddr#optional Assign this static IP address to the network
netmask#optional Assign this netmask to the network
gateway#optional Assign this gateway to the network
bootproto#optional Interface autoconfiguration protocol (typically 'dhcp' or 'static')
delay#optional The time to wait before starting the network device
onboot#optional Start the network device automatically during boot
remove#optional If True, remove existing network only
Since: 4.10.0


SetupNetworkBondAttributes:
Configuration attributes for a single bonded network interface device.
Members
nicsAn array of network device names to include in the bond
options#optional A string of space-separated <option>=<value> pairs
remove#optional If True, remove existing bond only
Since: 4.10.0


SetupNetworkOptions:
Additional options for setupNetworks.
Members
force#optional If True, skip validation of the configuration
connectivityCheck#optional After reconfiguration, check for network connectivity and roll back if necessary
connectivityTimeout#optional The amount of time to wait before failing the connectivity check in seconds
Since: 4.10.0


SetupNetworkNetConfig:
A mapping of network bridge configuration attributes indexed by bridge name.
Key
str
Value
SetupNetworkNetAttributes
Since: 4.10.0


SetupNetworkBondConfig:
A mapping of bond device configuration attributes indexed by bond name.
Key
str
Value
SetupNetworkBondAttributes
Since: 4.10.0


FenceNodeAction:
Specifies the type of fencing operation to perform.
Values
statusJust fetch the current power status
onTurn on the remote host
offShut down the remote host
rebootReboot the remote host
Since: 4.10.0


FenceNodePowerStatus:
Indicates the power state of a remote host.
Values
onThe remote host is powered on
offThe remote host is powered off
unknownThe power status is not known
Since: 4.10.0


TaskInfo:
Extra information about a task.
Members
idThe @UUID of the task
verbThe underlying operation to be performed by the task
Since: 4.10.0


TasksInfo:
A mapping of Task information indexed by Task UUID.
Key
UUID
Value
TaskInfo
Since: 4.10.0


TaskState:
An enumeration of possible task states.
Values
unknownThe state of the task is not known
initThe task is initializing
runningThe task is currently executing
finishedThe task has finished executing
abortingThe task has been interrupted by a user has encountered an error
cleaningThe task has failed and recovery actions are underway
Since: 4.10.0


TaskResult:
An enumeration of the possible final task results.
Values
successThe task was successful
cleanSuccessThe task failed but was successfully recovered
cleanFailureThe task failed and recovery also failed
Since: 4.10.0


TaskStatus:
A collection of status information about a task.
Members
taskIDThe task @UUID
taskStateCurrent task state (@TaskState)
taskResultFinal task result (@TaskResult)
messageDetailed error message from the underlying task verb
codeReturn code from the underlying task verb
Since: 4.10.0


TasksStatus:
A mapping of Task statuses indexed by Task UUID.
Key
UUID
Value
TaskStatus
Since: 4.10.0


BoolStr:
A string that can be interpreted as a boolean value.
Values
TrueTrue
FalseFalse
Since: 4.10.0


BoolStrLower:
A string that can be interpreted as a boolean value. This value conforms toJSON and XML which require lowercase names.
Values
trueTrue
falseFalse
Since: 4.10.0


BoolOnOff:
A string that can be interpreted as a boolean value.
Values
onTrue
offFalse
Since: 4.10.0


IntStr:
A string that can be converted into an integer.
Type
str
Since: 4.10.0


FloatStr:
A string that can be converted into an float.
Type
str
Since: 4.10.0


HexStr:
A string in hexidecimal format.
Type
str
Since: 4.10.0


StringMap:
A mapping between arbitrary strings.
Key
str
Value
str
Since: 4.10.0


NetInfoBridgedNetwork:
Information about a VDSM bridged network.
Members
portsA list of nic device names that are bridged
stpSpanning Tree Protocol status for the bridge device
addrThe IP address assigned to the bridge device
netmaskThe netmask of the defined subnet
gatewayThe IP address of the subnet's gateway
mtuThe Maximum Transmission Unit size for the bridge device
cfgA map containing network interface parameters from ifcfg-* files. It is indexed by parameter name and stores the parameter value.
bridgedAlways True to distinguish this type from @NetInfoBridgelessNetwork
Since: 4.10.0


NetInfoBridgelessNetwork:
Information about a VDSM bridgeless network.
Members
interfaceThe network device name associated with the network
bridgedAlways False to distinguish this type from @NetInfoBridgedNetwork
Since: 4.10.0


NetInfoNetwork:
A discriminated record to store information about a VDSM network.
Types
NetInfoBridgedNetwork
NetInfoBridgelessNetwork
Since: 4.10.0


NetInfoNic:
Information about a network interface card.
Members
speedThe reported speed of the nic
addrThe IP address assigned to the nic
netmaskThe netmask of the defined subnet
hwaddrThe Media Access Control address being used by the nic
mtuThe Maximum Transmission Unit size for the nic
permhwaddr#optional For bonded nics: the real MAC address which will be used if the card is freed from the bond.
Since: 4.10.0


NetInfoBond:
Information about a ethernet bond device
Members
slavesA list of devices that are enslaved to the bond device
addrThe IP address assigned to the bond
netmaskThe netmask of the defined subnet
hwaddrThe Media Access Control address being used by the bond device
cfgRaw device configuration parameters (@NetInfoIfaceCfg)
mtuThe Maximum Transmission Unit size for the nic
Since: 4.10.0


NetInfoVlan:
Information about a Virtual Local Area Network
Members
ifaceThe network device associated with the vlan
addrThe IP address assigned to the vlan device
netmaskThe netmask of the defined subnet
mtuThe Maximum Transmission Unit size for the vlan
Since: 4.10.0


HookScriptInfo:
Information about one script within a hook.
Members
md5The md5 sum of the script
Since: 4.10.0


OSName:
An enumeration of recognized operating system names.
Values
unknownThe operating system could not be detected
oVirt NodeoVirt Node standalone hypervisor
RHELRed Hat Enterprise Linux
FedoraFedora Linux
RHEV HypervisorRed Hat Enterprise Virtualization Hypervisor
DebianA Debian-based distribution (including Ubuntu)
Since: 4.10.0


OsVersion:
Host operating system version information.
Members
releaseThe release number for this @version
versionThe OS version (eg. 17 for Fedora 17)
nameThe name of the OS
Since: 4.10.0


SoftwarePackage:
An enumeration of aliases for important software components.
Values
kernelThe Linux kernel
qemu-kvmQemu virtual machine emulator
qemu-imgQemu VM disk image manipulation utility
vdsmVirtual Desktop and Server Manager (this software)
spice-serverThe server for SPICE protocol
libvirtLow level virtualization API
Since: 4.10.0


SoftwarePackageInfo:
Information about an installed piece of software.
Members
versionThe software version
releaseThe release number for this @version
buildtimeThe time and date the software was built
Since: 4.10.0


IscsiHba:
Information about an iSCSI host bus adapter.
Members
InitiatorNameiSCSI initiator
Since: 4.10.0


FcHba:
Information about a FibreChannel host bus adapter.
Members
wwpnWorld-wide port name
wwnnWorld-wide node name
modelModel of installed FibreChannel card
Since: 4.10.0


HbaInventory:
Information about all available host bus adapters.
Members
iSCSIList of iSCSI HBAs
FCList of FibreChannel HBAs
Since: 4.10.0


VmType:
Enumeration of supported virtual machine types.
Values
kvmVM runs on Linux Kernel Virtual Machine
Since: 4.10.0


NetInfoNetworkMap:
A mapping of vdsm Network information indexed by network name.
Key
str
Value
NetInfoNetwork
Since: 4.10.0


NetInfoNicMap:
A mapping of NIC information indexed by device name.
Key
str
Value
NetInfoNic
Since: 4.10.0


NetInfoBondMap:
A mapping of bond information indexed by device name.
Key
str
Value
NetInfoBond
Since: 4.10.0


NetInfoVlanMap:
A mapping of vlan information indexed by vlan tag.
Key
str
Value
NetInfoVlan
Since: 4.10.0


HookScriptInfoMap:
A mapping of hook script information indexed by script name.
Key
str
Value
HookScriptInfo
Since: 4.10.0


SoftwarePackageInfoMap:
A mapping of information indexed by software package name.
Key
SoftwarePackage
Value
SoftwarePackageInfo
Since: 4.10.0


VdsmCapabilities:
Host information and capabilities.
Members
kvmEnabledKVM is enabled on the host
cpuCoresThe number of CPU cores present
cpuSocketsThe numbet of CPU sockets
cpuSpeedThe speed of each CPU (in MHz)
cpuModelThe CPU model
cpuFlagsCPU feature flags (a comma-separated string)
version_nameThe name given to this version of VDSM
software_versionVDSM version (x.y.z)
software_revisionExtra VDSM version information
supportedRHEVMsA list of supported ovirt-engine versions
supportedProtocolsA list of supported xmlrpc protocol versions
clusterLevelsA list of supported cluster versions
networksInformation about configured VDSM networks
nicsInformation about the network cards on the host
bondingsInformation about configured bonding devices
vlansInformation about configured vlans
hooks#optional Information about installed hooks
operatingSystemOperating system version information
uuidA unique host ID
packages2Version information of important software packages
emulatedMachinesA list of supported emulated machines
ISCSIInitiatorNameThe iSCSI initiator name for this host
HBAInventoryInformation about available host bus adapters
vmTypesA list of supported virtual machine types
memSizeThe amount of total memory installed in the host
reservedMemThe amount of memory reserved for hypervisor overhead
guestOverheadThe amount of memory reserved for per-guest overhead
Notes:
Since ovirt-engine cannot parse software versions in 'x.y.z' format, the current API truncates @software_version to 'x.y'.
Since: 4.10.0


BlockDeviceType:
Enumeration of possible block device types.
Values
iSCSIThe device is pure iSCSI
FCPThe device is purely FibreChannel
MIXEDThe device consists of a mix of iSCSI and FibreChannel paths
Since: 4.10.0


BlockDevicePathState:
Enumeration of possible states for a block device path.
Values
activeThe path is active
failedThe path has failed
Since: 4.10.0


BlockDevicePathInfo:
Information about a single block device path.
Members
physdevThe physical device name
stateThe current state of this path
lunThe SCSI Logical Unit Number associated with this path
typeThe type of path (@BlockDeviceType)
Since: 4.10.0


IscsiSessionInfo:
Information about a single, active iSCSI session.
Members
connectionThe hostname of the iSCSI target
portThe port number of the iSCSI target
iqnThe ISCSI Qualified Name
portalThe Target Portal Group Tag
initiatornameiSCSI initiator
username#optional A login name on the iSCSI target
password#optional The password corresponding to @username
Since: 4.10.0


BlockDeviceInfo:
Block device information.
Members
GUIDThe globally unique identifier of the block device
pvUUIDThe LVM physical volume associated with this device
vendorIDA string identifying the device manufacturer
productIDA string identifying the device model
fwrevFirmware version information
serialThe device serial number
capacityThe device size (in bytes)
devtypeThe type of storage device (@BlockDeviceType)
pathstatusMultipath information
pathlistiSCSI session information
logicalblocksizeThe logical block size of the device (in bytes)
physicalblocksizeThe physical block size of the device (in bytes)
partitionedReports whether the device has been split into partitions
Since: 4.10.0


DeviceVisibilityMap:
A mapping of boolean values indexed by block device GUID.
Key
UUID
Value
Bool
Since: 4.10.0


VolumeGroupState:
An enumeration of possible Volume Group states.
Values
OKAll Physical Volumes are online
PARTIALOne or more Physical Volumes are not available
Since: 4.10.0


VolumeGroupAttributePermission:
An enumeration of possible values for the permission attribute.
Values
wThe Volume Group is writable
rThe 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
zThe Volume Group is resizeable
Since: 4.10.0


VolumeGroupAttributeExported:
An enumeration of possible values for the exported attribute.
Values
-The Volume Group has not been exported
xThe 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
pThe Volume Group cannot access some Physical Volumes
Since: 4.10.0


VolumeGroupAttributeAllocation:
An enumeration of possible values for the allocation policy attribute.
Values
cIndicates a contiguous allocation policy
nIndicates a normal allocation policy
iIndicates that the allocation policy is inherited
lIndicates a cling allocation policy
aIndicates 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
cIndicates that clustered locking is enabled
Since: 4.10.0


VolumeGroupAttributes:
A collection of Volume Group attributes.
Members
permissionIs the Volume Group read-only or writable
resizeableCan the Volume Group be resized?
exportedHas the Volume Group been exported?
partialAre all Physical Volumes available?
allocationWhat is the allocation policy?
clusteredIs clustered locking enabled?
Since: 4.10.0


VolumeGroupInfo:
Information about a Volume Group.
Members
nameThe Volume Group name
vgUUIDThe uuid of the Volume Group
vgsizeThe total capacity (in bytes)
vgfreeThe amount of currently unassigned capacity (in bytes)
typeThe storage type of this Volume Group's Physical Volumes
attrAdditional attributes
stateThe state of this Volume Group's underlying storage
Since: 4.10.0


NetworkInterfaceState:
An enumeration of possible network interface states.
Values
upThe interface is active
downThe interface is not active
Since: 4.10.0


NetworkInterfaceStats:
Statistics about a single network interface.
Members
nameThe network device name
speedThe interface speed (in Megabits/s)
rxDroppedThe number of incoming packets that have been dropped
txDroppedThe number of outgoing packets that have been dropped
rxErrorsThe number of incoming packets that have contained errors
txErrorsThe number of outgoing packets that have contained errors
stateIndicates whether the interface is currently active
rxRateThe rate of incoming packets (as a percentage of @speed)
txRateThe rate of outgoing packets (as a percentage of @speed)
macAddrThe hardware address
Since: 4.10.0


StorageDomainVitals:
Regularly collected Storage Domain vital statistics.
Members
codeStorage Domain status code
delayThe amount of time it takes to read a small amount of data from the storage.
lastCheckElapsed time since the Storage Domain was last checked
validIndicates if the Storage Domain is functioning properly
Since: 4.10.0


PathStats:
Statistics about a host filesystem path.
Members
freeThe amount of free space remaining (in MB)
Since: 4.10.0


THPStates:
An enumeration of possible states for the Transparent Huge Pages feature.
Values
alwaysAll memory regions will be scanned
madviseOnly memory regions indicated by a call to madvise will be scanned
neverNo memory regions will be scanned
Since: 4.10.0


NetworkInterfaceStatsMap:
A mapping of interface stats indexed by device name.
Key
str
Value
NetworkInterfaceStats
Since: 4.10.0


StorageDomainVitalsMap:
A mapping of Storage Domain vital statistics indexed by Storage Domain UUID.
Key
UUID
Value
StorageDomainVitals
Since: 4.10.0


PathStatsMap:
A mapping of filesystem statistics indexed by mount point.
Key
str
Value
PathStats
Since: 4.10.0


HostStats:
Statistics about this host.
Members
cpuUserRatio of CPU time spent in userspace
cpuSysRatio of CPU time spent in kernel
cpuIdleRatio of CPU time spent idle
rxRateIncoming packet rate (as a percentage of total capacity)
txRateOutgoing packet rate (as a percentage of total capacity)
statsAgeSeconds elapsed since the stats were last sampled
networkPer-interface network statistics
rxDroppedThe number of incoming packets dropped
txDroppedThe number of outgoing packets dropped
cpuSysVdsmdRatio of CPU time spent in kernel by vdsm
cpuUserVdsmdRatio of CPU time spent in userspace by vdsm
storageDomainsStorage Domain vital statistics
elapsedTimeThe number of seconds that vdsm has been running
memUsedThe percentage of memory used (not including caches)
anonHugePagesThe amount of anonymous memory in huge pages (in MB)
cpuLoadThe 5 minute CPU load average
diskStatsStatistics about paths on the host filesystem
thpStateCurrent mode of the Transparent Huge Pages feature
Since: 4.10.0


StorageDomainClass:
An enumeration of Storage Domain classes.
Values
UnknownThe class is not known
DataThe Storage Domain is used for virtual machine disk images
IsoThe Storage Domain is used for storing ISO images
BackupThe Storage Domain is used for import and export of disk images
Since: 4.10.0


StorageDomainType:
An enumeration of Storage Domain types.
Values
UNKNOWNThe type is not known
NFSThe Storage Domain uses Network File System based storage
FCPThe Storage Domain uses FibreChannel based storage
ISCSIThe Storage Domain uses iSCSI based storage
LOCALFSThe Storage Domain uses storage on the local file system
CIFSThe Storage Domain uses CIFS/SMB based storage
SHAREDFSThe Storage Domain uses storage from a Linux VFS file system
Since: 4.10.0


VmStatus:
An enumeration of possible virtual machine statuses.
Values
DownThe VM is powered off
Migration DestinationThe VM is migrating to this host
Migration SourceThe VM is migrating away from this host
PausedThe VM is paused
Powering downA shutdown command has been sent to the VM
RebootInProgressThe VM is currently rebooting
Restoring stateThe VM is waking from hibernation
Saving StateThe VM is preparing for hibernation
UpThe VM is running
WaitForLaunchThe VM is being created
Since: 4.10.0


VmDisplayType:
An enumeration of VM display modes.
Values
vncGraphical VM interaction is available via the VNC protocol
qxlGraphical VM interaction is available via SPICE
Since: 4.10.0


VmDeviceType:
An enumeration of VM device types.
Values
diskA hard disk, floppy, or cdrom device
interfaceA network interface
videoA video card
soundA sound card or PC speaker
controllerAn internal controller that usually provides a bus
balloonA memory balloon device
channelA host-guest communication channel
Since: 4.10.0


VmDiskDeviceType:
An enumeration of VM disk device types.
Values
diskA hard disk drive
cdromA CD-ROM drive (always readonly)
floppyA floppy disk drive
Since: 4.10.0


VmDiskDeviceInterface:
An enumeration of VM disk device interfaces.
Values
ideThe device is connected via an emulated IDE bus
virtioThe device uses a virtio para-virtualized interconnect
fdcThe device is connected to an emulated floppy disk controller
Since: 4.10.0


VmDiskDeviceFormat:
An enumeration of VM disk device formats.
Values
rawRaw data is written directly to backing storage
cowData is written using the Qemu qcow format
Since: 4.10.0


VmDeviceAddressType:
An enumeration of VM device address types.
Values
pciThe address describes a location on an PCI bus
driveThe address describes a location on an IDE bus
virtio-serialDescribes a location on a virtio-serial controller
Since: 4.10.0


VmDevicePciAddress:
Device address for a PCI device.
Members
typeThe device type (always @pci)
slotThe slot number on the PCI bus
busThe PCI bus number
domainThe PCI domain
functionFunction number on the PCI card that implements the device
Since: 4.10.0


VmDeviceIdeAddress:
Device address for an IDE device.
Members
typeThe device type (always @drive)
controllerThe IDE controller number
busThe IDE bus number
unitThe unit number on the IDE bus
Since: 4.10.0


VmDeviceVirtioSerialAddress:
Device address for a virtio-serial port.
Members
typeThe device type (always @virtio-serial)
controllerThe virtio-serial controller number
busThe virtio-serial bus number
portThe port number on the virtio-serial bus
Since: 4.10.0


VmDeviceAddress:
A discriminated record of device address information.
Types
VmDevicePciAddress
VmDeviceIdeAddress
VmDeviceVirtioSerialAddress
Since: 4.10.0


VmDiskDeviceSpecParams:
Extra parameters for VM disk devices.
Members
path#optional The filesystem path to the disk image
Since: 4.10.0


VmDiskDeviceVolumeChainEntry:
Identifies one volume in a VM disk device volume chain.
Members
domainIDThe UUID of the storage domain that contains the volume
imageIDThe UUID of the image that contains the volume
pathThe filesystem path to the volume
volumeIDThe UUID of the volume itself
Since: 4.10.0


VmDiskDevice:
Properties of a VM disk device.
Members
typeThe device type (always @disk)
deviceThe disk device type (eg. @cdrom or @disk)
iface#optional Indicates the device connection method exposed to the guest
path#optional The filesystem path to the drive's volume
readonlyIndicates if writes are prohibited for the device
bootOrder#optional If specified, this device is part of the boot sequence at the specified position
domainID#optional The UUID of the underlying Storage Domain object
poolID#optional The UUID of the underlying Storage Pool object
imageID#optional The UUID of the underlying Image object
volumeID#optional The UUID of the underlying Volume object
formatThe format used to store data on the backing storage
propagateErrorsIf enabled, disk I/O errors will be reported to vdsm for possible resolution (eg. allocating more space)
addressDevice hardware address
aliasAlias used to identify this device in commands
deviceIdA unique ID for this device
specParams#optional Additional device parameters
apparentsizeThe size of the disk (in bytes)
indexThe drive index
nameA user-friendly device name for display only
needExtendIndicates whether an underlying block device needs to be expanded to accomodate growing disk allocation
optionalStates if the VM may start if the disk is not present
reqsizeThe most recently requested drive size (in bytes)
sharedIndicates if this disk is intended to be shared by multiple virtual machines
truesizeThe amount of underlying storage allocated (in bytes)
volumeChainThe sequence of Volume objects needed to construct the disk
baseVolumeID#optional When used as a parameter to @VM.merge, indicates the Volume that should become the new base volume
Since: 4.10.0


VmInterfaceDeviceType:
An enumeration of VM network device types.
Values
bridgeThe device is connected via a host bridge device
Since: 4.10.0


VmInterfaceDeviceModel:
An enumeration of VM network device models.
Values
pvAlias for @virtio
virtioParavirtual network interface
ne2k_pciEmulated Realtek(R) PCI NIC
i82551Emulated Intel(R) 82551ER NIC
i82557bEmulated Intel i82557B NIC
i82559erEmulated Intel i82559ER NIC
rtl8139Emulated rtl8139 NIC
e1000Emulated Intel(R) Gigabit Ethernet NIC
pcnetEmulated AMD(R) PC-Net II NIC
Since: 4.10.0


VmInterfaceDeviceSpecParams:
Additional VM interface device parameters.
Members
None
Since: 4.10.0


VmInterfaceDevice:
Properties of a VM network interface device.
Members
typeThe device type (always @interface)
deviceThe host network device type used to create the connection
nicModelThe type of device that is exposed to the VM operating system
macAddrThe unique ethernet hardware address of the device
networkThe name of the attached host bridge device
bootOrder#optional If specified, this device is part of the boot sequence at the specified position
addressDevice hardware address
aliasAlias used to identify this device in commands
deviceIdA unique ID for this device
specParams#optional Additional device parameters
Since: 4.10.0


VmVideoDeviceType:
An enumeration of VM video device types.
Values
cirrusAn emulated Cirrus Logic GD5446 video card
stdAn emulated standard VESA 2.0 VBE video card
vmwareA paravirtualized VGA video device from VMWare(R)
qxlA paravirtualized video device meant for use with SPICE
noneNo video device is emulated
Since: 4.10.0


VmVideoDeviceSpecParams:
Additional parameters for VM video devices.
Members
vram#optional Specify the amount of video RAM available to the device in KB. Currently relevant for @qxl devices only
Since: 4.10.0


VmVideoDevice:
Properties of a VM video device.
Members
typeThe device type (always @video)
deviceThe type of video device exposed to the VM operating system
addressDevice hardware address
aliasAlias used to identify this device in commands
deviceIdA unique ID for this device
specParams#optional Additional device parameters
Since: 4.10.0


VmSoundDeviceType:
An enumeration of VM sound device types.
Values
ac97An emulated Intel 82801AA AC97 Audio card
pcspkAn emulated PC speaker
sb16An emulated Creative Labs Sound Blaster 16 card
es1370An emulated ENSONIQ AudioPCI ES1370 card
hdaAn emulated Intel High-Definition Audio card
ich6An emulated Intel ICH6 card
Since: 4.10.0


VmSoundDeviceSpecParams:
Additional parameters for VM sound devices.
Members
None
Since: 4.10.0


VmSoundDevice:
Properties of a VM sound device.
Members
typeThe device type (always @sound)
deviceThe type of sound hardware exposed to the VM operating system
addressDevice hardware address
aliasAlias used to identify this device in commands
deviceIdA unique ID for this device
specParams#optional Additional device parameters
Since: 4.10.0


VmControllerDeviceType:
An enumeration of VM controller device types.
Values
ideAn IDE controller
fdcA floppy disk controller
scsiA SCSI controller
sataA Serial ATA controller
usbA USB controller
ccidA ccid (smart card) controller
virtio-serialA virtio-serial controller
Since: 4.10.0


VmControllerDevice:
Properties of a VM controller device.
Members
typeThe device type (always @controller)
deviceThe specific type of controller device
addressDevice hardware address
aliasAlias used to identify this device in commands
deviceIdA unique ID for this device
Since: 4.10.0


VmBalloonDeviceType:
An enumeration of VM balloon device types.
Values
memballoonA memory balloon
Since: 4.10.0


VmBalloonDeviceModel:
An enumeration of VM balloon device models.
Values
noneIndicates that no device is present
virtioA balloon implemented using the virtio specification
Since: 4.10.0


VmBalloonDeviceSpecParams:
Additional parameters for VM balloon devices.
Members
modelThe balloon device model in use
Since: 4.10.0


VmBalloonDevice:
Properties of a VM balloon device.
Members
typeThe device type (always @balloon)
deviceThe the type of balloon device
addressDevice hardware address
aliasAlias used to identify this device in commands
specParams#optional Additional device parameters
deviceIdA unique ID for this device
Since: 4.10.0


VmChannelDeviceType:
An enumeration of VM channel device types.
Values
unixThe host end of the channel is a unix socket
spicevmcThis channel is used for SPICE communication
Since: 4.10.0


VmChannelDevice:
Properties of a VM channel device.
Members
typeThe device type (always @channel)
deviceThe specific type of channel device
addressDevice hardware address
aliasAlias used to identify this device in commands
deviceIdA unique ID for this device
Since: 4.10.0


VmDevice:
A discriminated record containing VM device properties.
Types
VmDiskDevice
VmInterfaceDevice
VmVideoDevice
VmSoundDevice
VmControllerDevice
VmBalloonDevice
VmChannelDevice
Since: 4.10.0


VmShortStatus:
Abbreviated virtual machine status.
Members
vmIdThe UUID of the VM
statusThe current status of the VM
Since: 4.10.0


VmFullStatus:
Full virtual machine status and properties.
Members
acpiEnableIndicates if ACPI is enabled inside the VM
clientIpThe IP address of the client connected to the display
cpuTypeThe type of CPU being emulated
customA dictionary of custom, free-form properties
devicesAn array of VM devices present
displayThe type of display
displayIpThe IP address to use for accessing the VM display
displayPortThe port in use for unencrypted display data
displaySecurePortThe port in use for encrypted display data
emulatedMachineThe specific machine specification being emulated
keyboardLayoutThe keyboard layout string (eg. 'en-us')
kvmEnableIndicates if KVM hardware acceleration is enabled
memSizeThe amount of memory assigned to the VM in MB
nicModelA comma-separated list of NIC models in use by the VM
niceThe host scheduling priority
pauseCodeIndicates the reason a VM has been paused
pidThe process ID of the underlying qemu process
smpThe number of CPUs presented to the VM
smpCoresPerSocket#optional Indicates the number of CPU cores per socket
smpThreadsPerCore#optional Indicates the number of CPU threads per core
statusThe current VM status
timeOffsetThe time difference from host to the VM in seconds
transparentHugePagesIndicates if the Transparent Huge Pages feature is enabled for this virtual machine
vmIdThe VM UUID
vmNameThe VM name
vmTypeThe type of VM
Since: 4.10.0


VmDefinition:
A discriminated record containing virtual machine status information.
Types
VmFullDefinition
VmShortDefinition
Since: 4.10.0


LoggingLevel:
An enumeration of logging verbosity levels.
Values
DEBUGLog everything (including debugging messages)
INFOLog informational messages and anything more severe
WARNINGLog warning messages and anything more severe
ERRORLog error messages and anything more severe
CRITICALLog only critical messages
Since: 4.10.0


ConnectionRefs.init:
Initialize a ConnectionRefs API object.
Since: 4.10.0


IscsiPortal:
A host/port pair that identifies an ISCSI target.
Members
hostA fully-qualified domain name (FQDN) or IP address
port#optional A port number
Since: 4.10.0


IscsiCredentialsLogin:
Login credentials for an ISCI target.
Members
usernameThe username used for authentication to an ISCI target
passwordThe password associated with the given username
Since: 4.10.0


IscsiCredentialsType:
An enumeration of ISCSI login credentials types.
Values
chapChallenge-Handshake Authentication Protocol
Since: 4.10.0


IscsiCredentials:
This structure stores ISCSI credentials.
Members
type#optional The type of authentication to be used
paramsType-specific authentication credentials
Since: 4.10.0


IscsiConnectionParameters:
Parameters for initiating a new ISCSI connection.
Members
portalAn @IscsiPortal to identify the requested target
iqnThe ISCSI Qualified Name
tpgt#optional The Target Portal Group Tag to use
iface#optional The ISCSI interface name
credentials#optional An @IscsiCredentials containing the required authentication information
Since: 4.10.0


PosixFsConnectionParameters:
Parameters for initiating a new POSIX FS connection.
Members
specA string identifying the location of the target filesystem
vfstypeThe Linux VFS filesystem type
options#optional A comma-separated list of mount options
Since: 4.10.0


NfsConnectionParameters:
Parameters for initiating a new NFS connection.
Members
exportThe remote target in <host>:<path> format
retrans#optional The number of retry attempts for failing operations
timeout#optional The time to wait before retrying a request (specified in tenths of one second).
version#optional Set the NFS protocol version
Since: 4.10.0


LocalFsConnectionParameters:
Parameters for initiating a connection to local storage.
Members
pathThe local filesystem path
Since: 4.10.0


ConnectionRefParameters:
A discriminated record of parameters used to establish a ConnectionRef.
Types
IscsiConnectionParameters
PosixFsConnectionParameters
NfsConnectionParameters
LocalFsConnectionParameters
Since: 4.10.0


ConnectionRefType:
An enumeration of @ConnectionRef types.
Values
iscsiStorage exported by a remote ISCSI target
posixfsStorage available through use of the 'mount' command
nfsStorage exported by a remote NFS server
localfsStorage available in the host's local file hierarchy
Since: 4.10.0


ConnectionRefArgs:
Structure to store @ConnectionRef arguments.
Members
typeThe type of connection (one of @ConnectionRefType)
paramsAn @ConnectionRefParameters structure appropriate for @type
Since: 4.10.0


ConnectionError:
A tuple containing @ConnectionRef error information.
Members
0The error code
1The error message
Since: 4.10.0


ConnectionRef:
Contains the details of a registered storage connection.
Members
connectedIndicates whether the storage is connected
lastErrorThe most recent error information (@ConnectionError)
connectionInfoType-specific connection details (@ConnectionRefParameters)
Since: 4.10.0


ConnectionRefArgsMap:
A mapping of connection arguments indexed by ConnectionRef UUID.
Key
UUID
Value
ConnectionRefArgs
Since: 4.10.0


ConnectionRefArgsStatusMap:
A mapping of status codes indexed by ConnectionRef UUID.
Key
UUID
Value
int
Since: 4.10.0


ConnectionRefMap:
A mapping of ConnectionRef information indexed by UUID.
Key
UUID
Value
ConnectionRef
Since: 4.10.0


ISCSIConnection.init:
Initialize a ISCSIConnection API object.
Since: 4.10.0


Image.init:
Initialize an Image API object.
Since: 4.10.0


ImageMoveOperation:
An enumeration of Image move operations.
Values
UNKNOWNThis operation is invalid
COPYThe Image is copied to the destination
MOVEThe Image is copied to the destination and removed from the source
Since: 4.10.0


LVMVolumeGroup.init:
Initialize an LVMVolumeGroup API object.
Since: 4.10.0


StorageDomain.init:
Initialize a StorageDomain API object.
Since: 4.10.0


StorageDomainCreateArgumentsBlock:
Creation argument for Block-based Storage Domains.
Members
vgUUIDThe UUID of a Volume Group to use as backing storage
Since: 4.10.0


StorageDomainCreateArgumentsLocal:
Creation argument for local filesystem Storage Domains.
Members
remotePathA path on the local filesystem
Since: 4.10.0


StorageDomainCreateArgumentsNfs:
Creation argument for NFS-based Storage Domains.
Members
remotePathAn export path in the form: <host>:<path>
Since: 4.10.0


StorageDomainCreateArguments:
A discriminated record of Storage Domain creation parameters.
Types
StorageDomainCreateArgumentsBlock
StorageDomainCreateArgumentsLocal
StorageDomainCreateArgumentsNfs
Since: 4.10.0


StorageDomainFileStats:
Information about files contained within a Storage Domain.
Members
sizeSize of the file in bytes
ctimeTime the file was last changed in seconds since the epoch
statusIndicates if the file is accessible
Since: 4.10.0


StorageDomainFileStatsMap:
A mapping of Storage Domain file statistics indexed by filename.
Key
str
Value
StorageDomainFileStats
Since: 4.10.0


StorageDomainRole:
An enumeration of possible Storage Domain roles.
Values
MasterThe Storage Domain contains Storage Pool metadata
RegularThe Storage Domain is not a Master domain
Since: 4.10.0


StorageDomainInfo:
Information about a Storage Domain.
Members
uuidThe Storage Domain UUID
typeThe type of backing storage used by this domain
classThe Storage Domain class
nameThe human-readable name for this Storage Domain
roleThe Storage Domain role
poolThe Storage Pool associated with this Storage Domain
versionThe version of this Storage Domain
lverThe lock version of the associated Storage Pool
spm_idContains the Host ID of the Storage Pool Manager
master_verThe version of the master Storage Domain
Since: 4.10.0


StorageDomainStats:
Storage Domain statistics.
Members
disktotalThe amount of total storage space in bytes
diskfreeThe amount of free storage space in bytes
mdasizeThe size of the metadata area in bytes
mdafreeThe amount of free space in the metadata area in bytes
mdavalidIndicates if the metadata area is large enough
mdathresholdIndicates if the metadata has exceeded its size threshold
Since: 4.10.0


UploadVolumeMethod:
An enumeration of uploadVolume methods.
Values
wgetFetch data using the wget command
rsyncFetch data using the rsync command
Since: 4.10.0


StoragePool.init:
Initialize a StoragePool API object.
Since: 4.10.0


ConnectStorageServerStatus:
Status of a single storage server connection attempt.
Members
idConnection UUID
statusStatus code
Since: 4.10.0


SpmRole:
An enumeration of Storage Pool Manager roles that are valid for a host.
Values
SPMThe host has the SPM role
ContendThe host is contending for the SPM role
FreeThe host does not have the SPM role
Since: 4.10.0


SpmStatus:
Storage Pool Manager status information.
Members
spmStatusThe SPM role for this host
spmLverThe lock version of the Storage Pool
spmIdThe Host ID of the Storage Pool Manager
Since: 4.10.0


OVFMap:
A mapping of OVF data indexed by VM UUID.
Key
UUID
Value
str
Since: 4.10.0


StoragePoolStatus:
An enumeration of Storage Pool statuses.
Values
uninitializedThe Storage Pool has not been initialized
connectedVdsm is connected to the Storage Pool
Since: 4.10.0


StoragePoolInfo:
Information about a Storage Pool.
Members
typeThe type of storage managed by this Storage Pool
nameThe Storage Pool name
domainsAll associated Storage Domains (the string has the following format: '<uuid>:<status>,<uuid>:<status>...'
master_uuidThe UUID of the Storage Domain serving as the master domain
master_verThe Storage Domain version of the master domain
lverThe Storage Pool lock version
spm_idThe Host ID of the host that is acting Storage Pool Manager
isoprefixThe filesystem path from where ISO images may be referenced
pool_statusThe current status of the Storage Pool
versionThe Storage Pool version
Since: 4.10.0


StoragePoolDomainAlert:
Alert information for a Storage Domain attached to this Storage Pool.
Members
codeThe alert code
messageA detailed alert string
Since: 4.10.0


StorageDomainStatus:
An enumeration of Storage Domain statuses.
Values
UnknownThe status of the Storage Domain is not known
AttachedThe domain is attached to a Storage Pool but is deactivated
UnattachedThe domain is not attached to a Storage Pool
ActiveThe domain is attached to a Storage Pool and is activated
Since: 4.10.0


StoragePoolDomainInfo:
Information about a Storage Domain that is attached to a Storage Pool.
Members
disktotalThe total amount of disk space in the Storage Domain in bytes
diskfreeThe remaining free disk space in bytes
alertsA list of alerts for this Storage Domain
statusCurrent Storage Domain status
Since: 4.10.0


StoragePoolDomainInfoMap:
A mapping of active Storage Domain information indexed by Storage Domain UUID.
Key
UUID
Value
StoragePoolDomainInfo
Since: 4.10.0


ImagePostZeroMap:
A mapping of postZero selectors indexed by Image UUID.
Key
UUID
Value
bool
Since: 4.10.0


StorageDomainStatusMap:
A mapping of Storage Domain statuses indexed by Storage Domain UUID.
Key
UUID
Value
StorageDomainStatus
Since: 4.10.0


StoragePoolUpgradeStatus:
An enumeration of Storage Pool upgrade job statuses.
Values
startedThe upgrade process has started
Since: 4.10.0


StorageServerConnectionValidateParams:
Validation parameters for a connection to backing storage.
Members
idA UUID to identify this set of parameters in the return value
Notes:
Deprecated since 4.10.0
Since: 4.10.0


StorageServerConnectionValidateStatus:
indicates validity of backing storage connection parameters.
Members
idA UUID to identify this set of parameters
statusCode indicating the validity of the parameters
Notes:
Deprecated since 4.10.0
Since: 4.10.0


UpdateVmDefinition:
Virtual machine definition data suitable for saving to a Storage Domain.
Members
vmThe VM UUID
ovfThe VM definition in OVF format
imglistThe Images this VM depends on (a comma-separated string of UUIDs)
Since: 4.10.0


Task.init:
Initialize a Task API object.
Since: 4.10.0


VM.init:
Initialize a VM API object.
Since: 4.10.0


DriveSpecVolume:
A drive specification that refers to a Volume managed by Vdsm.
Members
deviceThe disk device type (should be @disk)
domainIDThe Storage Domain containing the Volume
poolIDThe Storage Pool containing the Volume
imageIDThe Image associated with the Volume
volumeIDThe UUID of the target Volume
Since: 4.10.0


DriveSpecGUID:
A drive specification using a device mapper GUID.
Members
GUIDThe devmapper device GUID
Since: 4.10.0


DriveSpecUUID:
A drive specification using a blkid UUID.
Members
UUIDThe device blkid
Since: 4.10.0


DriveVmPayload:
Directly specified data to be inserted into a VM.
Members
fileA dictionary of file contents indexed by filename
Since: 4.10.0


DrivePayload:
The detailed specification of the image contents
Members
vmPayloadSpecifies data to be inserted into the VM Disk
Since: 4.10.0


DriveSpecPayload:
A drive specification that describes the exact image contents.
Members
deviceThe type of disk device being created
specParamsAdditional drive parameters (including the payload information)
Since: 4.10.0


DriveSpecPath:
A drive specification using a filesystem path to an image file.
Members
pathThe full filesystem path to the image file
Since: 4.10.0


DriveSpec:
A discriminated record containing a VM drive specification
Types
DriveSpecVolume
DriveSpecGUID
DriveSpecUUID
DriveSpecPayload
DriveSpecPath
Since: 4.10.0


VmExitCode:
An enumeration of final VM exit status codes.
Values
NORMALThe VM has exited gracefully
ERRORThe VM has terminated with errors
Since: 4.10.0


ExitedVmStats:
Statistics about a VM that no longer running.
Members
exitCodeCode indicating whether the VM exit was normal or in error
statusThe current VM status
exitMessageDetailed reason for the virtual machine exit
timeOffset#optional The time difference from host to the VM in seconds
Since: 4.10.0


VmDiskStats:
Statistics about a virtual machine disk device.
Members
truesizeThe amount of underlying storage allocated (in bytes)
apparentsizeThe size of the disk (in bytes)
imageIDThe UUID of the Image associated with this disk
readRateThe read activity in bytes per second
writeRateThe write activity in bytes per second
readLatencyThe latency of read operations in nanoseconds
writeLatencyThe latency of write operations in nanoseconds
flushLatencyThe latency of flush operations in nanoseconds
Since: 4.10.0


VmBootMode:
An enumeration of VM boot modes.
Values
aBoot from the first floppy device
cBoot from the first hard disk
dBoot from the first cdrom device
nBoot from the network
Since: 4.10.0


GuestMemoryStats:
Memory statistics as reported by the guest agent.
Members
mem_totalThe total amount of memory available to the OS (in KB)
mem_unusedThe amount of memory that is completely unused (in KB)
mem_freeThe amount of memory available for allocation in KB (includes easily reclaimable memory)
swap_inThe number of memory pages swapped in since the last collection
swap_outThe number of memory pages swapped out since the last collection
pagefltThe number of page faults since the last collection
majfltThe number of major page faults since the last collection
Since: 4.10.0


GuestMountInfo:
Information about a mounted filesystem as reported by the guest agent.
Members
pathThe filesystem mount point
fsThe filesystem type
totalThe total amount of space on the filesystem in bytes
usedThe 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
nameThe network device name
hwThe MAC address
inetThe IPv4 address
inet6The IPv6 address
Since: 4.10.0


GuestSessionState:
An enumeration of user session states.
Values
UnknownThe session state is not known
UserLoggedOnA user has logged in
LockedThe display is locked
ActiveThe display has been unlocked
LoggedOffA user has logged off
Since: 4.10.0


VmDiskStatsMap:
A mapping of VM disk statistics indexed by device name.
Key
str
Value
VmDiskStats
Since: 4.10.0


RunningVmStats:
Statistics for a running virtual machine.
Members
displayPortThe port in use for unencrypted display data
displaySecurePortThe port in use for encrypted display data
displayTypeThe type of display in use
displayIpThe IP address to use for accessing the VM display
pidThe process ID of the underlying qemu process
vmTypeThe type of VM
kvmEnableIndicates if KVM hardware acceleration is enabled
networkNetwork bandwidth/utilization statistics
disksDisk bandwidth/utilization statistics
monitorResponseIndicates if the qemu monitor is responsive
niceThe host scheduling priority
elapsedTimeThe number of seconds that the VM has been running
cdrom#optional The path to an ISO image used in the VM's CD-ROM device
boot#optional An alias for the type of device used to boot the VM
statsAgeThe age of these statistics in seconds
cpuSysRatio of CPU time spent in kernel by the qemu process
cpuUserRatio of CPU time spent in userspace by the qemu process
cpuIdleRatio of CPU time spent idle by the qemu process
acpiEnableIndicates if ACPI is enabled inside the VM
timeOffsetThe time difference from host to the VM in seconds
clientIpThe IP address of the client connected to the display
pauseCodeIndicates the reason a VM has been paused
memUsageThe percent of memory in use by the guest
usernameThe username associated with the current session
sessionThe current state of user interaction with the VM
appsListA list of installed applications with their versions
guestIPsA space separated string of assigned IPv4 addresses
memoryStatsMemory statistics as reported by the guest agent
disksUsageInfo about mounted filesystems as reported by the agent
netIfacesNetwork device address info as reported by the agent
Since: 4.10.0


VmStats:
A discriminated record containing virtual machine statistics.
Types
ExitedVmStats
RunningVmStats
Since: 4.10.0


HibernationVolumeHandle:
Indicates where VM hibernation state and metadata should be stored.The format is:<domainUUID>,<poolUUID>,<stateImageUUID>,<stateVolumeUUID>,<metaImageUUID>,<metaVolumeUUID>
Type
str
Since: 4.10.0


HotplugNicParams:
Parameters for @VM.hotplugNic.
Members
vmIdThe UUID of the VM to modify
nicThe network device specification
Since: 4.10.0


HotplugDiskParams:
Parameters for @VM.hotplugDisk.
Members
vmIdThe UUID of the VM to modify
driveThe disk device specification
Since: 4.10.0


MigrateMode:
An enumeration of VM migration modes.
Values
remoteMigrate to a remote host
fileSave the VM state to storage
Since: 4.10.0


MigrateMethod:
An enumeration of VM migration methods.
Values
onlineMigrate while the VM continues to run
Since: 4.10.0


MigrateParams:
Parameters for @VM.migrate.
Members
vmIdThe UUID of the virtual machine to migrate
dstThe destination host in <host>[:<port>] format. The port is optional and should usually be omitted.
dstparamsUsed only by the hibernate API. Ignored for @remote migration
modeThe migration mode. Callers of this API should use @remote. For @file migration use @VM.hibernate.
method
Since: 4.10.0


VmTicketConflictAction:
An enumeration of consequences if another user is connected to a display.
Values
disconnectDisconnect the current user
keepChange the password but keep the current user connected
failFail the operation and do not change the password
Since: 4.10.0


SnapshotVolumeDriveInfo:
Snapshot information for a Volume-based VM disk.
Members
domainIDThe Storage Domain associated with the VM disk
imageIDThe Image associated with the VM disk
baseVolumeIDThe Volume associated with the VM disk
volumeIDThe Volume in which to create the snapshot
mirrorDomainID#optional The Storage Domain to use for snapshot mirroring
mirrorImageID#optional The Image to use for snapshot mirroring
mirrorVolumeID#optional The Volume to use for snapshot mirroring
Since: 4.10.0


SnapshotGUIDDriveInfo:
Snapshot information for a VM disk that is identified by a devmapper GUID.
Members
baseGUIDThe devmapper device GUID associated with the VM disk
GUIDThe devmapper device GUID in which to create the snapshot
mirrorDomainID#optional The Storage Domain to use for snapshot mirroring
mirrorImageID#optional The Image to use for snapshot mirroring
mirrorVolumeID#optional The Volume to use for snapshot mirroring
Since: 4.10.0


SnapshotUUIDDriveInfo:
Snapshot information for a VM disk that is identified by a block device UUID.
Members
baseUUIDThe block device ID associated with the VM disk
UUIDThe block device ID in which to create the snapshot
mirrorDomainID#optional The Storage Domain to use for snapshot mirroring
mirrorImageID#optional The Image to use for snapshot mirroring
mirrorVolumeID#optional The Volume to use for snapshot mirroring
Since: 4.10.0


SnapshotDriveInfo:
A discriminated record of snapshot information for a VM disk.
Types
SnapshotVolumeDriveInfo
SnapshotGUIDDriveInfo
SnapshotUUIDDriveInfo
Since: 4.10.0


MergeStatusCode:
An enumeration of possible merge statuses.
Values
Not StartedThe merge operation has not yet started
In ProgressThe operation is ongoing
FailedThe merge operation failed
CompletedThe merge operation is finished
UnknownThe status cannot be determined
Drive Not FoundThe specified drive could not be found
Base Not FoundThe indicated base volume is not in the volume chain
Since: 4.10.0


MergeStatus:
Status of a merge operation on a single disk.
Members
diskThe name of the disk
statusThe current status of the operation
Notes:

Since: 4.10.0


Volume.init:
Initialize a Volume API object.
Since: 4.10.0


VolumeRole:
An enumeration of Volume Roles.
Values
SHAREDThe Volume is a shared template
INTERNALThe Volume is being used internally by vdsm
LEAFThe Volume is a writable leaf
Since: 4.10.0


VolumeFormat:
An enumeration of Volume data formats.
Values
COWThe Volume uses the Qemu Qcow image format
RAWThe Volume writes raw data directly to the backing image
Since: 4.10.0


VolumeAllocation:
An enumeration of Volume allocation modes.
Values
PREALLOCATEDAll necessary storage is allocated at Volume creation time
SPARSEStorage is allocated as needed
Since: 4.10.0


DiskType:
An enumeration of disk usage types.
Values
UNKNOWNThe type is not specified
SYSTEMThe disk contains the operating system
DATAThe disk is for data
SHAREDThe disk is shared among multiple VMs
SWAPThe disk is used for swap space
TEMPThe disk is used for temporary storage space
Since: 4.10.0


VolumeLegality:
An enumeration of Volume Legality indicators.
Values
ILLEGALThe Volume should no longer be used (because it is being deleted)
LEGALThe Volume is legal
FAKEThe Volume is a fake template on a backup domain
Since: 4.10.0


VolumeStatus:
An enumeration of Volume statuses.
Values
OKThere are no problems with the Volume or metadata
INVALIDThe Volume and metadata are not valid
ILLEGALThe Volume is not legal
Since: 4.10.0


VolumeInfo:
Information about a Volume.
Members
uuidThe Volume UUID
typeThe Volume allocation policy
formatThe format used to write data to the Volume
disktypeAn advisory code indicating the Volume's planned usage
voltypeThe Volume role
capacityThe size of the Volume (in bytes)
parentThe direct ancestor of this Volume if it exists
descriptionA human-readable description of the Volume
poolThe Storage Pool associated with the Volume
domainThe Storage Domain associated with the Volume
imageThe Image associated with the Volume
ctimeThe Volume creation time in seconds since the epoch
mtimeThe Volume modification time in seconds since the epoch
legalityIndicates whether the volume is legal to use
apparentsizeThe size of the Volume (in bytes)
truesizeThe amount of underlying storage allocated (in bytes)
statusIndicates whether the Volume and metadata are valid
childrenA list of decendent Volumes that depend on this Volume
Since: 4.10.0