Host.setupNetworks:
Reconfigure host networking by adding, removing, and editing multiple bridgeand bond devices in a single call.
Host.fenceNode:
Send a fencing command to a remote host.
Arguments
| addr | string | The IP address of the remote fence agent |
| port | int | The port number of the remote fence agent |
| agent | string | The type of agent being connected to (For example: rsa, ilo, drac5, ipmilan, etc) |
| username | string | The username used to login to the remote fence agent |
| password | string | The password for username |
| action | FenceNodeAction | The type of fencing operation to perform (from FenceNodeAction) |
| secure | boolean | Enable SSL communication |
| options | string | Additional agent-specific parameters in space-separated <var>=<val> pairs |
| policy | FencingPolicy | Additional options needed in fenceNode logic |
Host.getAllTasksInfo:
Get extra information about all tasks.
Returns
| [''] | TasksInfo | A mapping of Task information |
Host.getAllTasksStatuses:
Get status information for all tasks.
Host.setMOMPolicy:
Set MOM policy for different level of overcommitments.
Arguments
| policy | string | MOM policy string. |
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. |
Host.setKsmTune:
Set variables for controlling KSM mode and aggresivity.
Arguments
| tuningParams | KsmTuneParams | A dictionary where keys represent variable names and values contain the values for controlling KSM. |
Host.setHaMaintenanceMode:
Configure maintenance for Hosted Engine subsystem.
Arguments
| mode | HaMaintenanceMode | Type of maintenance to configure |
| enabled | boolean | Whether to enable or disable maintenance |
Host.add_image_ticket:
Start a session to expose an image via imaged daemon https api for reading and writing image data.
Host.get_image_ticket:
Get ticket from the imageio daemon via https api.
Arguments
| uuid | UUID | The image ticket id. |
Returns
| [''] | TicketInfo | Information about the image ticket. |
Host.remove_image_ticket:
Stop an image upload data transfer session.
Arguments
| uuid | UUID | uuid of the ticket to be removed |
Host.extend_image_ticket:
Extend an image upload data transfer session.
Arguments
| uuid | UUID | uuid of the ticket to be extended |
| timeout | uint | Timeout in seconds for the ticket to expire. |
Host.getAllTasks:
Get all information about all tasks.
Host.getCapabilities:
Get host capabilities.
Host.getNetworkCapabilities:
Get host network capabilities.
Host.getNetworkStatistics:
Get host network statistics.
Host.echo:
Log a user message and echo it
Arguments
| message | string | Message to log with api.Host logger |
Returns
| [''] | string | The logged message |
Host.getHardwareInfo:
Get host hardware information.
Host.getConnectedStoragePools:
Get a list of all Storage Pools that are connected to this host.
Returns
| [''] | UUID | A list of Storage Pool UUIDs |
Host.getDeviceList:
Get information about all block devices.
Arguments
| storageType | BlockDeviceType | Only return devices of this type |
| guids | string | Only return info on specific list of block device GUIDs |
| checkStatus | boolean | Indicates if device status should be checked |
| refresh | boolean | Indicates if storage refresh is required |
Host.getDevicesVisibility:
Check if the host has access to block storage devices.
Arguments
| guidList | UUID | A list of block device GUIDs |
Host.getLldp:
Get lldp information of a NIC
Arguments
| filter | StringListMap | Restrict the reported lldp information. Empty restriction means to report all lldp information from all NICs. |
Returns
| [''] | LldpMap | Lldp information of a NIC |
Host.getLVMVolumeGroups:
Get information about Volume Groups in this host.
Arguments
| storageType | BlockDeviceType | Limit results to Volume Groups of a specific storage type |
Host.getStats:
Get host statistics.
Host.getStorageDomains:
Get a list of known Storage Domains.
Arguments
| storagepoolID | UUID | Limit to Domains belonging to this Storage Pool |
| domainClass | StorageDomainImageClass | Limit to Domains of this StorageDomainImageClass |
| storageType | StorageDomainType | Limit to Domains of this StorageDomainType |
| remotePath | string | Limit to Domains having this remotePath. |
Returns
| [''] | UUID | A list of Storage Domain UUIDs |
Host.getStorageRepoStats:
Get statistics and liveness of currently monitored Storage Domains.
Arguments
| domains | UUID | Return statistics only for specified storage domain UUIDs. If not specified, return info for all storage domains. |
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 |
Host.stopMonitoringDomain:
Stop SD monitoring with hostID
Arguments
| sdUUID | UUID | The Storage Domain UUID |
Host.getVMList:
Get information about the current virtual machines.
Arguments
| fullStatus | boolean | When set to False return limited info |
| vmList | UUID | Filter the results by a list of UUIDs |
| onlyUUID | boolean | Control the Short Status format, and has no effect if on Full Status (fullStatus=True). if True, the return value is a list of UUIDs. if False, the return value is a list of ShortStatus. This parameter is provided for backward compatibility with engine-3.5.0. |
Returns
| [''] | VmInfo | A list of VmInfos |
Host.dumpxmls:
Get Libvirt domain XML of the given VMs.
Arguments
| vmList | UUID | A list of VM UUIDs to return domain XMLs for. |
Returns
| [''] | StringMap | A map of VM UUID to of domain XML. |
Host.getExternalVMs:
Get information about the not-KVM virtual machines.
Arguments
| uri | string | libvirt connection uri |
| username | string | libvirt connection user name |
| password | string | libvirt connection password |
| vm_names | string | Limit query only to hosts with specified names |
Host.getExternalVMNames:
Get names of all the VMs on external hypervisor
Arguments
| uri | string | Libvirt connection uri |
| username | string | Libvirt connection user name |
| password | string | Libvirt connection password |
Returns
| [''] | string | A list of VM names |
Host.getExternalVmFromOva:
Get VM information (disks, interfaces, memory etc) from OVA file
Arguments
| ova_path | string | path to the ova file |
Returns
| [''] | ExternalVmInfo | ExternalVmInfo with information regarding the VM |
Host.convertExternalVmFromOva:
Convert VM from external file (OVA) to data domain
Arguments
| ova_path | string | actual path to the ova file |
| vminfo | ExternalVmParams | information of the VM such as name, id etc |
| jobid | UUID | Assign a UUID to this operation which can be used to identify it in HostStats |
Host.convertExternalVm:
Convert VM from external source to data domain
Arguments
| uri | string | libvirt connection uri |
| username | string | libvirt connection user name |
| password | string | libvirt connection password |
| vminfo | ExternalVmParams | information of the VM such as name, id etc |
| jobid | UUID | Assign a UUID to this operation which can be used to identify it in HostStats |
Host.getConvertedVm:
Return OVF string that created via convertExternalVm call
Arguments
| jobid | UUID | UUID to identify the job that created in convertExternalVm |
Host.getJobs:
Get information about HostJobs on this host.
Arguments
| job_type | HostJobType | Return only jobs of this type |
| job_ids | UUID | Return only jobs matching the specified ids |
Host.abortV2VJob:
Abort V2V importing process
Arguments
| jobid | UUID | UUID to identify the job that created in convertExternalVm |
Host.deleteV2VJob:
Delete V2V job when job is done or stop due to errors
Arguments
| jobid | UUID | UUID to identify the job that created in convertExternalVm |
Host.registerSecrets:
Register secrets with libvirt
Arguments
| secrets | SecretInfo | List of secrets to register |
| clear | boolean | If true, unregister other registered secrets |
Host.unregisterSecrets:
Unregister secrets registered for given uuids
Arguments
| uuids | UUID | List of UUIDs |
Host.getVMFullList:
Get full information about the current virtual machines.
Arguments
| vmList | UUID | Filter the results by a list of UUIDs |
Returns
| [''] | VMFullInfo | A list of full information about current VMs |
Host.getAllVmStats:
Get statistics for all virtual machines.
Returns
| [''] | VmStats | A list of stats for all VMs |
Host.getAllVmIoTunePolicies:
Get io tune policies for all virtual machines.
Host.hostdevListByCaps:
Refresh and get information about devices available on the host
Arguments
| caps | string | List of capabilities. Devices of given capabilities will be fetched. Omitting or sending empty list returns all devices. |
Host.hostdevChangeNumvfs:
Change number of VFs for specified PF
Arguments
| deviceName | string | Libvirt name of the device (specified using underscores - pci_0000_05_00_0 for example) |
| numvfs | uint | Number of requested VFs. Should be smaller or equal to totalvfs of PF. |
Host.hostdevReattach:
Reattach device back to the host
Arguments
| deviceName | string | Libvirt name of the device (specified using underscores - pci_0000_05_00_0 for example) |
Host.ping:
Test connectivity to vdsm.
Host.ping2:
Test connectivity to vdsm.
Host.confirmConnectivity:
Confirm remaining external connectivity to vdsm host.
Host.setLogLevel:
Set the vdsm logging verbosity level.
Arguments
| level | LoggingLevel | The new verosity level desired |
| name | string | The logger to set |
Host.setSafeNetworkConfig:
Mark the current network configuration good and persist any changes.
ManagedVolume.attach_volume:
Attach a volume. If the volume is already attached an error will be returned.
ManagedVolume.detach_volume:
Detach a volume. If the volume is not attached, the operation will succeed.
Arguments
| vol_id | UUID | The volume ID |
ManagedVolume.volumes_info:
Get information about list of volumes
Arguments
| vol_ids | UUID | The list of volume IDs |
Returns
| [''] | ManagedVolumeInformation | Information about the attached volumes. If list of volume IDs is not specified or empty, info about all volumes in DB is returned. |
ISCSIConnection.discoverSendTargets:
Discover available targets for this ISCSIConnection.
Arguments
| host | string | A fully-qualified domain name (FQDN) or IP address |
| port | int | A port number |
| user | string | The username used for authentication to an ISCI target |
| password | string | The password associated with the given username |
| ipv6_enabled | boolean | If true, the returned list includes porals on IPv6 |
Returns
| [''] | string | A list of discovered targets in the form: '<host>:<port>,<tpgt><iqn>' |
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 | boolean | If True, overwrite Volume data with zeroes after deletion |
| force | boolean | Force the operation and do not perform any validation |
| discard | boolean | If true, discard the image and its volumes before deletion |
Returns
| [''] | UUID | A task UUID |
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 | boolean | If True, overwrite Volume data with zeroes after deletion |
| force | boolean | Force the operation and do not perform any validation |
| discard | boolean | If true, discard the volumes before deletion |
Returns
| [''] | UUID | A task UUID |
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 |
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 | boolean | If True, overwrite Volume data with zeroes after deletion |
| force | boolean | Force the operation and do not perform any validation |
| discard | boolean | If true, discard the volume before deletion |
Returns
| [''] | UUID | A task UUID |
Image.cloneStructure:
Deprecated. 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 |
Returns
| [''] | UUID | A task UUID |
Image.syncData:
Deprecated. 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 |
Returns
| [''] | UUID | A task UUID |
Image.download:
Download an image to a remote endpoint using the specified method and methodArgs.
Arguments
| methodArgs | ImageSharingMethodArgs | An ImageSharingMethodArgs record specifying the download method. |
| 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 | The UUID of the Volume |
Returns
| [''] | UUID | A task UUID |
Image.upload:
Upload an image to a remote endpoint using the specified method andmethodArgs.
Arguments
| methodArgs | ImageSharingMethodArgs | An ImageSharingMethodArgs record specifying the upload method. |
| 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 | The UUID of the Volume (optional) |
Returns
| [''] | UUID | A task UUID |
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 | The UUID of the Volume |
| allowIllegal | boolean | False by default. If set to True, prepare will succeed even if any of the image volumes are illegal, for making the volume writable by untrusted source. Never use this when exposing the volume's image to a vm! |
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 | The UUID of the Volume (optional) |
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 |
Lease.create:
Create an external lease (only on the SPM host)
Arguments
| lease | Lease | The lease to create |
| metadata | LeaseMetadata | If specified, the lease metadata will be written to lease's LVB. |
Returns
| [''] | UUID | A task UUID |
Lease.delete:
Delete an external lease (only on the SPM host)
Arguments
| lease | Lease | The lease to delete |
Returns
| [''] | UUID | A task UUID |
Lease.rebuild_leases:
Rebuild external leases index on storage domain
Arguments
| sd_id | UUID | The storage domain where external leases volume is located |
Returns
| [''] | UUID | A task UUID |
Lease.info:
Return external lease information
Arguments
| lease | Lease | The lease to query |
Returns
| [''] | LeaseInfo | Information about this lease |
Lease.status:
Return the underlying sanlock lease status
Arguments
| lease | Lease | Lease to query |
Lease.fence:
Fence a lease. For example, if used for job fencing, the operation will increase the generation and change the job status.
Arguments
| lease | Lease | Lease to fence |
| metadata | LeaseMetadata | Expected lease metadata read from lease's LVB. |
LVMVolumeGroup.create:
Create a new Volume Group.
Arguments
| lvmvolumegroupID | UUID | The UUID of the LVM Volume Group |
| name | UUID | The new Volume Group UUID |
| devlist | string | An array of device names to include in the Volume Group |
| force | boolean | Force the operation and do not perform any validation |
Returns
| [''] | UUID | The uuid of the created Volume Group |
LVMVolumeGroup.getInfo:
Get information about a Volume Group.
Arguments
| lvmvolumegroupID | UUID | The UUID of the LVM Volume Group |
LVMVolumeGroup.remove:
Remove this Volume Group.
Arguments
| lvmvolumegroupID | UUID | The UUID of the LVM Volume Group |
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 |
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 |
StorageDomain.create:
Create a new Storage Domain.
Arguments
| storagedomainID | UUID | The UUID of the Storage Domain |
| domainType | StorageDomainType | The type of backing storage used by the Storage Domain |
| typeArgs | StorageDomainCreateArguments | Type specific backing storage specifier |
| name | string | A human-readable name |
| domainClass | StorageDomainImageClass | The Storage Domain Class |
| version | int | The Storage Domain version that should be used |
| blockSize | int | Underlying storage block size. Valid values are 512 and 4096 (only for file based storage domains). In case valid value supplied, but underlying storage can't work with that block size, this call will fail. Setting to the speical value 0 means that VDSM will try to detect the block size and will set it to the 512 if detection fails. |
| maxHosts | int | Maximum number of hosts, supported by this domain. The number of hosts is defined by combination of sanlock alignment and block size. Because of that, handling 2000 hosts with 4k/8M lockspaces will require about 30GB of disk space. To decrease that overhead, we support reduced number of hosts per SD, so we can use smaller alignments and allocate less disk space for leases. |
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 |
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 | 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 |
| force | boolean | Force operation -- do not perform validation |
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 | string | An array of block device names to add to the domain |
| force | boolean | Try to extend a domain with LUN even if it is not empty (e.g. already marked as part of a VG). |
StorageDomain.resizePV:
Resize PV will cause the PV to use the entire size of the block device, after the block device was resized on the storage server.
Arguments
| storagedomainID | UUID | The UUID of the Storage Domain |
| storagepoolID | UUID | The UUID of the Storage Pool |
| guid | string | A block device GUID |
Returns
| [''] | uint | The size in bytes of the device after resize |
StorageDomain.format:
Format a storage domain and erase all of its data.
Arguments
| storagedomainID | UUID | The UUID of the Storage Domain |
| autoDetach | boolean | Detach the Storage Domain before formatting. Useful when formatting the master domain. |
StorageDomain.getFileStats:
Get a list of files in an ISO domain.
Arguments
| storagedomainID | UUID | The UUID of the Storage Domain |
| pattern | string | Filter results by this glob pattern |
| caseSensitive | boolean | Enables case-sensitive matching |
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 |
StorageDomain.getInfo:
Get information about a Storage Domain.
Arguments
| storagedomainID | UUID | The UUID of the Storage Domain |
StorageDomain.getStats:
Get Storage Domain statistics.
Arguments
| storagedomainID | UUID | The UUID of the Storage Domain |
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 |
StorageDomain.setDescription:
Set the Storage Domain description.
Arguments
| storagedomainID | UUID | The UUID of the Storage Domain |
| description | string | A human-readable description |
StorageDomain.validate:
Check that the Storage Domain is accessible.
Arguments
| storagedomainID | UUID | The UUID of the Storage Domain |
StorageDomain.dump:
Get raw storage domain metadata from storage.
Arguments
| sd_id | UUID | The UUID of the Storage Domain. |
| full | boolean | If set to True, will also dump leases, lockspace and xleases information along with SD metadata and volumes information. Taking a full dump may be up to 10 times slower. |
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 | string | 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 | The Storage Domain statuses. If this argument is present the Storage Pool will use the memory backend (no metadata). |
StoragePool.connectStorageServer:
Establish a connection to backing storage.
StoragePool.create:
Create a new Storage Pool.
Arguments
| storagepoolID | UUID | The UUID of the Storage Pool |
| name | string | 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. |
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 | string | Deprecated. Retained here to support older versions |
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 | string | Deprecated. Retained here to support older versions |
| remove | boolean | If True, remove the Storage Pool after it is disconnected. Not used by vdsm and set to false |
StoragePool.disconnectStorageServer:
Remove backing storage connections.
StoragePool.getBackedUpVmsInfo:
Get information about backed-up virtual machines from a Backup StorageDomain.
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 |
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 |
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 |
StoragePool.getSpmStatus:
Get the status of the Storage Pool Manager role.
Arguments
| storagepoolID | UUID | The UUID of the Storage Pool |
StoragePool.getInfo:
Get information about a Storage Pool and its Active Storage Domains.
Arguments
| storagepoolID | UUID | The UUID of the Storage Pool |
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 | string | 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. |
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 |
StoragePool.setDescription:
Set the Storage Pool description. Deprecated since '4.0'.
Arguments
| storagepoolID | UUID | The UUID of the Storage Pool |
| description | string | A human-readable string describing the Storage Pool |
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 | string | Deprecated. The lver of the previous SPM |
| enableScsiFencing | string | This parameter is not used |
| maxHostID | int | The maximum number of hosts that could be in the cluster |
| domVersion | string | The expected Storage Domain version of the master domain |
Returns
| [''] | UUID | A task UUID |
StoragePool.spmStop:
Instruct this host to release the Storage Pool Manager role for this pool.
Arguments
| storagepoolID | UUID | The UUID of the Storage Pool |
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 |
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 | The Storage Domain to use for storing the VM definitions |
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 | The Storage Domain where the VM is stored |
StoragePool.prepareMerge:
This operation is required before performing (cold) merge. Prepare merge will calculate the required allocation for base volume, extend the base volume or enlarge it (if the size of volume being removed is larger than the base size), and mark it as ILLEGAL.
Arguments
| storagepoolID | UUID | The UUID of the Storage Pool |
| subchainInfo | SubchainInfo | Subchain to prepare |
Returns
| [''] | UUID | A task UUID |
StoragePool.finalizeMerge:
This operation is required after (cold) merge completes. Finalize will update qcow metadata and the vdsm volume metadata to reflect that a volume is being removed from the chain.
Arguments
| storagepoolID | UUID | The UUID of the Storage Pool |
| subchainInfo | SubchainInfo | Subchain to finalize |
Returns
| [''] | UUID | A task UUID |
StoragePool.reduceVolume:
Reduce volume size. Mainly used after merge operation.
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 |
| allowActive | boolean | A flag indicating whether to allow reducing the size of active volumes. |
Returns
| [''] | UUID | A task UUID |
StoragePool.switchMaster:
Switch the master role to the requested storage domain.
Arguments
| storagepoolID | UUID | The storage pool associated with the storage domains |
| oldMasterUUID | UUID | The current master storage domain UUID |
| newMasterUUID | UUID | The new master storage domain UUID |
| masterVersion | int | The new master storage domain version |
Returns
| [''] | UUID | A task UUID |
Task.clear:
Discard information about a finished Task.
Arguments
| taskID | UUID | The UUID of the Task |
Task.getInfo:
Get information about a Task.
Arguments
| taskID | UUID | The UUID of the Task |
Returns
| [''] | TaskInfo | General Task information |
Task.getStatus:
Get Task status information.
Arguments
| taskID | UUID | The UUID of the Task |
Task.revert:
Rollback a Task to restore the previous system state.
Arguments
| taskID | UUID | The UUID of the Task |
Task.stop:
Stop a currently running Task.
Arguments
| taskID | UUID | The UUID of the Task |
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 |
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 |
VM.cont:
Resume a paused VM.
Arguments
| vmID | UUID | The UUID of the VM |
VM.create:
Create a new virtual machine.
VM.desktopLock:
Lock the active user session in the guest operating system.
Arguments
| vmID | UUID | The UUID of the VM |
VM.desktopLogin:
Log a user into the guest operating system.
Arguments
| vmID | UUID | The UUID of the VM |
| domain | string | The Active Directory domain (if applicable) |
| username | string | The username to use |
| password | string | The password corresponding to username |
VM.desktopLogoff:
Logoff the active user of the guest operating system.
Arguments
| vmID | UUID | The UUID of the VM |
| force | boolean | Force the operation (unused) |
VM.desktopSendHcCommand:
Send an arbitrary command to the guest agent.
Arguments
| vmID | UUID | The UUID of the VM |
| message | string | The message to send |
VM.destroy:
Forcibly stop a running VM.
Arguments
| vmID | UUID | The UUID of the VM |
| gracefulAttempts | uint | number of times Vdsm should try to gracefully destroy the VM before to switch to forceful. Default is 1. |
VM.getExternalData:
Retrieve VM data stored outside the VM, typically in a local file system.
Arguments
| vmID | UUID | The UUID of the VM |
| kind | string | Which data is requested. The only currently supported data kinds are "tpm" and "nvram". |
| lastHash | string | The hash, if provided, is compared to the hash of the current data. If both hashes are the same, data is not returned. |
| forceUpdate | boolean | Whether to force data update before returning the data (true) or whether it's possible to use data recently retrieved by Vdsm without checking for an update. |
Returns
| [''] | VmDataMap | Return requested VM data and related information. |
VM.getInfo:
Get detailed information about a VM.
Arguments
| vmID | UUID | The UUID of the VM |
VM.getMigrationStatus:
Report virtual machine migration statistics.On going progress or statistics on done migration
Arguments
| vmID | UUID | The UUID of the VM |
Returns
| [''] | MigrationStats | Statistics on ongoing migration or done migration |
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 |
VM.hibernate:
Save the live state of the VM to disk and stop it.
VM.updateDevice:
Update the status of a VM's device.
VM.hotplugHostdev:
Add a new host device to a running VM.
Arguments
| vmID | UUID | The UUID of the VM |
| devices | string | List of device XMLs |
Returns
| [''] | string | List of hot plugged device XMLs |
VM.hotunplugHostdev:
Remove a host device from a running VM
Arguments
| vmID | UUID | The UUID of the VM |
| devices | string | List of device XMLs |
Returns
| [''] | string | List of device XMLs, indicating which devices were successfully hotunplugged. |
VM.hotplugNic:
Add a new network device to a running VM.
VM.hotunplugNic:
Remove a network device from a running VM.
VM.hotplugDisk:
Add a new disk device to a running VM.
VM.hotunplugDisk:
Remove a disk device from a running VM.
VM.hotplugLease:
Add a new lease device to a running VM.
VM.hotunplugLease:
Remove a lease device from a running VM.
VM.migrate:
Migrate a VM to a remote host.
VM.migrateCancel:
Cancel a currently outgoing migration process.
Arguments
| vmID | UUID | The UUID of the VM |
VM.migrateChangeParams:
Change parameters of an ongoing migration
VM.migrationCreate:
Start a migrating VM on a destination host.
Arguments
| vmID | UUID | The UUID of the VM |
| params | VmDefinition | The VM definition |
| incomingLimit | uint | The maxiumum number of incoming migrations that Vdsm should allow from now on. Must be > 0. |
VM.pause:
Pause the CPUs of a running VM.
Arguments
| vmID | UUID | The UUID of the VM |
VM.reset:
Reset a virtual machine.
Arguments
| vmID | UUID | The UUID of the VM |
VM.setTicket:
Set the password to be used to connect to a VM display.
Arguments
| vmID | UUID | The UUID of the VM |
| password | string | 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 |
VM.shutdown:
Request a graceful shutdown of a VM.
Arguments
| vmID | UUID | The UUID of the VM |
| delay | int | Wait a number of seconds before shutting down |
| message | string | Message to display to VM users before shutting down |
| reboot | boolean | True if reboot is desired, False for shutdown |
| timeout | int | Number of seconds to wait before trying next shutdown/reboot method. |
| force | boolean | True if shutdown/reboot desired by any means necessary (forceful reboot/shutdown if all graceful methods fail) Default is False (i.e. graceful only). |
VM.setDestroyOnReboot:
Set trap to shutdown VM on guest-initiated reboot.
Arguments
| vmID | UUID | The UUID of the VM |
VM.freeze:
Freeze mounted filesystems within the guest (hence guest agent may be required depending on hypervisor used).
Arguments
| vmID | UUID | The UUID of the VM |
VM.thaw:
Thaw mounted filesystems within the guest (hence guest agent may be required depending on hypervisor used).
Arguments
| vmID | UUID | The UUID of the VM |
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 | string | str representation of the volumes in which the memory dump and vm configuration should be saved |
| frozen | boolean | Boolean value set to true if the vm is frozen and does not need to be freezed during the snapshot. |
| jobUUID | UUID | Assign a UUID to this operation which can be used to identify it in VmStats |
| timeout | uint | Timeout in minutes for the snapshot operation |
| freeze_timeout | uint | Timeout in minutes for non-memory snapshot operation |
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 |
VM.diskReplicateStart:
Start the replication of a disk to a destination.
Arguments
| vmID | UUID | The UUID of the VM |
| srcDisk | DriveSpecVolume | A DriveSpecVolume structure representing the source disk |
| dstDisk | DriveSpecVolume | A DriveSpecVolume structure representing the destination disk |
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 representing the source disk |
| dstDisk | DriveSpecVolume | A DriveSpecVolume structure representing the destination disk |
VM.getDiskAlignment:
Check alignment of virtual machine disk partitions.
Arguments
| vmID | UUID | The UUID of the VM |
| disk | DriveSpecVolume | A DriveSpecVolume structure representing the disk |
VM.diskSizeExtend:
Extends the virtual size of a disk through the running VM.
Arguments
| vmID | UUID | The UUID of the VM |
| driveSpecs | DriveSpec | A DriveSpec structure representing the disk. Supported types are DriveSpecVolume and DriveSpecGuid. |
| newSize | string | The new desired size (in bytes). |
Returns
| [''] | string | The new size of the disk (might have been rounded) |
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 representing the disk |
| baseVolUUID | UUID | The UUID of the base volume |
| topVolUUID | UUID | The UUID of the top volume |
| bandwidth | int | Limit I/O for the merge (in MB/s) |
| jobUUID | UUID | Assign a UUID to this operation which can be used to identify it in VmStats |
VM.seal:
Run virt-sysprep on all disk images of the VM, erasing all machine-specific configuration from the filesystem.
Arguments
| vmID | UUID | The UUID of the VM |
| job_id | UUID | A UUID to be used for tracking the job progress |
| sp_id | UUID | The UUID of the Storage Pool |
| images | VolumeInfo | List of Images to be processed. Volume must always reference the leaf volume of the image. |
Volume.copy:
Deprecated. 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 | string | Set the destination Volume description Up to 210 bytes; longer values will be truncated |
| 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 | boolean | If force is set and dstVolUUID exists, zero the destination Volume before copying new data |
| force | boolean | If dstVolUUID already exists, overwrite it |
| discard | boolean | Discard the destination volume before copying new data |
Returns
| [''] | UUID | A task UUID |
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 | string | The Volume size in bytes (as string) |
| volFormat | VolumeFormat | The data format to use for the destination Volume |
| preallocate | VolumeAllocation | The Volume allocation mode |
| diskType | DiskContentType | An advisory disk usage type |
| desc | string | The Volume description Up to 210 bytes; longer values will be truncated |
| srcImgUUID | UUID | If specified, create a snapshot from this Image |
| srcVolUUID | UUID | If specified, create a snapshot from this Volume |
| initialSize | string | if specified, initial size of volume in bytes (as string). Allowed only when creating cow-sparse volume on block storage or when creating raw preallocated volume on file storage. |
| addBitmaps | boolean | if specified, instruct to add new empty bitmaps with the same names as they had in the source volume to the newly created volume. Allowed only when creating a snapshot from cow-sparse volume. Must not be used when a VM is running. In this case libvirt adds the bitmaps when creating a snapshot. |
| legal | boolean | Create legal volume that can be used by the system immediately. Set to false to create illegal volume that cannot be used by the system. To use the volume it must be set to legal. |
| sequence | int | The sequence number of the volume. Newer volume will have a higher number. |
| bitmap | UUID | If specified, create a new empty bitmap with the specified UUID. Allowed only when creating a snapshot or when creating a new volume in COW format. The new bitmap records the changes in the volume since the volume was created. |
Returns
| [''] | UUID | A task UUID |
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 | boolean | Zero Volume data before deletion |
| force | boolean | Remove even if VolumeRole is SHARED or INTERNAL |
| discard | boolean | Discard the volume before deletion |
Returns
| [''] | UUID | A task UUID |
Volume.verify_untrusted:
An untrusted volume is a volume that was in control of a user or untrusted external program, and may contain malicious data. One example is a volume uploaded by a user using ovirt-imageio. The verification includes comparing the untrusted volume's format with the format that is specified in the volume's metadata, and if the format is QCOW, verifying that it has no backingfile. If one of the verifications above fails, an ImageVerificationError will be returned.
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 |
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 | string | The new desired size (in bytes) |
Returns
| [''] | UUID | A task UUID |
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 |
Volume.measure:
Measure required allocation for copying source volume to destination volume.
Arguments
| volumeID | UUID | The UUID of the source volume |
| storagepoolID | UUID | The Storage Pool associated with the source volume |
| storagedomainID | UUID | The Storage Domain associated with the source volume |
| imageID | UUID | The Image associated with the source volume |
| dstVolFormat | VolumeFormat | The volume format to use for the destination volume |
| backing_chain | boolean | A flag indicating whether to measure a single volume or the entire chain. |
Volume.getQemuImageInfo:
Information returned from qemuimg info about a Volume. This verb must be called when the volume is prepared. The caller is responsible to prepare and teardown the 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 |
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 |
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 |
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 | string | A human-readable Volume description. Up to 210 bytes; longer values will be truncated |
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 |
Volume.teardown:
Teardown a volume. Called when a volume is detached from a prepared image during live merge flow. In this case, the volume will not be torn down when the image is torn down.
Arguments
| storagedomainID | UUID | The Storage Domain associated with the Volume. |
| imageID | UUID | The UUID of the image containing the Volume. |
| volumeID | UUID | The UUID of the Volume. |
VM.hotplugMemory:
Hotplug memory to a running VM NUMA node
VM.hotunplugMemory:
Hotunplug memory from a running VM
VM.setNumberOfCpus:
Set the number CPUs for a VM
Arguments
| vmID | UUID | The UUID of the VM |
| numberOfCpus | int | The new number of cpus |
| cpusets | string | A list of cpuset definitions (e.g. '1,3-5') for all CPUs. Items of the list correspond to vCPUs and, if specified, length of the list must match numberOfCpus. |
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 |
VM.getIoTune:
Sets the ioTune parameters for block devices
Arguments
| vmID | UUID | The UUID of the VM |
VM.getIoTunePolicy:
Gets the ioTune policy settings for block devices
Arguments
| vmID | UUID | The UUID of the VM |
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 |
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 |
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. |
SDM.copy_data:
Copy data from one volume to another.
Arguments
| job_id | UUID | A UUID to be used for tracking the job progress |
| source | CopyDataEndpoint | The source endpoint |
| destination | CopyDataEndpoint | The destination endpoint |
| copy_bitmaps | boolean | if specified, copy the bitmaps from the copied volume to the new volume. Allowed only when copying a single qcow2 volume to a qcow2 volume. |
SDM.sparsify_volume:
Perform an in-place sparsify (e.g. not creating a new image) on a given volume, removing unused space from the volume.
Arguments
| job_id | UUID | A UUID to be used for tracking the job progress |
| vol_info | CopyDataDIVEndpoint | Address of the Volume to be processed |
SDM.merge:
Merge data from top volume to base volume.
Arguments
| job_id | UUID | A UUID to be used for tracking the job progress |
| subchain_info | SubchainInfo | Subchain to merge |
| merge_bitmaps | boolean | if specified, merge the bitmaps from the removed volume to the base volume. Allowed only when merging into a cow-sparse volume. |
SDM.amend_volume:
Amend the volume with specific parameters described in the qcow2_attr.
Arguments
| job_id | UUID | A UUID to be used for tracking the job progress |
| vol_info | CopyDataDIVEndpoint | The volume to amend. |
| qcow2_attr | Qcow2Attributes | Possible QCOW2 attributes which are allowed to be changed in a volume using qcow2 format. |
SDM.move_domain_device:
Moves the data stored on a Storage Domain block device PV to other PVs that are part of the domain.
SDM.reduce_domain:
Reduces a device from a block Storage Domain, should be executed after the data has been moved from the device using SDM.move_domain_device
SDM.update_volume:
Update the volume with specific parameters described in the vol_attr. Each call increases the generation, unless it is specified in the attributes then the provided will be used.
Arguments
| job_id | UUID | A UUID to be used for tracking the job progress |
| vol_info | CopyDataDIVEndpoint | The volume to update. |
| vol_attr | VolumeAttributes | The possible attributes which are allowed to be changed in a volume. |
SDM.add_bitmap:
Add a bitmap to the volume for cold backup operation. Allowed only for a volume with qcow2 format, this volume must not be used by a VM or any other processes.
Arguments
| job_id | UUID | A UUID to be used for tracking the job progress |
| vol_info | CopyDataDIVEndpoint | The volume to add the bitmap to. |
| bitmap | string | The name of the bitmap that will be added to the volume. |
SDM.remove_bitmap:
Remove a bitmap from the volume for fixing manually backup chain. Allowed only for a volume with qcow2 format, this volume must not be used by a VM or any other processes.
Arguments
| job_id | UUID | A UUID to be used for tracking the job progress |
| vol_info | CopyDataDIVEndpoint | The volume to remove the bitmap from. |
| bitmap | string | The name of the bitmap that will be removed from the volume. |
SDM.clear_bitmaps:
Remove all the bitmaps from the volume. Allowed only for a volume with qcow2 format, this volume must not be used by a VM or any other processes.
Arguments
| job_id | UUID | A UUID to be used for tracking the job progress |
| vol_info | CopyDataDIVEndpoint | The volume to remove the bitmap from. |
NBD.start_server:
Start serving a volume using NBD protocol. Fail if the service was already running.
Arguments
| server_id | UUID | NBD server UUID for controlling the server. |
| config | NBDServerConfig | The server configuration. |
Returns
| [''] | string | NBD URL for accessing the server. |
NBD.stop_server:
Stop serving a volume. If the service is not running, the call will succeed.
Arguments
| server_id | UUID | server UUID. |
VM.start_backup:
Starts a backup for specified VM and selected disks of this VM.
Returns
| [''] | BackupInfo | Information about the started backup. |
VM.stop_backup:
Stops a backup with specified UUID.
Arguments
| vmID | UUID | A UUID of the VM |
| backup_id | UUID | A UUID of the backup |
VM.backup_info:
Returns VM backup info.
Arguments
| vmID | UUID | A UUID of the VM |
| backup_id | UUID | A UUID of the backup |
| checkpoint_id | UUID | A UUID of the checkpoint, must be the same value as to_checkpoint_id argument that was used for starting a backup (optional). |
Returns
| [''] | BackupInfo | Information about the backup identified by backup_id. |
VM.delete_checkpoints:
Deletes specified VM checkpoint ids.
Arguments
| vmID | UUID | A UUID of the VM |
| checkpoint_ids | string | List of checkpoints ids to delete, ordered from oldest to newest. |
VM.redefine_checkpoints:
Redefines VM checkpoints with specified list.
Arguments
| vmID | UUID | A UUID of the VM |
| checkpoints | Checkpoint | List of checkpoints ordered by creation order (from oldest to newest). Redefine fails if a checkpoint is missing on storage, or storage contains checkpoint not in this list. |
VM.list_checkpoints:
Returns a List of checkpoint ids defined on the VM.
Arguments
| vmID | UUID | A UUID of the VM |
Returns
| [''] | UUID | List of checkpoint ids ordered by creation order (from oldest to newest). |
VM.dump_checkpoint:
Returns VM backup checkpoint XML.
Arguments
| vmID | UUID | A UUID of the VM. |
| checkpoint_id | UUID | A UUID of the checkpoint. |
VM.refresh_disk:
Refresh VM drive volume. Reload LVM and update disk size on the host. Reload runs only on block based storage disks, on file based storage disks only disk size is refreshed. Should be run in case the disk size was changed on one host and this change should be visible on another host.
Arguments
| vmID | UUID | The UUID of the VM |
| drive | DriveSpecVolume | The specification (PDIV) of drive to be refreshed. |
VM.screenshot:
Returns a screenshot of the guest console
Arguments
| vmID | UUID | The UUID of the VM |
AutoNumaBalancingStatus:
An enumeration of the status of auto numa balancing function in kernel.
Values
| 0 | | Auto numa balancing is not active |
| 1 | | Auto numa balancing is active |
| 2 | | Can't get the status(maybe not support in this kernel version) |
BalloonInfo:
Guest memory balloon information. Values are present only when the balloon is enabled and ready.
Members
| balloon_cur | string | The current amount of memory available to the guest (in KiB) |
| balloon_max | string | The maximum amount of memory available to the guest (in KiB) |
| balloon_min | string | The minimum amount of memory guaranteed to the guest (in KiB) |
| balloon_target | string | The amount of memory requested (in KiB) |
| ballooning_enabled | boolean | Flag indicating whether ballooning is enabled or disabled for the VM. Even though we want to prevent certain VMs from ballooning the memory, we still want to keep the balloon device in such VMs because that's how we get memory statistics from the guest. |
BandwidthCurve:
Bandwidth traffic shaping curve parameters for Host networking QoS.
Members
| d | uint | Amount of microseconds the burst can be applied. |
| m1 | int | Burst rate in bits per second. |
| m2 | int | Average rate in bits per second. |
BandwidthParams:
Bandwidth traffic shape parameters for VM Interface device expressed as integers.
Members
| burst | uint | Amount of data that can be burst at peak speed in kB. |
| average | uint | Average bit rate of the interface being shaped in kB/sec. |
| peak | uint | Maximum rate at which interface can send data in kB/sec. |
BlockDeviceStatus:
Enumeration of possible status for a block device.
Values
| free | | The device is free |
| unknown | | The device status is unknown |
| used | | The device is in use. A device will be considered used on the following cases: - a PV exists on this device and is part of a VG - a partition table is found on the device - The device may have a mounted file system |
BlockDeviceType:
Enumeration of possible block device types.
Values
| FCP | | The device is purely FibreChannel |
| MIXED | | The device consists of a mix of iSCSI and FibreChannel paths |
| iSCSI | | The device is pure iSCSI |
BlockDevicePathState:
Enumeration of possible states for a block device path.
Values
| active | | The path is active |
| failed | | The path has failed |
DiskBackupMode:
Enumeration of possible backup modes for a disk.
Values
| full | | Full backup should be taken for the disk |
| incremental | | Incremental backup should be taken for the disk |
BlockDevicePathInfo:
Information about a single block device path.
Members
| lun | string | The SCSI Logical Unit Number associated with this path |
| capacity | string | The path size (in bytes) |
| type | BlockDeviceType | The type of path (BlockDeviceType) |
| state | BlockDevicePathState | The current state of this path |
| physdev | string | The physical device name |
IscsiSessionInfo:
Information about a single, active iSCSI session.
Members
| username | string | A login name on the iSCSI target |
| portal | string | The Target Portal Group Tag |
| iqn | string | The ISCSI Qualified Name |
| password | string | The password corresponding to username |
| port | string | The port number of the iSCSI target |
| connection | string | The hostname of the iSCSI target |
| initiatorname | string | iSCSI initiator |
UUID:
A universally unique identifier in RFC 4122 format.eg. "407cb255-34be-432c-be7c-eb43b8de82be"
Type
| UUID | string | A universally unique identifier in RFC 4122 format.eg. "407cb255-34be-432c-be7c-eb43b8de82be" |
BlockDeviceInfo:
Block device information.
Members
| pvsize | uint | The LVM physical volume size (in bytes) |
| status | BlockDeviceStatus | The device status (free/used/unknown) |
| capacity | uint | The device logical size (in bytes) |
| vendorID | string | A string identifying the device manufacturer |
| discard_max_bytes | ulong | The maximal number of bytes that can be trimmed or unmapped in a single discard operation. 0 means that the device does not support discard functionality. |
| discard_zeroes_data | uint | Deprecated by the kernel since version 4.12 (see https://patchwork.kernel.org/patch/9641263/). Always returns 0 for backward compatibility. |
| productID | string | A string identifying the device model |
| pvUUID | UUID | The LVM physical volume associated with this device |
| fwrev | string | Firmware version information |
| devtype | BlockDeviceType | The type of storage device (BlockDeviceType) |
| pathlist | IscsiSessionInfo | iSCSI session information |
| partitioned | boolean | Reports whether the device has been split into partitions |
| GUID | UUID | The globally unique identifier of the block device |
| logicalblocksize | uint | The logical block size of the device (in bytes) |
| physicalblocksize | uint | The physical block size of the device (in bytes) |
| serial | string | The device serial number (if available) |
| pathstatus | BlockDevicePathInfo | Multipath information |
BlockJobType:
An enumeration of block job types
Values
| commit | | A blockCommit operation (backward merge) |
| copy | | A blockCopy operation |
| pull | | A blockPull operation (forward merge) |
| unknown | | The block job type is not known or supported |
JobType:
An enumeration of job types
Values
| block | | A block job |
| unknown | | An unrecognized or unsupported job |
BlockJobInfo:
Information about a currently active block job.
Members
| imgUUID | UUID | The UUID of the image on which this job is operating |
| blockJobType | BlockJobType | The specific type of block operation underway |
| bandwidth | int | I/O limit in MB/s (zero means no limit) |
| jobType | JobType | The general job type (always block) |
| end | int | Indicates the value of cur that will signify job completion |
| id | UUID | An ID that was associated with the job when it was started |
| cur | int | Indicates progress of the job relative to end |
ConnectStorageServerStatus:
Status of a single storage server connection attempt.
Members
| id | UUID | Connection UUID |
| status | int | Status code |
IscsiConnectionParameters:
Parameters for initiating a new ISCSI connection.
Members
| tpgt | string | The Target Portal Group Tag to use |
| port | string | A port number |
| connection | string | A fully-qualified domain name (FQDN) or IP address |
| iqn | string | The ISCSI Qualified Name |
| user | string | The username used for authentication to an ISCI target |
| password | string | The password associated with the given username |
| id | UUID | A UUID that will be used to identify this connection in subsequent API calls. |
LocalFsConnectionParameters:
Parameters for initiating a connection to local storage.
Members
| path | string | The local filesystem path |
NfsConnectionParameters:
Parameters for initiating a new NFS connection.
Members
| timeout | int | The time to wait before retrying a request (specified in tenths of one second). |
| version | string | Set the NFS protocol version |
| export | string | The remote target in <host>:<path> format |
| retrans | int | The number of retry attempts for failing operations |
PosixFsConnectionParameters:
Parameters for initiating a new POSIX FS connection.
Members
| spec | string | A string identifying the location of the target filesystem |
| vfstype | string | The Linux VFS filesystem type |
| options | string | A comma-separated list of mount options |
ConnectionRefParameters:
A discriminated record of parameters used to establish a ConnectionRef.
CpuCoreStats:
Statistics about a cpu core.
Members
| cpuSys | string | Ratio of CPU time spent in kernel |
| cpuUser | string | Ratio of CPU time spent in userspace |
| nodeIndex | uint | Which numa node this cpu core belongs to |
| cpuIdle | string | Ratio of CPU time spent idle |
CpuCoreStatsMap:
A mapping of cpu core stats indexed by cpu core id.
DiskContentType:
Disk content type.
Values
| DATA | | This volume is for data (>=4.2) |
| OVFS | | This volume is OVF store (>=4.2) |
| MEMD | | This is a memory dump volume (>=4.2) |
| MEMM | | This is a memory metadata volume (>=4.2) |
| ISOF | | This is ISO volume (>=4.2) |
QemuImageFormat:
An enumeration of qemu image format.
Values
| raw | | The Volume writes raw data directly to the backing image |
| qcow2 | | The Volume uses the Qemu Qcow image format |
Qcow2Compat:
An enumeration of qcow compat version.
Values
| 0.1 | | qemu versions 0.10 which are supported by QCOW2 |
| 1.1 | | qemu versions starting with 1.1 which are supported by QCOW2 version 3. |
Qcow2Attributes:
Possible QCOW2 attributes which are allowed to be changed in a volume using qcow2 format.
Members
| compat | Qcow2Compat | The compat version for qcow volume. |
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 |
DeviceVisibilityMap:
A mapping of boolean values indexed by block device GUID.
DiskAlignmentMap:
A map of the disk alignment from partition name to whether it's aligned
StringMap:
A mapping between arbitrary strings.
StringListMap:
A mapping from string to a list of strings.
SupportedBlockSizeMap:
A mapping from storage domain type name to a list of supported block size.
DriveVmPayload:
Directly specified data to be inserted into a VM.
Members
| file | StringMap | A dictionary of file contents indexed by filename |
DrivePayload:
The detailed specification of the image contents
Members
| vmPayload | DriveVmPayload | Specifies data to be inserted into the VM Disk |
DriveSpecGUID:
A drive specification using a device mapper GUID.
Members
| GUID | string | The devmapper device GUID |
DriveSpecPath:
A drive specification using a filesystem path to an image file.
Members
| path | string | The full filesystem path to the image file |
VmDiskDeviceType:
An enumeration of VM disk device types.
Values
| cdrom | | A CD-ROM drive (always readonly) |
| disk | | A hard disk drive |
| floppy | | A floppy disk drive |
| lun | | A LUN device (required for LUN passthrough) |
DriveSpecPayload:
A drive specification that describes the exact image contents.
Members
| specParams | DrivePayload | Additional drive parameters (including the payload information) |
| device | VmDiskDeviceType | The type of disk device being created |
DriveSpecVolume:
A drive specification that refers to a Volume managed by Vdsm.
Members
| volumeID | UUID | The UUID of the target Volume |
| device | VmDiskDeviceType | The disk device type (should be disk) |
| poolID | UUID | The Storage Pool containing the Volume |
| domainID | UUID | The Storage Domain containing the Volume |
| imageID | UUID | The Image associated with the Volume |
DriveSpecCdrom:
A cdrom specification that allows directly indexing the cdrom. Kept for backward compatibility with older engines. Shouldn't be used. DriveSpecVolumeCdrom should be used instead.
Members
| path | string | The full filesystem path to the image file |
| iface | string | Bus that the cdrom resides on |
| index | int | Index on the iface used |
DriveSpecCdrom:
A cdrom specification that allows directly indexing the cdrom. CD is specified by PDIV. In the new code all images should be specified this way.
Members
| drive_spec | DriveSpecVolume | Image PDIV specification. |
| iface | string | Bus that the cdrom resides on. |
| index | int | Index on the iface used. |
DriveSpecCdrom:
A cdrom specification that allows directly indexing the cdrom. DriveSpecPathCdrom is kept for backward compatibility, current code should use only DriveSpecVolumeCdrom.
DriveSpec:
A discriminated record containing a VM drive specification
ErrorInfo:
Information about an error
Members
| code | int | An error code |
| message | string | A free-form description of the error |
VmExitCode:
An enumeration of final VM exit status codes.
Values
| ERROR | | The VM has terminated with errors |
| NORMAL | | The VM has exited gracefully |
VmExitReason:
An enumeration of VM exit reason, explaining why the VMhas gone down, either successfully on in error.
Values
| admin shutdown | | The VM was shut down by the admin from the engine UI |
| destroyed on startup | | VM destroyed during the startup |
| generic error | | Unspecified error code. |
| libvirt domain missing | | Failed to find the libvirt domain for the VM |
| libvirt start failed | | The VM failed to start through libvirt |
| lost qemu connection | | The VM has lost the connection with QEMU |
| migration failed | | The VM failed to migrate, and do not moved from the source host |
| migration succeeded | | The VM was successfully migrated |
| save state succeeded | | The VM state was successfully saved |
| success | | The VM has exited gracefully |
| user shutdown | | The VM was shut down by an user from within the guest |
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 |
| Powering up | | The VM is booting |
| 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 |
ExitedVmStats:
Statistics about a VM that no longer running.
Members
| exitMessage | string | Detailed reason for the virtual machine exit |
| exitCode | VmExitCode | Code indicating whether the VM exit was normal or in error |
| vmId | UUID | The UUID of the Vm |
| timeOffset | int | The time difference from host to the VM in seconds |
| status | VmStatus | The current VM status |
| exitReason | VmExitReason | The specific exit reason code |
ExternalDiskParams:
Disk information for importing external source
Members
| imageID | UUID | The UUID of the image that contains the volume |
| volumeID | UUID | The UUID of the volume |
ExternalDiskInfo:
Disk information from external source
Members
| dev | string | guest device name (sda, sdb, etc) |
| alias | string | device path (file path) |
| capacity | uint | logical size bytes |
| allocation | uint | current allocation bytes |
| type | string | device argument (disk, cdrom, lun) |
ExternalNetworkInfo:
Network information from external source
Members
| dev | string | network name |
| macAddr | string | phisical address |
| bridge | string | bridge name |
| type | string | network type (bridge, network) |
| model | string | interface model |
VolumeAllocation:
An enumeration of Volume allocation modes.
Values
| PREALLOCATED | | All necessary storage is allocated at Volume creation time |
| SPARSE | | Storage is allocated as needed |
ExternalVmParams:
map of VM properties to convert external source
Members
| disks | ExternalDiskParams | list of disk devices |
| vmName | string | The name of the VM |
| poolID | UUID | The UUID of the underlying Storage Pool object |
| domainID | UUID | The UUID of the storage domain that contains the volume |
| virtio_iso_path | string | Path to virtio drivers iso file |
| format | VolumeFormat | converted disk format (raw, cow etc) |
| qcow2_compat | string | set version of QCOW2 images (0.10, 1.1); ignored for KVM imports |
ExternalVmInfo:
map of VM properties
Members
| disks | ExternalDiskInfo | list of disk devices |
| allocation | VolumeAllocation | disk allocation type (sparse, preallocated) |
| memSize | uint | size of actual memory in MB |
| smp | uint | number of cpu |
| virtio_iso_path | string | path for iso contains virtio guest drivers |
| vmId | UUID | The VM uuid |
| vmName | string | The name of the VM |
| status | VmStatus | The current VM status |
| networks | ExternalNetworkInfo | list of network devices |
| format | VolumeFormat | converted disk format (raw, cow etc) |
| graphics | string | graphics supported by libvirt (spice, vnc etc) |
| video | string | video supported by libvirt (qxl, vga etc) |
| has_snapshots | boolean | Information on whether the VM has snapshots or not. |
FcHba:
Information about a FibreChannel host bus adapter.
Members
| model | string | Model of installed FibreChannel card |
| wwpn | string | World-wide port name |
| wwnn | string | World-wide node name |
ConnectorInfo:
Connector information. The data structure is according to os-brick output.
Members
| initiator | string | IQN initiator |
| ip | string | IP address of the host |
| platform | string | Hardware platform |
| os_type | string | The operating system type |
| do_local_attach | boolean | Describe if volume attachment is local (RBD only) |
| host | string | Host name |
| multipath | boolean | Describe if multipath is enabled |
ManagedVolumeConnection:
Managed Volume Connection information. The data structure is according to Cinder output.
Members
| driver_volume_type | string | The volume type (iscsi, fibre_channel, rbd) |
| data | StringMap | A map containing needed information about the volume. The specific options change according to the volume type. |
ManagedVolumeAttachement:
Attached managed volume information.
Members
| path | string | The local volume path (for example /dev/dm-25, /dev/sda, /dev/rbd1) |
| type | string | The volume type (for example block) |
| scsi_wwn | string | The WWN scsi ID of the volume (optional) |
| multipath_id | string | The multipath ID of the volume (optional) |
| conf | string | The Ceph local conf file path (optional) |
ManagedVolumeInformation:
Volume information after attachment.
Members
| exists | boolean | Indicate if the volume is attached to the host (path exists on the host) or not. Property is added only if volume was attached and has a path. |
| connection_info | ManagedVolumeConnection | Managed volume connection information provided by Cinderlib |
| path | string | The volume path to be used in the VM XML |
| attachment | ManagedVolumeAttachement | The attached volume information |
| vol_id | string | ID of the volume |
FenceNodeAction:
Specifies the type of fencing operation to perform.
Values
| off | | Shut down the remote host |
| on | | Turn on the remote host |
| reboot | | Reboot the remote host |
| status | | Just fetch the current power status |
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 |
FenceNodePowerStatusResult:
The host power status as a result of 'status' action.
Values
| off | | The remote host is powered off |
| on | | The remote host is powered on |
| unknown | | The power status is not known |
FenceNodeResult:
Result of fenceNode command.
HostIdMap:
A mapping of hostId indexed by domain UUID.
FencingPolicy:
Additional options for fenceNode logic.
Members
| storageDomainHostIdMap | HostIdMap | 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. |
| skipFencingIfGlusterBricksUp | boolean | A boolean value to indicate fence actions 'on', 'off' and 'reboot' should be skipped if there is any 'UP' brick from the host being fenced. Execution of 'status' action is unaffected by this value. |
| skipFencingIfGlusterQuorumNotMet | boolean | A boolean value to indicate fence actions 'on', 'off' and 'reboot' should be skipped if there is any 'UP' brick from the host being fenced and killing that brick will make the gluster volume to lose the quorum. Execution of 'status' action is unaffected by this value. |
| glusterServerUuid | UUID | Gluster Server UUID of the host being fenced |
GuestContainerInfo:
Information about a container defined in the guest Vm
Members
| id | string | Identifier of the container |
| names | string | List of given names/aliases for the container |
| image | string | Name of the image the container was started from |
| status | string | Status message for the container (e.g. uptime in case of Docker) |
| command | string | Executed command in the container |
GuestDiskMappingInfo:
disk mapping information indexed by property name.
Members
| name | string | device logical name within the guest. |
GuestDisksMappingMap:
guest disks mapping information indexed by serial.
GuestMemoryStats:
Memory statistics as reported by the guest agent.
Members
| mem_total | string | The total amount of memory available to the OS (in KiB) |
| mem_cached | string | The amount of pagecache used by the OS (in KiB) |
| mem_buffers | string | The amount of temporary raw disk block storage used by the OS (in KiB) |
| pageflt | uint | Average number of page faults per second |
| mem_free | string | The amount of memory available for allocation in KiB (includes easily reclaimable memory) |
| majflt | uint | Average number of major page faults per second |
| minflt | uint | Average number of minor page faults per second |
| mem_unused | string | The amount of memory that is completely unused (in KiB) |
| swap_out | uint | Average number of memory pages swapped out per second |
| swap_in | uint | Average number of memory pages swapped in per second |
GuestMountInfo:
Information about a mounted filesystem as reported by the guest agent.
Members
| used | uint | The amount of free space on the filesystem in bytes |
| path | string | The filesystem mount point |
| fs | string | The filesystem type |
| total | uint | The total amount of space on the filesystem in bytes |
GuestNetworkDeviceInfo:
Information about a VM network device as reported by the guest agent.
Members
| name | string | The network device name |
| inet | string | The IPv4 addresses |
| hw | string | The MAC address |
| inet6 | string | The IPv6 addresses |
GuestNumaNode:
Information about a guest numa node(also known as cell)
Members
| cpus | string | The guest cpu ids in this guest numa node. Refer to http://libvirt.org/formatdomain.html#elementsCPU for the format details. |
| nodeIndex | int | The index of the guest numa node |
| memory | int | The total memory of this guest numa node in MiB. |
GuestPCIDevice:
Infomation about PCI device and driver in the guest
Members
| device_id | int | PCI Device ID |
| driver_date | string | Creation date of the driver assigned to device |
| driver_name | string | Name of the driver assigned to device |
| driver_version | string | Version of the driver assigned to device |
| vendor_id | int | PCI Vendor ID |
GuestSessionState:
An enumeration of user session states.
Values
| Active | | The display has been unlocked |
| Locked | | The display is locked |
| LoggedOff | | A user has logged off |
| Unknown | | The session state is not known |
| UserLoggedOn | | A user has logged in |
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. |
HardwareInformation:
Host hardware fields.
Members
| systemProductName | string | Host's hardware module |
| systemUUID | string | Host's hardware UUID |
| systemManufacturer | string | Host manufacturer's name |
| systemVersion | string | Host's hardware version |
| systemFamily | string | Processor type |
| systemSerialNumber | string | Hardware serial number |
IscsiHba:
Information about an iSCSI host bus adapter.
Members
| InitiatorName | string | iSCSI initiator |
HbaInventory:
Information about all available host bus adapters.
Members
| FC | FcHba | List of FibreChannel HBAs |
| iSCSI | IscsiHba | List of iSCSI HBAs |
HibernationVolumeHandle:
Indicates where VM hibernation state and metadata should be stored.The format is:<domainUUID>,<poolUUID>,<stateImageUUID>, <stateVolumeUUID>,<metaImageUUID>,<metaVolumeUUID>
Type
| HibernationVolumeHandle | string | Indicates where VM hibernation state and metadata should be stored.The format is:<domainUUID>,<poolUUID>,<stateImageUUID>, <stateVolumeUUID>,<metaImageUUID>,<metaVolumeUUID> |
HookScriptInfo:
Information about one script within a hook.
Members
| checksum | string | The sha256 digest of the script |
HookScriptAdditional:
A mapping of hook script information
HookScriptInfoMap:
A mapping of hook script information indexed by script name.
HostBandwidthParams:
Host Bandwidth traffic shape parameters for Host networking QoS.
Members
| ul | BandwidthCurve | upper limit curve, puts an absolute cap to the traffic class traffic. |
| ls | BandwidthCurve | Link sharing curve, establishes a sharing proportion with other traffic classes over the same device. |
| rt | BandwidthCurve | Real time curve, can steal traffic from other curves to 'guarantee' a kind of minimum traffic. Use with caution. |
PCIAddress:
PCI address
Members
| domain | string | domain |
| bus | string | bus |
| slot | string | slot |
| function | string | function |
SCSIAddress:
SCSI address
Members
| host | string | host |
| bus | string | bus |
| target | string | target |
| lun | string | lun |
USBAddress:
USB address
Members
| bus | string | bus |
| device | string | device |
HostDeviceAddress:
A host device address
HostDeviceParams:
A host device parameters
Members
| capability | string | The capability of the device (usually pci, usb_device, scsi) |
| vendor | string | String representation of the vendor |
| vendor_id | string | Hexadecimal representation of the vendor |
| product | string | String representation of the product specified by vendor |
| parent | string | Name of the parent device |
| product_id | string | Hexadecimal representation of the product specified by vendor |
| is_assignable | string | Assignable flag |
| driver | string | Values like usbhid, usb, qxl or sd |
| interface | string | Network interface assigned to a device |
| udev_path | string | device udev path |
| block_path | string | device block path |
| address | HostDeviceAddress | device address |
| device_path | string | Device path |
| numa_node | string | NUMA node of the device |
| mode | string | Device mode |
| align_size | ulong | Device alignment in bytes |
| device_size | ulong | Size of the device in bytes |
HostDevice:
Assignment of the device to VM
HostDevices:
Mapping of device names to device details
HostJobStatus:
The execution state of a HostJob (string)
Values
| aborted | | The job was aborted by user request |
| done | | The job has finished successfully |
| failed | | The job has failed |
| pending | | The job is has not started yet |
| running | | The job is running |
HostJobType:
The type of a HostJob (string)
Values
| storage | | Storage job |
| v2v | | v2v job |
HostJobInfo:
A discriminated record providing information about a long-running operation on a host.
Members
| error | ErrorInfo | If the job has failed, information about the error |
| progress | uint | If the job can report progress in the current state, an integer (0-100) indicating the progress |
| id | UUID | The job UUID |
| status | HostJobStatus | The job status |
| description | string | A description of the job or the current status of the job (for debugging purposes) |
| job_type | HostJobType | The specific job type |
HostJobInfoMap:
A mapping of HostJobInfo records indexed by job UUID.
NetworkInterfaceState:
An enumeration of possible network interface states.
Values
| down | | The interface is not active |
| up | | The interface is active |
| unknown | | The interface state is unknown |
HostNetworkInterfaceStats:
Statistics about a single host network interface.
Members
| rxErrors | string | The number of incoming packets that have contained errors |
| name | string | The network device name |
| state | NetworkInterfaceState | Indicates whether the interface is currently active |
| rx | string | The number of incoming bytes in total |
| txDropped | string | The number of outgoing packets that have been dropped |
| txErrors | string | The number of outgoing packets that have contained errors |
| speed | string | The interface speed (in Megabits/s) |
| tx | string | The number of outgoing bytes in total |
| sampleTime | float | Time stamp of the sample |
| rxDropped | string | The number of incoming packets that have been dropped |
HostedEngineStatus:
Hosted Engine subsystem status, according to each host.
Members
| configured | boolean | Indicates if Hosted Engine is configured on this host |
| score | uint | Numeric host score |
| localMaintenance | boolean | Indicates if host is in local HA maintenance mode |
| globalMaintenance | boolean | Indicates if cluster is in global maintenance mode |
| active | boolean | Indicates if the HA agent is alive and updating data |
HostNetworkInterfaceStatsMap:
A mapping of host interface stats indexed by device name.
HostQoSParams:
Host networking QoS parameters. Outbound only for now
Members
| out | HostBandwidthParams | upper limit curve, puts an absolute cap to the traffic class traffic. |
DeviceQoSParams:
Device host networking QoS parameters.
Members
| hostQos | HostQoSParams | host traffic QoS params. |
| vlan | int | network vlan-id of the hostQos Params. |
NumaNodeHugePagesStats:
Statistics about the hugepages of a given size for a numa node
Members
| freePages | string | The number of free hugepages of a given size in a numa node |
NumaNodeHugePageStatsMap:
A mapping of hugepages statistics indexed by hugepages size in KiB
NumaNodeMemoryStats:
Statistics about the memory of a numa node.
Members
| memFree | string | The amount of free memory (in MB) |
| memPercent | uint | The ratio of used memory |
| hugepages | NumaNodeHugePageStatsMap | Hugepages statistics |
NumaNodeMemoryStatsMap:
A mapping of numa node memory stats indexed by node index.
MOMStatus:
An enumeration of possible MOM statuses.
Values
| active | | MOM is enabled and running |
| disabled | | MOM is not enabled on this host |
| inactive | | MOM has terminated |
PathStats:
Statistics about a host filesystem path.
Members
| free | string | The amount of free space remaining (in MB) |
PathStatsMap:
A mapping of filesystem statistics indexed by mount point.
StorageDomainVitals:
Regularly collected Storage Domain vital statistics.
Members
| acquired | boolean | Indicates if the lockspace on the Storage Domain has been acquired and therefore if it's possible to run (sanlock) protected VMs |
| actual | boolean | Indicates if the returned status is an actual monitoring result or initial result that means that the first monitor run was not yet completed |
| lastCheck | string | Elapsed time since the Storage Domain was last checked |
| valid | boolean | Indicates if the Storage Domain is functioning properly |
| code | int | Storage Domain status code |
| version | int | Indicates the Storage Domain version |
| delay | string | The amount of time it takes to read a small amount of data from the storage. |
StorageDomainVitalsMap:
A mapping of Storage Domain vital statistics indexed by Storage Domain UUID.
MultipathStatus:
Regularly collected multipath health status.
MultipathHealthMap:
A mapping of multipath status indexed by multipath device UUID.
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 |
V2VJobInfo:
Structure for current v2v jobs status
Members
| id | UUID | An ID that was associated with the job when it was started |
| status | string | Indicates jobs status (done, error, aborted, copying_disk, starting) |
| description | string | Description for the current status such as error or copying disk description. |
| progress | uint | Job progress between 0-100 |
V2VJobs:
A mapping of VM job information indexed by job UUID.
HostStats:
Statistics about this host.
Members
| cpuUserVdsmd | string | Ratio of CPU time spent in userspace by vdsm |
| swapTotal | int | The total amount of swap space (in MB) |
| incomingVmMigrations | uint | The number of VMs migrating to this host |
| cpuLoad | string | The 5 minute CPU load average |
| ksmPages | int | The number of memory pages KSM will scan at each interval |
| memUsed | string | The percentage of memory used |
| cpuIdle | string | Ratio of CPU time spent idle |
| haScore | int | The host score according to the HA agent, if installed |
| txDropped | string | The number of outgoing packets dropped |
| ksmState | boolean | Indicates if KSM is enabled or disabled |
| elapsedTime | string | The number of seconds that vdsm has been running |
| netConfigDirty | string | Indicates if there are uncommitted changes to the network configuration |
| vmActive | int | The number of VMs active on this host |
| vmMigrating | int | The number of VMs migrating to or from this host |
| network | HostNetworkInterfaceStatsMap | Per-interface network statistics |
| outgoingVmMigrations | uint | The number of VMs migrating away from this host |
| cpuSys | string | Ratio of CPU time spent in kernel |
| dateTime | string | The current date and time according to this host |
| cpuStatistics | CpuCoreStatsMap | Statistics about each cpu core |
| swapFree | int | The amount of free swap space remaining (in MB) |
| cpuUser | string | Ratio of CPU time spent in userspace |
| ksmCpu | uint | The amount of CPU being used by the KSM thread |
| numaNodeMemFree | NumaNodeMemoryStatsMap | Statistics about the memory of numa nodes |
| momStatus | MOMStatus | The current status of the MOM policy engine |
| 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) |
| storageDomains | StorageDomainVitalsMap | Storage Domain vital statistics |
| vmCount | int | The number of VMs present on this host |
| diskStats | PathStatsMap | Statistics about paths on the host filesystem |
| cpuSysVdsmd | string | Ratio of CPU time spent in kernel by vdsm |
| haStats | HostedEngineStatus | The current status of the Hosted Engine HA system |
| v2vJobs | V2VJobs | Current v2v jobs that running/ended on current host |
| bootTime | string | The boot time of the system in seconds since epoch |
| thpState | THPStates | Current mode of the Transparent Huge Pages feature |
| rxDropped | string | The number of incoming packets dropped |
| anonHugePages | string | The amount of anonymous memory in huge pages (in MB) |
| ksmMergeAcrossNodes | boolean | Indicates whether ksm merge is enabled |
| multipathHealth | MultipathHealthMap | Multipath status for devices with failed paths. If this map is empty, all multipath devices are healthy. |
VmDiskDeviceFormat:
An enumeration of VM disk device formats.
Values
| cow | | Data is written using the Qemu qcow format |
| raw | | Raw data is written directly to backing storage |
NetworkDiskHostInfo:
Map of network disk host information
Members
| name | string | IP address or DNS name |
| transport | string | Transport protocol |
| port | string | Port number |
VmDiskDeviceInterface:
An enumeration of VM disk device interfaces.
Values
| fdc | | The device is connected to an emulated floppy disk controller |
| 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 |
VmDiskDeviceIoTuneParams:
I/O tune parameters for the VM disk device.
Members
| total_bytes_sec | uint | Total throughput limit in bytes per second. Value 0 means unlimited. |
| read_bytes_sec | uint | Read throughput limit in bytes per second. Value 0 means unlimited. |
| write_bytes_sec | uint | Write throughput limit in bytes per second. Value 0 means unlimited. |
| total_iops_sec | uint | Total I/O operations limit per second. Value 0 means unlimited. |
| read_iops_sec | uint | Read I/O operations limit per second. Value 0 means unlimited. |
| write_iops_sec | uint | Write I/O operations limit per second. Value 0 means unlimited. |
VmDiskDeviceSpecParams:
Extra parameters for VM disk devices.
Members
| path | string | The filesystem path to the disk image |
| ioTune | VmDiskDeviceIoTuneParams | Additional IO tune parameters |
| pinToIoThread | uint | pin this device to a specific IO Thread |
VmDiskDeviceVolumeChainEntry:
Identifies one volume in a VM disk device volume chain.
Members
| path | string | The filesystem path to the volume |
| imageID | UUID | The UUID of the image that contains the volume |
| domainID | UUID | The UUID of the storage domain that contains the volume |
| volumeID | UUID | The UUID of the volume itself |
SharedDriveType:
Specifies the share policy for a VM disk drive.
Values
| exclusive | | The disk is used exclusively by this VM |
| none | | Same as exclusive but no locking mechanism is used |
| shared | | The disk is shared between multiple VMs |
VmSharedDriveType:
Specifies the share policy for a VM disk drive.
VmDeviceAddressType:
An enumeration of VM device address types.
Values
| drive | | The address describes a location on an IDE bus |
| pci | | The address describes a location on an PCI bus |
| virtio-serial | | Describes a location on a virtio-serial controller |
VmDevicePciAddress:
Device address for a PCI device.
Members
| slot | uint | The slot number on the PCI bus |
| domain | uint | The PCI domain |
| bus | uint | The PCI bus number |
| addressType | VmDeviceAddressType | The device address type (always pci) |
| function | uint | Function number on the PCI card that implements the device |
VmDeviceIdeAddress:
Device address for an IDE device.
Members
| unit | uint | The unit number on the IDE bus |
| controller | uint | The IDE controller number |
| bus | uint | The IDE bus number |
| addressType | VmDeviceAddressType | The device address type (always drive) |
VmDeviceVirtioSerialAddress:
Device address for a virtio-serial port.
Members
| controller | uint | The virtio-serial controller number |
| port | uint | The port number on the virtio-serial bus |
| bus | uint | The virtio-serial bus number |
| addressType | VmDeviceAddressType | The device address type (always virtio-serial) |
VmDeviceAddress:
A discriminated record of device address information.
NetworkDiskAuthInfo:
Authentication credentials needed to access a network disk
Members
| username | string | Identifies the username |
| type | string | Libvirt secret object type |
| uuid | UUID | Libvirt secret object uuid |
VmDeviceType:
An enumeration of VM device types.
Values
| balloon | | A memory balloon device |
| channel | | A host-guest communication channel |
| console | | A console device |
| controller | | An internal controller that usually provides a bus |
| disk | | A hard disk, floppy, or cdrom device |
| graphics | | The graphics device |
| hostdev | | A host device |
| interface | | A network interface |
| memory | | A memory device |
| rng | | A rng device |
| tpm | | A TPM device |
| smartcard | | A smartcard device |
| sound | | A sound card or PC speaker |
| video | | A video card |
| lease | | A lease device |
VmDiskDevice:
Properties of a VM disk device.
Members
| readonly | boolean | Indicates if writes are prohibited for the device |
| apparentsize | uint | The size of the disk (in bytes) |
| volumeID | UUID | The UUID of the underlying Volume object |
| index | int | The drive index |
| path | string | The filesystem path to the drive's volume |
| hosts | NetworkDiskHostInfo | List of network disk host info objects. At least one host is required if diskType is set to "network" |
| volumeChain | VmDiskDeviceVolumeChainEntry | The sequence of Volume objects needed to construct the disk |
| device | VmDiskDeviceType | The disk device type (eg. cdrom or disk) |
| diskType | string | Disk type name. Currently only the "network" type is supported |
| bootOrder | uint | If specified, this device is part of the boot sequence at the specified position |
| format | VmDiskDeviceFormat | The format used to store data on the backing storage |
| truesize | uint | The amount of underlying storage allocated (in bytes) |
| iface | VmDiskDeviceInterface | Indicates the device connection method exposed to the guest |
| protocol | string | Network disk protocol. Required if diskType is set to "network" |
| propagateErrors | boolean | If enabled, disk I/O errors will be reported to vdsm for possible resolution (eg. allocating more space) |
| specParams | VmDiskDeviceSpecParams | Additional device parameters |
| alias | string | Alias used to identify this device in commands |
| shared | VmSharedDriveType | Indicates if this disk is intended to be shared by multiple virtual machines |
| optional | boolean | States if the VM may start if the disk is not present |
| baseVolumeID | UUID | When used as a parameter to VM.merge, indicates the Volume that should become the new base volume |
| name | string | A user-friendly device name for display only |
| address | VmDeviceAddress | Device hardware address |
| imageID | UUID | The UUID of the underlying Image object |
| poolID | UUID | The UUID of the underlying Storage Pool object |
| deviceId | UUID | A unique ID for this device |
| deviceType | VmDeviceType | The device type (always disk) |
| domainID | UUID | The UUID of the underlying Storage Domain object |
| auth | NetworkDiskAuthInfo | Network disk auth info |
HotplugDiskParams:
Parameters for VM.hotplugDisk.
Members
| vmId | UUID | The UUID of the VM to modify |
| drive | VmDiskDevice | The disk device specification |
| xml | string | XML snippet containing <devices> element with exactly one device. <metadata> element may be optionally present, providing device metadata. Used in hot plugs and hot unplugs. |
VmLeaseDevice:
Properties of a VM lease device.
Members
| type | VmDeviceType | The device type ("lease") |
| sd_id | UUID | The storage domain id where this lease is stored |
| lease_id | UUID | The unique id of this lease |
VmMemoryDeviceType:
An enumeration of VM memory device types.
Values
| memory | | A memory device |
VmMemoryDevice:
Properties of a VM memory device
Members
| size | uint | The memory size to hotplug |
| node | uint | The NUMA node to use for hotplug |
| device | VmMemoryDeviceType | The type of the memory device |
| deviceId | UUID | A unique ID for this device |
| deviceType | VmDeviceType | The device type (always memory) |
| alias | string | Alias used to identify this device in commands |
| address | VmDeviceAddress | Device hardware address |
HotplugMemoryParams:
Parameters for VM.hotplugMemory.
Members
| vmId | UUID | The UUID of the VM to modify |
| memGuaranteedSize | uint | The amount of memory guaranteed to the VM in MB |
| memory | VmMemoryDevice | The memory device specification |
| xml | string | XML snippet containing <devices> element with exactly one memory device. |
VmInterfaceDeviceSpecParams:
Additional VM interface device parameters.
Members
| outbound | BandwidthParams | Bandwidth parameters for shaping outgoing traffic. |
| inbound | BandwidthParams | Bandwidth parameters for shaping incoming traffic. |
VmInterfaceDeviceType:
An enumeration of VM network device types.
Values
| bridge | | The device is connected via a host bridge device |
VmInterfaceDeviceModel:
An enumeration of VM network device models.
Values
| e1000 | | Emulated Intel(R) Gigabit Ethernet NIC |
| e1000e | | Emulated PCIe Intel(R) Gigabit Ethernet NIC |
| i82551 | | Emulated Intel(R) 82551ER NIC |
| i82557b | | Emulated Intel i82557B NIC |
| i82559er | | Emulated Intel i82559ER NIC |
| ne2k_pci | | Emulated Realtek(R) PCI NIC |
| pcnet | | Emulated AMD(R) PC-Net II NIC |
| pv | | Alias for virtio |
| rtl8139 | | Emulated rtl8139 NIC |
| virtio | | Paravirtual network interface |
VmInterfaceDeviceFilterParameters:
The tuple of the name and the value of a network filter parameter.
Members
| name | string | The name of the parameter |
| value | string | The value of the parameter |
VmInterfaceDevice:
Properties of a VM network interface device.
Members
| specParams | VmInterfaceDeviceSpecParams | Additional device parameters |
| address | VmDeviceAddress | Device hardware address |
| alias | string | Alias used to identify this device in commands |
| custom | StringMap | A dictionary of custom, free-form properties for device. |
| nicModel | VmInterfaceDeviceModel | The type of device that is exposed to the VM operating system |
| macAddr | string | The unique ethernet hardware address of the device |
| device | VmInterfaceDeviceType | The host network device type used to create the connection |
| linkActive | boolean | Whether the VM network card has its link active (up) or not (down). If omitted, the link will be active |
| portMirroring | string | If present, indicates the traffic of which networks should be mirrored to the interface. |
| deviceId | UUID | A unique ID for this device |
| deviceType | VmDeviceType | The device type (always interface) |
| bootOrder | uint | If specified, this device is part of the boot sequence at the specified position |
| network | string | The name of the attached host bridge device |
| filter | string | The name of the referenced network filter |
| filterParameters | VmInterfaceDeviceFilterParameters | The list of parameters of the network filter. Applicable only if 'filter' is supplied. |
HotplugNicParams:
Parameters for VM.hotplugNic.
Members
| vmId | UUID | The UUID of the VM to modify |
| nic | VmInterfaceDevice | The network device specification |
| xml | string | XML snippet containing <devices> element with exactly one device. <metadata> element may be optionally present, providing device metadata. Used in hot plugs and hot unplugs. |
PreparedImageInfo:
Information about a prepared image
Members
| path | string | The image path |
ImageMoveOperation:
An enumeration of Image move operations.
Values
| COPY | | The Image is copied to the destination |
| MOVE | | The Image is copied to the destination and removed from the source |
| UNKNOWN | | This operation is invalid |
ImagePostZeroMap:
A mapping of postZero selectors indexed by Image UUID.
ImageSharingMethodArgsHttp:
Specific arguments used to to share (upload/download) an image using http.
Members
| headers | StringMap | Additional http headers to be used in the request |
| url | string | Url where upload or download the image |
ImageSharingMethod:
Specifies the method used to share (upload/download) an image.
Values
| http | | Upload or download an image using http |
ImageSharingMethodArgs:
A discriminated record to store the arguments used by the sharing method.
ImageTicketOps:
An enumeration of operation types allowed by an image ticket
Values
| read | | permission to read data from image |
| write | | permission to write data to image |
ImageTicket:
Information about an image ticket.
Members
| size | uint | Maximum size (in bytes) that can be written or read from the image. |
| url | string | The image url, e.g. "file:///path/to/image" |
| timeout | uint | Timeout in seconds for the ticket to expire |
| uuid | UUID | A ticket UUID |
| ops | ImageTicketOps | operations allowed by this ticket |
| filename | string | If set, it will be used as the filename attribute of the content-disposition header when downloading an image. When downloading using a browser, this is typically the download filename. |
TicketInfo:
Information about an existing image ticket.
Members
| size | uint | The ticket size. |
| url | string | The image url, e.g. "file:///path/to/image". |
| timeout | int | The up to date time that is left for the ticket to expire in seconds. A negative value means that the ticket has already expired. |
| uuid | UUID | The ticket UUID. |
| ops | ImageTicketOps | Allowed operations for this ticket. |
| filename | string | The filename value that was set when creating the ticket. |
| active | boolean | States whether the ticket has at least one active upload/download session. |
| transferred | uint | The amount of bytes that were transferred using this ticket so far. |
KsmTuneParams:
Parameters for controling KSM.
Members
| sleep_millisecs | int | The wait time between page scans. |
| run | int | The action: 0 nothing, 1 merge pages, 2 unmerge pages. |
| pages_to_scan | int | The amount of pages to scan during one cycle. |
| merge_across_nodes | int | |
LoggingLevel:
An enumeration of logging verbosity levels.
Values
| CRITICAL | | Log only critical messages |
| CRIT | | An alias to CRITICAL |
| DEBUG | | Log everything (including debugging messages) |
| ERROR | | Log error messages and anything more severe |
| INFO | | Log informational messages and anything more severe |
| WARNING | | Log warning messages and anything more severe |
| WARN | | An alias to WARNING |
Tlv:
LLDP Information
Lldp:
LLDP Information
LldpMap:
A mapping from interface name to LLDP information
MigrateMethod:
An enumeration of VM migration methods.
Values
| online | | Migrate while the VM continues to run |
MigrateMode:
An enumeration of VM migration modes.
Values
| file | | Save the VM state to storage |
| remote | | Migrate to a remote host |
ConvergenceAction:
Description of one action which has to be executed.
Members
| params | string | List of parameters of the action |
| name | string | The name of the action (e.g. abort, setDowntime, postcopy) |
ConvergenceItem:
A convergence action which will be executed when the migration is stalling longer than the first argument.
Members
| action | ConvergenceAction | The specific action which has to be executed. |
| limit | int | If the migration is stalling for this amount of time, execute the action. |
ConvergenceSchedule:
Map of actions which will be executed before migration starts and list of actions which will be executed as a reaction to stalling.
MigrateParams:
Parameters for VM.migrate.
Members
| mode | MigrateMode | The migration mode. Callers of this API should use remote. For file migration use VM.hibernate. |
| dst | string | The destination host in <host>[:<port>] format. The port is optional and should usually be omitted. |
| autoConverge | boolean | Force convergence during live migration. |
| maxBandwidth | int | maximal bandwidth used by the migration (MiB/s) |
| parallel | uint | The number of parallel migration connections to use. If unspecified or 0, parallel connections are not used. |
| vmId | UUID | The UUID of the virtual machine to migrate |
| compressed | boolean | Compress repeated pages during live migration. |
| consoleAddress | string | The destination host graphics address in format: hostname[:port]/[?tlsPort] port and tlsPort are optional. |
| dstparams | string | Used only by the hibernate API. Ignored for remote migration |
| dstqemu | string | The destination's host address dedicated for migration. |
| tunneled | boolean | use libvirt's tunneled migration. default it False. |
| encrypted | boolean | whether to use TLS migration |
| convergenceSchedule | ConvergenceSchedule | initial actions and actions to perform when stalling |
| method | MigrateMethod | |
| abortOnError | boolean | Abort migration on I/O errors and refuse to migrate VMs, paused due to EIO |
| enableGuestEvents | boolean | whether or not to send migration/hibernation events to the guest operating systems |
| outgoingLimit | uint | maximum number of outgoing migrations. Must be > 0. |
| incomingLimit | uint | maximum number of incoming migrations. Must be > 0. |
| cpusets | string | A list of cpuset definitions (e.g. '1,3-5') for all CPUs. Items of the list correspond to vCPUs and, if specified, length of the list must match number of vCPUs. |
MigrationStatus:
An enumeration of VM migration status.
Values
| done | | Migration completed |
| in_progress | | Migration in progress |
MigratedStats:
Statistics about the last completed migration of a VM
Members
| vmId | UUID | The UUID of the Vm |
| status | MigrationStatus | The current migration status of a VM |
| downtime | uint | The downtime the VM experienced |
MigratingStats:
Statistics about the current ongoing migration of a VM
Members
| vmId | UUID | The UUID of the Vm |
| status | MigrationStatus | The current migration status of a VM |
| progress | uint | The migration percentage progress |
VmDisplayType:
An enumeration of VM display modes.
Values
| qxl | | Graphical VM interaction is available via SPICE |
| vnc | | Graphical VM interaction is available via the VNC protocol |
VmVideoDeviceSpecParams:
Additional parameters for VM video devices.
Members
| ram | uint | size of the primary bar for qxl in KB, rejected by libvirt for 'cirrus' or 'vga' |
| vgamem | uint | framebuffer size for qxl in KB, rejected by libvirt for 'cirrus' or 'vga' |
| vram | uint | value of virtual ram in KB, for 'cirrus' the default is '9216' for qxl is the size of the secondary bar, |
| heads | uint | Specify the amount of monitors that will use single pci device. Currently relevant for qxl devices only |
VmVideoDeviceType:
An enumeration of VM video device types.
Values
| cirrus | | An emulated Cirrus Logic GD5446 video card |
| none | | No video device is emulated |
| qxl | | A paravirtualized video device meant for use with SPICE |
| std | | An emulated standard VESA 2.0 VBE video card |
| vmware | | A paravirtualized VGA video device from VMWare(R) |
VmVideoDevice:
Properties of a VM video device.
VmSoundDeviceSpecParams:
Additional parameters for VM sound devices.
VmSoundDeviceType:
An enumeration of VM sound device types.
Values
| ac97 | | An emulated Intel 82801AA AC97 Audio card |
| es1370 | | An emulated ENSONIQ AudioPCI ES1370 card |
| hda | | An emulated Intel High-Definition Audio card |
| ich6 | | An emulated Intel ICH6 card |
| pcspk | | An emulated PC speaker |
| sb16 | | An emulated Creative Labs Sound Blaster 16 card |
VmSoundDevice:
Properties of a VM sound device.
VmControllerDeviceType:
An enumeration of VM controller device types.
Values
| ccid | | A ccid (smart card) controller |
| fdc | | A floppy disk controller |
| ide | | An IDE controller |
| sata | | A Serial ATA controller |
| scsi | | A SCSI controller |
| usb | | A USB controller |
| virtio-serial | | A virtio-serial controller |
VmControllerDevice:
Properties of a VM controller device.
Members
| device | VmControllerDeviceType | The specific type of controller device |
| model | string | The controller device model in use |
| deviceId | UUID | A unique ID for this device |
| deviceType | VmDeviceType | The device type (always controller) |
| alias | string | Alias used to identify this device in commands |
| address | VmDeviceAddress | Device hardware address |
VmBalloonDeviceModel:
An enumeration of VM balloon device models.
Values
| none | | Indicates that no device is present |
| virtio | | A balloon implemented using the virtio specification |
VmBalloonDeviceSpecParams:
Additional parameters for VM balloon devices.
VmBalloonDeviceType:
An enumeration of VM balloon device types.
Values
| memballoon | | A memory balloon |
VmBalloonDevice:
Properties of a VM balloon device.
VmChannelDeviceType:
An enumeration of VM channel device types.
Values
| spicevmc | | This channel is used for SPICE communication |
| unix | | The host end of the channel is a unix socket |
| virtio-serial | | This channel supports a virtio-serial connection |
VmChannelDevice:
Properties of a VM channel device.
Members
| deviceId | UUID | A unique ID for this device |
| device | VmChannelDeviceType | The specific type of channel device |
| alias | string | Alias used to identify this device in commands |
| deviceType | VmDeviceType | The device type (always channel) |
| address | VmDeviceAddress | Device hardware address |
VmWatchdogDeviceAction:
An enumeration of VM watchdog device actions.
Values
| dump | | automatically dump the guest |
| none | | do nothing |
| pause | | pause the guest |
| poweroff | | forcefully power off the guest |
| reset | | default, forcefully reset the guest |
| shutdown | | gracefully shutdown the guest (not recommended) |
VmWatchdogDeviceModel:
An enumeration of VM watchdog device models.
Values
| IB700 | | emulating an ISA iBase IB700 as watchdog |
| i6300esb | | the recommended device, emulating a PCI Intel 6300ESB |
VmWatchdogDeviceSpecParams:
Additional parameters for VM watchdog devices.
VmWatchdogDeviceType:
An enumeration of VM watchdog device types.
Values
| watchdog | | Device type watchdog |
VmWatchdogDevice:
Properties of a VM watchdog device.
VmConsoleDeviceType:
Type of console to be used
Values
| serial | | Configures a serial port console device and adds a serial port controller device |
| virtio | | Configures a virtio console device |
VmConsoleDeviceSpecParams:
Additional console device parameters
Members
| enableSocket | boolean | if enabled, export console endpoint as UNIX domain socket instead of pty. |
| consoleType | VmConsoleDeviceType | Type of console to be configured for the VM |
VmConsoleDevice:
Properties of a VM console device.
VmSmartcardDeviceMode:
An enumeration of VM smartcard device modes.
Values
| host | | Direct request to host |
| passthrough | | Third party provider (requires spicevmc) |
VmSmartcardDeviceProtocol:
An enumeration of VM smartcard device protocols.
Values
| spicevmc | | Use smartcard channel of SPICE |
VmSmartcardDeviceSpecParams:
Additional VM smartcard device parameters.
VmSmartcardDeviceType:
An enumeration of VM smartcard device types.
Values
| smartcard | | A smartcard |
VmSmartcardDevice:
Properties of a VM smartcard device.
VmGraphicsDeviceSpecParams:
Additional parameters for VM graphics devices.
Members
| keyMap | string | The keyboard layout string (eg. 'en-us') |
| displayNetwork | string | Address of the display network |
| spiceSecureChannels | string | Secure space channels, comma separated |
| copyPasteEnable | boolean | Specify if copy and paste is enabled. Currently relevant for spice devices only. |
| fileTransferEnable | boolean | Specify if file transfer is enabled. Currently relevant for qxl devices only. |
VmGraphicsDeviceType:
An enumeration of VM graphics device types.
Values
| spice | | SPICE graphics device |
| vnc | | VNC graphics device |
VmGraphicsDevice:
Properties of a VM graphics device.
VmHostDeviceSpecParams:
Additional VM host device parameters.
Members
| iommuPlaceholder | boolean | Flag identifying that the device should not be passed through, but needs to be detached and reattached in order not to violate IOMMU group restrictions. |
VmHostDevice:
Properties of a VM host device.
Members
| specParams | VmHostDeviceSpecParams | Additional device parameters |
| device | string | Libvirt identifier of the device (such as pci_0000_10_0_1) |
| deviceType | VmDeviceType | The device type (always hostdev) |
| deviceId | UUID | A unique ID for this device |
| address | VmDeviceAddress | Device hardware address as seen from the guest. If not specified, this field will be populated by libvirt generated address. |
| alias | string | Alias used to identify this device in commands |
| bootOrder | int | If specified, this device is part of the boot sequence at the specified position |
VmRngDeviceSource:
An enumeration of VM rng device models
Values
| hwrng | | Host hardware entropy source |
| random | | Host standard software+hardware based /dev/random |
VmRngDeviceSpecParams:
An enumeration of VM rng device models
Members
| bytes | int | Maximum number of bytes consumed per period |
| source | VmRngDeviceSource | Entropy source |
| period | int | Required if bytes are set Limits the rate of entropy consumption from source |
VmRngDeviceModel:
An enumeration of VM rng device models
Values
| virtio | | supported by qemu and virtio-rng kernel module |
VmRngDeviceType:
An enumeration of VM rng device types
Values
| virtio | | supported by qemu and virtio-rng kernel module |
VmRngDevice:
Properties of a VM rng device.
VmTpmDeviceModel:
An enumeration of VM tpm device modes.
Values
| tpm-tis | | TPM Interface Standard |
VmTpmDeviceMode:
An enumeration of VM tpm device types.
Values
| passthrough | | use hosts TPM |
VmTpmDeviceSpecParams:
Additional VM tpm device parameters.
VmTpmDeviceType:
An enumeration of VM tpm device types.
VmTpmDevice:
Properties of a VM tpm device.
VmDevice:
A discriminated record containing VM device properties.
VmType:
Enumeration of supported virtual machine types.
Values
| kvm | | VM runs on Linux Kernel Virtual Machine |
VmDefinition:
Full virtual machine status and properties.
Members
| hypervEnable | boolean | Enables hyperv specific optimizations for the Guest OS |
| display | VmDisplayType | The type of display |
| custom | StringMap | A dictionary of custom, free-form properties |
| memSize | uint | The amount of memory assigned to the VM in MB |
| smp | uint | The number of CPUs presented to the VM |
| maxMemSlots | uint | Maximum number of memory slots available This is the upper boundary for hot plug memory action, if not specified, defaults to 16 |
| devices | VmDevice | An array of VM devices present |
| fileTransferEnable | boolean | Specify if file transfer is enabled. Currently relevant for qxl devices only. |
| emulatedMachine | string | The machine specification being emulated |
| kvmEnable | boolean | Indicates if KVM hardware acceleration is enabled |
| transparentHugePages | boolean | Indicates if the Transparent Huge Pages feature is enabled for this virtual machine |
| vmName | string | The VM name |
| numOfIoThreads | uint | The num of iothreads qemu allocates |
| timeOffset | uint | The time difference from host to the VM in seconds |
| displayPort | int | The port in use for unencrypted display data |
| nice | int | The host scheduling priority |
| pid | uint | The process ID of the underlying qemu process |
| pauseCode | string | Indicates the reason a VM has been paused |
| cpuShares | string | The host scheduling priority (relative to other VMs). In case both cpuShares and nice are present, cpuShares will be used. |
| acpiEnable | boolean | Indicates if ACPI is enabled inside the VM |
| displaySecurePort | int | The port in use for encrypted display data |
| maxMemSize | uint | The maximum amount of memory that can be assigned to the VM in MB |
| clientIp | string | The IP address of the client connected to the display |
| smpThreadsPerCore | uint | Indicates the number of CPU threads per core |
| keyboardLayout | string | The keyboard layout string (eg. 'en-us') |
| vmId | UUID | The VM UUID |
| smpCoresPerSocket | uint | Indicates the number of CPU cores per socket |
| maxVCpus | uint | Maximum number of CPU available for the guest It is the upper boundry for hot plug CPU action |
| cpuType | string | The type of CPU being emulated special values 'hostPassthrough' and 'hostModel' are reserved for host-passthrough and host-mode cpu mode |
| displayIp | string | The IP address to use for accessing the VM display |
| exitMessage | string | Explains the reason that the VM process has exited |
| memGuaranteedSize | uint | The amount of memory guaranteed to the VM in MB |
| serial | string | Serial number for the VM. |
| copyPasteEnable | boolean | Specify if copy and paste is enabled. Currently relevant for qxl devices only. |
| exitCode | int | The exit code f the VM process has ended |
| status | VmStatus | The current VM status |
| vmType | VmType | The type of VM |
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 |
MigrationParameters:
Parameters for VM.migrateChangeParams
Members
| maxBandwidth | int | the new bandwidth |
MigrationStats:
A discriminated record containing virtual machine migration statistics. discriminating field: status,status.done returns MigratedStats; status.in_progress returns MigratingStats
NetInfoBond:
Information about a ethernet bond device
Members
| dhcpv4 | boolean | Whether DHCPv4 was used to set up the bond. |
| ipv6addrs | string | A list of IPv6 addresses in the format of 'address/prefixlen' that are assigned to the bond device |
| hwaddr | string | The Media Access Control address being used by the bond device |
| ipv6gateway | string | The default IPv6 gateway for the bridge device |
| slaves | string | A list of devices that are enslaved to the bond device |
| opts | StringMap | A map of options; the values are numeric, but reported as strings |
| active_slave | string | Active slave of the bond if exists, '' otherwise |
| ipv4addrs | string | A list of IPv4 addresses in the format of 'address/prefixlen' that are assigned to the vlan device |
| mtu | string | The Maximum Transmission Unit size for the nic |
| netmask | string | The primary IPv4 netmask of the defined subnet |
| dhcpv6 | boolean | Whether DHCPv6 was used to set up the network. |
| addr | string | The primary IPv4 address assigned to the bond device |
| ipv6autoconf | boolean | Whether use stateless autoconfiguration |
| gateway | string | Assign this gateway to the network |
| ipv4defaultroute | boolean | Whether the gateway is the host default |
| qos | DeviceQoSParams | List of host traffic QoS entries on the interface |
| switch | string | Specify Switch. Legacy is used if not passed |
NetInfoBondMap:
A mapping of bond information indexed by device name.
NetInfoBridgedNetwork:
Information about a VDSM bridged network.
Members
| dhcpv4 | boolean | Whether DHCPv4 was used to set up the network. |
| mtu | string | The Maximum Transmission Unit size for the bridge device |
| ipv6gateway | string | The default IPv6 gateway for the bridge device |
| gateway | string | The IP address of the subnet's gateway |
| ipv4defaultroute | boolean | Whether the gateway is the host default |
| ipv6addrs | string | A list of IPv6 addresses in the format of 'address/prefixlen' that are assigned to the bridge device |
| ports | string | A list of nic device names that are bridged |
| netmask | string | The primary IPv4 netmask of the defined subnet |
| dhcpv6 | boolean | Whether DHCPv6 was used to set up the network. |
| stp | string | Whether Spanning Tree Protocol status for the bridge device should be turned on |
| opts | StringMap | A map containing information about the bridge specific options. |
| hostQos | HostQoSParams | host traffic QoS params. |
| ipv4addrs | string | A list of IPv4 addresses in the format of 'address/prefixlen' that are assigned to the vlan device |
| bridged | boolean | Always True to distinguish this type from NetInfoBridgelessNetwork |
| addr | string | The primary IPv4 address assigned to the bridge device |
| iface | string | The network device associated with the network |
| switch | string | Specify Switch. Legacy is used if not passed |
| ipv6autoconf | boolean | Whether use ipv6 stateless autoconfiguration |
NetInfoBridgeMap:
A mapping of NIC information indexed by device name.
NetInfoBridgelessNetwork:
Information about a VDSM bridgeless network.
Members
| interface | string | The network device name associated with the network |
| bridged | boolean | Always False to distinguish this type from NetInfoBridgedNetwork |
NetInfoNetwork:
A discriminated record to store information about a VDSM network.
NetInfoNetworkMap:
A mapping of vdsm Network information indexed by network name.
NetInfoNic:
Information about a network interface card.
Members
| dhcpv4 | boolean | Whether DHCPv4 was used to set up the nic. |
| gateway | string | Assign this gateway to the network |
| ipv4defaultroute | boolean | Whether the gateway is the host default |
| ipv6autoconf | boolean | Whether use stateless autoconfiguration |
| ipv6gateway | string | The default IPv6 gateway for the bridge device |
| dhcpv6 | boolean | Whether DHCPv6 was used to set up the network. |
| ipv6addrs | string | A list of IPv6 addresses in the format of 'address/prefixlen' that are assigned to the nic |
| hwaddr | string | The Media Access Control address being used by the nic |
| permhwaddr | string | For bonded nics: the real MAC address which will be used if the card is freed from the bond. |
| speed | int | The reported speed of the nic |
| ipv4addrs | string | A list of IPv4 addresses in the format of 'address/prefixlen' that are assigned to the vlan device |
| mtu | string | The Maximum Transmission Unit size for the nic |
| netmask | string | The primary IPv4 netmask of the defined subnet |
| addr | string | The primary IPv4 address assigned to the nic device |
| qos | DeviceQoSParams | List of host traffic QoS entries on the interface |
NetInfoNicMap:
A mapping of NIC information indexed by device name.
NetInfoVlan:
Information about a Virtual Local Area Network
Members
| dhcpv4 | boolean | Whether DHCPv4 was used to set up the vlan. |
| ipv4defaultroute | boolean | Whether the gateway is the host default |
| iface | string | The network device associated with the vlan |
| mtu | uint | The Maximum Transmission Unit size for the vlan |
| vlanid | uint | The vlan ID assigned to the vlan device |
| ipv6addrs | string | A list of IPv6 addresses in the format of 'address/prefixlen' that are assigned to the vlan device |
| dhcpv6 | boolean | Whether DHCPv6 was used to set up the network. |
| ipv6gateway | string | The default IPv6 gateway for the bridge device |
| ipv4addrs | string | A list of IPv4 addresses in the format of 'address/prefixlen' that are assigned to the vlan device |
| netmask | string | The primary IPv4 netmask of the defined subnet |
| addr | string | The primary IPv4 address assigned to the vlan device |
NetInfoVlanMap:
A mapping of vlan information indexed by vlan tag.
NetworkInterfaceStats:
Statistics about a single network interface.
Members
| rxErrors | string | The number of incoming packets that have contained errors |
| name | string | The network device name |
| state | NetworkInterfaceState | Indicates whether the interface is currently active |
| rx | string | The number of incoming bytes in total |
| txDropped | string | The number of outgoing packets that have been dropped |
| macAddr | string | The hardware address |
| txErrors | string | The number of outgoing packets that have contained errors |
| speed | string | The interface speed (in Megabits/s) |
| tx | string | The number of outgoing bytes in total |
| sampleTime | float | Time stamp of the sample |
| rxDropped | string | The number of incoming packets that have been dropped |
NetworkInterfaceStatsMap:
A mapping of interface stats indexed by device name.
NumaNodeHugePages:
Information about hugepages of a given size for a numa node
Members
| totalPages | string | The number of hugepages of a given size in a numa node |
NumaNodeHugePagesMap:
A mapping of hugepages information indexed by hugepages size in KiB
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 | string | The total memory of this numa node in MiB. |
| hugepages | NumaNodeHugePagesMap | Hugepages statistics |
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
NumaNodeMap:
A mapping of numa node(cell) information indexed by numa cell id.
MemNode:
Pinning of a VM NUMA node to host NUMA nodes
Members
| vmNodeIndex | string | VM NUMA node index |
| nodeset | string | List of host numa nodes |
NumaTune:
Information about a vm numatune configuration
Members
| mode | string | The numatune mode. Either 'interleave', 'strict', or 'preferred', defaults to 'strict'. |
| nodeset | string | Specify the numa nodes that the vm will use. Refer to http://libvirt.org/formatdomain.html#elementsNUMATuning for the format details. |
| memnodes | MemNode | List of pinning information |
OSName:
An enumeration of recognized operating system names.
Values
| Debian | | A Debian-based distribution (including Ubuntu) |
| Fedora | | Fedora Linux |
| RHEL | | Red Hat Enterprise Linux |
| RHEV Hypervisor | | Red Hat Enterprise Virtualization Hypervisor |
| oVirt Node | | oVirt Node standalone hypervisor |
| unknown | | The operating system could not be detected |
OVFMap:
A mapping of OVF data indexed by VM UUID.
OsVersion:
Host operating system version information.
Members
| name | OSName | The name of the OS |
| release | string | The release number for this version |
| version | string | The OS version (eg. 17 for Fedora 17) |
| pretty_name | string | The OS pretty name |
WatchdogEventAction:
An enumeration of action that watchdog takes when it is triggered.
Values
| destroy | | Guest is forcibly powered off |
| ignore | | No action, watchdog ignored |
| log | | No action, a debug message logged |
| pause | | Guest CPUs are paused |
| reset | | Guest CPUs are reset |
| shutdown | | Guest is requested to gracefully shutdown |
WatchdogEvent:
The message of watchdog event when it is triggered
Members
| action | WatchdogEventAction | Action whatchdog takes when event is triggered |
| time | float | Time the whatchdog event is triggered in seconds since the epoch |
VmDiskStats:
Statistics about a virtual machine disk device.
Members
| writtenBytes | string | Bytes written |
| flushLatency | string | The latency of flush operations in nanoseconds |
| apparentsize | string | The size of the disk (in bytes) |
| readLatency | string | The latency of read operations in nanoseconds |
| readBytes | string | Bytes read |
| writeLatency | string | The latency of write operations in nanoseconds |
| truesize | string | The amount of underlying storage allocated (in bytes) |
| imageID | UUID | The UUID of the Image associated with this disk |
| readRate | string | The read activity in bytes per second |
| writeRate | string | The write activity in bytes per second |
| readOps | string | Read operations since VM start |
| writeOps | string | Write operations since VM start |
VmDiskStatsMap:
A mapping of VM disk statistics indexed by device name.
VmDiskDeviceTuneParams:
Extra parameters for VM disk devices. At least one device identifier (name/path) is needed.
Members
| name | string | The name of the taget device |
| path | string | The path of the taget device |
| ioTune | VmDiskDeviceIoTuneParams | IO tune parameters |
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 |
VmJobInfo:
Information about a currently active block job.
VmJobsMap:
A mapping of VM job information indexed by job UUID.
VmDisplayInfo:
Display and graphics device information.
Members
| tlsPort | string | The port in use for encrypted display data |
| port | string | The port in use for unencrypted display data |
| type | VmGraphicsDeviceType | The type of display in use |
| ipAddress | string | The IP address to use for accessing the VM display |
RunningVmStats:
Statistics for a running virtual machine.
Members
| memoryStats | GuestMemoryStats | Memory statistics as reported by the guest agent |
| timeOffset | string | The time difference from host to the VM in seconds |
| kvmEnable | string | Indicates if KVM hardware acceleration is enabled |
| cpuSys | string | Ratio of CPU time spent by qemu on other than guest time |
| vcpuUserLimit | int | Cpu usage hard limit in percents. |
| elapsedTime | string | The number of seconds that the VM has been running |
| watchdogEvent | WatchdogEvent | Information about the most recent watchdog event |
| acpiEnable | string | Indicates if ACPI is enabled inside the VM |
| network | NetworkInterfaceStatsMap | Network bandwidth/utilization statistics |
| disks | VmDiskStatsMap | Disk bandwidth/utilization statistics |
| cpuUsage | string | Total cpu usage since VM start in ns |
| cpuActual | boolean | Indicates whether all the CPU stats (cpuUser, cpuSys, cpuUsage) are based on actual values rather than initial fake values. |
| cpuUser | string | Ratio of CPU time spent by the guest VM |
| vmId | UUID | The UUID of the Vm |
| migrationProgress | uint | Indicates the percentage progress of a Migration, when there is one active. |
| balloonInfo | BalloonInfo | Guest memory balloon information |
| displayIp | string | The IP address to use for accessing the VM display |
| vcpuQuota | string | Setting for libvirt cpu_quota. |
| guestIPs | string | A space separated string of assigned IPv4 addresses |
| vcpuPeriod | long | Setting for libvirt cpu_period. |
| ioTune | VmDiskDeviceTuneParams | Current QoS settings for IO devices |
| vmType | VmType | The type of VM |
| guestFQDN | string | Fully qualified domain name of the guest OS. (Reported by the guest agent) |
| username | string | The username associated with the current session |
| pid | string | The process ID of the underlying qemu process |
| cdrom | string | The path to an ISO image used in the VM's CD-ROM device |
| vmName | string | The Name of the Vm |
| boot | VmBootMode | An alias for the type of device used to boot the VM |
| statusTime | string | Time in milliseconds when this structure was created. It is used to order vm status updates by a client. |
| clientIp | string | The IP address of the client connected to the display |
| pauseCode | string | Indicates the reason a VM has been paused |
| vmJobs | VmJobsMap | Info about active vm jobs |
| memUsage | string | The percent of memory in use by the guest |
| displayInfo | VmDisplayInfo | Display and graphics device informations. |
| vcpuCount | string | Number of vCPUs assigned to the VM |
| displayType | VmDisplayType | The type of display in use |
| monitorResponse | string | Indicates if the qemu monitor is responsive |
| appsList | string | A list of installed applications with their versions |
| guestCPUCount | int | The number of CPU cores are visible as online on the guest OS. This value is -1 if not supported to report |
| disksUsage | GuestMountInfo | Info about mounted filesystems as reported by the agent |
| displayPort | string | The port in use for unencrypted display data |
| netIfaces | GuestNetworkDeviceInfo | Network device address info as reported by the agent |
| displaySecurePort | string | The port in use for encrypted display data |
| session | GuestSessionState | The current state of user interaction with the VM |
| guestContainers | GuestContainerInfo | A list of running containers in the Vm |
| hash | string | hash |
| tpmHash | string | |
| nvramHash | string | |
| status | VmStatus | The current VM status |
| pci_devices | GuestPCIDevice | List of PCI devices and their drivers |
SELinuxStatus:
Information about host SELinux.
Members
| mode | string | The policy enforcement mode. Values are (from SELinux documentation): 1 = enforcing, 0 = permissive, -1 = disabled. |
SecretUsageType:
Enumeration for secret usage type
Values
| ceph | | This secret is associated with a Ceph RBD (rados block device) |
| iscsi | | This secret is associated with an iSCSI target for CHAP authentication |
| volume | | This secret is associated with a volume |
SecretInfo:
Libvirt secret info
Members
| description | string | A human-readable description of this secret |
| usageID | string | Specifies a unique usage id for the current usage type, as documented in https://libvirt.org/formatsecret.html |
| usageType | SecretUsageType | Specifies the usage type for this secret |
| uuid | UUID | An unique identifier for this secret |
| password | string | Base64 encoded value of this secret |
SetupNetworkBondAttributes:
Configuration attributes for a single bonded network interface device.
Members
| remove | boolean | If True, remove existing bond only |
| nics | string | An array of network device names to include in the bond |
| options | string | A string of space-separated <option>=<value> pairs |
| hwaddr | string | Define the Media Access Control address of the bond |
| switch | string | Specify Switch. Legacy is used if not passed |
SetupNetworkBondConfig:
A mapping of bond device configuration attributes indexed by bond name.
SetupNetworkNetAttributes:
Configuration attributes for a single host network.
Members
| bootproto | string | Interface autoconfiguration protocol (typically 'dhcp' or 'none') |
| dhcpv6 | boolean | Whether use DHCPv6 |
| ipv6autoconf | boolean | Whether use stateless autoconfiguration |
| nic | string | If the network is not bonded, an array containing a single network device name |
| hostQos | HostQoSParams | host traffic QoS params. |
| ipv6addr | string | Assign this static IPv6 address to the interface ('<ip>/<prefixlen>') |
| ipv6gateway | string | IPv6 address of the network gateway |
| gateway | string | Assign this gateway to the network |
| vlan | string | The name of an associated vlan |
| ipaddr | string | Assign this static IP address to the network |
| remove | boolean | If True, remove existing network only |
| custom | StringMap | A dictionary of custom, free-form properties for network. |
| bonding | string | If the network is bonded, the name of the bond device |
| netmask | string | Assign this netmask to the network |
| defaultRoute | boolean | boolean - Is this network's gateway the host's default gateway? |
| nameservers | string | List of nameservers |
| switch | string | Specify Switch. Legacy is used if not passed |
SetupNetworkNetConfig:
A mapping of network bridge configuration attributes indexed by bridge name.
SetupNetworkOptions:
Additional options for setupNetworks.
Members
| connectivityCheck | int | After reconfiguration, check for network connectivity and roll back if necessary |
| connectivityTimeout | int | The amount of time to wait before failing the connectivity check in seconds |
SnapshotVolumeDriveInfo:
Snapshot information for a Volume-based VM disk.
Members
| baseVolumeID | UUID | The Volume associated with the VM disk |
| imageID | UUID | The Image associated with the VM disk |
| domainID | UUID | The Storage Domain associated with the VM disk |
| volumeID | UUID | The Volume in which to create the snapshot |
SnapshotGUIDDriveInfo:
Snapshot information for a VM disk that is identified by a devmapper GUID.
Members
| GUID | UUID | The devmapper device GUID in which to create the snapshot |
| baseGUID | UUID | The devmapper device GUID associated with the VM disk |
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 |
SnapshotDriveInfo:
A discriminated record of snapshot information for a VM disk.
SoftwarePackage:
An enumeration of aliases for important software components.
Values
| glusterfs | | Glusterfs binary and glusterfs translator modules common |
| glusterfs-cli | | GlusterFS a distributed file-system cli |
| glusterfs-geo-replication | | Glusterfs geo-replication support |
| glusterfs-fuse | | FUSE based clients and glusterfsd |
| glusterfs-rdma | | Supports to ib-verbs library neede by Glusterfs |
| glusterfs-server | | Glusterfs server daemon |
| kernel | | The Linux kernel |
| librbd1 | | RADOS block device client library |
| libvirt | | Low level virtualization API |
| mom | | Dynamically manage system resources on virtualization hosts |
| qemu-img | | Qemu VM disk image manipulation utility |
| qemu-kvm | | Qemu virtual machine emulator |
| spice-server | | The server for SPICE protocol |
| vdsm | | Virtual Desktop and Server Manager (this software) |
SoftwarePackageInfo:
Information about an installed piece of software.
Members
| release | string | The release number for this version |
| version | string | The software version |
SoftwarePackageInfoMap:
A mapping of information indexed by software package name.
SpmRole:
An enumeration of Storage Pool Manager roles that are valid for a host.
Values
| Contend | | The host is contending for the SPM role |
| Free | | The host does not have the SPM role |
| SPM | | The host has the SPM role |
SpmStatus:
Storage Pool Manager status information.
Members
| spmId | int | The Host ID of the Storage Pool Manager |
| spmStatus | SpmRole | The SPM role for this host |
| spmLver | long | The lock version of the Storage Pool |
StorageDomainCreateArgumentsBlock:
Creation argument for Block-based Storage Domains.
Members
| vgUUID | UUID | The UUID of a Volume Group to use as backing storage |
StorageDomainCreateArgumentsLocal:
Creation argument for local filesystem Storage Domains.
Members
| remotePath | string | A path on the local filesystem |
StorageDomainCreateArgumentsNfs:
Creation argument for NFS-based Storage Domains.
Members
| remotePath | string | An export path in the form: <host>:<path> |
StorageDomainCreateArguments:
A discriminated record of Storage Domain creation parameters.
StorageDomainFileStats:
Information about files contained within a Storage Domain.
Members
| ctime | uint | Time the file was last changed in seconds since the epoch |
| size | uint | Size of the file in bytes |
| status | int | Indicates if the file is accessible |
StorageDomainFileStatsMap:
A mapping of Storage Domain file statistics indexed by filename.
StorageDomainImageClass:
An enumeration of Storage Domain classes.
Values
| Backup | | The Storage Domain is used for import and export of disk images |
| Data | | The Storage Domain is used for virtual machine disk images |
| Iso | | The Storage Domain is used for storing ISO images |
| Unknown | | The class is not known |
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 |
StorageDomainStats:
Storage Domain statistics.
Members
| mdafree | int | The amount of free space in the metadata area in bytes |
| mdathreshold | boolean | Indicates if the metadata has exceeded its size threshold |
| diskfree | int | The amount of free storage space in bytes |
| mdavalid | boolean | Indicates if the metadata area is large enough |
| disktotal | int | The amount of total storage space in bytes |
| mdasize | int | The size of the metadata area in bytes |
StorageDomainType:
An enumeration of Storage Domain types.
Values
| CIFS | | The Storage Domain uses CIFS/SMB 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 |
| NFS | | The Storage Domain uses Network File System based storage |
| SHAREDFS | | The Storage Domain uses storage from a Linux VFS file system |
| GLUSTERFS | | The Storage Domain uses GlusterFS based storage |
| UNKNOWN | | The type is not known |
StorageDomainType:
An enumeration of Storage Domain types.
Values
| 0 | | The type is not known |
| 1 | | The Storage Domain uses Network File System based storage |
| 2 | | The Storage Domain uses FibreChannel based storage |
| 3 | | The Storage Domain uses iSCSI based storage |
| 4 | | The Storage Domain uses storage on the local file system |
| 6 | | The Storage Domain uses posix file system |
| 7 | | The Storage Domain uses glusterfs |
StorageDomainInfo:
Information about a Storage Domain.
Members
| role | StorageDomainRole | The Storage Domain role |
| lver | int | The lock version of the associated Storage Pool |
| version | int | The version of this Storage Domain |
| type | StorageDomainType | The type of backing storage used by this domain |
| name | string | The human-readable name for this Storage Domain |
| pool | UUID | The Storage Pool associated with this Storage Domain |
| master_ver | int | The version of the master Storage Domain |
| class | StorageDomainImageClass | The Storage Domain class |
| spm_id | int | Contains the Host ID of the Storage Pool Manager |
| uuid | UUID | The Storage Domain UUID |
| metadataDevice | string | The GUID of the first device containing the domain metadata lv for block storage domains only |
| vgMetadataDevice | string | The GUID of the device containing the domain vg metadata for block storage domains (optional) |
| block_size | int | Logical block size in bytes of the underlying storage (512, 4096). |
| alignment | int | Size of clusterlock resource in bytes (1048576, 2097152, 4194304, 8388608). |
StorageDomainStatus:
An enumeration of Storage Domain statuses. There is inconsistenty (capitalization) between engien and vdsm so we keep both.
Values
| active | | The domain is attached to a Storage Pool and is activated |
| Active | | The domain is attached to a Storage Pool and is activated |
| attached | | The domain is attached to a Storage Pool but is deactivated |
| Attached | | The domain is attached to a Storage Pool but is deactivated |
| unattached | | The domain is not attached to a Storage Pool |
| Unattached | | The domain is not attached to a Storage Pool |
| unknown | | The status of the Storage Domain is not known |
| Unknown | | The status of the Storage Domain is not known |
StorageDomainStatusMap:
A mapping of Storage Domain statuses indexed by Storage Domain UUID.
StoragePoolDomainAlert:
Alert information for a Storage Domain attached to this Storage Pool.
Members
| code | int | The alert code |
| message | string | A detailed alert string |
StoragePoolDomainInfo:
Information about a Storage Domain that is attached to a Storage Pool.
Members
| diskfree | string | The remaining free disk space in bytes |
| alerts | StoragePoolDomainAlert | A list of alerts for this Storage Domain |
| disktotal | string | The total amount of disk space in the Storage Domain in bytes |
| isoprefix | string | ISO domain images directory |
| status | StorageDomainStatus | Current Storage Domain status |
| version | int | Indicates the Storage Domain version |
| isoprefix | string | The filesystem path from where ISO images may be referenced. Empty if no iso domain exists in the pool. |
StoragePoolDomainInfoMap:
A mapping of active Storage Domain information indexed by Storage DomainUUID.
StoragePoolStatus:
An enumeration of Storage Pool statuses.
Values
| connected | | Vdsm is connected to the Storage Pool |
| uninitialized | | The Storage Pool has not been initialized |
StoragePoolInfo:
Information about a Storage Pool.
Members
| master_uuid | UUID | The UUID of the Storage Domain serving as the master domain |
| lver | long | The Storage Pool lock version |
| version | string | The Storage Pool version |
| type | StorageDomainType | The type of storage managed by this Storage Pool |
| name | string | The Storage Pool name |
| master_ver | int | The Storage Domain version of the master domain |
| domains | string | All associated Storage Domains (the string has the following format: '<uuid>:<status>,<uuid>:<status>...' |
| spm_id | int | The Host ID of the host that is acting Storage Pool Manager |
| isoprefix | string | The filesystem path from where ISO images may be referenced |
| pool_status | StoragePoolStatus | The current status of the Storage Pool |
StoragePoolFullInfo:
Storage Pool and Storage Domain information.
StoragePoolUpgradeStatus:
An enumeration of Storage Pool upgrade job statuses.
Values
| started | | The upgrade process has started |
TaskResult:
An enumeration of the possible final task results.
Values
| cleanFailure | | The task failed and recovery also failed |
| cleanSuccess | | The task failed but was successfully recovered |
| success | | The task was successful |
| | Task is in progress |
TaskState:
An enumeration of possible task states.
Values
| aborting | | The task has been interrupted by a user has encountered an error |
| cleaning | | The task has failed and recovery actions are underway |
| finished | | The task has finished executing |
| init | | The task is initializing |
| running | | The task is currently executing |
| unknown | | The state of the task is not known |
TaskDetails:
A collection of information about a task.
Members
| taskResult | TaskResult | Final task result (TaskResult) |
| message | string | Detailed error message from the underlying task verb |
| id | UUID | The task UUID |
| code | int | Return code from the underlying task verb |
| tag | string | The tag assigned to the task |
| state | TaskState | Current task state (TaskState) |
| verb | string | The underlying operation to be performed by the task |
TaskInfo:
Extra information about a task.
Members
| id | UUID | The UUID of the task |
| verb | string | The underlying operation to be performed by the task |
TaskStatus:
A collection of status information about a task.
Members
| taskResult | TaskResult | Final task result (TaskResult) |
| code | int | Return code from the underlying task verb |
| taskID | UUID | The task UUID |
| taskState | TaskState | Current task state (TaskState) |
| message | string | Detailed error message from the underlying task verb |
TasksDetails:
A mapping of Task details indexed by Task UUID.
TasksInfo:
A mapping of Task information indexed by Task UUID.
TasksStatus:
A mapping of Task statuses indexed by Task UUID.
UpdateVmDefinition:
Virtual machine definition data suitable for saving to a Storage Domain.
Members
| vm | UUID | The VM UUID |
| imglist | string | The Images this VM depends on (a comma-separated string of UUIDs) |
| ovf | string | The VM definition in OVF format |
VmDiskDeviceTuneLimits:
Extra parameters for VM disk devices. Either name, path or all 4 IDs must be present
BulkIoTunePolicy:
Io tune policy info and current values for a vm
BulkIoTunePolicyMap:
A map of io tune policies for all VMs
Lease:
External sanlock lease
Members
| sd_id | UUID | The storage domain id where this lease is stored |
| lease_id | UUID | The unique id of this lease |
LeaseInfo:
Information about external sanlock lease
Members
| sd_id | UUID | The storage domain id where this lease is stored |
| lease_id | UUID | The id of this lease |
| path | string | The path to the lease file. Set when a lease is created and valid until the lease is remvoed. |
| offset | ulong | The offset of the lease in the lease file. Set when a lease is created and valid until the lease is removed. |
VolumeLeaseStatus:
The status of a sanlock lease
Members
| path | string | The path to the lease file. Set when a lease is created and valid until the lease is removed. |
| offset | ulong | The offset of the lease in the lease file. Set when a lease is created and valid until the lease is removed. |
| owners | uint | The host ids of the hosts owning this lease. If empty, the lease is free; otherwise the lease is acquired. If a lease is exclusive, contains the host id of the single host owning this lease. If a lease is shared, there may be multiple host ids. If the lease needs repair, this key will not be available. (optional) |
| version | int | A monotonically increasing unsigned 64 bit integer, incremented each time a lease is acquired successfully. If the lease needs repair, this key will not be available. (optional) |
UpdateVmPolicyParams:
QoS policy update data
Members
| vcpuLimit | int | 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 | list of ioTune limits to set |
VMGuestTimezone:
Timezone configuration of the guest operating system
Members
| offset | uint | Time offset of the configured timezone in minutes |
| zone | string | Name of the timezone native to the Guest OS |
VMGuestOsInfo:
Information about the guest operating system on a VM
Members
| codename | string | Codename of the OS |
| arch | string | Architecture of the OS (x86, x86_64, ppc64, ...) |
| version | string | Operating system version |
| type | string | Type of the OS (linux, windows, ...) |
| distribution | string | Name of the linux distribution |
| kernel | string | Kernel version reported by a linux guest |
VMFullInfo:
Full information about VM.
CpuInfo:
Information about single CPU/thread
Members
| cpu_id | int | ID of the CPU on host |
| numa_cell_id | int | To which NUMA cell the CPU belongs |
| socket_id | int | On which socket this CPU is |
| die_id | int | On which die of the socket this CPU is |
| core_id | int | On which core of the die this CPU is |
VdsmCapabilities:
Host information and capabilities.
Members
| bondings | NetInfoBondMap | Information about configured bonding devices |
| autoNumaBalancing | AutoNumaBalancingStatus | The status of auto numa balancing function |
| netConfigDirty | string | Indicates if there are uncommitted changes to the network configuration |
| nics | NetInfoNicMap | Information about the network cards on the host |
| emulatedMachines | string | A list of supported emulated machines |
| cpuFlags | string | CPU feature flags (a comma-separated string) |
| reservedMem | string | The amount of memory reserved for hypervisor overhead |
| onlineCpus | string | The list of online logical CPUs |
| cpuTopology | CpuInfo | Detailed CPU topology |
| cpuSpeed | string | The speed of each CPU (in MHz) |
| software_version | string | VDSM version (x.y.z) |
| vdsmToCpusAffinity | int | CPU affinity of the VDSM process |
| vmTypes | VmType | A list of supported virtual machine types |
| hostdevPassthrough | string | Indicates status of Intel VT-d or AMD-vi |
| rngSources | VmRngDeviceSource | Sources of entropy available at this host |
| version_name | string | The name given to this version of VDSM |
| numaNodes | NumaNodeMap | Information about host numa topology |
| memSize | string | The amount of total memory installed in the host |
| supportedENGINEs | string | A list of supported ovirt-engine versions |
| cpuModel | string | The CPU model |
| selinux | SELinuxStatus | The status and configuration of SELinux on the host. |
| networks | NetInfoNetworkMap | Information about configured VDSM networks |
| kvmEnabled | string | KVM is enabled on the host |
| liveMerge | string | Indicates if live merge is supported on this host. |
| ISCSIInitiatorName | string | The iSCSI initiator name for this host |
| cpuThreads | string | The number of CPU threads present |
| software_revision | string | Extra VDSM version information |
| liveSnapshot | string | Indicates if the host supports live snapshotting |
| bridges | NetInfoBridgeMap | Information about the network bridges on the host |
| guestOverhead | string | The amount of memory reserved for per-guest overhead |
| HBAInventory | HbaInventory | Information about available host bus adapters |
| clusterLevels | string | A list of supported cluster versions |
| cpuCores | string | The number of CPU cores present |
| cpuSockets | string | The number of CPU sockets |
| lastClientIface | string | Interface on which client is communicating |
| uuid | string | A unique host ID |
| operatingSystem | OsVersion | Operating system version information |
| vlans | NetInfoVlanMap | Information about configured vlans |
| supportsIPv6 | boolean | Whether IPv6 is enabled in the kernel |
| nameservers | string | Provides host DNS servers from /etc/resolve.conf |
| numaNodeDistance | NumaNodeDistanceMap | Distance information between each two numa nodes |
| kdumpStatus | int | The current status of kdump configuration for the host: enabled (1), disabled(0), unknown(-1) |
| packages2 | SoftwarePackageInfoMap | Version information of important software packages |
| hooks | HookScriptInfoMap | Information about installed hooks |
| additionalFeatures | string | Provides a list of additional features supported in this host. |
| kernelArgs | string | Arguments of currently running kernel (contents of /proc/cmdline) |
| realtimeKernel | boolean | Indication whether the running kernel is compiled with RT_PREEMPT enabled |
| nestedVirtualization | boolean | Indication whether the system is capable of nested virtualization (considers platform & module options). |
| hostedEngineDeployed | boolean | Indicates whether hosted engine has been deployed on the host |
| hugepages | int | A list of available hugepage sizes (in kb) |
| vncEncrypted | string | Indicates whether libvirt is configured to encrypt VNC connections |
| connector_info | ConnectorInfo | Connector information. Only present if os-brick is installed on the host |
| backupEnabled | boolean | Indicates if the host supports backup |
| domain_versions | int | Storage domain versions supported on this host. |
| supported_block_size | SupportedBlockSizeMap | Map of supported block size per storage domain type. |
| fipsEnabled | boolean | Indicates if the host is running in the FIPS mode |
| tscFrequency | string | TSC frequency of the CPU |
| tscScaling | boolean | Indicates if the host's CPU supports TSC scaling |
| boot_uuid | string | Boot partition UUID |
| ovnConfigured | boolean | Indicates if the host has OVN configured |
VdsmNetworkCapabilities:
Host network information and capabilities.
Members
| networks | NetInfoNetworkMap | Information about configured VDSM networks |
| bridges | NetInfoBridgeMap | Information about the network bridges on the host |
| vlans | NetInfoVlanMap | Information about configured vlans |
| bondings | NetInfoBondMap | Information about configured bonding devices |
| nics | NetInfoNicMap | Information about the network cards on the host |
| netConfigDirty | string | Indicates if there are uncommitted changes to the network configuration |
| supportsIPv6 | boolean | Whether IPv6 is enabled in the kernel |
| nameservers | string | Provides host DNS servers from /etc/resolve.conf |
HostNetworkStatistics:
Host network statistics.
Members
| network | HostNetworkInterfaceStatsMap | Per-interface network statistics |
| txDropped | string | The number of outgoing packets dropped |
| rxDropped | string | The number of incoming packets dropped |
VmShortStatus:
Abbreviated virtual machine status.
Members
| vmId | UUID | The UUID of the VM |
| status | VmStatus | The current status of the VM |
VmInfo:
A discriminated record of VM status information.
VmParameters:
Parameters for creating a new virtual machine
Members
| hypervEnable | boolean | Enables hyperv specific optimizations for the Guest OS. |
| display | VmDisplayType | The type of display |
| launchPaused | boolean | If present, launch the VM in pause mode. |
| memSize | uint | The amount of memory assigned to the VM in MB |
| smpThreadsPerCore | string | Indicates the number of CPU threads per core |
| smp | string | The number of CPUs presented to the VM |
| guestNumaNodes | GuestNumaNode | Indicates the guest numa topology. |
| vmId | UUID | The VM UUID |
| bootMenuEnable | string | enable the BIOS boot menu |
| custom | StringMap | A dictionary of custom, free-form properties |
| devices | VmDevice | An array of VM devices requested |
| kvmEnable | string | Indicates if KVM hardware acceleration is enabled |
| transparentHugePages | string | Indicates if the Transparent Huge Pages feature is enabled for this virtual machine |
| vmName | string | The VM name |
| timeOffset | string | The time difference from host to the VM in seconds |
| nice | string | The host scheduling priority |
| numaTune | NumaTune | Indicates the numatune configuration. |
| smpCoresPerSocket | string | Indicates the number of CPU cores per socket |
| cpuShares | string | The host scheduling priority (relative to other VMs). In case both cpuShares and nice are present, cpuShares will be used. |
| acpiEnable | string | Indicates if ACPI is enabled inside the VM |
| vmType | VmType | The type of VM |
| emulatedMachine | string | The emulated machine type |
| memGuaranteedSize | uint | The amount of memory guaranteed to be available to the VM in MB |
| cpuType | string | The model of CPU to emulate |
| maxMemSize | uint | The maximum amount of the memory this VM could have. Needed for the memory hotplug. FIXME find the unit size. |
| maxMemSlots | uint | The number of emulated memory slots for this VM. Needed for the memory hotplug. |
| smartcardEnable | string | Indicates if the smartcard support is enabled for this VM. |
| pitReinjection | string | Indicates if the PIT reinjection is enabled for this VM. DEPRECATED. |
| displayNetwork | string | The network this VM should use for the graphic display connections. DEPRECATED. |
| maxVCpus | string | The maximum number of virtual CPUs this VM could support. Needed for the CPU hotplug. |
| agentChannelName | string | The name to use for the oVirt guest agent channel. When not specified the legacy name 'com.redhat.rhevm.vdsm' will be used. |
| xml | string | Domain XML to passthrough to libvirt |
| _X_tpmdata | string | TPM data of the VM |
| _X_nvramdata | string | NVRAM data of the VM |
VmStats:
A discriminated record containing virtual machine statistics.
VmTicketConflictAction:
An enumeration of consequences if another user is connected to a display.
Values
| disconnect | | Disconnect the current user |
| fail | | Fail the operation and do not change the password |
| keep | | Change the password but keep the current user connected |
VolumeGroupAttributeAllocation:
An enumeration of possible values for the allocation policy attribute.
Values
| a | | Indicates an anywhere allocation policy |
| c | | Indicates a contiguous allocation policy |
| i | | Indicates that the allocation policy is inherited |
| l | | Indicates a cling allocation policy |
| n | | Indicates a normal allocation policy |
VolumeGroupAttributeClustered:
An enumeration of possible values for the clustered attribute.
Values
| - | | Indicates that clustered locking is disabled |
| c | | Indicates that clustered locking is enabled |
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 |
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 |
VolumeGroupAttributePermission:
An enumeration of possible values for the permission attribute.
Values
| r | | The Volume Group is read-only |
| w | | The Volume Group is writable |
VolumeGroupAttributeResizeable:
An enumeration of possible values for the resizeable attribute.
Values
| - | | The Volume Group is not resizeable |
| z | | The Volume Group is resizeable |
VolumeGroupAttributes:
A collection of Volume Group attributes.
VolumeGroupState:
An enumeration of possible Volume Group states.
Values
| OK | | All Physical Volumes are online |
| PARTIAL | | One or more Physical Volumes are not available |
PhysicalVolumeInfo:
Phisical volume information.
Members
| capacity | string | The device logical size (in bytes) |
| devcapacity | string | The device size (in bytes) |
| vendorID | string | A string identifying the device manufacturer |
| productID | string | A string identifying the device model |
| pvUUID | UUID | The LVM physical volume associated with this device |
| vgUUID | UUID | The volume group associated with this device |
| fwrev | string | Firmware version information |
| devtype | BlockDeviceType | The type of storage device (BlockDeviceType) |
| pathlist | IscsiSessionInfo | iSCSI session information |
| GUID | UUID | The globally unique identifier of the block device |
| serial | string | The device serial number (if available) |
| pathstatus | BlockDevicePathInfo | Multipath information |
VolumeGroupInfo:
Information about a Volume Group.
Members
| vgUUID | UUID | The uuid of the Volume Group |
| vgsize | string | The total capacity (in bytes) |
| name | string | The Volume Group name |
| attr | VolumeGroupAttributes | Additional attributes |
| state | VolumeGroupState | The state of this Volume Group's underlying storage |
| vgfree | string | The amount of currently unassigned capacity (in bytes) |
| type | StorageDomainType | The type of backing storage used by this domain |
| pvlist | PhysicalVolumeInfo | Phisical volume list |
VolumeStatus:
An enumeration of Volume statuses.
Values
| ILLEGAL | | The Volume is not legal |
| INVALID | | The Volume and metadata are not valid |
| OK | | There are no problems with the Volume or metadata |
VolumeLegality:
An enumeration of Volume Legality indicators.
Values
| FAKE | | The Volume is a fake template on a backup domain |
| ILLEGAL | | The Volume should no longer be used (because it is being deleted) |
| LEGAL | | The Volume is legal |
VolumeRole:
An enumeration of Volume Roles.
Values
| INTERNAL | | The Volume is being used internally by vdsm |
| LEAF | | The Volume is a writable leaf |
| SHARED | | The Volume is a shared template |
VolumeInfoResponse:
Information about a Volume.
Members
| disktype | DiskContentType | An advisory code indicating the Volume's planned usage |
| status | VolumeStatus | Indicates whether the Volume and metadata are valid |
| pool | UUID | The Storage Pool associated with the Volume. Not used and is effectively empty since version 3.5 |
| capacity | uint | The size of the Volume (in bytes) |
| parent | UUID | The direct ancestor of this Volume if it exists |
| allocType | VolumeAllocation | The Volume allocation policy |
| children | UUID | A list of descendent Volumes that depend on this Volume |
| mtime | uint | The Volume modification time (deprecated) |
| description | string | A human-readable description of the Volume |
| legality | VolumeLegality | Indicates whether the volume is legal to use |
| ctime | int | The Volume creation time in seconds since the epoch |
| voltype | VolumeRole | The Volume role |
| truesize | uint | The amount of underlying storage allocated (in bytes) |
| uuid | UUID | The Volume UUID |
| domain | UUID | The Storage Domain associated with the Volume |
| apparentsize | uint | The size of the Volume (in bytes) |
| format | VolumeFormat | The format used to write data to the Volume |
| image | UUID | The Image associated with the Volume |
| lease | VolumeLeaseStatus | The status of the Volume lease, or null if this storage domains does not support volume leases. |
| generation | uint | A monotonically increasing number, incremented each time a volume operation is completed successfully. The maximum value is 999 and the next increment will reset the value to 0. |
QemuImageInfo:
Volume's information returned from qemuimg info.
Members
| format | QemuImageFormat | The format used to write data to the Volume |
| virtualsize | uint | The size of the Volume (in bytes) |
| clustersize | uint | The cluster size of the Volume in bytes. |
| backingfile | string | The backing file name. New volumes will always use uuid of the volume, while old volumes will use relative path of the volume (../image-uuid/vol-uuid). |
| compat | Qcow2Compat | The compat version. |
VolumeSizeInfo:
Volume size information:
Members
| truesize | uint | The amount of underlying storage allocated (in bytes) |
| apparentsize | uint | The size of the Volume (in bytes) |
syncType:
An enumeration of possible Image synchronization types.
Values
| ALL | | Sync all volumes |
| INTERNAL | | Sync internal volumes only |
| LEAF | | Sync leaf volumes only |
vmUpdateInterfaceDeviceParams:
Parameters for VM.updateDevice
Members
| alias | string | Alias used to identify this device in commands. |
| portMirroring | string | 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. |
| linkActive | boolean | Whether the VM network card has its link active (up) or not (down). If omitted, keeps the previous link state. |
| network | string | 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. |
| filter | string | The name of the referenced network filter |
| filterParameters | VmInterfaceDeviceFilterParameters | The list of parameters of the network filter. Applicable only if 'filter' is supplied. |
vmUpdateGraphicsDeviceParams:
Parameters for VM.updateDevice
Members
| existingConnAction | VmTicketConflictAction | Indicate what to do with any existing connections |
| graphicsType | VmGraphicsDeviceType | The type of the device to update |
| params | StringMap | Arbitrary key:val pairs that will be passed to hooks |
| ttl | int | The number of seconds before the password expires |
| password | string | The desired connection password |
| consoleDisconnectActionDelay | uint | If Console Disconnect Action is set to Shutdown, this parameter sets the length of the delay before vm shutdown is initiated, in minutes. |
vmUpdateXMLDeviceParams:
Parameters for VM.updateDevice
Members
| xml | string | XML snippet about the device to update |
vmUpdateDeviceParams:
A discriminated record of update parameters for a VM device.
CopyDataEndpointType:
An enumeration of possible CopyDataEndpoint types
Values
| div | | A vdsm volume identified by domain, image, and volume UUIDs |
| external | | An endpoint that is not managed by vdsm, represented as a url. |
CopyDataDIVEndpoint:
An endpoint describing a Volume on a vdsm Storage Domain.
Members
| sd_id | UUID | The UUID of the Storage Domain |
| img_id | UUID | The UUID of the Image |
| vol_id | UUID | The UUID of the Volume |
| generation | uint | The expected generation of the Volume |
CopyDataExternalEndpoint:
An endpoint describing an external path to copy.
Members
| url | string | The expected url of the image, like rbd:pool/vol See https://qemu.readthedocs.io/en/latest/system/images.html |
| lease | Lease | The lease to be used for job tracking. |
| generation | uint | The expected generation of the lease. |
| format | string | Format of the target image. Only officially supported formats are raw and qcow2. |
| sprase | boolean | True if the image is sparse, False if preallocated. |
| create | boolean | True if the image needs to be created. In cases where the image is not created and the format is qcow2, the caller has to create qcow2 image. |
| is_zero | boolean | False if the target should be zeroed, True if it is already zeroed. Can only be used with create=False. |
CopyDataEndpoint:
A discriminated record containing an endpoint for a copy data operation.
SubchainInfo:
A descriptor for a (cold) merge volumes operation.
Members
| sd_id | UUID | The UUID of the Storage Domain |
| img_id | UUID | The UUID of the Image |
| top_id | UUID | The UUID of the top Volume |
| base_id | UUID | The UUID of the base Volume |
| base_generation | uint | The expected generation of the base volume |
StorageDomainDeviceMoveParams:
An descriptor for a storage domain device data move operation.
Members
| sd_id | UUID | The UUID of the Storage Domain |
| guid | string | The GUID of the block device |
| dst_guids | string | Optional list of target block device GUIDs |
StorageDomainReduceParams:
An descriptor for a storage domain reduce operation.
Members
| sd_id | UUID | The UUID of the Storage Domain |
| guid | string | The GUID of the block device to reduce from the domain |
VolumeAttributes:
Possible attributes which are allowed to be changed in a volume.
Members
| legality | VolumeLegality | Legality of the volume. |
| description | string | Description of the volume. Up to 210 bytes. Longer values will be truncated |
| generation | uint | Change a volume's generation from a known value to a new value. The maximum value is 999 and the next increment will reset the value to 0. On each call to update_volume, the generation is increased, unless specified here. In that case, the provided generation will be used |
| type | VolumeRole | Type of the volume. The only valid value is SHARED. Only a leaf volume without a parent can be changed to shared. |
VolumeInfo:
A descriptor for an Image on a vdsm Storage Domain.
Members
| sd_id | UUID | The UUID of the Storage Domain |
| img_id | UUID | The UUID of the Image |
| vol_id | UUID | The UUID of the Volume |
DiskType:
Disk type.
Values
| FILE | | This volume is based on file storage domain |
| BLOCK | | This volume is based on block storage domain |
FileScratchDisk:
VM backup file-based scratch disk parameters for usage when starting a backup.
Members
| path | string | The path to the prepared scratch disk |
| type | DiskType | Indicates the type of the storage domain that the volume resides on ('file'). |
| domainID | UUID | The UUID of the Storage Domain containing the Volume |
| imageID | UUID | The UUID of the Image |
| volumeID | UUID | The UUID of the Volume |
BlockScratchDisk:
VM backup block-based scratch disk parameters for usage when starting a backup.
Members
| path | string | The path to the prepared scratch disk |
| type | DiskType | Indicates the type of the storage domain that the volume resides on ('block'). |
| domainID | UUID | The UUID of the Storage Domain containing the Volume |
| imageID | UUID | The UUID of the Image |
| volumeID | UUID | The UUID of the Volume |
ScratchDisk:
A discriminated record containing a scratch disk specification.
BackupDisk:
Backup disk descriptor.
Members
| sd_id | UUID | The UUID of the storage domain |
| img_id | UUID | The UUID of the image |
| vol_id | UUID | The UUID of the volume |
| checkpoint | boolean | Should the disk be included in a checkpoint |
| backup_mode | DiskBackupMode | If specified during an incremental backup, it allows full backup for disks that cannot be used in the incremental backup. If not specified, all disks included in the incremental backup will be prepared for an incremental backup. If one of the disks cannot be prepared for an incremental backup the entire request will fail. Using "incremental" when full backup requested (from_checkpoint_id == None) is not supported. |
| scratch_disk | ScratchDisk | Information on the scratch disk created by the engine for the backup disk, if this is not specified a temporary scratch disk will be created on the host storage. |
NBDServerConfig:
NBD server configuration.
BackupInfo:
A backup info entity
Members
| disks | StringMap | Mapping of disks in the backup to NBD URLs (imageId -> "nbd:unix:/path:exportname=sdx") |
| checkpoint | string | Checkpoint XML description returned from libvirt. This XML can be used to redefine the checkpoint later. |
BackupConfig:
Backup configuration.
CheckpointInfo:
A checkpoint info entity.
Checkpoint:
Configuration of the checkpoint, can be the checkpoint XML or the backup configuration to compose the checkpoint XML from it.
Members
| id | UUID | UUID of the checkpoint |
| xml | string | Checkpoint XML description returned from libvirt. |
| config | BackupConfig | The backup configuration |
CheckpointsResponse:
Checkpoints operation response.
JobStatus:
The status of the job stored on a lease's metadata
Values
| PENDING | | Job was created on engine, but was not started yet. |
| FAILED | | Job has failed to run and the host reported the failure. |
| SUCCEEDED | | Job completed successfully. |
| FENCED | | Job was fenced by another host. |
LeaseMetadataType:
The type of metadata stored on the lease
Values
| JOB | | The metadata will be used to store job related information. |
JobMetadata:
Job attributes to be set on a Lease's metadata (LVB)
Members
| type | LeaseMetadataType | The type of metadata (always JOB). |
| job_status | JobStatus | The status of the job. |
| generation | uint | The generation of the job. Will be used to determine whether the job succeeded or needs to be fenced. The generation will be increased by the host running the job when it successfully completes the job. It will be increased by another host when it is determine that the host originally running the job is no longer running it (no longer holds the lease). |
| job_id | UUID | The ID of the submitted job. |
| created | uint | Time of metadata creation. |
| modified | uint | Time of metadata modification. |
| host_hardware_id | UUID | Hardware ID of the host that changed the metadata |
LeaseMetadata:
Type of lease metadata, this will be used to provide context about what values are stored on lease's metadata.
ExternalLeaseStatus:
The status of an external lease
Members
| owners | uint | The host ids of the hosts owning this lease. If empty, the lease is free; otherwise the lease is acquired. If a lease is exclusive, contains the host id of the single host owning this lease. |
| version | uint | A monotonically increasing unsigned 64 bit integer, incremented each time a lease is acquired successfully. |
| metadata | LeaseMetadata | The lease metadata read from lease's LVB. |
VolumeMeasureResult:
Volume size measured by qemu-img measure
Members
| required | int | The required size of the volume measured by qemu-img |
VolumeDump:
Volume raw metadata.
Members
| disktype | DiskContentType | Advisory code indicating the Volume's planned usage. Available if volume metadata is valid. |
| status | VolumeStatus | Indicates whether the Volume and metadata are valid. |
| capacity | uint | The size of the Volume in bytes. Available if volume metadata is valid. |
| parent | UUID | The direct ancestor of this Volume if it exists. Available if volume metadata is valid or LV has a parent UUID tag, in case of a volume in a FC or an ISCSI storage domain. |
| description | string | A human-readable description of the Volume. Available if volume metadata is valid |
| legality | VolumeLegality | Indicates whether the volume is legal to use. Available if volume metadata is valid. |
| ctime | int | The Volume creation time in seconds since the epoch. Available if volume metadata is valid. |
| format | VolumeFormat | The format used to write data to the Volume. Available if volume metadata is valid. |
| image | UUID | The Image associated with the Volume. |
| type | VolumeAllocation | The Volume allocation type (sparse, preallocated). Available if volume metadata is valid. |
| mdslot | uint | The metadata slot index, available only for a volume on ISCSI or FC storage domain. Available if volume has a metadata slot LV tag. |
| generation | uint | A monotonically increasing number, incremented each time a volume operation is completed successfully. The maximum value is 999 and the next increment will reset the value to 0. Available if volume metadata is valid. |
| voltype | VolumeRole | The Volume role. Available if volume metadata is valid. |
| truesize | uint | The amount of underlying storage allocated in bytes. Available of volume is accessible. |
| apparentsize | uint | The size of the disk in bytes. Availbale if volume is accessible. |
VolumesDumpMap:
A mapping of volumes UUIDs to their dumped raw metadata.
LeaseDump:
Lease metadata.
Members
| offset | ulong | Lease file offset. |
| lockspace | string | Lockspace name. |
| resource | string | Resource name. |
| timestamp | uint | Modification timestamp. |
| own | uint | Owner host id. |
| gen | uint | Generation. |
| lver | uint | Lease version. Only for volume leases. |
XleaseDump:
Xlease metadata.
Members
| offset | ulong | The offset of the lease in the xlease file. |
| updating | boolean | xlease update indicator. |
XleasesDumpMap:
A mapping of VM UUIDs to their xleases.
StorageDomainDump:
Storage domain raw metadata.
Members
| metadata | StorageDomainInfo | Storage domain metadata. |
| volumes | VolumesDumpMap | Volumes metadata. |
| leases | LeaseDump | Leases metadata. For a storage domain using sanlock to manage volumes leases, applies to non-local FS SD type from version 3 or later. Available only when using StorageDoamin.dump(full=True). |
| lockspace | LeaseDump | Lockspace metadata. For a storage domain using sanlock to manage domain leases, applies to non-local FS SD type from version 3 or later. Available only when using StorageDoamin.dump(full=True). |
| xleases | XleasesDumpMap | External leases metadata. For a storage domain using sanlock volumes leases, applies to non-local FS SD type from version 4 or later. Available only when using StorageDoamin.dump(full=True). |
VmDataMap:
VM data and related information
Members
| _X_data | string | The encoded data, suitable for use in VM.create. If only changed data was requested and the data is unchanged, or if there is no data, then this item is omitted. |
| hash | string | Hash of the data, whether the data itself is present here or not (it may be empty in the latter case). |
ScreenshotResponse:
VM Screenshot dump operation response.