Red Hat SummitChapter 7. Types
This section enumerates all the data types that are available in the API.
7.1. AccessProtocol enum
| Name | Summary |
|---|---|
|
| |
|
| |
|
|
7.2. Action struct
| Name | Type | Summary |
|---|---|---|
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| Free text containing comments about this object. | |
|
| ||
|
| ||
|
| ||
|
| A human-readable description in plain text. | |
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| A unique identifier. | |
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| A human-readable name in plain text. | |
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
|
7.3. AffinityGroup struct
An affinity group represents a group of virtual machines with a defined relationship.
| Name | Type | Summary |
|---|---|---|
|
| Free text containing comments about this object. | |
|
| A human-readable description in plain text. | |
|
| Specifies whether the affinity group uses hard or soft enforcement of the affinity applied to virtual machines that are members of that affinity group. | |
|
| Specifies the affinity rule applied between virtual machines and hosts that are members of this affinity group. | |
|
| A unique identifier. | |
|
| A human-readable name in plain text. | |
|
| Specifies whether the affinity group applies positive affinity or negative affinity to virtual machines that are members of that affinity group. | |
|
| Specifies the affinity rule applied to virtual machines that are members of this affinity group. |
7.3.1. enforcing
Specifies whether the affinity group uses hard or soft enforcement of the affinity applied to virtual machines that are members of that affinity group.
Please note that this attribute has been deprecated since version 4.1 of the engine, and will be removed in the future. Use the vms_rule attribute from now on.
7.3.2. positive
Specifies whether the affinity group applies positive affinity or negative affinity to virtual machines that are members of that affinity group.
Please note that this attribute has been deprecated since version 4.1 of the engine, and will be removed in the future. Use the vms_rule attribute from now on.
7.4. AffinityLabel struct
The affinity label can influence virtual machine scheduling. It is most frequently used to create a sub-cluster from the available hosts.
| Name | Type | Summary |
|---|---|---|
|
| Free text containing comments about this object. | |
|
| A human-readable description in plain text. | |
|
| A unique identifier. | |
|
| A human-readable name in plain text. | |
|
|
The |
7.4.1. read_only
The read_only property marks a label that can not be modified. This is usually the case when listing internally-generated labels.
7.5. AffinityRule struct
Generic rule definition for affinity group. Each supported resource type (virtual machine, host) is controlled by a separate rule. This allows expressing of rules like: no affinity between defined virtual machines, but hard affinity between defined virtual machines and virtual hosts.
| Name | Type | Summary |
|---|---|---|
|
| Specifies whether the affinity group uses this rule or not. | |
|
| Specifies whether the affinity group uses hard or soft enforcement of the affinity applied to the resources that are controlled by this rule. | |
|
| Specifies whether the affinity group applies positive affinity or negative affinity to the resources that are controlled by this rule. |
7.5.1. enabled
Specifies whether the affinity group uses this rule or not. This attribute is optional during creation and is considered to be true when it is not provided. In case this attribute is not provided to the update operation, it is considered to be true if AffinityGroup positive attribute is set as well. The backend enabled value will be preserved when both enabled and positive attributes are missing.
7.5.2. enforcing
Specifies whether the affinity group uses hard or soft enforcement of the affinity applied to the resources that are controlled by this rule. This argument is mandatory if the rule is enabled and is ignored when the rule is disabled.
7.5.3. positive
Specifies whether the affinity group applies positive affinity or negative affinity to the resources that are controlled by this rule. This argument is mandatory if the rule is enabled and is ignored when the rule is disabled.
7.6. Agent struct
Type representing a fence agent.
| Name | Type | Summary |
|---|---|---|
|
| Fence agent address. | |
|
| Free text containing comments about this object. | |
|
| Specifies whether the agent should be used concurrently or sequentially. | |
|
| A human-readable description in plain text. | |
|
| Specifies whether the options should be encrypted. | |
|
| A unique identifier. | |
|
| A human-readable name in plain text. | |
|
| Fence agent options (comma-delimited list of key-value pairs). | |
|
| The order of this agent if used with other agents. | |
|
| Fence agent password. | |
|
| Fence agent port. | |
|
| Fence agent type. | |
|
| Fence agent user name. |
| Name | Type | Summary |
|---|---|---|
|
| Reference to the host service. |
7.6.1. host
Reference to the host service. Each fence agent belongs to a single host.
7.7. AgentConfiguration struct
7.8. Api struct
This type contains the information returned by the root service of the API.
To get that information send a request like this:
GET /ovirt-engine/api
GET /ovirt-engine/apiThe result will be like this:
| Name | Type | Summary |
|---|---|---|
|
| Information about the product, such as its name, the name of the vendor, and the version. | |
|
| References to special objects, such as the blank template and the root of the hierarchy of tags. | |
|
| A summary containing the total number of relevant objects, such as virtual machines, hosts, and storage domains. | |
|
| The date and time when this information was generated. |
7.9. ApiSummary struct
A summary containing the total number of relevant objects, such as virtual machines, hosts, and storage domains.
| Name | Type | Summary |
|---|---|---|
|
| The summary of hosts. | |
|
| The summary of storage domains. | |
|
| The summary of users. | |
|
| The summary of virtual machines. |
7.10. ApiSummaryItem struct
This type contains an item of the API summary. Each item contains the total and active number of some kind of object.
7.11. Application struct
| Name | Type | Summary |
|---|---|---|
|
| Free text containing comments about this object. | |
|
| A human-readable description in plain text. | |
|
| A unique identifier. | |
|
| A human-readable name in plain text. |
| Name | Type | Summary |
|---|---|---|
|
|
7.12. Architecture enum
| Name | Summary |
|---|---|
|
| |
|
| |
|
|
7.13. AuthorizedKey struct
| Name | Type | Summary |
|---|---|---|
|
| Free text containing comments about this object. | |
|
| A human-readable description in plain text. | |
|
| A unique identifier. | |
|
| ||
|
| A human-readable name in plain text. |
| Name | Type | Summary |
|---|---|---|
|
|
7.14. AutoNumaStatus enum
| Name | Summary |
|---|---|
|
| |
|
| |
|
|
7.15. Balance struct
| Name | Type | Summary |
|---|---|---|
|
| Free text containing comments about this object. | |
|
| A human-readable description in plain text. | |
|
| A unique identifier. | |
|
| A human-readable name in plain text. |
| Name | Type | Summary |
|---|---|---|
|
| ||
|
|
7.16. Bios struct
| Name | Type | Summary |
|---|---|---|
|
|
7.17. BlockStatistic struct
| Name | Type | Summary |
|---|---|---|
|
|
7.18. Bonding struct
Represents a network interfaces bond.
| Name | Type | Summary |
|---|---|---|
|
|
The | |
|
| A list of option elements for a bonded interface. | |
|
| A list of slave NICs for a bonded interface. |
7.18.1. ad_partner_mac
The ad_partner_mac property of the partner bond in mode 4. Bond mode 4 is the 802.3ad standard, which is also called dynamic link aggregation. See Wikipedia and Presentation for more information. ad_partner_mac is the MAC address of the system (switch) at the other end of a bond. This parameter is read-only. Setting it will have no effect on the bond. It is retrieved from /sys/class/net/bondX/bonding/ad_partner_mac file on the system where the bond is located.
7.18.2. options
A list of option elements for a bonded interface. Each option contains property name and value attributes. Only required when adding bonded interfaces.
7.18.3. slaves
A list of slave NICs for a bonded interface. Only required when adding bonded interfaces.
| Name | Type | Summary |
|---|---|---|
|
|
The |
7.18.4. active_slave
The active_slave property of the bond in modes that support it (active-backup, balance-alb and balance-tlb). See Linux documentation for further details. This parameter is read-only. Setting it will have no effect on the bond. It is retrieved from /sys/class/net/bondX/bonding/active_slave file on the system where the bond is located.
For example:
GET /ovirt-engine/api/hosts/123/nics/321
GET /ovirt-engine/api/hosts/123/nics/321Will respond:
7.19. Bookmark struct
7.20. Boot struct
| Name | Type | Summary |
|---|---|---|
|
|
7.21. BootDevice enum
| Name | Summary |
|---|---|
|
| |
|
| |
|
|
7.23. BootProtocol enum
Defines the options of the IP address assignment method to a NIC.
| Name | Summary |
|---|---|
|
| Stateless address auto-configuration. |
|
| Dynamic host configuration protocol. |
|
| No address configuration. |
|
| Statically-defined address, mask and gateway. |
7.23.1. autoconf
Stateless address auto-configuration.
The mechanism is defined by RFC 4862. Please refer to this wikipedia article for more information.
The value is valid for IPv6 addresses only.
7.23.2. dhcp
Dynamic host configuration protocol.
Please refer to this wikipedia article for more information.
7.24. BrickProfileDetail struct
| Name | Type | Summary |
|---|---|---|
|
|
| Name | Type | Summary |
|---|---|---|
|
|
7.25. Cdrom struct
| Name | Type | Summary |
|---|---|---|
|
| Free text containing comments about this object. | |
|
| A human-readable description in plain text. | |
|
| ||
|
| A unique identifier. | |
|
| A human-readable name in plain text. |
| Name | Type | Summary |
|---|---|---|
|
| Optionally references to an instance type the device is used by. | |
|
| Optionally references to a template the device is used by. | |
|
|
Don’t use this element, use | |
|
| References to the virtual machines that are using this device. |
7.25.1. vms
References to the virtual machines that are using this device. A device may be used by several virtual machines; for example, a shared disk my be used simultaneously by two or more virtual machines.
7.26. Certificate struct
| Name | Type | Summary |
|---|---|---|
|
| Free text containing comments about this object. | |
|
| ||
|
| A human-readable description in plain text. | |
|
| A unique identifier. | |
|
| A human-readable name in plain text. | |
|
| ||
|
|
7.27. CloudInit struct
| Name | Type | Summary |
|---|---|---|
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
|
7.28. Cluster struct
Type representation of a cluster.
A JSON representation of a cluster
| Name | Type | Summary |
|---|---|---|
|
| ||
|
| Free text containing comments about this object. | |
|
| ||
|
| Custom scheduling policy properties of the cluster. | |
|
| A human-readable description in plain text. | |
|
| ||
|
| ||
|
| Custom fencing policy can be defined for a cluster. | |
|
| ||
|
| The name of the https://fedorahosted. | |
|
| ||
|
| A unique identifier. | |
|
| ||
|
| ||
|
| ||
|
| ||
|
| A human-readable name in plain text. | |
|
| ||
|
| Set of random number generator (RNG) sources required from each host in the cluster. | |
|
| ||
|
| ||
|
| Type of switch to be used by all networks in given cluster. | |
|
| ||
|
| ||
|
| ||
|
| The compatibility version of the cluster. | |
|
|
7.28.1. custom_scheduling_policy_properties
Custom scheduling policy properties of the cluster. These optional properties override the properties of the scheduling policy specified by the scheduling_policy link, and apply only for this specific cluster.
For example, to update the custom properties of the cluster, send a request:
PUT /ovirt-engine/api/clusters/123
PUT /ovirt-engine/api/clusters/123With a request body:
Update operations using the custom_scheduling_policy_properties attribute will not update the the properties of the scheduling policy specified by the scheduling_policy link, they will only be reflected on this specific cluster.
7.28.2. fencing_policy
Custom fencing policy can be defined for a cluster.
Here is an example:
PUT /ovirt-engine/api/cluster/123
PUT /ovirt-engine/api/cluster/123With request body:
7.28.3. gluster_tuned_profile
The name of the tuned profile to set on all the hosts in the cluster. This is not mandatory and relevant only for clusters with gluster service.
7.28.4. required_rng_sources
Set of random number generator (RNG) sources required from each host in the cluster.
When read, it returns the implicit urandom (for cluster version 4.1 and higher) or random (for cluster version 4.0 and lower) plus additional selected RNG sources. When written, the implicit urandom and random RNG sources cannot be removed.
Before version 4.1 of the engine, the set of required random number generators was completely controllable by the administrator; any source could be added or removed, including the random source. But starting with version 4.1, the urandom and random sources will always be part of the set, and can’t be removed.
Engine version 4.1 introduces a new RNG source urandom that replaces random RNG source in clusters with compatibility version 4.1 or higher.
7.28.5. version
The compatibility version of the cluster.
All hosts in this cluster must support at least this compatibility version.
For example:
GET /ovirt-engine/api/clusters/123
GET /ovirt-engine/api/clusters/123Will respond:
To update the compatibility version, use:
PUT /ovirt-engine/api/clusters/123
PUT /ovirt-engine/api/clusters/123With a request body:
In order to update the cluster compatibility version, all hosts in the cluster must support the new compatibility version.
| Name | Type | Summary |
|---|---|---|
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| A reference to the MAC pool used by this cluster. | |
|
| ||
|
| ||
|
| ||
|
| ||
|
| Reference to the default scheduling policy used by this cluster. |
7.28.6. scheduling_policy
Reference to the default scheduling policy used by this cluster.
The scheduling policy properties are taken by default from the referenced scheduling policy, but they are overridden by the properties specified in the custom_scheduling_policy_properties attribute for this cluster.
7.29. ClusterLevel struct
Describes the capabilities supported by a specific cluster level.
| Name | Type | Summary |
|---|---|---|
|
| Free text containing comments about this object. | |
|
| The CPU types supported by this cluster level. | |
|
| A human-readable description in plain text. | |
|
| A unique identifier. | |
|
| A human-readable name in plain text. | |
|
| The permits supported by this cluster level. |
7.30. Configuration struct
| Name | Type | Summary |
|---|---|---|
|
| The document describing the virtual machine. | |
|
|
7.30.1. data
The document describing the virtual machine.
Example of the OVF document:
7.31. ConfigurationType enum
| Name | Summary |
|---|---|
|
|
7.32. Console struct
| Name | Type | Summary |
|---|---|---|
|
|
7.33. Core struct
7.34. Cpu struct
| Name | Type | Summary |
|---|---|---|
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
|
7.35. CpuMode enum
| Name | Summary |
|---|---|
|
| |
|
| |
|
|
7.36. CpuProfile struct
| Name | Type | Summary |
|---|---|---|
|
| Free text containing comments about this object. | |
|
| A human-readable description in plain text. | |
|
| A unique identifier. | |
|
| A human-readable name in plain text. |
| Name | Type | Summary |
|---|---|---|
|
| ||
|
| ||
|
|
7.37. CpuTopology struct
7.38. CpuTune struct
| Name | Type | Summary |
|---|---|---|
|
|
7.39. CpuType struct
Describes a supported CPU type.
| Name | Type | Summary |
|---|---|---|
|
| The architecture of the CPU. | |
|
| The level of the CPU type. | |
|
|
The name of the CPU type, for example |
7.40. CreationStatus enum
| Name | Summary |
|---|---|
|
| |
|
| |
|
| |
|
|
7.41. CustomProperty struct
7.42. DataCenter struct
| Name | Type | Summary |
|---|---|---|
|
| Free text containing comments about this object. | |
|
| A human-readable description in plain text. | |
|
| A unique identifier. | |
|
| ||
|
| A human-readable name in plain text. | |
|
| ||
|
| ||
|
| ||
|
| ||
|
| The compatibility version of the data center. |
7.42.1. version
The compatibility version of the data center.
All clusters in this data center must already be set to at least this compatibility version.
For example:
GET /ovirt-engine/api/datacenters/123
GET /ovirt-engine/api/datacenters/123Will respond:
To update the compatibility version, use:
PUT /ovirt-engine/api/datacenters/123
PUT /ovirt-engine/api/datacenters/123With a request body:
| Name | Type | Summary |
|---|---|---|
|
| Reference to clusters inside this data center. | |
|
| Reference to ISCSI bonds used by this data center. | |
|
| Reference to the MAC pool used by this data center. | |
|
| Reference to networks attached to this data center. | |
|
| Reference to permissions assigned to this data center. | |
|
| Reference to quality of service used by this data center. | |
|
| Reference to quotas assigned to this data center. | |
|
| Reference to storage domains attached to this data center. |
7.43. DataCenterStatus enum
| Name | Summary |
|---|---|
|
| |
|
| |
|
| |
|
| |
|
| |
|
|
7.44. Device struct
A device wraps links to potential parents of a device.
| Name | Type | Summary |
|---|---|---|
|
| Free text containing comments about this object. | |
|
| A human-readable description in plain text. | |
|
| A unique identifier. | |
|
| A human-readable name in plain text. |
| Name | Type | Summary |
|---|---|---|
|
| Optionally references to an instance type the device is used by. | |
|
| Optionally references to a template the device is used by. | |
|
|
Don’t use this element, use | |
|
| References to the virtual machines that are using this device. |
7.44.1. vms
References to the virtual machines that are using this device. A device may be used by several virtual machines; for example, a shared disk my be used simultaneously by two or more virtual machines.
7.45. Disk struct
Represents a virtual disk device.
| Name | Type | Summary |
|---|---|---|
|
| Indicates if the disk is visible to the virtual machine. | |
|
| The actual size of the disk, in bytes. | |
|
| ||
|
| Indicates if the disk is marked as bootable. | |
|
| Free text containing comments about this object. | |
|
| A human-readable description in plain text. | |
|
| The underlying storage format. | |
|
| A unique identifier. | |
|
| ||
|
| The initial size of a sparse image disk created on block storage, in bytes. | |
|
| The type of interface driver used to connect the disk device to the virtual machine. | |
|
| ||
|
| ||
|
| A human-readable name in plain text. | |
|
| Indicates if disk errors should not cause virtual machine to be paused and, instead, disk errors should be propagated to the the guest operating system. | |
|
| The virtual size of the disk, in bytes. | |
|
| The underlying QCOW version of a QCOW volume. | |
|
| Indicates if the disk is in read-only mode. | |
|
| ||
|
| Indicates if the disk can be attached to multiple virtual machines. | |
|
| Indicates if the physical storage for the disk should not be preallocated. | |
|
| The status of the disk device. | |
|
| ||
|
| ||
|
| Indicates if the disk’s blocks will be read back as zeros after it is deleted: - On block storage, the disk will be zeroed and only then deleted. |
7.45.1. active
Indicates if the disk is visible to the virtual machine.
When adding a disk attachment to a virtual machine, the server accepts requests that don’t contain this attribute, but the effect is then undefined. In some cases the disk will be automatically activated and in other cases it won’t. To avoid issues it is strongly recommended to always include the this attribute with the desired value.
7.45.2. actual_size
The actual size of the disk, in bytes.
The actual size is the number of bytes actually used by the disk, and it will be smaller than the provisioned size for disks that use the cow format.
7.45.3. bootable
Indicates if the disk is marked as bootable.
This attribute only makes sense for disks that are actually connected to virtual machines, and in version 4 of the API it has been moved to the DiskAttachment type. It is preserved here only for backwards compatibility, and it will be removed in the future.
7.45.4. initial_size
The initial size of a sparse image disk created on block storage, in bytes.
The initial size is the number of bytes a sparse disk is initially allocated with when created on block storage. The initial size will be smaller than the provisioned size. If not specified the default initial size used by the system will be allocated.
7.45.5. interface
The type of interface driver used to connect the disk device to the virtual machine.
This attribute only makes sense for disks that are actually connected to virtual machines, and in version 4 of the API it has been moved to the DiskAttachment type. It is preserved here only for backwards compatibility, and it will be removed in the future.
7.45.6. provisioned_size
The virtual size of the disk, in bytes.
This attribute is mandatory when creating a new disk.
7.45.7. qcow_version
The underlying QCOW version of a QCOW volume. The QCOW version specifies to the qemu which qemu version the volume supports. This field can be updated using the update API and will be reported only for QCOW volumes, it is determined by the storage domain’s version which the disk is created on. Storage domains with version lower than V4 support QCOW2 volumes, while V4 storage domains also support QCOW2v3. For more information about features of the different QCOW versions, see here.
7.45.9. wipe_after_delete
Indicates if the disk’s blocks will be read back as zeros after it is deleted:
- On block storage, the disk will be zeroed and only then deleted.
- On file storage, since the file system already guarantees that previously removed blocks are read back as zeros, the disk will be deleted immediately.
| Name | Type | Summary |
|---|---|---|
|
| ||
|
| Optionally references to an instance type the device is used by. | |
|
| ||
|
| ||
|
| ||
|
| ||
|
| Statistics exposed by the disk. | |
|
| ||
|
| The storage domains associated with this disk. | |
|
| Optionally references to a template the device is used by. | |
|
|
Don’t use this element, use | |
|
| References to the virtual machines that are using this device. |
7.45.10. statistics
Statistics exposed by the disk. For example:
These statistics aren’t directly included when the disk is retrieved, only a link. To obtain the statistics follow that link:
GET /ovirt-engine/api/disks/123/statistics
GET /ovirt-engine/api/disks/123/statistics7.45.11. storage_domains
The storage domains associated with this disk.
Only required when the first disk is being added to a virtual machine that was not itself created from a template.
7.45.12. vms
References to the virtual machines that are using this device. A device may be used by several virtual machines; for example, a shared disk my be used simultaneously by two or more virtual machines.
7.46. DiskAttachment struct
Describes how a disk is attached to a virtual machine.
| Name | Type | Summary |
|---|---|---|
|
| Defines whether the disk is active in the virtual machine it’s attached to. | |
|
| Defines whether the disk is bootable. | |
|
| Free text containing comments about this object. | |
|
| A human-readable description in plain text. | |
|
| A unique identifier. | |
|
| The type of interface driver used to connect the disk device to the virtual machine. | |
|
| The logical name of the virtual machine’s disk, as seen from inside the virtual machine. | |
|
| A human-readable name in plain text. | |
|
| Defines whether the virtual machine passes discard commands to the storage. | |
|
| Indicates whether the disk is connected to the virtual machine as read only. | |
|
| Defines whether SCSI reservation is enabled for this disk. |
7.46.1. active
Defines whether the disk is active in the virtual machine it’s attached to.
A disk attached to a virtual machine in an active status is connected to the virtual machine at run time and can be used.
7.46.2. logical_name
The logical name of the virtual machine’s disk, as seen from inside the virtual machine.
The logical name of a disk is reported only when the guest agent is installed and running inside the virtual machine.
For example, if the guest operating system is Linux and the disk is connected via a VirtIO interface, the logical name will be reported as /dev/vda:
<disk_attachment> ... <logical_name>/dev/vda</logical_name> </disk_attachment>
<disk_attachment>
...
<logical_name>/dev/vda</logical_name>
</disk_attachment>
If the guest operating system is Windows, the logical name will be reported as \\.\PHYSICALDRIVE0.
7.46.3. read_only
Indicates whether the disk is connected to the virtual machine as read only.
When adding a new disk attachment the default value is false.
<disk_attachment> ... <read_only>true</read_only> </disk_attachment>
<disk_attachment>
...
<read_only>true</read_only>
</disk_attachment>7.46.4. uses_scsi_reservation
Defines whether SCSI reservation is enabled for this disk.
Virtual machines with VIRTIO-SCSI passthrough enabled can set persistent SCSI reservations on disks. If they set persistent SCSI reservations, those virtual machines cannot be migrated to a different host because they would lose access to the disk, because SCSI reservations are specific to SCSI initiators, and therefore hosts. This scenario cannot be automatically detected. To avoid migrating these virtual machines, the user can set this attribute to true, to indicate the virtual machine is using SCSI reservations.
7.47. DiskFormat enum
The underlying storage format of disks.
| Name | Summary |
|---|---|
|
| The Copy On Write format allows snapshots, with a small performance overhead. |
|
| The raw format does not allow snapshots, but offers improved performance. |
7.48. DiskInterface enum
| Name | Summary |
|---|---|
|
| |
|
| |
|
| |
|
|
7.49. DiskProfile struct
| Name | Type | Summary |
|---|---|---|
|
| Free text containing comments about this object. | |
|
| A human-readable description in plain text. | |
|
| A unique identifier. | |
|
| A human-readable name in plain text. |
| Name | Type | Summary |
|---|---|---|
|
| ||
|
| ||
|
|
7.50. DiskSnapshot struct
| Name | Type | Summary |
|---|---|---|
|
| Indicates if the disk is visible to the virtual machine. | |
|
| The actual size of the disk, in bytes. | |
|
| ||
|
| Indicates if the disk is marked as bootable. | |
|
| Free text containing comments about this object. | |
|
| A human-readable description in plain text. | |
|
| The underlying storage format. | |
|
| A unique identifier. | |
|
| ||
|
| The initial size of a sparse image disk created on block storage, in bytes. | |
|
| The type of interface driver used to connect the disk device to the virtual machine. | |
|
| ||
|
| ||
|
| A human-readable name in plain text. | |
|
| Indicates if disk errors should not cause virtual machine to be paused and, instead, disk errors should be propagated to the the guest operating system. | |
|
| The virtual size of the disk, in bytes. | |
|
| The underlying QCOW version of a QCOW volume. | |
|
| Indicates if the disk is in read-only mode. | |
|
| ||
|
| Indicates if the disk can be attached to multiple virtual machines. | |
|
| Indicates if the physical storage for the disk should not be preallocated. | |
|
| The status of the disk device. | |
|
| ||
|
| ||
|
| Indicates if the disk’s blocks will be read back as zeros after it is deleted: - On block storage, the disk will be zeroed and only then deleted. |
7.50.1. active
Indicates if the disk is visible to the virtual machine.
When adding a disk attachment to a virtual machine, the server accepts requests that don’t contain this attribute, but the effect is then undefined. In some cases the disk will be automatically activated and in other cases it won’t. To avoid issues it is strongly recommended to always include the this attribute with the desired value.
7.50.2. actual_size
The actual size of the disk, in bytes.
The actual size is the number of bytes actually used by the disk, and it will be smaller than the provisioned size for disks that use the cow format.
7.50.3. bootable
Indicates if the disk is marked as bootable.
This attribute only makes sense for disks that are actually connected to virtual machines, and in version 4 of the API it has been moved to the DiskAttachment type. It is preserved here only for backwards compatibility, and it will be removed in the future.
7.50.4. initial_size
The initial size of a sparse image disk created on block storage, in bytes.
The initial size is the number of bytes a sparse disk is initially allocated with when created on block storage. The initial size will be smaller than the provisioned size. If not specified the default initial size used by the system will be allocated.
7.50.5. interface
The type of interface driver used to connect the disk device to the virtual machine.
This attribute only makes sense for disks that are actually connected to virtual machines, and in version 4 of the API it has been moved to the DiskAttachment type. It is preserved here only for backwards compatibility, and it will be removed in the future.
7.50.6. provisioned_size
The virtual size of the disk, in bytes.
This attribute is mandatory when creating a new disk.
7.50.7. qcow_version
The underlying QCOW version of a QCOW volume. The QCOW version specifies to the qemu which qemu version the volume supports. This field can be updated using the update API and will be reported only for QCOW volumes, it is determined by the storage domain’s version which the disk is created on. Storage domains with version lower than V4 support QCOW2 volumes, while V4 storage domains also support QCOW2v3. For more information about features of the different QCOW versions, see here.
7.50.9. wipe_after_delete
Indicates if the disk’s blocks will be read back as zeros after it is deleted:
- On block storage, the disk will be zeroed and only then deleted.
- On file storage, since the file system already guarantees that previously removed blocks are read back as zeros, the disk will be deleted immediately.
| Name | Type | Summary |
|---|---|---|
|
| ||
|
| ||
|
| Optionally references to an instance type the device is used by. | |
|
| ||
|
| ||
|
| ||
|
| ||
|
| Statistics exposed by the disk. | |
|
| ||
|
| The storage domains associated with this disk. | |
|
| Optionally references to a template the device is used by. | |
|
|
Don’t use this element, use | |
|
| References to the virtual machines that are using this device. |
7.50.10. statistics
Statistics exposed by the disk. For example:
These statistics aren’t directly included when the disk is retrieved, only a link. To obtain the statistics follow that link:
GET /ovirt-engine/api/disks/123/statistics
GET /ovirt-engine/api/disks/123/statistics7.50.11. storage_domains
The storage domains associated with this disk.
Only required when the first disk is being added to a virtual machine that was not itself created from a template.
7.50.12. vms
References to the virtual machines that are using this device. A device may be used by several virtual machines; for example, a shared disk my be used simultaneously by two or more virtual machines.
7.51. DiskStatus enum
| Name | Summary |
|---|---|
|
| |
|
| |
|
|
7.52. DiskStorageType enum
| Name | Summary |
|---|---|
|
| |
|
| |
|
|
7.53. DiskType enum
| Name | Summary |
|---|---|
|
| |
|
|
7.54. Display struct
| Name | Type | Summary |
|---|---|---|
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
|
7.55. DisplayType enum
| Name | Summary |
|---|---|
|
| |
|
|
7.56. Dns struct
Represents the DNS resolver configuration.
7.57. DnsResolverConfiguration struct
Represents the DNS resolver configuration.
| Name | Type | Summary |
|---|---|---|
|
| Array of addresses of name servers. |
7.57.1. name_servers
Array of addresses of name servers. Either IPv4 or IPv6 addresses may be specified.
7.58. Domain struct
This type represents a directory service domain.
| Name | Type | Summary |
|---|---|---|
|
| Free text containing comments about this object. | |
|
| A human-readable description in plain text. | |
|
| A unique identifier. | |
|
| A human-readable name in plain text. | |
|
|
| Name | Type | Summary |
|---|---|---|
|
| A reference to all groups in the directory service. | |
|
| A reference to a list of all users in the directory service. |
7.58.1. users
A reference to a list of all users in the directory service. This information is used to add new users to the Red Hat Virtualization environment.
7.59. EntityExternalStatus enum
Type representing an external entity status.
| Name | Summary |
|---|---|
|
| The external entity status is erroneous. |
|
| The external entity has an issue that causes failures. |
|
| There external entity status is okay but with some information that might be relevant. |
|
| The external entity status is okay. |
|
| The external entity status is okay but with an issue that might require attention. |
7.59.1. error
The external entity status is erroneous. This might require a moderate attention.
7.59.2. failure
The external entity has an issue that causes failures. This might require immediate attention.
7.60. EntityProfileDetail struct
| Name | Type | Summary |
|---|---|---|
|
|
7.61. ErrorHandling struct
| Name | Type | Summary |
|---|---|---|
|
|
7.62. Event struct
Type representing an event.
| Name | Type | Summary |
|---|---|---|
|
| The event code. | |
|
| Free text containing comments about this object. | |
|
| The event correlation identifier. | |
|
| Free text representing custom event data. | |
|
| A custom event identifier. | |
|
| A human-readable description in plain text. | |
|
| Defines the flood rate. | |
|
| A unique identifier. | |
|
| A human-readable name in plain text. | |
|
| Free text identifying the origin of the event. | |
|
| The event severity. | |
|
| The event time. |
7.62.1. correlation_id
The event correlation identifier. Used in order to correlate several events together.
7.62.2. flood_rate
Defines the flood rate. This prevents flooding in case an event appeared more than once in the defined rate. Defaults is 30 seconds.
| Name | Type | Summary |
|---|---|---|
|
| Reference to the cluster service. | |
|
| Reference to the data center service. | |
|
| Reference to the host service. | |
|
| Reference to the storage domain service. | |
|
| Reference to the template service. | |
|
| Reference to the user service. | |
|
| Reference to the virtual machine service. |
7.62.3. cluster
Reference to the cluster service. Event can be associated with a cluster.
7.62.4. data_center
Reference to the data center service. Event can be associated with a data center.
7.62.5. host
Reference to the host service. Event can be associated with a host.
7.62.6. storage_domain
Reference to the storage domain service. Event can be associated with a storage domain.
7.62.7. template
Reference to the template service. Event can be associated with a template.
7.62.8. user
Reference to the user service. Event can be associated with a user.
7.62.9. vm
Reference to the virtual machine service. Event can be associated with a virtual machine.
7.63. ExternalComputeResource struct
| Name | Type | Summary |
|---|---|---|
|
| Free text containing comments about this object. | |
|
| A human-readable description in plain text. | |
|
| A unique identifier. | |
|
| A human-readable name in plain text. | |
|
| ||
|
| ||
|
|
| Name | Type | Summary |
|---|---|---|
|
|
7.64. ExternalDiscoveredHost struct
| Name | Type | Summary |
|---|---|---|
|
| Free text containing comments about this object. | |
|
| A human-readable description in plain text. | |
|
| A unique identifier. | |
|
| ||
|
| ||
|
| ||
|
| A human-readable name in plain text. | |
|
|
| Name | Type | Summary |
|---|---|---|
|
|
7.65. ExternalHost struct
| Name | Type | Summary |
|---|---|---|
|
| ||
|
| Free text containing comments about this object. | |
|
| A human-readable description in plain text. | |
|
| A unique identifier. | |
|
| A human-readable name in plain text. |
| Name | Type | Summary |
|---|---|---|
|
|
7.66. ExternalHostGroup struct
| Name | Type | Summary |
|---|---|---|
|
| ||
|
| Free text containing comments about this object. | |
|
| A human-readable description in plain text. | |
|
| ||
|
| A unique identifier. | |
|
| A human-readable name in plain text. | |
|
| ||
|
|
| Name | Type | Summary |
|---|---|---|
|
|
7.67. ExternalHostProvider struct
| Name | Type | Summary |
|---|---|---|
|
| Defines the external provider authentication URL address. | |
|
| Free text containing comments about this object. | |
|
| A human-readable description in plain text. | |
|
| A unique identifier. | |
|
| A human-readable name in plain text. | |
|
| Defines password for the user during the authentication process. | |
|
| Array of provider name/value properties. | |
|
| Defines whether provider authentication is required or not. | |
|
| Defines URL address of the external provider. | |
|
| Defines user name to be used during authentication process. |
7.67.1. requires_authentication
Defines whether provider authentication is required or not.
If authentication is required, both username and password attributes will be used during authentication.
| Name | Type | Summary |
|---|---|---|
|
| ||
|
| ||
|
| ||
|
| ||
|
|
7.68. ExternalProvider struct
Represents an external provider.
| Name | Type | Summary |
|---|---|---|
|
| Defines the external provider authentication URL address. | |
|
| Free text containing comments about this object. | |
|
| A human-readable description in plain text. | |
|
| A unique identifier. | |
|
| A human-readable name in plain text. | |
|
| Defines password for the user during the authentication process. | |
|
| Array of provider name/value properties. | |
|
| Defines whether provider authentication is required or not. | |
|
| Defines URL address of the external provider. | |
|
| Defines user name to be used during authentication process. |
7.68.1. requires_authentication
Defines whether provider authentication is required or not.
If authentication is required, both username and password attributes will be used during authentication.
7.69. ExternalStatus enum
| Name | Summary |
|---|---|
|
| |
|
| |
|
| |
|
| |
|
|
7.70. ExternalSystemType enum
Represents the type of the external system that is associated with the step.
| Name | Summary |
|---|---|
|
|
Represents |
|
|
Represents |
7.71. ExternalVmImport struct
Describes the parameters for the virtual machine import operation from an external system.
| Name | Type | Summary |
|---|---|---|
|
| The name of the virtual machine to be imported, as is defined within the external system. | |
|
| The password to authenticate against the external hypervisor system. | |
|
| The type of external virtual machine provider. | |
|
|
Specifies the disk allocation policy of the resulting virtual machine: | |
|
|
The URL to be passed to the | |
|
| The username to authenticate against the external hypervisor system. |
7.71.1. url
The URL to be passed to the virt-v2v tool for conversion.
Example:
vpx://wmware_user@vcenter-host/DataCenter/Cluster/esxi-host?no_verify=1
vpx://wmware_user@vcenter-host/DataCenter/Cluster/esxi-host?no_verify=1More examples can be found at http://libguestfs.org/virt-v2v.1.html.
| Name | Type | Summary |
|---|---|---|
|
| Specifies the target cluster for the resulting virtual machine. | |
|
| Optional. | |
|
| Optional. | |
|
| Optional. | |
|
| Optional. | |
|
| Specifies the target storage domain for converted disks. | |
|
| The virtual machine entity used to specify a name for the newly created virtual machine. |
7.71.2. cpu_profile
Optional. Specifies the CPU profile of the resulting virtual machine.
7.71.3. drivers_iso
Optional. The name of the ISO containing drivers that can be used during the virt-v2v conversion process.
7.71.4. host
Optional. Specifies the host (using host’s ID) to be used for the conversion process. If not specified, one is selected automatically.
7.71.5. quota
Optional. Specifies the quota that will be applied to the resulting virtual machine.
7.71.6. vm
The virtual machine entity used to specify a name for the newly created virtual machine.
If a name is not specified, the source virtual machine name will be used.
7.72. ExternalVmProviderType enum
Describes the type of external hypervisor system.
| Name | Summary |
|---|---|
|
| |
|
| |
|
|
7.73. Fault struct
7.74. FenceType enum
Type representing the type of the fence operation.
| Name | Summary |
|---|---|
|
| Manual host fencing via power management. |
|
| Restart the host via power management. |
|
| Start the host via power management. |
|
| Check the host power status via power management. |
|
| Stop the host via power management. |
7.75. FencingPolicy struct
Type representing a cluster fencing policy.
| Name | Type | Summary |
|---|---|---|
|
| Enable or disable fencing on this cluster. | |
|
| If enabled, we will not fence a host in case more than a configurable percentage of hosts in the cluster lost connectivity as well. | |
|
| A flag indicating if fencing should be skipped if Gluster bricks are up and running in the host being fenced. | |
|
| A flag indicating if fencing should be skipped if Gluster bricks are up and running and Gluster quorum will not be met without those bricks. | |
|
| If enabled, we will skip fencing in case the host maintains its lease in the storage. |
7.75.1. skip_if_connectivity_broken
If enabled, we will not fence a host in case more than a configurable percentage of hosts in the cluster lost connectivity as well. This comes to prevent fencing storm in cases where there is a global networking issue in the cluster.
7.75.2. skip_if_gluster_bricks_up
A flag indicating if fencing should be skipped if Gluster bricks are up and running in the host being fenced. This flag is optional, and the default value is false.
7.75.3. skip_if_gluster_quorum_not_met
A flag indicating if fencing should be skipped if Gluster bricks are up and running and Gluster quorum will not be met without those bricks. This flag is optional, and the default value is false.
7.75.4. skip_if_sd_active
If enabled, we will skip fencing in case the host maintains its lease in the storage. It means that if the host still has storage access then it won’t get fenced.
7.76. File struct
| Name | Type | Summary |
|---|---|---|
|
| Free text containing comments about this object. | |
|
| ||
|
| A human-readable description in plain text. | |
|
| A unique identifier. | |
|
| A human-readable name in plain text. | |
|
|
| Name | Type | Summary |
|---|---|---|
|
|
7.77. Filter struct
| Name | Type | Summary |
|---|---|---|
|
| Free text containing comments about this object. | |
|
| A human-readable description in plain text. | |
|
| A unique identifier. | |
|
| A human-readable name in plain text. | |
|
|
| Name | Type | Summary |
|---|---|---|
|
|
7.78. Floppy struct
| Name | Type | Summary |
|---|---|---|
|
| Free text containing comments about this object. | |
|
| A human-readable description in plain text. | |
|
| ||
|
| A unique identifier. | |
|
| A human-readable name in plain text. |
| Name | Type | Summary |
|---|---|---|
|
| Optionally references to an instance type the device is used by. | |
|
| Optionally references to a template the device is used by. | |
|
|
Don’t use this element, use | |
|
| References to the virtual machines that are using this device. |
7.78.1. vms
References to the virtual machines that are using this device. A device may be used by several virtual machines; for example, a shared disk my be used simultaneously by two or more virtual machines.
7.79. FopStatistic struct
| Name | Type | Summary |
|---|---|---|
|
| ||
|
|
7.80. GlusterBrick struct
| Name | Type | Summary |
|---|---|---|
|
| ||
|
| Free text containing comments about this object. | |
|
| A human-readable description in plain text. | |
|
| ||
|
| ||
|
| ||
|
| A unique identifier. | |
|
| ||
|
| ||
|
| A human-readable name in plain text. | |
|
| ||
|
| ||
|
| ||
|
|
| Name | Type | Summary |
|---|---|---|
|
| ||
|
| Optionally references to an instance type the device is used by. | |
|
| ||
|
| Optionally references to a template the device is used by. | |
|
|
Don’t use this element, use | |
|
| References to the virtual machines that are using this device. |
7.80.1. vms
References to the virtual machines that are using this device. A device may be used by several virtual machines; for example, a shared disk my be used simultaneously by two or more virtual machines.
7.81. GlusterBrickAdvancedDetails struct
| Name | Type | Summary |
|---|---|---|
|
| Free text containing comments about this object. | |
|
| A human-readable description in plain text. | |
|
| ||
|
| ||
|
| ||
|
| A unique identifier. | |
|
| ||
|
| ||
|
| A human-readable name in plain text. | |
|
| ||
|
|
| Name | Type | Summary |
|---|---|---|
|
| Optionally references to an instance type the device is used by. | |
|
| Optionally references to a template the device is used by. | |
|
|
Don’t use this element, use | |
|
| References to the virtual machines that are using this device. |
7.81.1. vms
References to the virtual machines that are using this device. A device may be used by several virtual machines; for example, a shared disk my be used simultaneously by two or more virtual machines.
7.82. GlusterBrickMemoryInfo struct
| Name | Type | Summary |
|---|---|---|
|
|
7.83. GlusterBrickStatus enum
| Name | Summary |
|---|---|
|
|
Brick is in |
|
| When the status cannot be determined due to host being non-responsive. |
|
|
Brick is in |
7.84. GlusterClient struct
7.85. GlusterHook struct
| Name | Type | Summary |
|---|---|---|
|
| ||
|
| Free text containing comments about this object. | |
|
| ||
|
| ||
|
| ||
|
| ||
|
| A human-readable description in plain text. | |
|
| ||
|
| A unique identifier. | |
|
| A human-readable name in plain text. | |
|
| ||
|
|
| Name | Type | Summary |
|---|---|---|
|
| ||
|
|
7.86. GlusterHookStatus enum
| Name | Summary |
|---|---|
|
| Hook is disabled in the cluster. |
|
| Hook is enabled in the cluster. |
|
| Unknown/missing hook status. |
7.87. GlusterMemoryPool struct
| Name | Type | Summary |
|---|---|---|
|
| ||
|
| ||
|
| Free text containing comments about this object. | |
|
| A human-readable description in plain text. | |
|
| ||
|
| A unique identifier. | |
|
| ||
|
| ||
|
| A human-readable name in plain text. | |
|
| ||
|
| ||
|
|
7.88. GlusterServerHook struct
| Name | Type | Summary |
|---|---|---|
|
| ||
|
| Free text containing comments about this object. | |
|
| ||
|
| A human-readable description in plain text. | |
|
| A unique identifier. | |
|
| A human-readable name in plain text. | |
|
|
| Name | Type | Summary |
|---|---|---|
|
|
7.89. GlusterState enum
| Name | Summary |
|---|---|
|
| |
|
| |
|
|
7.90. GlusterVolume struct
| Name | Type | Summary |
|---|---|---|
|
| Free text containing comments about this object. | |
|
| A human-readable description in plain text. | |
|
| ||
|
| A unique identifier. | |
|
| A human-readable name in plain text. | |
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
|
| Name | Type | Summary |
|---|---|---|
|
| ||
|
| ||
|
|
7.91. GlusterVolumeProfileDetails struct
| Name | Type | Summary |
|---|---|---|
|
| ||
|
| Free text containing comments about this object. | |
|
| A human-readable description in plain text. | |
|
| A unique identifier. | |
|
| A human-readable name in plain text. | |
|
|
7.92. GlusterVolumeStatus enum
| Name | Summary |
|---|---|
|
| Volume needs to be started, for clients to be able to mount and use it. |
|
| When the status cannot be determined due to host being non-responsive. |
|
| Volume is started, and can be mounted and used by clients. |
7.93. GlusterVolumeType enum
Type representing the type of Gluster Volume.
| Name | Summary |
|---|---|
|
| Dispersed volumes are based on erasure codes, providing space-efficient protection against disk or server failures. |
|
| Distributed volumes distributes files throughout the bricks in the volume. |
|
| Distributed dispersed volumes distribute files across dispersed subvolumes. |
|
| Distributed replicated volumes distributes files across replicated bricks in the volume. |
|
| Distributed striped volumes stripe data across two or more nodes in the cluster. |
|
| Distributed striped replicated volumes distributes striped data across replicated bricks in the cluster. |
|
| Replicated volumes replicates files across bricks in the volume. |
|
| Striped volumes stripes data across bricks in the volume. |
|
| Striped replicated volumes stripes data across replicated bricks in the cluster. |
7.93.1. disperse
Dispersed volumes are based on erasure codes, providing space-efficient protection against disk or server failures.
Dispersed volumes an encoded fragment of the original file to each brick in a way that only a subset of the fragments is needed to recover the original file. The number of bricks that can be missing without losing access to data is configured by the administrator on volume creation time.
7.93.2. distribute
Distributed volumes distributes files throughout the bricks in the volume.
Distributed volumes can be used where the requirement is to scale storage and the redundancy is either not important or is provided by other hardware/software layers.
7.93.3. distributed_disperse
Distributed dispersed volumes distribute files across dispersed subvolumes.
This has the same advantages of distribute replicate volumes, but using disperse to store the data into the bricks.
7.93.4. distributed_replicate
Distributed replicated volumes distributes files across replicated bricks in the volume.
Distributed replicated volumes can be used in environments where the requirement is to scale storage and high-reliability is critical. Distributed replicated volumes also offer improved read performance in most environments.
7.93.5. distributed_stripe
Distributed striped volumes stripe data across two or more nodes in the cluster.
Distributed striped volumes should be used where the requirement is to scale storage and in high concurrency environments accessing very large files is critical.
Note: With the introduction of Sharding in Glusterfs 3.7 releases, striped volumes are not recommended and it will be removed in future release.
7.93.6. distributed_striped_replicate
Distributed striped replicated volumes distributes striped data across replicated bricks in the cluster.
For best results, distributed striped replicated volumes should be used in highly concurrent environments where parallel access of very large files and performance is critical.
Note: With the introduction of Sharding in Glusterfs 3.7 releases, striped volumes are not recommended and it will be removed in future release.
7.93.7. replicate
Replicated volumes replicates files across bricks in the volume.
Replicated volumes can be used in environments where high-availability and high-reliability are critical.
7.93.8. stripe
Striped volumes stripes data across bricks in the volume.
For best results, striped volumes should only in high concurrency environments accessing very large files.
Note: With the introduction of Sharding in Glusterfs 3.7 releases, striped volumes are not recommended and it will be removed in future release.
7.93.9. striped_replicate
Striped replicated volumes stripes data across replicated bricks in the cluster.
For best results, striped replicated volumes should be used in highly concurrent environments where there is parallel access of very large files and performance is critical.
Note: With the introduction of Sharding in Glusterfs 3.7 releases, striped volumes are not recommended and it will be removed in future release.
7.94. GracePeriod struct
| Name | Type | Summary |
|---|---|---|
|
|
7.95. GraphicsConsole struct
| Name | Type | Summary |
|---|---|---|
|
| ||
|
| Free text containing comments about this object. | |
|
| A human-readable description in plain text. | |
|
| A unique identifier. | |
|
| A human-readable name in plain text. | |
|
| ||
|
| ||
|
|
| Name | Type | Summary |
|---|---|---|
|
| ||
|
| ||
|
|
7.96. GraphicsType enum
| Name | Summary |
|---|---|
|
| |
|
|
7.97. Group struct
This type represents all groups in the directory service.
| Name | Type | Summary |
|---|---|---|
|
| Free text containing comments about this object. | |
|
| A human-readable description in plain text. | |
|
| The containing directory service domain id. | |
|
| A unique identifier. | |
|
| A human-readable name in plain text. | |
|
| Namespace where group resides. |
| Name | Type | Summary |
|---|---|---|
|
| A link to the domain containing this group. | |
|
| A link to the permissions sub-collection for permissions attached to this group. | |
|
| A link to the roles sub-collection for roles attached to this group. | |
|
| A link to the tags sub-collection for tags attached to this group. |
7.97.1. roles
A link to the roles sub-collection for roles attached to this group.
Used only to represent the initial role assignments for a new group; thereafter, modification of role assignments is only supported via the roles sub-collection.
7.98. GuestOperatingSystem struct
7.99. HardwareInformation struct
7.100. HighAvailability struct
| Name | Type | Summary |
|---|---|---|
|
| ||
|
| Indicates the priority of the virtual machine inside the run and migration queues. |
7.100.1. priority
Indicates the priority of the virtual machine inside the run and migration queues.
Virtual machines with higher priorities will be started and migrated before virtual machines with lower priorities.
The value is an integer between 0 and 100. The higher the value, the higher the priority.
The graphical user interface (GUI) does not allow specifying all the possible values, instead it only allows you to select Low, Medium or High. When the value is set using the API, the GUI will set the label as follows:
| API Value | GUI Label |
|---|---|
| 0 - 25 | Low |
| 26 - 74 | Medium |
| 75 - 100 | High |
When the label is selected using the GUI, the value in the API will be set as follows:
| GUI Label | API Value |
|---|---|
| Low | 1 |
| Medium | 50 |
| High | 100 |
7.101. Hook struct
Represents a hook.
| Name | Type | Summary |
|---|---|---|
|
| Free text containing comments about this object. | |
|
| A human-readable description in plain text. | |
|
| Name of the event to execute the hook on. | |
|
| A unique identifier. | |
|
| Checksum of the hook. | |
|
| A human-readable name in plain text. |
| Name | Type | Summary |
|---|---|---|
|
| Reference to the host the hook belongs to. |
7.102. HookContentType enum
Represents content type of hook script.
| Name | Summary |
|---|---|
|
| Binary content type of the hook. |
|
| Text content type of the hook. |
7.103. HookStage enum
| Name | Summary |
|---|---|
|
| |
|
|
7.104. HookStatus enum
Type represents the status of a hook.
| Name | Summary |
|---|---|
|
| Hook is disabled. |
|
| Hook is enabled. |
|
| Hook is missing. |
7.105. Host struct
Type representing a host.
| Name | Type | Summary |
|---|---|---|
|
| The host address (FQDN/IP). | |
|
| The host auto non uniform memory access (NUMA) status. | |
|
| The host certificate. | |
|
| Free text containing comments about this object. | |
|
| The CPU type of this host. | |
|
| A human-readable description in plain text. | |
|
| Specifies whether host device passthrough is enabled on this host. | |
|
| Optionally specify the display address of this host explicitly. | |
|
| The host external status. | |
|
| The host hardware information. | |
|
| The hosted engine status on this host. | |
|
| A unique identifier. | |
|
| The host iSCSI details. | |
|
| The host KDUMP status. | |
|
| Kernel SamePage Merging (KSM) reduces references to memory pages from multiple identical pages to a single page reference. | |
|
| The host libvirt version. | |
|
| The max scheduling memory on this host in bytes. | |
|
| The amount of physical memory on this host in bytes. | |
|
| A human-readable name in plain text. | |
|
| Specifies whether non uniform memory access (NUMA) is supported on this host. | |
|
| The operating system on this host. | |
|
| Specifies whether we should override firewall definitions. | |
|
| The host port. | |
|
| The host power management definitions. | |
|
| The protocol that the engine uses to communicate with the host. | |
|
| When creating a new host, a root password is required if the password authentication method is chosen, but this is not subsequently included in the representation. | |
|
| The host SElinux status. | |
|
| The host storage pool manager (SPM) status and definition. | |
|
| The SSH definitions. | |
|
| The host status. | |
|
| The host status details. | |
|
| The virtual machine summary - how many are active, migrating and total. | |
|
| Transparent huge page support expands the size of memory pages beyond the standard 4 KiB limit. | |
|
| Indicates if the host contains a full installation of the operating system or a scaled-down version intended only to host virtual machines. | |
|
| Specifies whether there is an oVirt-related update on this host. | |
|
| The version of VDSM. |
7.105.1. external_status
The host external status. This can be used by third-party software to change the host external status in case of an issue. This has no effect on the host lifecycle, unless a third-party software checks for this status and acts accordingly.
7.105.2. kdump_status
The host KDUMP status. KDUMP happens when the host kernel has crashed and it is now going through memory dumping.
7.105.3. ksm
Kernel SamePage Merging (KSM) reduces references to memory pages from multiple identical pages to a single page reference. This helps with optimization for memory density.
For example, to enable KSM for host 123, send a request like this:
PUT /ovirt-engine/api/hosts/123
PUT /ovirt-engine/api/hosts/123With a request body like this:
<host>
<ksm>
<enabled>true</enabled>
</ksm>
</host>
<host>
<ksm>
<enabled>true</enabled>
</ksm>
</host>7.105.4. libvirt_version
The host libvirt version. For more information on libvirt please go to libvirt.
7.105.5. override_iptables
Specifies whether we should override firewall definitions. This applies only when the host is installed or re-installed.
7.105.6. protocol
The protocol that the engine uses to communicate with the host.
Since version 4.1 of the engine the protocol is always set to stomp since xml was removed.
7.105.7. se_linux
The host SElinux status. Security-Enhanced Linux (SELinux) is a component in the Linux kernel that provides a mechanism for supporting access control security policies.
7.105.8. spm
The host storage pool manager (SPM) status and definition. Use it to set the SPM priority of this host, and to see whether this is the current SPM or not.
7.105.9. status_detail
The host status details. Relevant for Gluster hosts.
7.105.10. transparent_huge_pages
Transparent huge page support expands the size of memory pages beyond the standard 4 KiB limit. This reduces memory consumption and increases host performance.
For example, to enable transparent huge page support for host 123, send a request like this:
PUT /ovirt-engine/api/hosts/123
PUT /ovirt-engine/api/hosts/123With a request body like this:
<host>
<transparent_hugepages>
<enabled>true</enabled>
</transparent_hugepages>
</host>
<host>
<transparent_hugepages>
<enabled>true</enabled>
</transparent_hugepages>
</host>7.105.11. version
The version of VDSM.
For example:
GET /ovirt-engine/api/hosts/123
GET /ovirt-engine/api/hosts/123
This GET request will return the following output:
| Name | Type | Summary |
|---|---|---|
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| Lists all the Katello errata assigned to the host. | |
|
| ||
|
| ||
|
| ||
|
| ||
|
| Each host resource exposes a statistics sub-collection for host-specific statistics. | |
|
| ||
|
| ||
|
| ||
|
|
7.105.12. katello_errata
Lists all the Katello errata assigned to the host.
GET /ovirt-engine/api/hosts/123/katelloerrata
GET /ovirt-engine/api/hosts/123/katelloerrataYou will receive response in XML like this one:
7.105.13. statistics
Each host resource exposes a statistics sub-collection for host-specific statistics.
An example of an XML representation:
This statistics sub-collection is read-only.
The following list shows the statistic types for hosts:
| Name | Description |
|---|---|
|
| Total memory in bytes on the host. |
|
| Memory in bytes used on the host. |
|
| Memory in bytes free on the host. |
|
| Memory in bytes shared on the host. |
|
| I/O buffers in bytes. |
|
| OS caches in bytes. |
|
| Total swap memory in bytes on the host. |
|
| Swap memory in bytes free on the host. |
|
| Swap memory in bytes used on the host. |
|
| Swap memory in bytes also cached in host’s memory. |
|
| Percentage of CPU usage for Kernel SamePage Merging. |
|
| Percentage of CPU usage for user slice. |
|
| Percentage of CPU usage for system. |
|
| Percentage of idle CPU usage. |
|
| CPU load average per five minutes. |
|
| Boot time of the machine. |
7.106. HostDevice struct
| Name | Type | Summary |
|---|---|---|
|
| ||
|
| Free text containing comments about this object. | |
|
| A human-readable description in plain text. | |
|
| The name of the driver this device is bound to. | |
|
| A unique identifier. | |
|
| ||
|
| A human-readable name in plain text. | |
|
| ||
|
| ||
|
| ||
|
| ||
|
|
7.106.1. driver
The name of the driver this device is bound to.
For example: pcieport or uhci_hcd.
| Name | Type | Summary |
|---|---|---|
|
| ||
|
| ||
|
|
7.107. HostDevicePassthrough struct
| Name | Type | Summary |
|---|---|---|
|
|
7.108. HostNic struct
Represents a host NIC.
For example, the XML representation of a host NIC looks like this:
A bonded interface is represented as a HostNic object containing the bonding and slaves attributes.
For example, the XML representation of a bonded host NIC looks like this:
| Name | Type | Summary |
|---|---|---|
|
|
The | |
|
| The base interface of the NIC. | |
|
| The bonding parameters of the NIC. | |
|
| The IPv4 boot protocol configuration of the NIC. | |
|
| Defines the bridged network status. | |
|
| ||
|
| Free text containing comments about this object. | |
|
| ||
|
| A human-readable description in plain text. | |
|
| A unique identifier. | |
|
| The IPv4 address of the NIC. | |
|
| The IPv6 address of the NIC. | |
|
| The IPv6 boot protocol configuration of the NIC. | |
|
| The MAC address of the NIC. | |
|
| The maximum transmission unit for the interface. | |
|
| A human-readable name in plain text. | |
|
| The labels that are applied to this NIC. | |
|
| ||
|
| ||
|
| ||
|
| A link to the statistics of the NIC. | |
|
| ||
|
| Describes the virtual functions configuration of a physical function NIC. | |
|
|
7.108.1. ad_aggregator_id
The ad_aggregator_id property of a bond or bond slave, for bonds in mode 4. Bond mode 4 is the 802.3ad standard, also called dynamic link aggregation. (See Wikipedia and Presentation for more information). This is only valid for bonds in mode 4, or NICs which are part of a bond. It is not present for bonds in other modes, or NICs which are not part of a bond in mode 4. The ad_aggregator_id property indicates which of the bond slaves are active. The value of the ad_aggregator_id of an active slave is the same as the value of the ad_aggregator_id property of the bond. This parameter is read only. Setting it will have no effect on the bond/NIC. It is retrieved from the /sys/class/net/bondX/bonding/ad_aggregator file for a bond, and the /sys/class/net/ensX/bonding_slave/ad_aggregator_id file for a NIC.
7.108.2. bridged
Defines the bridged network status. Set to true for a bridged network and false for a bridgeless network.
7.108.3. statistics
A link to the statistics of the NIC.
The data types for HostNic statistical values:
- data.current.rx - The rate in bytes per second of data received.
- data.current.tx - The rate in bytes per second of data transmitted.
- data.total.rx - Total received data.
- data.total.tx - Total transmitted data.
- errors.total.rx - Total errors from receiving data.
- errors.total.tx - Total errors from transmitting data.
| Name | Type | Summary |
|---|---|---|
|
| ||
|
| A reference to the network to which the interface should be connected. | |
|
| A reference to the physical function NIC of a SR-IOV virtual function NIC. | |
|
| A link to the quality-of-service configuration of the interface. |
7.108.4. network
A reference to the network to which the interface should be connected. A blank network ID is allowed.
7.109. HostNicVirtualFunctionsConfiguration struct
Describes the virtual functions configuration of an SR-IOV-enabled physical function NIC.
| Name | Type | Summary |
|---|---|---|
|
| Defines whether all networks are allowed to be defined on the related virtual functions, or specified ones only. | |
|
| The maximum number of virtual functions the NIC supports. | |
|
| The number of virtual functions currently defined. |
7.109.1. max_number_of_virtual_functions
The maximum number of virtual functions the NIC supports. This property is read-only.
7.109.2. number_of_virtual_functions
The number of virtual functions currently defined. A user-defined value between 0 and max_number_of_virtual_functions.
7.110. HostProtocol enum
The protocol used by the engine to communicate with a host.
Since version 4.1 of the engine the protocol is always set to stomp since xml was removed.
| Name | Summary |
|---|---|
|
| JSON-RPC protocol on top of STOMP. |
|
| XML-RPC protocol. |
7.111. HostStatus enum
Type representing a host status.
| Name | Summary |
|---|---|
|
| The engine cannot communicate with the host for a specific threshold so it is now trying to connect before going through fencing. |
|
| The host is down. |
|
| The host is in error status. |
|
| The host is initializing. |
|
| The host installation failed. |
|
| The host is being installed. |
|
| The host operating system is now installing. |
|
| The host kernel has crashed and it is now going through memory dumping. |
|
| The host is in maintenance status. |
|
| The host is non operational. |
|
| The host is not responsive. |
|
| The host is pending administrator approval. |
|
| The host is preparing for maintenance. |
|
| The host is being rebooted. |
|
| The host is in activation process. |
|
| The host is up. |
7.111.1. error
The host is in error status. This will happen if we will try to run a virtual machine several times and it will fail.
7.111.2. initializing
The host is initializing. This is an intermediate step before moving the host to 'up' status.
7.111.3. install_failed
The host installation failed. In such cases look at the event log to understand what failed the installation, and issue a re-install.
7.111.4. installing_os
The host operating system is now installing. This status is relevant when using a Satellite/Foreman provider, and issuing a bare-metal provisioning (discovered host provisioning).
7.111.5. maintenance
The host is in maintenance status. When a host is in maintenance it cannot run virtual machines.
7.111.6. non_operational
The host is non operational. This can happen due to various reasons, such as not having a connection with the storage, not supporting a mandatory network, not supporting the cluster level, and more.
7.111.7. non_responsive
The host is not responsive. This means that the engine is not able to communicate with the host.
7.111.8. pending_approval
The host is pending administrator approval. This is relevant only for vintage ovirt-node / RHV-H.
7.111.9. preparing_for_maintenance
The host is preparing for maintenance. During this time the engine makes sure to live migrate all the virtual machines from this host to other hosts. Once all migrations have been completed the host will move to 'maintenance' status.
7.112. HostStorage struct
| Name | Type | Summary |
|---|---|---|
|
| ||
|
| Free text containing comments about this object. | |
|
| A human-readable description in plain text. | |
|
| A unique identifier. | |
|
| ||
|
| ||
|
| A human-readable name in plain text. | |
|
| The number of times to retry a request before attempting further recovery actions. | |
|
| The time in tenths of a second to wait for a response before retrying NFS requests. | |
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
|
7.112.1. nfs_retrans
The number of times to retry a request before attempting further recovery actions. The value must be in the range of 0 to 65535. For more details see the description of the retrans mount option in the nfs man page.
7.112.2. nfs_timeo
The time in tenths of a second to wait for a response before retrying NFS requests. The value must be in the range of 0 to 65535. For more details see the description of the timeo mount option in the nfs man page.
| Name | Type | Summary |
|---|---|---|
|
|
7.113. HostType enum
This enumerated type is used to determine which type of operating system is used by the host.
| Name | Summary |
|---|---|
|
| The host contains Red Hat Virtualization Host (RHVH): a new implementation of Red Hat Enterprise Virtualization Hypervisor (RHEV-H) which uses the same installer as Red Hat Enterprise Linux, CentOS, or Fedora. |
|
| The host contains a full Red Hat Enterprise Linux, CentOS, or Fedora installation. |
|
| The host contains Red Hat Enterprise Virtualization Hypervisor (RHEV-H), a small-scaled version of Red Hat Enterprise Linux, CentOS, or Fedora, used solely to host virtual machines. |
7.113.1. ovirt_node
The host contains Red Hat Virtualization Host (RHVH): a new implementation of Red Hat Enterprise Virtualization Hypervisor (RHEV-H) which uses the same installer as Red Hat Enterprise Linux, CentOS, or Fedora. The main difference between RHVH and legacy RHEV-H is that RHVH has a writeable file system and will handle its own installation instead of having RPMs pushed to it by the Manager like in legacy RHEV-H.
7.114. HostedEngine struct
7.115. Icon struct
Icon of virtual machine or template.
| Name | Type | Summary |
|---|---|---|
|
| Free text containing comments about this object. | |
|
| Base64 encode content of the icon file. | |
|
| A human-readable description in plain text. | |
|
| A unique identifier. | |
|
| Format of icon file. | |
|
| A human-readable name in plain text. |
7.115.1. media_type
Format of icon file.
One of:
-
image/jpeg -
image/png -
image/gif
7.116. Identified struct
This interface is the base model for all types that represent objects with an identifier.
7.117. Image struct
| Name | Type | Summary |
|---|---|---|
|
| Free text containing comments about this object. | |
|
| A human-readable description in plain text. | |
|
| A unique identifier. | |
|
| A human-readable name in plain text. |
| Name | Type | Summary |
|---|---|---|
|
|
7.118. ImageTransfer struct
This type contains information regarding an image transfer being performed.
| Name | Type | Summary |
|---|---|---|
|
| Free text containing comments about this object. | |
|
| A human-readable description in plain text. | |
|
|
The direction indicates whether the transfer is sending image data ( | |
|
| A unique identifier. | |
|
| A human-readable name in plain text. | |
|
| The current phase of the image transfer in progress. | |
|
| The URL of the proxy server that the user inputs or outputs to. | |
|
|
The signed ticket that should be attached as an |
7.118.1. direction
The direction indicates whether the transfer is sending image data (upload) or receiving image data (download).
If a direction is not set during an addition of a new transfer, The default direction for the transfer will be upload.
7.118.2. phase
The current phase of the image transfer in progress. Each transfer needs a managed session, which must be opened for the user to input or output an image. Please refer to image transfer for further documentation.
7.118.3. proxy_url
The URL of the proxy server that the user inputs or outputs to. This attribute is available only if the image transfer entity is in the transferring phase. See phase for details.
7.119. ImageTransferDirection enum
The image transfer direction for a transfer.
When adding a new transfer, the user can choose whether the transfer will be to an image, choosing upload, or to transfer from an image- choosing download as an ImageTransferDirection.
Please refer to image transfer for further documentation.
| Name | Summary |
|---|---|
|
|
The user must choose |
|
|
The user can choose |
7.120. ImageTransferPhase enum
A list of possible phases for an image transfer entity. Each of these values defines a specific point in a transfer flow.
Please refer to image transfer for more information.
| Name | Summary |
|---|---|
|
| This phase will be set as a result of the user cancelling the transfer. |
|
| This phase can only be set in the Administration Portal, and indicates that there was an error during the transfer, and it is being finalized with a failure. |
|
| This phase will be set when the user calls finalize. |
|
| Indicates that the targeted image failed the verification, and cannot be used. |
|
| Indicates that the transfer session was successfully closed, and the targeted image was verified and ready to be used. |
|
| The initial phase of an image transfer. |
|
| This phase means the session timed out, or some other error occurred with this transfer; for example ovirt-imageio-daemon is not running in the selected host. |
|
| This phase is a result of a pause call by the user, using pause. |
|
| The phase where the transfer has been resumed by the client calling resume. |
|
| The phase where the transfer session is open, and the client can input or output the desired image using the preferred tools. |
|
| An unknown phase. |
7.120.1. cancelled
This phase will be set as a result of the user cancelling the transfer. The cancellation can only be performed in the Administration Portal.
7.120.2. finalizing_success
This phase will be set when the user calls finalize. Calling finalize is essential to finish the transfer session, and finish using the targeted image. After finalizing, the phase will be changed to finished_success or finished_failure.
Refer to image transfer for more information.
7.120.3. finished_failure
Indicates that the targeted image failed the verification, and cannot be used. After reaching this phase, the image transfer entity will be deleted, and the targeted image will be set to illegal.
7.120.4. finished_success
Indicates that the transfer session was successfully closed, and the targeted image was verified and ready to be used. After reaching this phase, the image transfer entity will be deleted.
7.120.5. initializing
The initial phase of an image transfer. It is set while the transfer session is establishing. Once the session is established, the phase will be changed to transferring
7.120.6. paused_system
This phase means the session timed out, or some other error occurred with this transfer; for example ovirt-imageio-daemon is not running in the selected host. To resume the session, the client should call resume. After resuming, the phase will change to resuming.
7.120.7. resuming
The phase where the transfer has been resumed by the client calling resume. Resuming starts a new session, and after calling it, the phase will be changed to transferring, or paused_system in case of a failure.
7.120.8. unknown
An unknown phase. This will only be set in cases of unpredictable errors.
7.121. InheritableBoolean enum
Enum representing the boolean value that can be either set, or inherited from a higher level. The inheritance order is virtual machine
| Name | Summary |
|---|---|
|
| Set the value to false on this level. |
|
| Inherit the value from higher level. |
|
| Set the value to true on this level. |
7.122. Initialization struct
| Name | Type | Summary |
|---|---|---|
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
|
7.123. InstanceType struct
Describes the hardware configuration of virtual machines.
For example medium instance type includes 1 virtual CPU and 4 GiB of memory. It is a top-level entity (e.g. not bound to any data center or cluster). The attributes that are used for instance types and are common to virtual machine and template types are:
-
console -
cpu -
custom_cpu_model -
custom_emulated_machine -
display -
high_availability -
io -
memory -
memory_policy -
migration -
migration_downtime -
os -
rng_device -
soundcard_enabled -
usb -
virtio_scsi
When creating a virtual machine from both an instance type and a template, the virtual machine will inherit the hardware configurations from the instance type
An instance type inherits it’s attributes from the template entity although most template attributes are not used in instance types.
| Name | Type | Summary |
|---|---|---|
|
| Reference to virtual machine’s BIOS configuration. | |
|
| Free text containing comments about this object. | |
|
| Console configured for this virtual machine. | |
|
| The configuration of the virtual machine CPU. | |
|
| ||
|
| The virtual machine creation date. | |
|
| Virtual machine custom compatibility version. | |
|
| ||
|
| ||
|
| Properties sent to VDSM to configure various hooks. | |
|
|
If | |
|
| A human-readable description in plain text. | |
|
| The virtual machine display configuration. | |
|
| Domain configured for this virtual machine. | |
|
| The virtual machine high availability configuration. | |
|
| A unique identifier. | |
|
| Reference to virtual machine’s initialization configuration. | |
|
| For performance tuning of IO threading. | |
|
| Virtual machine’s large icon. | |
|
| Reference to the storage domain this virtual machine/template lease reside on. | |
|
| The virtual machine’s memory, in bytes. | |
|
| Reference to virtual machine’s memory management configuration. | |
|
| Reference to configuration of migration of running virtual machine to another host. | |
|
| Maximum time the virtual machine can be non responsive during its live migration to another host in ms. | |
|
| A human-readable name in plain text. | |
|
| The origin of this virtual machine. | |
|
| Operating system type installed on the virtual machine. | |
|
| Random Number Generator device configuration for this virtual machine. | |
|
| Virtual machine’s serial number in a cluster. | |
|
| Virtual machine’s small icon. | |
|
|
If | |
|
| Reference to the Single Sign On configuration this virtual machine is configured for. | |
|
|
If | |
|
|
If | |
|
| The status of the template. | |
|
| The virtual machine’s time zone set by oVirt. | |
|
|
If | |
|
| Determines whether the virtual machine is optimized for desktop or server. | |
|
| Configuration of USB devices for this virtual machine (count, type). | |
|
| Indicates whether this is a base version or a sub version of another template. | |
|
| Reference to VirtIO SCSI configuration. | |
|
| The virtual machine configuration associated with this template. |
7.123.1. cpu
The configuration of the virtual machine CPU.
The socket configuration can be updated without rebooting the virtual machine. The cores and the threads require a reboot.
For example, to change the number of sockets to 4 immediately, and the number of cores and threads to 2 after reboot, send the following request:
PUT /ovirt-engine/api/vms/123
PUT /ovirt-engine/api/vms/123With a request body:
7.123.2. custom_compatibility_version
Virtual machine custom compatibility version.
Enables a virtual machine to be customized to its own compatibility version. If custom_compatibility_version is set, it overrides the cluster’s compatibility version for this particular virtual machine.
The compatibility version of a virtual machine is limited by the data center the virtual machine resides in, and is checked against capabilities of the host the virtual machine is planned to run on.
7.123.3. high_availability
The virtual machine high availability configuration. If set, the virtual machine will be automatically restarted when it unexpectedly goes down.
7.123.4. large_icon
Virtual machine’s large icon. Either set by user or refers to image set according to operating system.
7.123.5. lease
Reference to the storage domain this virtual machine/template lease reside on.
A virtual machine running with a lease requires checking while running that the lease is not taken by another host, preventing another instance of this virtual machine from running on another host. This provides protection against split-brain in highly available virtual machines. A template can also have a storage domain defined for a lease in order to have the virtual machines created from this template to be preconfigured with this storage domain as the location of the leases.
7.123.6. memory
The virtual machine’s memory, in bytes.
For example, to update a virtual machine to contain 1 Gibibyte (GiB) of memory, send the following request:
PUT /ovirt-engine/api/vms/123
PUT /ovirt-engine/api/vms/123With the following request body:
<vm> <memory>1073741824</memory> </vm>
<vm>
<memory>1073741824</memory>
</vm>
Memory in the example is converted to bytes using the following formula:
1 GiB = 230 bytes = 1073741824 bytes.
Memory hot plug is supported from Red Hat Virtualization 3.6 onwards. You can use the example above to increase memory while the virtual machine is running.
7.123.7. migration_downtime
Maximum time the virtual machine can be non responsive during its live migration to another host in ms.
Set either explicitly for the virtual machine or by engine-config -s DefaultMaximumMigrationDowntime=[value]
7.123.8. origin
The origin of this virtual machine.
Possible values:
-
ovirt -
rhev -
vmware -
xen -
external -
hosted_engine -
managed_hosted_engine -
kvm -
physical_machine -
hyperv
7.123.9. small_icon
Virtual machine’s small icon. Either set by user or refers to image set according to operating system.
7.123.10. sso
Reference to the Single Sign On configuration this virtual machine is configured for. The user can be automatically signed in the virtual machine’s operating system when console is opened.
| Name | Type | Summary |
|---|---|---|
|
| References to the CD-ROM devices attached to the template. | |
|
| Reference to cluster the virtual machine belongs to. | |
|
| Reference to CPU profile used by this virtual machine. | |
|
| References to the disks attached to the template. | |
|
| References to the graphic consoles attached to the template. | |
|
| References to the network interfaces attached to the template. | |
|
| References to the user permissions attached to the template. | |
|
| Reference to quota configuration set for this virtual machine. | |
|
| Reference to storage domain the virtual machine belongs to. | |
|
| References to the tags attached to the template. | |
|
| References to the watchdog devices attached to the template. |
7.124. Io struct
| Name | Type | Summary |
|---|---|---|
|
|
7.125. Ip struct
Represents the IP configuration of a network interface.
| Name | Type | Summary |
|---|---|---|
|
| The text representation of the IP address. | |
|
| The address of the default gateway. | |
|
| The network mask. | |
|
| The version of the IP protocol. |
7.125.1. address
The text representation of the IP address.
For example, an IPv4 address will be represented as follows:
<ip> <address>192.168.0.1</address> ... </ip>
<ip>
<address>192.168.0.1</address>
...
</ip>An IPv6 address will be represented as follows:
<ip> <address>2620:52:0:20f0:4216:7eff:feaa:1b50</address> ... </ip>
<ip>
<address>2620:52:0:20f0:4216:7eff:feaa:1b50</address>
...
</ip>7.125.2. netmask
The network mask.
For IPv6 addresses the value is an integer in the range of 0-128, which represents the subnet prefix.
7.125.3. version
The version of the IP protocol.
From version 4.1 of the Manager this attribute will be optional, and when a value is not provided, it will be inferred from the value of the address attribute.
7.126. IpAddressAssignment struct
Represents an IP address assignment for a network device.
For a static boot protocol assignment, subnet mask and IP address (and optinally default gateway) must be provided in the IP configuration.
| Name | Type | Summary |
|---|---|---|
|
| Sets the boot protocol used to assign the IP configuration for a network device. | |
|
| Sets the IP configuration for a network device. |
7.127. IpVersion enum
Defines the values for the IP protocol version.
| Name | Summary |
|---|---|
|
| IPv4. |
|
| IPv6. |
7.128. IscsiBond struct
| Name | Type | Summary |
|---|---|---|
|
| Free text containing comments about this object. | |
|
| A human-readable description in plain text. | |
|
| A unique identifier. | |
|
| A human-readable name in plain text. |
| Name | Type | Summary |
|---|---|---|
|
| ||
|
| ||
|
|
7.129. IscsiDetails struct
| Name | Type | Summary |
|---|---|---|
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
|
7.130. Job struct
Represents a job, which monitors execution of a flow in the system. A job can contain multiple steps in a hierarchic structure. The steps can be processed in parallel, depends on the implementation of the flow.
| Name | Type | Summary |
|---|---|---|
|
| Indicates if the job should be cleared automatically after it was completed by the system. | |
|
| Free text containing comments about this object. | |
|
| A human-readable description in plain text. | |
|
| The end time of the job. | |
|
| Indicates if the job is originated by an external system. | |
|
| A unique identifier. | |
|
| The last update date of the job. | |
|
| A human-readable name in plain text. | |
|
| The start time of the job. | |
|
| The status of the job. |
7.130.1. external
Indicates if the job is originated by an external system. External jobs are managed externally, by the creator of the job.
7.131. JobStatus enum
Represents the status of the job.
| Name | Summary |
|---|---|
|
| The aborted job status. |
|
| The failed job status. |
|
| The finished job status. |
|
| The started job status. |
|
| The unknown job status. |
7.131.1. aborted
The aborted job status. This status is applicable for an external job that was forcibly aborted.
7.131.2. finished
The finished job status. This status describes a completed job execution.
7.131.3. started
The started job status. This status represents a job which is currently being executed.
7.131.4. unknown
The unknown job status. This status represents jobs which their resolution is not known, i.e. jobs that were executed before the system was unexpectedly restarted.
7.132. KatelloErratum struct
Type representing a Katello erratum.
| Name | Type | Summary |
|---|---|---|
|
| Free text containing comments about this object. | |
|
| A human-readable description in plain text. | |
|
| A unique identifier. | |
|
| The date when the Katello erratum was issued. | |
|
| A human-readable name in plain text. | |
|
| The list of packages which solve the issue reported by the Katello erratum. | |
|
| The severity of the Katello erratum. | |
|
| The solution for the issue described by the Katello erratum. | |
|
| The summary of the Katello erratum. | |
|
| The title of the Katello erratum. | |
|
| The type of the Katello erratum. |
7.132.1. severity
The severity of the Katello erratum.
The supported severities are moderate, important or critical.
7.132.2. type
The type of the Katello erratum.
The supported types are bugfix, enhancement or security.
7.133. KdumpStatus enum
| Name | Summary |
|---|---|
|
| |
|
| |
|
|
7.134. Kernel struct
| Name | Type | Summary |
|---|---|---|
|
|
7.135. Ksm struct
7.136. LogSeverity enum
Enum representing a severity of an event.
| Name | Summary |
|---|---|
|
| Alert severity. |
|
| Error severity. |
|
| Normal severity. |
|
| Warning severity. |
7.136.1. alert
Alert severity. Used to specify a condition that requires an immediate attention.
7.136.2. error
Error severity. Used to specify that there is an error that needs to be examined.
7.136.3. normal
Normal severity. Used for information events.
7.136.4. warning
Warning severity. Used to warn something might be wrong.
7.137. LogicalUnit struct
| Name | Type | Summary |
|---|---|---|
|
| ||
|
| The maximum number of bytes that can be discarded by the logical unit’s underlying storage in a single operation. | |
|
| True, if previously discarded blocks in the logical unit’s underlying storage are read back as zeros. | |
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
|
7.137.1. discard_max_size
The maximum number of bytes that can be discarded by the logical unit’s underlying storage in a single operation. A value of 0 means that the device does not support discard functionality.
This is the software limit, and not the hardware limit, as noted in the documentation of queue-sysfs for discard_max_bytes.
7.137.2. discard_zeroes_data
True, if previously discarded blocks in the logical unit’s underlying storage are read back as zeros. For more information please see the documentation of queue-sysfs for discard_zeroes_data.
7.138. LunStatus enum
| Name | Summary |
|---|---|
|
| |
|
| |
|
|
7.139. Mac struct
| Name | Type | Summary |
|---|---|---|
|
|
7.140. MacPool struct
Represents a MAC address pool.
Example of an XML representation of a MAC address pool:
| Name | Type | Summary |
|---|---|---|
|
| Defines whether duplicate MAC addresses are permitted in the pool. | |
|
| Free text containing comments about this object. | |
|
| Defines whether this is the default pool. | |
|
| A human-readable description in plain text. | |
|
| A unique identifier. | |
|
| A human-readable name in plain text. | |
|
| Defines the range of MAC addresses for the pool. |
7.140.1. allow_duplicates
Defines whether duplicate MAC addresses are permitted in the pool. If not specified, defaults to false.
7.140.2. default_pool
Defines whether this is the default pool. If not specified, defaults to false.
7.140.3. ranges
Defines the range of MAC addresses for the pool. Multiple ranges can be defined.
7.141. MemoryOverCommit struct
| Name | Type | Summary |
|---|---|---|
|
|
7.142. MemoryPolicy struct
Logical grouping of memory related properties of virtual machine-like entities.
| Name | Type | Summary |
|---|---|---|
|
| ||
|
| ||
|
| Maximum virtual machine’s memory, in bytes. | |
|
| ||
|
|
7.142.1. max
Maximum virtual machine’s memory, in bytes.
The user provides the value in bytes, and the engine rounds the value down to the nearest lower MiB value.
For example, if the user enters a value of 1073741825 (1 GiB + 1 byte), then the Red Hat Virtualization Manager will truncate that value to the nearest lower MiB boundary: in this case 1073741824 (1 GiB).
7.143. MessageBrokerType enum
| Name | Summary |
|---|---|
|
| |
|
|
7.144. Method struct
| Name | Type | Summary |
|---|---|---|
|
|
7.145. MigrateOnError enum
| Name | Summary |
|---|---|
|
| |
|
| |
|
|
7.146. MigrationBandwidth struct
Defines the bandwidth used by migration.
| Name | Type | Summary |
|---|---|---|
|
| The method used to assign the bandwidth. | |
|
| Custom bandwidth in Mbps. |
7.146.1. custom_value
Custom bandwidth in Mbps. Will be applied only if the assignmentMethod attribute is custom.
7.147. MigrationBandwidthAssignmentMethod enum
Defines how the migration bandwidth is assigned.
| Name | Summary |
|---|---|
|
| Takes the bandwidth from the Quality of Service if the Quality of Service is defined. |
|
| Custom defined bandwidth in Mbit/s. |
|
| Takes the value as configured on the hypervisor. |
7.147.1. auto
Takes the bandwidth from the Quality of Service if the Quality of Service is defined. If the Quality of Service is not defined the bandwidth is taken from the detected link speed being used. If nothing is detected, bandwidth falls back to the hypervisor_default value.
7.148. MigrationOptions struct
The type for migration options.
| Name | Type | Summary |
|---|---|---|
|
| ||
|
| The bandwidth that is allowed to be used by the migration. | |
|
|
| Name | Type | Summary |
|---|---|---|
|
|
A reference to the migration policy, as defined using |
7.149. MigrationPolicy struct
A policy describing how the migration is treated, such as convergence or how many parallel migrations are allowed.
7.150. Network struct
The type for a logical network.
An example of the JSON representation of a logical network:
An example of the XML representation of the same logical network:
| Name | Type | Summary |
|---|---|---|
|
| Free text containing comments about this object. | |
|
| A human-readable description in plain text. | |
|
| ||
|
| ||
|
| A unique identifier. | |
|
| ||
|
| Specifies the maximum transmission unit for the network. | |
|
| A human-readable name in plain text. | |
|
| ||
|
| ||
|
| ||
|
| Specifies whether the spanning tree protocol is enabled for the network. | |
|
| Defines a set of usage elements for the network. | |
|
|
7.150.1. usages
Defines a set of usage elements for the network.
For example, users can specify that the network is to be used for virtual machine traffic and also for display traffic with the vm and display values.
| Name | Type | Summary |
|---|---|---|
|
| ||
|
| A reference to the data center that the network is a member of. | |
|
| A reference to the labels assigned to the network. | |
|
| A reference to the permissions of the network. | |
|
| ||
|
| A reference to the profiles of the network. |
7.151. NetworkAttachment struct
Describes how a host connects to a network.
An XML representation of a network attachment on a host:
The network element, with either a name or an id, is required in order to attach a network to a network interface card (NIC).
For example, to attach a network to a host network interface card, send a request like this:
POST /ovirt-engine/api/hosts/123/nics/456/networkattachments
POST /ovirt-engine/api/hosts/123/nics/456/networkattachmentsWith a request body like this:
<networkattachment> <network id="234"/> </networkattachment>
<networkattachment>
<network id="234"/>
</networkattachment>To attach a network to a host, send a request like this:
POST /ovirt-engine/api/hosts/123/networkattachments
POST /ovirt-engine/api/hosts/123/networkattachmentsWith a request body like this:
<network_attachment> <network id="234"/> <host_nic id="456"/> </network_attachment>
<network_attachment>
<network id="234"/>
<host_nic id="456"/>
</network_attachment>
The ip_address_assignments and properties elements are updatable post-creation.
For example, to update a network attachment, send a request like this:
PUT /ovirt-engine/api/hosts/123/nics/456/networkattachments/789
PUT /ovirt-engine/api/hosts/123/nics/456/networkattachments/789With a request body like this:
To detach a network from the network interface card send a request like this:
DELETE /ovirt-engine/api/hosts/123/nics/456/networkattachments/789
DELETE /ovirt-engine/api/hosts/123/nics/456/networkattachments/789Changes to network attachment configuration must be explicitly committed.
An XML representation of a network attachment’s properties sub-collection:
| Name | Type | Summary |
|---|---|---|
|
| Free text containing comments about this object. | |
|
| A human-readable description in plain text. | |
|
| DNS resolver configuration will be reported when retrieving the network attachment using GET. | |
|
| A unique identifier. | |
|
| ||
|
| The IP configuration of the network. | |
|
| A human-readable name in plain text. | |
|
| Defines custom properties for the network configuration. | |
|
| A read-only list of configuration properties. |
7.151.1. dns_resolver_configuration
DNS resolver configuration will be reported when retrieving the network attachment using GET. It is optional when creating a new network attachment or updating an existing one.
7.151.2. properties
Defines custom properties for the network configuration.
Bridge options have the set name of bridge_opts. Separate multiple entries with a whitespace character. The following keys are valid for bridge_opts:
| Name | Default value |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
7.152. NetworkConfiguration struct
7.153. NetworkFilter struct
Network filters filter packets sent to and from the virtual machine’s NIC according to defined rules.
There are several types of network filters supported based on libvirt. For more details about the different network filters see here.
In addition to libvirt’s network filters, there are two additional network filters: The first is called vdsm-no-mac-spoofing and is composed of no-mac-spoofing and no-arp-mac-spoofing. The second is called ovirt-no-filter and is used when no network filter is to be defined for the virtual machine’s NIC. The ovirt-no-filter network filter is only used for internal implementation, and does not exist on the NICs.
This is a example of the XML representation:
If any part of the version is not present, it is represented by -1.
| Name | Type | Summary |
|---|---|---|
|
| Free text containing comments about this object. | |
|
| A human-readable description in plain text. | |
|
| A unique identifier. | |
|
| A human-readable name in plain text. | |
|
| The minimum supported version of a specific NetworkFilter. |
7.153.1. version
The minimum supported version of a specific NetworkFilter. This is the version that the NetworkFilter was first introduced in.
7.154. NetworkLabel struct
Represents a label which can be added to a host network interface.
| Name | Type | Summary |
|---|---|---|
|
| Free text containing comments about this object. | |
|
| A human-readable description in plain text. | |
|
| A unique identifier. | |
|
| A human-readable name in plain text. |
7.155. NetworkPluginType enum
| Name | Summary |
|---|---|
|
|
7.156. NetworkStatus enum
| Name | Summary |
|---|---|
|
| |
|
|
7.157. NetworkUsage enum
This type indicates the purpose that the network is used for in the cluster.
| Name | Summary |
|---|---|
|
| The network will be used for SPICE and VNC traffic. |
|
| The network will be used for Gluster (bricks) data traffic. |
|
| The network will be used for communication between the Red Hat Virtualization Manager and the nodes. |
|
| The network will be used for virtual machine migration. |
|
|
7.157.1. management
The network will be used for communication between the Red Hat Virtualization Manager and the nodes. This is the network where the ovirtmgmt bridge will be created.
7.158. NfsProfileDetail struct
| Name | Type | Summary |
|---|---|---|
|
| ||
|
|
7.159. NfsVersion enum
| Name | Summary |
|---|---|
|
| |
|
| |
|
| |
|
| |
|
| NFS 4. |
7.159.1. v4_2
NFS 4.2.
7.160. Nic struct
Represents a virtual machine NIC.
For example, the XML representation of a NIC will look like this:
| Name | Type | Summary |
|---|---|---|
|
| ||
|
| Free text containing comments about this object. | |
|
| A human-readable description in plain text. | |
|
| A unique identifier. | |
|
| The type of driver used for the NIC. | |
|
| Defines if the NIC is linked to the virtual machine. | |
|
| The MAC address of the interface. | |
|
| A human-readable name in plain text. | |
|
| ||
|
| Defines if the NIC is plugged in to the virtual machine. |
| Name | Type | Summary |
|---|---|---|
|
| Optionally references to an instance type the device is used by. | |
|
| A reference to the network that the interface should be connected to. | |
|
| ||
|
| ||
|
| ||
|
| A link to the statistics for the NIC. | |
|
| Optionally references to a template the device is used by. | |
|
| ||
|
| ||
|
|
Don’t use this element, use | |
|
| References to the virtual machines that are using this device. | |
|
|
7.160.1. network
A reference to the network that the interface should be connected to. A blank network ID is allowed.
Usage of this element for creating or updating a NIC is deprecated; use vnic_profile instead. It is preserved because it is still in use by the initialization element, as a holder for IP addresses and other network details.
7.160.2. vms
References to the virtual machines that are using this device. A device may be used by several virtual machines; for example, a shared disk my be used simultaneously by two or more virtual machines.
7.161. NicConfiguration struct
| Name | Type | Summary |
|---|---|---|
|
| ||
|
| ||
|
| ||
|
|
7.162. NicInterface enum
| Name | Summary |
|---|---|
|
| |
|
| |
|
| |
|
| |
|
| |
|
|
7.163. NicStatus enum
| Name | Summary |
|---|---|
|
| |
|
|
7.164. NumaNode struct
Represents a physical NUMA node.
Example XML representation:
| Name | Type | Summary |
|---|---|---|
|
| Free text containing comments about this object. | |
|
| ||
|
| A human-readable description in plain text. | |
|
| A unique identifier. | |
|
| ||
|
| Memory of the NUMA node in MB. | |
|
| A human-readable name in plain text. | |
|
|
| Name | Type | Summary |
|---|---|---|
|
| ||
|
| Each host NUMA node resource exposes a statistics sub-collection for host NUMA node specific statistics. |
7.164.1. statistics
Each host NUMA node resource exposes a statistics sub-collection for host NUMA node specific statistics.
An example of an XML representation:
This statistics sub-collection is read-only.
The following list shows the statistic types for a host NUMA node:
| Name | Description |
|---|---|
|
| Total memory in bytes on the NUMA node. |
|
| Memory in bytes used on the NUMA node. |
|
| Memory in bytes free on the NUMA node. |
|
| Percentage of CPU usage for user slice. |
|
| Percentage of CPU usage for system. |
|
| Percentage of idle CPU usage. |
7.165. NumaNodePin struct
Represents the pinning of a virtual NUMA node to a physical NUMA node.
| Name | Type | Summary |
|---|---|---|
|
| Deprecated. | |
|
| The index of a physical NUMA node to which the virtual NUMA node is pinned. | |
|
| Deprecated. |
7.165.1. host_numa_node
Deprecated. Has no function.
7.165.2. pinned
Deprecated. Should always be true.
7.166. NumaTuneMode enum
| Name | Summary |
|---|---|
|
| |
|
| |
|
|
7.167. OpenStackImage struct
| Name | Type | Summary |
|---|---|---|
|
| Free text containing comments about this object. | |
|
| A human-readable description in plain text. | |
|
| A unique identifier. | |
|
| A human-readable name in plain text. |
| Name | Type | Summary |
|---|---|---|
|
|
7.168. OpenStackImageProvider struct
| Name | Type | Summary |
|---|---|---|
|
| Defines the external provider authentication URL address. | |
|
| Free text containing comments about this object. | |
|
| A human-readable description in plain text. | |
|
| A unique identifier. | |
|
| A human-readable name in plain text. | |
|
| Defines password for the user during the authentication process. | |
|
| Array of provider name/value properties. | |
|
| Defines whether provider authentication is required or not. | |
|
| ||
|
| Defines URL address of the external provider. | |
|
| Defines user name to be used during authentication process. |
7.168.1. requires_authentication
Defines whether provider authentication is required or not.
If authentication is required, both username and password attributes will be used during authentication.
| Name | Type | Summary |
|---|---|---|
|
| ||
|
|
7.169. OpenStackNetwork struct
| Name | Type | Summary |
|---|---|---|
|
| Free text containing comments about this object. | |
|
| A human-readable description in plain text. | |
|
| A unique identifier. | |
|
| A human-readable name in plain text. |
| Name | Type | Summary |
|---|---|---|
|
|
7.170. OpenStackNetworkProvider struct
| Name | Type | Summary |
|---|---|---|
|
| Agent configuration settings. | |
|
| Defines the external provider authentication URL address. | |
|
| Free text containing comments about this object. | |
|
| A human-readable description in plain text. | |
|
| A unique identifier. | |
|
| A human-readable name in plain text. | |
|
| Defines password for the user during the authentication process. | |
|
| Network plugin type. | |
|
| Array of provider name/value properties. | |
|
| Indicates whether the provider is read-only. | |
|
| Defines whether provider authentication is required or not. | |
|
| ||
|
| The type of provider. | |
|
| Defines URL address of the external provider. | |
|
| Defines user name to be used during authentication process. |
7.170.1. read_only
Indicates whether the provider is read-only.
A read-only provider does not allow adding, modifying, or deleting of networks or subnets. Port-related operations are allowed, as they are required for the provisioning of virtual NICs.
7.170.2. requires_authentication
Defines whether provider authentication is required or not.
If authentication is required, both username and password attributes will be used during authentication.
| Name | Type | Summary |
|---|---|---|
|
| Reference to the certificates list. | |
|
| Reference to OpenStack networks list. | |
|
| Reference to OpenStack networks subnets list. |
7.171. OpenStackNetworkProviderType enum
The OpenStack network provider can either be implemented by OpenStack Neutron, in which case the Neutron agent is automatically installed on the hosts, or it can be an external provider implementing the OpenStack API, in which case the virtual interface driver is a custom solution installed manually.
| Name | Summary |
|---|---|
|
| Indicates that the provider is an external one, implementing the OpenStack Neutron API. |
|
| Indicates that the provider is OpenStack Neutron. |
7.171.1. external
Indicates that the provider is an external one, implementing the OpenStack Neutron API. The virtual interface driver in this case is implemented by the external provider.
7.171.2. neutron
Indicates that the provider is OpenStack Neutron. The standard OpenStack Neutron agent is used as the virtual interface driver.
7.172. OpenStackProvider struct
| Name | Type | Summary |
|---|---|---|
|
| Defines the external provider authentication URL address. | |
|
| Free text containing comments about this object. | |
|
| A human-readable description in plain text. | |
|
| A unique identifier. | |
|
| A human-readable name in plain text. | |
|
| Defines password for the user during the authentication process. | |
|
| Array of provider name/value properties. | |
|
| Defines whether provider authentication is required or not. | |
|
| ||
|
| Defines URL address of the external provider. | |
|
| Defines user name to be used during authentication process. |
7.172.1. requires_authentication
Defines whether provider authentication is required or not.
If authentication is required, both username and password attributes will be used during authentication.
7.173. OpenStackSubnet struct
| Name | Type | Summary |
|---|---|---|
|
| Defines network CIDR. | |
|
| Free text containing comments about this object. | |
|
| A human-readable description in plain text. | |
|
| Defines a list of DNS servers. | |
|
| Defines IP gateway. | |
|
| A unique identifier. | |
|
| Defines IP version. | |
|
| A human-readable name in plain text. |
7.173.1. ip_version
Defines IP version.
Values can be v4' for IPv4 or `v6 for IPv6.
| Name | Type | Summary |
|---|---|---|
|
| Reference to the service managing the OpenStack network. |
7.174. OpenStackVolumeProvider struct
| Name | Type | Summary |
|---|---|---|
|
| Defines the external provider authentication URL address. | |
|
| Free text containing comments about this object. | |
|
| A human-readable description in plain text. | |
|
| A unique identifier. | |
|
| A human-readable name in plain text. | |
|
| Defines password for the user during the authentication process. | |
|
| Array of provider name/value properties. | |
|
| Defines whether provider authentication is required or not. | |
|
| ||
|
| Defines URL address of the external provider. | |
|
| Defines user name to be used during authentication process. |
7.174.1. requires_authentication
Defines whether provider authentication is required or not.
If authentication is required, both username and password attributes will be used during authentication.
| Name | Type | Summary |
|---|---|---|
|
| ||
|
| ||
|
| ||
|
|
7.175. OpenStackVolumeType struct
| Name | Type | Summary |
|---|---|---|
|
| Free text containing comments about this object. | |
|
| A human-readable description in plain text. | |
|
| A unique identifier. | |
|
| A human-readable name in plain text. | |
|
|
| Name | Type | Summary |
|---|---|---|
|
|
7.176. OpenstackVolumeAuthenticationKey struct
| Name | Type | Summary |
|---|---|---|
|
| Free text containing comments about this object. | |
|
| ||
|
| A human-readable description in plain text. | |
|
| A unique identifier. | |
|
| A human-readable name in plain text. | |
|
| ||
|
| ||
|
|
| Name | Type | Summary |
|---|---|---|
|
|
7.177. OpenstackVolumeAuthenticationKeyUsageType enum
| Name | Summary |
|---|---|
|
|
7.178. OperatingSystem struct
Information describing the operating system. This is used for both virtual machines and hosts.
| Name | Type | Summary |
|---|---|---|
|
| ||
|
| ||
|
| A custom part of the host kernel command line. | |
|
| ||
|
| ||
|
| The host kernel command line as reported by a running host. | |
|
| ||
|
|
7.178.1. custom_kernel_cmdline
A custom part of the host kernel command line. This will be merged with the existing kernel command line.
You must reinstall and then reboot the host to apply the changes implemented by this attribute.
During each host deploy procedure, kernel parameters that were added in the previous host deploy procedure are removed using grubby --update-kernel DEFAULT --remove-args <previous_custom_params>, and the current kernel command line customization is applied using grubby --update-kernel DEFAULT --args <custom_params>. The Manager internally keeps track of the last-applied kernel parameters customization.
This attribute is currently only used for hosts.
7.178.2. reported_kernel_cmdline
The host kernel command line as reported by a running host.
This is a read-only attribute. Attempts to change this attribute are silently ignored.
This attribute is currently only used for hosts.
7.179. OperatingSystemInfo struct
7.180. Option struct
7.181. OsType enum
| Name | Summary |
|---|---|
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
|
7.182. Package struct
Type representing a package.
This is an example of the package element:
<package> <name>libipa_hbac-1.9.2-82.11.el6_4.i686</name> </package>
<package>
<name>libipa_hbac-1.9.2-82.11.el6_4.i686</name>
</package>| Name | Type | Summary |
|---|---|---|
|
| The name of the package. |
7.183. Payload struct
| Name | Type | Summary |
|---|---|---|
|
| ||
|
| ||
|
|
7.184. PayloadEncoding enum
| Name | Summary |
|---|---|
|
| |
|
|
7.185. Permission struct
| Name | Type | Summary |
|---|---|---|
|
| Free text containing comments about this object. | |
|
| A human-readable description in plain text. | |
|
| A unique identifier. | |
|
| A human-readable name in plain text. |
7.186. Permit struct
Type represents a permit.
| Name | Type | Summary |
|---|---|---|
|
| Specifies whether permit is administrative or not. | |
|
| Free text containing comments about this object. | |
|
| A human-readable description in plain text. | |
|
| A unique identifier. | |
|
| A human-readable name in plain text. |
| Name | Type | Summary |
|---|---|---|
|
| Reference to the role the permit belongs to. |
7.187. PmProxy struct
| Name | Type | Summary |
|---|---|---|
|
|
7.188. PmProxyType enum
| Name | Summary |
|---|---|
|
| The fence proxy is selected from the same cluster as the fenced host. |
|
| The fence proxy is selected from the same data center as the fenced host. |
|
| The fence proxy is selected from a different data center than the fenced host. |
7.189. PolicyUnitType enum
Holds the types of all internal policy unit types.
| Name | Summary |
|---|---|
|
| |
|
| |
|
|
7.190. PortMirroring struct
7.191. PowerManagement struct
| Name | Type | Summary |
|---|---|---|
|
| The host name or IP address of the host. | |
|
| Specifies fence agent options when multiple fences are used. | |
|
| Toggles the automated power control of the host in order to save energy. | |
|
| Indicates whether power management configuration is enabled or disabled. | |
|
| Toggles whether to determine if kdump is running on the host before it is shut down. | |
|
| Fencing options for the selected type= specified with the option name="" and value="" strings. | |
|
| A valid, robust password for power management. | |
|
| Determines the power management proxy. | |
|
| Determines the power status of the host. | |
|
| Fencing device code. | |
|
| A valid user name for power management. |
7.191.1. agents
Specifies fence agent options when multiple fences are used.
Use the order sub-element to prioritize the fence agents. Agents are run sequentially according to their order until the fence action succeeds. When two or more fence agents have the same order, they are run concurrently. Other sub-elements include type, ip, user, password, and options.
7.191.2. automatic_pm_enabled
Toggles the automated power control of the host in order to save energy. When set to true, the host will be automatically powered down if the cluster’s load is low, and powered on again when required. This is set to true when a host is created, unless disabled by the user.
7.191.3. kdump_detection
Toggles whether to determine if kdump is running on the host before it is shut down. When set to true, the host will not shut down during a kdump process. This is set to true when a host has power management enabled, unless disabled by the user.
7.191.4. type
Fencing device code.
A list of valid fencing device codes are available in the capabilities collection.
7.192. PowerManagementStatus enum
| Name | Summary |
|---|---|
|
| Host is OFF. |
|
| Host is ON. |
|
| Unknown status. |
7.193. Product struct
7.194. ProductInfo struct
Product information.
The entry point contains a product_info element to help an API user determine the legitimacy of the Red Hat Virtualization environment. This includes the name of the product, the vendor and the version.
Verify a genuine Red Hat Virtualization environment
The follow elements identify a genuine Red Hat Virtualization environment:
| Name | Type | Summary |
|---|---|---|
|
|
The name of the product, for example | |
|
| The name of the vendor, for example `ovirt. | |
|
| The version number of the product. |
7.194.1. vendor
The name of the vendor, for example ovirt.org.
7.195. ProfileDetail struct
| Name | Type | Summary |
|---|---|---|
|
| ||
|
| ||
|
| ||
|
| ||
|
|
7.196. Property struct
7.197. ProxyTicket struct
| Name | Type | Summary |
|---|---|---|
|
|
7.198. QcowVersion enum
The QCOW version specifies to the qemu which qemu version the volume supports.
This field can be updated using the update API and will be reported only for QCOW volumes, it is determined by the storage domain’s version which the disk is created on. Storage domains with version lower than V4 support QCOW2 version 2 volumes, while V4 storage domains also support QCOW2 version 3. For more information about features of the different QCOW versions, see here.
| Name | Summary |
|---|---|
|
| The Copy On Write default compatibility version It means that every QEMU can use it. |
|
| The Copy On Write compatibility version which was introduced in QEMU 1. |
7.198.1. qcow2_v3
The Copy On Write compatibility version which was introduced in QEMU 1.1 It means that the new format is in use.
7.199. Qos struct
This type represents the attributes to define Quality of service (QoS).
For storage the type is storage, the attributes max_throughput, max_read_throughput, max_write_throughput, max_iops, max_read_iops and max_write_iops are relevant.
For resources with computing capabilities the type is cpu, the attribute cpu_limit is relevant.
For virtual machines networks the type is network, the attributes inbound_average, inbound_peak, inbound_burst, outbound_average, outbound_peak and outbound_burst are relevant.
For host networks the type is hostnetwork, the attributes outbound_average_linkshare, outbound_average_upperlimit and outbound_average_realtime are relevant.
| Name | Type | Summary |
|---|---|---|
|
| Free text containing comments about this object. | |
|
| The maximum processing capability in %. | |
|
| A human-readable description in plain text. | |
|
| A unique identifier. | |
|
| The desired average inbound bit rate in Mbps. | |
|
| The amount of data that can be delivered in a single burst in MiB. | |
|
| The maximum inbound rate in Mbps. | |
|
| Maximum permitted number of input and output operations per second. | |
|
| Maximum permitted number of input operations per second. | |
|
| Maximum permitted throughput for read operations. | |
|
| Maximum permitted total throughput. | |
|
| Maximum permitted number of output operations per second. | |
|
| Maximum permitted throughput for write operations. | |
|
| A human-readable name in plain text. | |
|
| The desired average outbound bit rate in Mbps. | |
|
| Weighted share. | |
|
| The committed rate in Mbps. | |
|
| The maximum bandwidth to be used by a network in Mbps. | |
|
| The amount of data that can be sent in a single burst in MiB. | |
|
| The maximum outbound rate in Mbps. | |
|
| The kind of resources this entry can be assigned. |
7.199.1. cpu_limit
The maximum processing capability in %.
Used to configure computing resources.
7.199.2. inbound_average
The desired average inbound bit rate in Mbps.
Used to configure virtual machines networks. If defined, inbound_peak and inbound_burst also has to be set.
See Libvirt-QOS for further details.
7.199.3. inbound_burst
The amount of data that can be delivered in a single burst in MiB.
Used to configure virtual machines networks. If defined, inbound_average and inbound_peak also has to be set.
See Libvirt-QOS for further details.
7.199.4. inbound_peak
The maximum inbound rate in Mbps.
Used to configure virtual machines networks. If defined, inbound_average and inbound_burst also has to be set.
See Libvirt-QOS for further details.
7.199.5. max_iops
Maximum permitted number of input and output operations per second.
Used to configure storage. Must not be set if max_read_iops or max_write_iops is set.
7.199.6. max_read_iops
Maximum permitted number of input operations per second.
Used to configure storage. Must not be set if max_iops is set.
7.199.7. max_read_throughput
Maximum permitted throughput for read operations.
Used to configure storage. Must not be set if max_throughput is set.
7.199.8. max_throughput
Maximum permitted total throughput.
Used to configure storage. Must not be set if max_read_throughput or max_write_throughput is set.
7.199.9. max_write_iops
Maximum permitted number of output operations per second.
Used to configure storage. Must not be set if max_iops is set.
7.199.10. max_write_throughput
Maximum permitted throughput for write operations.
Used to configure storage. Must not be set if max_throughput is set.
7.199.11. outbound_average
The desired average outbound bit rate in Mbps.
Used to configure virtual machines networks. If defined, outbound_peak and outbound_burst also has to be set.
See Libvirt-QOS for further details.
7.199.13. outbound_average_realtime
The committed rate in Mbps.
Used to configure host networks. The minimum bandwidth required by a network. The committed rate requested is not guaranteed and will vary depending on the network infrastructure and the committed rate requested by other networks on the same logical link.
7.199.14. outbound_average_upperlimit
The maximum bandwidth to be used by a network in Mbps.
Used to configure host networks. If outboundAverageUpperlimit and outbound_average_realtime are provided, the outbound_averageUpperlimit must not be lower than the outbound_average_realtime.
See Libvirt-QOS for further details.
7.199.15. outbound_burst
The amount of data that can be sent in a single burst in MiB.
Used to configure virtual machines networks. If defined, outbound_average and outbound_peak also has to be set.
See Libvirt-QOS for further details.
7.199.16. outbound_peak
The maximum outbound rate in Mbps.
Used to configure virtual machines networks. If defined, outbound_average and outbound_burst also has to be set.
See Libvirt-QOS for further details.
| Name | Type | Summary |
|---|---|---|
|
| The data center the QoS is assiciated to. |
7.200. QosType enum
This type represents the kind of resource the Quality of service (QoS) can be assigned to.
| Name | Summary |
|---|---|
|
| The Quality of service (QoS) can be assigned to resources with computing capabilities. |
|
| The Quality of service (QoS) can be assigned to host networks. |
|
| The Quality of service (QoS) can be assigned to virtual machines networks. |
|
| The Quality of service (QoS) can be assigned to storage. |
7.201. Quota struct
Represents a quota object.
An example XML representation of a quota:
| Name | Type | Summary |
|---|---|---|
|
| ||
|
| ||
|
| Free text containing comments about this object. | |
|
| ||
|
| A human-readable description in plain text. | |
|
| ||
|
| A unique identifier. | |
|
| A human-readable name in plain text. | |
|
| ||
|
| ||
|
| ||
|
|
| Name | Type | Summary |
|---|---|---|
|
| ||
|
| ||
|
|
7.202. QuotaClusterLimit struct
| Name | Type | Summary |
|---|---|---|
|
| Free text containing comments about this object. | |
|
| A human-readable description in plain text. | |
|
| A unique identifier. | |
|
| ||
|
| ||
|
| A human-readable name in plain text. | |
|
| ||
|
|
7.203. QuotaModeType enum
| Name | Summary |
|---|---|
|
| |
|
| |
|
|
7.204. QuotaStorageLimit struct
| Name | Type | Summary |
|---|---|---|
|
| Free text containing comments about this object. | |
|
| A human-readable description in plain text. | |
|
| A unique identifier. | |
|
| ||
|
| A human-readable name in plain text. | |
|
|
| Name | Type | Summary |
|---|---|---|
|
| ||
|
|
7.205. Range struct
7.206. Rate struct
Determines maximum speed of consumption of bytes from random number generator device.
7.207. ReportedConfiguration struct
7.208. ReportedDevice struct
| Name | Type | Summary |
|---|---|---|
|
| Free text containing comments about this object. | |
|
| A human-readable description in plain text. | |
|
| A unique identifier. | |
|
| ||
|
| ||
|
| A human-readable name in plain text. | |
|
|
| Name | Type | Summary |
|---|---|---|
|
|
7.209. ReportedDeviceType enum
| Name | Summary |
|---|---|
|
|
7.210. ResolutionType enum
| Name | Summary |
|---|---|
|
| |
|
|
7.211. RngDevice struct
Random number generator (RNG) device model.
7.212. RngSource enum
Representing the random generator backend types.
| Name | Summary |
|---|---|
|
|
Obtains random data from the |
|
|
Obtains random data from the |
|
|
Obtains random data from the |
7.212.1. urandom
Obtains random data from the /dev/urandom device.
This RNG source is meant to replace random RNG source for non-cluster-aware entities (i.e. Blank template and instance types) and entities associated with clusters with compatibility version 4.1 or higher.
7.213. Role struct
Represents a system role.
| Name | Type | Summary |
|---|---|---|
|
| Defines the role as administrative-only or not. | |
|
| Free text containing comments about this object. | |
|
| A human-readable description in plain text. | |
|
| A unique identifier. | |
|
| Defines the ability to update or delete the role. | |
|
| A human-readable name in plain text. |
7.213.1. mutable
Defines the ability to update or delete the role.
Roles with mutable set to false are predefined roles.
7.214. RoleType enum
Type representing whether a role is administrative or not. A user which was granted at least one administrative role is considered an administrator.
| Name | Summary |
|---|---|
|
| Administrative role. |
|
| User role. |
7.215. SchedulingPolicy struct
| Name | Type | Summary |
|---|---|---|
|
| Free text containing comments about this object. | |
|
| ||
|
| A human-readable description in plain text. | |
|
| A unique identifier. | |
|
| ||
|
| A human-readable name in plain text. | |
|
|
7.216. SchedulingPolicyUnit struct
| Name | Type | Summary |
|---|---|---|
|
| Free text containing comments about this object. | |
|
| A human-readable description in plain text. | |
|
| ||
|
| A unique identifier. | |
|
| ||
|
| A human-readable name in plain text. | |
|
| ||
|
|
7.217. ScsiGenericIO enum
| Name | Summary |
|---|---|
|
| |
|
|
7.218. SeLinux struct
| Name | Type | Summary |
|---|---|---|
|
|
7.219. SeLinuxMode enum
| Name | Summary |
|---|---|
|
| |
|
| |
|
|
7.220. SerialNumber struct
| Name | Type | Summary |
|---|---|---|
|
| ||
|
|
7.221. SerialNumberPolicy enum
| Name | Summary |
|---|---|
|
| |
|
| |
|
|
7.222. Session struct
Describes a user session to a virtual machine.
| Name | Type | Summary |
|---|---|---|
|
| Free text containing comments about this object. | |
|
| Indicates if this is a console session. | |
|
| A human-readable description in plain text. | |
|
| A unique identifier. | |
|
| The IP address the user is connected from. | |
|
| A human-readable name in plain text. | |
|
| The protocol used by the session. |
7.222.1. console_user
Indicates if this is a console session.
The value will be true for console users (SPICE or VNC), and false for others (such as RDP or SSH).
7.222.2. ip
The IP address the user is connected from.
Currently only available for console users.
7.222.3. protocol
The protocol used by the session.
Currently not used. Intended for info about how the user is connected: through SPICE, VNC, SSH, or RDP.
7.222.4. user
The user related to this session.
If the user is a console user, this is a link to the real Red Hat Virtualization user. Otherwise, only the user name is provided.
7.223. SkipIfConnectivityBroken struct
| Name | Type | Summary |
|---|---|---|
|
| If enabled, we will not fence a host in case more than a configurable percentage of hosts in the cluster lost connectivity as well. | |
|
| Threshold for connectivity testing. |
7.223.1. enabled
If enabled, we will not fence a host in case more than a configurable percentage of hosts in the cluster lost connectivity as well. This comes to prevent fencing storm in cases where there is a global networking issue in the cluster.
7.223.2. threshold
Threshold for connectivity testing. If at least the threshold percentage of hosts in the cluster lost connectivity then fencing will not take place.
7.224. SkipIfSdActive struct
This type represents the storage related configuration in the fencing policy.
| Name | Type | Summary |
|---|---|---|
|
| If enabled, we will skip fencing in case the host maintains its lease in the storage. |
7.224.1. enabled
If enabled, we will skip fencing in case the host maintains its lease in the storage. It means that if the host still has storage access then it won’t get fenced.
7.225. Snapshot struct
Represents a snapshot object.
Example XML representation:
| Name | Type | Summary |
|---|---|---|
|
| Reference to virtual machine’s BIOS configuration. | |
|
| Free text containing comments about this object. | |
|
| Console configured for this virtual machine. | |
|
| The configuration of the virtual machine CPU. | |
|
| ||
|
| The virtual machine creation date. | |
|
| Virtual machine custom compatibility version. | |
|
| ||
|
| ||
|
| Properties sent to VDSM to configure various hooks. | |
|
| ||
|
|
If | |
|
| A human-readable description in plain text. | |
|
| The virtual machine display configuration. | |
|
| Domain configured for this virtual machine. | |
|
| Fully qualified domain name of the virtual machine. | |
|
| What operating system is installed on the virtual machine. | |
|
| What time zone is used by the virtual machine (as returned by guest agent). | |
|
| The virtual machine high availability configuration. | |
|
| A unique identifier. | |
|
| Reference to virtual machine’s initialization configuration. | |
|
| For performance tuning of IO threading. | |
|
| Virtual machine’s large icon. | |
|
| Reference to the storage domain this virtual machine/template lease reside on. | |
|
| The virtual machine’s memory, in bytes. | |
|
| Reference to virtual machine’s memory management configuration. | |
|
| Reference to configuration of migration of running virtual machine to another host. | |
|
| Maximum time the virtual machine can be non responsive during its live migration to another host in ms. | |
|
| A human-readable name in plain text. | |
|
| Virtual machine configuration has been changed and requires restart of the virtual machine. | |
|
| How the NUMA topology is applied. | |
|
| The origin of this virtual machine. | |
|
| Operating system type installed on the virtual machine. | |
|
| Optional payloads of the virtual machine, used for ISOs to configure it. | |
|
| Indicates if the content of the memory of the virtual machine is included in the snapshot. | |
|
| The configuration of the virtual machine’s placement policy. | |
|
| Random Number Generator device configuration for this virtual machine. | |
|
|
If | |
|
| Virtual machine’s serial number in a cluster. | |
|
| Virtual machine’s small icon. | |
|
| ||
|
| ||
|
|
If | |
|
| Reference to the Single Sign On configuration this virtual machine is configured for. | |
|
|
If | |
|
| The date in which the virtual machine was started. | |
|
|
If | |
|
| The current status of the virtual machine. | |
|
| Human readable detail of current status. | |
|
| The reason the virtual machine was stopped. | |
|
| The date in which the virtual machine was stopped. | |
|
| The virtual machine’s time zone set by oVirt. | |
|
|
If | |
|
| Determines whether the virtual machine is optimized for desktop or server. | |
|
| Configuration of USB devices for this virtual machine (count, type). | |
|
|
If | |
|
| Reference to VirtIO SCSI configuration. |
7.225.1. cpu
The configuration of the virtual machine CPU.
The socket configuration can be updated without rebooting the virtual machine. The cores and the threads require a reboot.
For example, to change the number of sockets to 4 immediately, and the number of cores and threads to 2 after reboot, send the following request:
PUT /ovirt-engine/api/vms/123
PUT /ovirt-engine/api/vms/123With a request body:
7.225.2. custom_compatibility_version
Virtual machine custom compatibility version.
Enables a virtual machine to be customized to its own compatibility version. If custom_compatibility_version is set, it overrides the cluster’s compatibility version for this particular virtual machine.
The compatibility version of a virtual machine is limited by the data center the virtual machine resides in, and is checked against capabilities of the host the virtual machine is planned to run on.
7.225.3. high_availability
The virtual machine high availability configuration. If set, the virtual machine will be automatically restarted when it unexpectedly goes down.
7.225.4. large_icon
Virtual machine’s large icon. Either set by user or refers to image set according to operating system.
7.225.5. lease
Reference to the storage domain this virtual machine/template lease reside on.
A virtual machine running with a lease requires checking while running that the lease is not taken by another host, preventing another instance of this virtual machine from running on another host. This provides protection against split-brain in highly available virtual machines. A template can also have a storage domain defined for a lease in order to have the virtual machines created from this template to be preconfigured with this storage domain as the location of the leases.
7.225.6. memory
The virtual machine’s memory, in bytes.
For example, to update a virtual machine to contain 1 Gibibyte (GiB) of memory, send the following request:
PUT /ovirt-engine/api/vms/123
PUT /ovirt-engine/api/vms/123With the following request body:
<vm> <memory>1073741824</memory> </vm>
<vm>
<memory>1073741824</memory>
</vm>
Memory in the example is converted to bytes using the following formula:
1 GiB = 230 bytes = 1073741824 bytes.
Memory hot plug is supported from Red Hat Virtualization 3.6 onwards. You can use the example above to increase memory while the virtual machine is running.
7.225.7. migration_downtime
Maximum time the virtual machine can be non responsive during its live migration to another host in ms.
Set either explicitly for the virtual machine or by engine-config -s DefaultMaximumMigrationDowntime=[value]
7.225.8. next_run_configuration_exists
Virtual machine configuration has been changed and requires restart of the virtual machine. Changed configuration is applied at processing the virtual machine’s shut down.
7.225.9. origin
The origin of this virtual machine.
Possible values:
-
ovirt -
rhev -
vmware -
xen -
external -
hosted_engine -
managed_hosted_engine -
kvm -
physical_machine -
hyperv
7.225.10. persist_memorystate
Indicates if the content of the memory of the virtual machine is included in the snapshot.
When a snapshot is created the default value is true.
7.225.11. placement_policy
The configuration of the virtual machine’s placement policy.
This configuration can be updated to pin a virtual machine to one or more hosts.
Virtual machines that are pinned to multiple hosts cannot be live migrated, but in the event of a host failure, any virtual machine configured to be highly available is automatically restarted on one of the other hosts to which the virtual machine is pinned.
For example, to pin a virtual machine to two hosts, send the following request:
PUT /api/vms/123
PUT /api/vms/123With a request body like this:
7.225.12. small_icon
Virtual machine’s small icon. Either set by user or refers to image set according to operating system.
7.225.13. sso
Reference to the Single Sign On configuration this virtual machine is configured for. The user can be automatically signed in the virtual machine’s operating system when console is opened.
7.225.14. stop_reason
The reason the virtual machine was stopped. Optionally set by user when shutting down the virtual machine.
| Name | Type | Summary |
|---|---|---|
|
| Optional. | |
|
| List of applications installed on the virtual machine. | |
|
| Reference to the ISO mounted to the CDROM. | |
|
| Reference to cluster the virtual machine belongs to. | |
|
| Reference to CPU profile used by this virtual machine. | |
|
| References the disks attached to the virtual machine. | |
|
| ||
|
| Reference to the ISO mounted to the floppy. | |
|
| List of graphics consoles configured for this virtual machine. | |
|
| Reference to the host the virtual machine is running on. | |
|
| References devices associated to this virtual machine. | |
|
| The virtual machine configuration can be optionally predefined via one of the instance types. | |
|
| Lists all the Katello errata assigned to the virtual machine. | |
|
| References the list of network interface devices on the virtual machine. | |
|
| Refers to the NUMA Nodes configuration used by this virtual machine. | |
|
| References the original template used to create the virtual machine. | |
|
| Permissions set for this virtual machine. | |
|
| Reference to quota configuration set for this virtual machine. | |
|
| ||
|
| List of user sessions opened for this virtual machine. | |
|
| Refers to all snapshots taken from the virtual machine. | |
|
| Statistics data collected from this virtual machine. | |
|
| Reference to storage domain the virtual machine belongs to. | |
|
| ||
|
| Reference to the template the virtual machine is based on. | |
|
| ||
|
| Reference to the pool the virtual machine is optionally member of. | |
|
| Refers to the Watchdog configuration. |
7.225.15. affinity_labels
Optional. Used for labeling of sub-clusters.
7.225.16. katello_errata
Lists all the Katello errata assigned to the virtual machine.
GET /ovirt-engine/api/vms/123/katelloerrata
GET /ovirt-engine/api/vms/123/katelloerrataYou will receive response in XML like this one:
7.225.17. original_template
References the original template used to create the virtual machine.
If the virtual machine is cloned from a template or another virtual machine, the template links to the Blank template, and the original_template is used to track history.
Otherwise the template and original_template are the same.
7.226. SnapshotStatus enum
| Name | Summary |
|---|---|
|
| |
|
| |
|
|
7.227. SnapshotType enum
| Name | Summary |
|---|---|
|
| |
|
| |
|
| |
|
|
7.228. SpecialObjects struct
This type contains references to special objects, such as blank templates and the root of a hierarchy of tags.
7.229. Spm struct
7.230. SpmStatus enum
| Name | Summary |
|---|---|
|
| |
|
| |
|
|
7.231. Ssh struct
| Name | Type | Summary |
|---|---|---|
|
| ||
|
| Free text containing comments about this object. | |
|
| A human-readable description in plain text. | |
|
| ||
|
| A unique identifier. | |
|
| A human-readable name in plain text. | |
|
| ||
|
|
7.232. SshAuthenticationMethod enum
| Name | Summary |
|---|---|
|
| |
|
|
7.233. SshPublicKey struct
| Name | Type | Summary |
|---|---|---|
|
| Free text containing comments about this object. | |
|
| ||
|
| A human-readable description in plain text. | |
|
| A unique identifier. | |
|
| A human-readable name in plain text. |
| Name | Type | Summary |
|---|---|---|
|
|
7.234. Sso struct
| Name | Type | Summary |
|---|---|---|
|
|
7.235. SsoMethod enum
| Name | Summary |
|---|---|
|
|
7.236. Statistic struct
A generic type used for all kinds of statistics.
Statistic contains the statistics values for various entities. The following object contain statistics:
- Disk
- Host
- HostNic
- NumaNode
- Nic
- Vm
- GlusterBrick
- Step
- GlusterVolume
An example of a XML representation:
This statistics sub-collection is read-only.
| Name | Type | Summary |
|---|---|---|
|
| Free text containing comments about this object. | |
|
| A human-readable description in plain text. | |
|
| A unique identifier. | |
|
| The type of statistic measures. | |
|
| A human-readable name in plain text. | |
|
| The data type for the statistical values that follow. | |
|
| The unit or rate to measure of the statistical values. | |
|
|
A data set that contains |
| Name | Type | Summary |
|---|---|---|
|
| ||
|
|
A relationship to the containing | |
|
| ||
|
| ||
|
| A reference to the host NIC. | |
|
| ||
|
| ||
|
| ||
|
|
7.237. StatisticKind enum
| Name | Summary |
|---|---|
|
| |
|
|
7.238. StatisticUnit enum
| Name | Summary |
|---|---|
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
|
7.239. Step struct
Represents a step, which is part of job execution. Step is used to describe and track a specific execution unit which is part of a wider sequence. Some steps support reporting their progress.
| Name | Type | Summary |
|---|---|---|
|
| Free text containing comments about this object. | |
|
| A human-readable description in plain text. | |
|
| The end time of the step. | |
|
| Indicates if the step is originated by an external system. | |
|
| The external system which is referenced by the step. | |
|
| A unique identifier. | |
|
| A human-readable name in plain text. | |
|
| The order of the step in current hierarchy level. | |
|
| The step progress (if reported) in percentages. | |
|
| The start time of the step. | |
|
| The status of the step. | |
|
| The type of the step. |
7.239.1. external
Indicates if the step is originated by an external system. External steps are managed externally, by the creator of the step.
| Name | Type | Summary |
|---|---|---|
|
| The host used for the step execution (optional). | |
|
|
References the | |
|
| References the parent step of the current step in the hierarchy. | |
|
|
7.240. StepEnum enum
Type representing a step type.
| Name | Summary |
|---|---|
|
| The executing step type. |
|
| The finalizing step type. |
|
|
The |
|
|
The |
|
| The unknown step type. |
|
| The validation step type. |
7.240.1. executing
The executing step type. Used to track the main execution block of the job. Usually it will be a parent step of several sub-steps which describe portions of the execution step.
7.240.2. finalizing
The finalizing step type. Describes the post-execution steps requires to complete the job.
7.240.3. rebalancing_volume
The rebalancing volume step type. Describes a step type which is part of Gluster flow.
7.240.4. removing_bricks
The removing bricks step type. Describes a step type which is part of Gluster flow.
7.240.5. unknown
The unknown step type. Describes a step type which its origin is unknown.
7.240.6. validating
The validation step type. Used to verify the correctness of parameters and the validity of the parameters prior to the execution.
7.241. StepStatus enum
Represents the status of the step.
| Name | Summary |
|---|---|
|
| The aborted step status. |
|
| The failed step status. |
|
| The finished step status. |
|
| The started step status. |
|
| The unknown step status. |
7.241.1. aborted
The aborted step status. This status is applicable for an external step that was forcibly aborted.
7.241.2. finished
The finished step status. This status describes a completed step execution.
7.241.3. started
The started step status. This status represents a step which is currently being executed.
7.241.4. unknown
The unknown step status. This status represents steps which their resolution is not known, i.e. steps that were executed before the system was unexpectedly restarted.
7.242. StorageConnection struct
Represents a storage server connection.
Example XML representation:
<storage_connection id="123"> <address>mynfs.example.com</address> <type>nfs</type> <path>/exports/mydata</path> </storage_connection>
<storage_connection id="123">
<address>mynfs.example.com</address>
<type>nfs</type>
<path>/exports/mydata</path>
</storage_connection>| Name | Type | Summary |
|---|---|---|
|
| ||
|
| Free text containing comments about this object. | |
|
| A human-readable description in plain text. | |
|
| A unique identifier. | |
|
| ||
|
| A human-readable name in plain text. | |
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
| ||
|
|
| Name | Type | Summary |
|---|---|---|
|
|
7.243. StorageConnectionExtension struct
| Name | Type | Summary |
|---|---|---|
|
| Free text containing comments about this object. | |
|
| A human-readable description in plain text. | |
|
| A unique identifier. | |
|
| A human-readable name in plain text. | |
|
| ||
|
| ||
|
|
| Name | Type | Summary |
|---|---|---|
|
|
7.244. StorageDomain struct
Storage domain.
An XML representation of a NFS storage domain with identifier 123:
| Name | Type | Summary |
|---|---|---|
|
| ||
|
| Free text containing comments about this object. | |
|
| ||
|
| ||
|
| A human-readable description in plain text. | |
|
| Indicates whether disks' blocks on block storage domains will be discarded right before they are deleted. | |
|
| ||
|
| A unique identifier. | |
|
| ||
|
| ||
|
| A human-readable name in plain text. | |
|
| ||
|
| ||
|
| ||
|
| Indicates whether a block storage domain supports discard operations. | |
|
| Indicates whether a block storage domain supports the property that discard zeroes the data. | |
|
| ||
|
| ||
|
| ||
|
|
Serves as the default value of |
7.244.1. discard_after_delete
Indicates whether disks' blocks on block storage domains will be discarded right before they are deleted.
If true, and a disk on this storage domain has its wipe_after_delete value enabled, then when the disk is deleted:
- It is first wiped.
- Then its blocks are discarded.
- Finally it is deleted.
Note that:
-
Discard after delete will always be
falsefor non block storage types. -
Discard after delete can be set to
trueonly if the storage domain supports discard.
7.244.2. supports_discard
Indicates whether a block storage domain supports discard operations. A storage domain only supports discard if all of the logical units that it is built from support discard; that is, if each logical unit’s discard_max_size value is greater than 0. This is one of the conditions necessary for a virtual disk in this storage domain to have its pass_discard attribute enabled. Since the engine cannot check if the underlying block device supports discard for file storage domains, this attribute will not be reported for them at all.
7.244.3. supports_discard_zeroes_data
Indicates whether a block storage domain supports the property that discard zeroes the data. A storage domain only supports the property that discard zeroes the data if all of the logical units that it is built from support it; that is, if each logical unit’s discard_zeroes_data value is true. This is one of the conditions necessary for a virtual disk in this storage domain to have both wipe_after_delete and pass_discard attributes enabled. Since the engine cannot check if the underlying block device supports the property that discard zeroes the data for file storage domains, this attribute will not be reported for them at all.
7.244.4. wipe_after_delete
Serves as the default value of wipe_after_delete for disks on this storage domain.
That is, newly created disks will get their wipe_after_delete value from their storage domains by default. Note that the configuration value SANWipeAfterDelete serves as the default value of block storage domains' wipe_after_delete value.
| Name | Type | Summary |
|---|---|---|
|
| A link to the data center that the storage domain is attached to. | |
|
| A set of links to the data centers that the storage domain is attached to. | |
|
| ||
|
| ||
|
| ||
|
| ||
|
| Host is only relevant at creation time. | |
|
| ||
|
| ||
|
| ||
|
| ||
|
|
7.244.5. data_center
A link to the data center that the storage domain is attached to. This is preserved for backwards compatibility only, as the storage domain may be attached to multiple data centers (if it is an ISO domain). Use the dataCenters element instead.
7.245. StorageDomainLease struct
Represents a lease residing on a storage domain.
A lease is a Sanlock resource residing on a special volume on the storage domain, this Sanlock resource is used to provide storage base locking.
| Name | Type | Summary |
|---|---|---|
|
| Reference to the storage domain on which the lock resides on. |
7.246. StorageDomainStatus enum
| Name | Summary |
|---|---|
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
|
7.247. StorageDomainType enum
| Name | Summary |
|---|---|
|
| |
|
| |
|
| |
|
| |
|
|
7.248. StorageFormat enum
| Name | Summary |
|---|---|
|
| |
|
| |
|
| |
|
| Version 4 of the storage domain format. |
7.249. StorageType enum
Type representing a storage domain type.
| Name | Summary |
|---|---|
|
| Cinder storage domain. |
|
| Fibre-Channel storage domain. |
|
| Glance storage domain. |
|
| Gluster-FS storage domain. |
|
| iSCSI storage domain. |
|
| Storage domain on Local storage. |
|
| NFS storage domain. |
|
| POSIX-FS storage domain. |
7.249.1. cinder
Cinder storage domain. For more details on Cinder please go to Cinder.
7.249.2. glance
Glance storage domain. For more details on Glance please go to Glance.
7.249.3. glusterfs
Gluster-FS storage domain. For more details on Gluster please go to Gluster.
7.250. SwitchType enum
Describes all switch types supported by the Manager.
| Name | Summary |
|---|---|
|
| The native switch type. |
|
| The Open vSwitch type. |
7.251. Tag struct
Represents a tag in the system.
| Name | Type | Summary |
|---|---|---|
|
| Free text containing comments about this object. | |
|
| A human-readable description in plain text. | |
|
| A unique identifier. | |
|
| A human-readable name in plain text. |
| Name | Type | Summary |
|---|---|---|
|
| Reference to the group which has this tag assigned. | |
|
| Reference to the host which has this tag assigned. | |
|
| Reference to the parent tag of this tag. | |
|
| Reference to the template which has this tag assigned. | |
|
| Reference to the user who has this tag assigned. | |
|
| Reference to the virtual machine which has this tag assigned. |
7.252. Template struct
Type representing a virtual machine template. This allows a rapid instanstiation of virtual machines with common configuration and disk states.
| Name | Type | Summary |
|---|---|---|
|
| Reference to virtual machine’s BIOS configuration. | |
|
| Free text containing comments about this object. | |
|
| Console configured for this virtual machine. | |
|
| The configuration of the virtual machine CPU. | |
|
| ||
|
| The virtual machine creation date. | |
|
| Virtual machine custom compatibility version. | |
|
| ||
|
| ||
|
| Properties sent to VDSM to configure various hooks. | |
|
|
If | |
|
| A human-readable description in plain text. | |
|
| The virtual machine display configuration. | |
|
| Domain configured for this virtual machine. | |
|
| The virtual machine high availability configuration. | |
|
| A unique identifier. | |
|
| Reference to virtual machine’s initialization configuration. | |
|
| For performance tuning of IO threading. | |
|
| Virtual machine’s large icon. | |
|
| Reference to the storage domain this virtual machine/template lease reside on. | |
|
| The virtual machine’s memory, in bytes. | |
|
| Reference to virtual machine’s memory management configuration. | |
|
| Reference to configuration of migration of running virtual machine to another host. | |
|
| Maximum time the virtual machine can be non responsive during its live migration to another host in ms. | |
|
| A human-readable name in plain text. | |
|
| The origin of this virtual machine. | |
|
| Operating system type installed on the virtual machine. | |
|
| Random Number Generator device configuration for this virtual machine. | |
|
| Virtual machine’s serial number in a cluster. | |
|
| Virtual machine’s small icon. | |
|
|
If | |
|
| Reference to the Single Sign On configuration this virtual machine is configured for. | |
|
|
If | |
|
|
If | |
|
| The status of the template. | |
|
| The virtual machine’s time zone set by oVirt. | |
|
|
If | |
|
| Determines whether the virtual machine is optimized for desktop or server. | |
|
| Configuration of USB devices for this virtual machine (count, type). | |
|
| Indicates whether this is a base version or a sub version of another template. | |
|
| Reference to VirtIO SCSI configuration. | |
|
| The virtual machine configuration associated with this template. |
7.252.1. cpu
The configuration of the virtual machine CPU.
The socket configuration can be updated without rebooting the virtual machine. The cores and the threads require a reboot.
For example, to change the number of sockets to 4 immediately, and the number of cores and threads to 2 after reboot, send the following request:
PUT /ovirt-engine/api/vms/123
PUT /ovirt-engine/api/vms/123With a request body:
7.252.2. custom_compatibility_version
Virtual machine custom compatibility version.
Enables a virtual machine to be customized to its own compatibility version. If custom_compatibility_version is set, it overrides the cluster’s compatibility version for this particular virtual machine.
The compatibility version of a virtual machine is limited by the data center the virtual machine resides in, and is checked against capabilities of the host the virtual machine is planned to run on.
7.252.3. high_availability
The virtual machine high availability configuration. If set, the virtual machine will be automatically restarted when it unexpectedly goes down.
7.252.4. large_icon
Virtual machine’s large icon. Either set by user or refers to image set according to operating system.
7.252.5. lease
Reference to the storage domain this virtual machine/template lease reside on.
A virtual machine running with a lease requires checking while running that the lease is not taken by another host, preventing another instance of this virtual machine from running on another host. This provides protection against split-brain in highly available virtual machines. A template can also have a storage domain defined for a lease in order to have the virtual machines created from this template to be preconfigured with this storage domain as the location of the leases.
7.252.6. memory
The virtual machine’s memory, in bytes.
For example, to update a virtual machine to contain 1 Gibibyte (GiB) of memory, send the following request:
PUT /ovirt-engine/api/vms/123
PUT /ovirt-engine/api/vms/123With the following request body:
<vm> <memory>1073741824</memory> </vm>
<vm>
<memory>1073741824</memory>
</vm>
Memory in the example is converted to bytes using the following formula:
1 GiB = 230 bytes = 1073741824 bytes.
Memory hot plug is supported from Red Hat Virtualization 3.6 onwards. You can use the example above to increase memory while the virtual machine is running.
7.252.7. migration_downtime
Maximum time the virtual machine can be non responsive during its live migration to another host in ms.
Set either explicitly for the virtual machine or by engine-config -s DefaultMaximumMigrationDowntime=[value]
7.252.8. origin
The origin of this virtual machine.
Possible values:
-
ovirt -
rhev -
vmware -
xen -
external -
hosted_engine -
managed_hosted_engine -
kvm -
physical_machine -
hyperv
7.252.9. small_icon
Virtual machine’s small icon. Either set by user or refers to image set according to operating system.
7.252.10. sso
Reference to the Single Sign On configuration this virtual machine is configured for. The user can be automatically signed in the virtual machine’s operating system when console is opened.
| Name | Type | Summary |
|---|---|---|
|
| References to the CD-ROM devices attached to the template. | |
|
| Reference to cluster the virtual machine belongs to. | |
|
| Reference to CPU profile used by this virtual machine. | |
|
| References to the disks attached to the template. | |
|
| References to the graphic consoles attached to the template. | |
|
| References to the network interfaces attached to the template. | |
|
| References to the user permissions attached to the template. | |
|
| Reference to quota configuration set for this virtual machine. | |
|
| Reference to storage domain the virtual machine belongs to. | |
|
| References to the tags attached to the template. | |
|
| References to the watchdog devices attached to the template. |
7.253. TemplateStatus enum
Type representing a status of a virtual machine template.
| Name | Summary |
|---|---|
|
| This status indicates that at least one of the disks of the template is illegal. |
|
| This status indicates that some operation that prevents other operations with the template is being executed. |
|
| This status indicates that the template is valid and ready for use. |
7.254. TemplateVersion struct
Type representing a version of a virtual machine template.
| Name | Type | Summary |
|---|---|---|
|
| The name of this version. | |
|
| The index of this version in the versions hierarchy of the template. |
7.254.1. version_number
The index of this version in the versions hierarchy of the template. The index 1 represents the original version of a template that is also called base version.
| Name | Type | Summary |
|---|---|---|
|
| References the template that this version is associated with. |
7.255. Ticket struct
Type representing a ticket that allows virtual machine access.
7.256. TimeZone struct
Time zone representation.
| Name | Type | Summary |
|---|---|---|
|
| Name of the time zone. | |
|
| Offset from https://en. |
7.256.1. utc_offset
Offset from UTC.
7.257. TransparentHugePages struct
Type representing a transparent huge pages (THP) support.
| Name | Type | Summary |
|---|---|---|
|
| Enable THP support. |
7.258. TransportType enum
Protocol used to access a Gluster volume.
| Name | Summary |
|---|---|
|
| Remote direct memory access. |
|
| TCP. |
7.259. UnmanagedNetwork struct
| Name | Type | Summary |
|---|---|---|
|
| Free text containing comments about this object. | |
|
| A human-readable description in plain text. | |
|
| A unique identifier. | |
|
| A human-readable name in plain text. |
7.260. Usb struct
7.261. UsbType enum
| Name | Summary |
|---|---|
|
| A legacy USB type. |
|
|
7.261.1. legacy
A legacy USB type.
This USB type has been deprecated since version 3.6 of the engine, and has been completely removed in version 4.1. It is preserved only to avoid syntax errors in existing scripts. If it is used it will be automatically replaced by native.
7.262. User struct
Represents a user in the system.
| Name | Type | Summary |
|---|---|---|
|
| Free text containing comments about this object. | |
|
| ||
|
| A human-readable description in plain text. | |
|
| ||
|
| ||
|
| A unique identifier. | |
|
| ||
|
| ||
|
| A human-readable name in plain text. | |
|
| Namespace where the user resides. | |
|
| ||
|
|
Similar to | |
|
| The user’s username. |
7.262.1. namespace
Namespace where the user resides. When using the authorization provider that stores users in the LDAP server, this attribute equals the naming context of the LDAP server. See https://github.com/oVirt/ovirt-engine-extension-aaa-ldap for more information. When using the built-in authorization provider that stores users in the database this attribute is ignored. See https://github.com/oVirt/ovirt-engine-extension-aaa-jdbc for more information.
7.262.2. principal
Similar to user_name. The format depends on the LDAP provider. With most LDAP providers it is the value of the uid LDAP attribute. In the case of Active Directory it is the User Principal Name (UPN).
7.262.3. user_name
The user’s username. The format depends on authorization provider type. In most LDAP providers it is the value of the uid LDAP attribute. In Active Directory it is the User Principal Name (UPN). UPN or uid must be followed by the authorization provider name. For example, in the case of LDAP’s uid attribute it is: myuser@myextension-authz. In the case of Active Directory using UPN it is: myuser@mysubdomain.mydomain.com@myextension-authz. This attribute is a required parameter when adding a new user.
| Name | Type | Summary |
|---|---|---|
|
| ||
|
| ||
|
| ||
|
| A link to the roles sub-collection for user resources. | |
|
| ||
|
| A link to the tags sub-collection for user resources. |
7.263. Value struct
7.264. ValueType enum
| Name | Summary |
|---|---|
|
| |
|
| |
|
|
7.265. VcpuPin struct
7.266. Vendor struct
7.267. Version struct
| Name | Type | Summary |
|---|---|---|
|
| ||
|
| Free text containing comments about this object. | |
|
| A human-readable description in plain text. | |
|
| ||
|
| A unique identifier. | |
|
| ||
|
| ||
|
| A human-readable name in plain text. | |
|
|
7.268. VirtioScsi struct
Type representing the support of virtio-SCSI. If it supported we use virtio driver for SCSI guest device.
| Name | Type | Summary |
|---|---|---|
|
| Enable Virtio SCSI support. |
7.269. VirtualNumaNode struct
Represents the virtual NUMA node.
An example XML representation:
| Name | Type | Summary |
|---|---|---|
|
| Free text containing comments about this object. | |
|
| ||
|
| A human-readable description in plain text. | |
|
| A unique identifier. | |
|
| ||
|
| Memory of the NUMA node in MB. | |
|
| A human-readable name in plain text. | |
|
| ||
|
|
| Name | Type | Summary |
|---|---|---|
|
| ||
|
| Each host NUMA node resource exposes a statistics sub-collection for host NUMA node specific statistics. | |
|
|
7.269.1. statistics
Each host NUMA node resource exposes a statistics sub-collection for host NUMA node specific statistics.
An example of an XML representation:
This statistics sub-collection is read-only.
The following list shows the statistic types for a host NUMA node:
| Name | Description |
|---|---|
|
| Total memory in bytes on the NUMA node. |
|
| Memory in bytes used on the NUMA node. |
|
| Memory in bytes free on the NUMA node. |
|
| Percentage of CPU usage for user slice. |
|
| Percentage of CPU usage for system. |
|
| Percentage of idle CPU usage. |
7.270. Vlan struct
Type representing a Virtual LAN (VLAN) type.
| Name | Type | Summary |
|---|---|---|
|
| Virtual LAN ID. |
7.271. Vm struct
Represents a virtual machine.
| Name | Type | Summary |
|---|---|---|
|
| Reference to virtual machine’s BIOS configuration. | |
|
| Free text containing comments about this object. | |
|
| Console configured for this virtual machine. | |
|
| The configuration of the virtual machine CPU. | |
|
| ||
|
| The virtual machine creation date. | |
|
| Virtual machine custom compatibility version. | |
|
| ||
|
| ||
|
| Properties sent to VDSM to configure various hooks. | |
|
|
If | |
|
| A human-readable description in plain text. | |
|
| The virtual machine display configuration. | |
|
| Domain configured for this virtual machine. | |
|
| Fully qualified domain name of the virtual machine. | |
|
| What operating system is installed on the virtual machine. | |
|
| What time zone is used by the virtual machine (as returned by guest agent). | |
|
| The virtual machine high availability configuration. | |
|
| A unique identifier. | |
|
| Reference to virtual machine’s initialization configuration. | |
|
| For performance tuning of IO threading. | |
|
| Virtual machine’s large icon. | |
|
| Reference to the storage domain this virtual machine/template lease reside on. | |
|
| The virtual machine’s memory, in bytes. | |
|
| Reference to virtual machine’s memory management configuration. | |
|
| Reference to configuration of migration of running virtual machine to another host. | |
|
| Maximum time the virtual machine can be non responsive during its live migration to another host in ms. | |
|
| A human-readable name in plain text. | |
|
| Virtual machine configuration has been changed and requires restart of the virtual machine. | |
|
| How the NUMA topology is applied. | |
|
| The origin of this virtual machine. | |
|
| Operating system type installed on the virtual machine. | |
|
| Optional payloads of the virtual machine, used for ISOs to configure it. | |
|
| The configuration of the virtual machine’s placement policy. | |
|
| Random Number Generator device configuration for this virtual machine. | |
|
|
If | |
|
| Virtual machine’s serial number in a cluster. | |
|
| Virtual machine’s small icon. | |
|
|
If | |
|
| Reference to the Single Sign On configuration this virtual machine is configured for. | |
|
|
If | |
|
| The date in which the virtual machine was started. | |
|
|
If | |
|
| The current status of the virtual machine. | |
|
| Human readable detail of current status. | |
|
| The reason the virtual machine was stopped. | |
|
| The date in which the virtual machine was stopped. | |
|
| The virtual machine’s time zone set by oVirt. | |
|
|
If | |
|
| Determines whether the virtual machine is optimized for desktop or server. | |
|
| Configuration of USB devices for this virtual machine (count, type). | |
|
|
If | |
|
| Reference to VirtIO SCSI configuration. |
7.271.1. cpu
The configuration of the virtual machine CPU.
The socket configuration can be updated without rebooting the virtual machine. The cores and the threads require a reboot.
For example, to change the number of sockets to 4 immediately, and the number of cores and threads to 2 after reboot, send the following request:
PUT /ovirt-engine/api/vms/123
PUT /ovirt-engine/api/vms/123With a request body:
7.271.2. custom_compatibility_version
Virtual machine custom compatibility version.
Enables a virtual machine to be customized to its own compatibility version. If custom_compatibility_version is set, it overrides the cluster’s compatibility version for this particular virtual machine.
The compatibility version of a virtual machine is limited by the data center the virtual machine resides in, and is checked against capabilities of the host the virtual machine is planned to run on.
7.271.3. high_availability
The virtual machine high availability configuration. If set, the virtual machine will be automatically restarted when it unexpectedly goes down.
7.271.4. large_icon
Virtual machine’s large icon. Either set by user or refers to image set according to operating system.
7.271.5. lease
Reference to the storage domain this virtual machine/template lease reside on.
A virtual machine running with a lease requires checking while running that the lease is not taken by another host, preventing another instance of this virtual machine from running on another host. This provides protection against split-brain in highly available virtual machines. A template can also have a storage domain defined for a lease in order to have the virtual machines created from this template to be preconfigured with this storage domain as the location of the leases.
7.271.6. memory
The virtual machine’s memory, in bytes.
For example, to update a virtual machine to contain 1 Gibibyte (GiB) of memory, send the following request:
PUT /ovirt-engine/api/vms/123
PUT /ovirt-engine/api/vms/123With the following request body:
<vm> <memory>1073741824</memory> </vm>
<vm>
<memory>1073741824</memory>
</vm>
Memory in the example is converted to bytes using the following formula:
1 GiB = 230 bytes = 1073741824 bytes.
Memory hot plug is supported from Red Hat Virtualization 3.6 onwards. You can use the example above to increase memory while the virtual machine is running.
7.271.7. migration_downtime
Maximum time the virtual machine can be non responsive during its live migration to another host in ms.
Set either explicitly for the virtual machine or by engine-config -s DefaultMaximumMigrationDowntime=[value]
7.271.8. next_run_configuration_exists
Virtual machine configuration has been changed and requires restart of the virtual machine. Changed configuration is applied at processing the virtual machine’s shut down.
7.271.9. origin
The origin of this virtual machine.
Possible values:
-
ovirt -
rhev -
vmware -
xen -
external -
hosted_engine -
managed_hosted_engine -
kvm -
physical_machine -
hyperv
7.271.10. placement_policy
The configuration of the virtual machine’s placement policy.
This configuration can be updated to pin a virtual machine to one or more hosts.
Virtual machines that are pinned to multiple hosts cannot be live migrated, but in the event of a host failure, any virtual machine configured to be highly available is automatically restarted on one of the other hosts to which the virtual machine is pinned.
For example, to pin a virtual machine to two hosts, send the following request:
PUT /api/vms/123
PUT /api/vms/123With a request body like this:
7.271.11. small_icon
Virtual machine’s small icon. Either set by user or refers to image set according to operating system.
7.271.12. sso
Reference to the Single Sign On configuration this virtual machine is configured for. The user can be automatically signed in the virtual machine’s operating system when console is opened.
7.271.13. stop_reason
The reason the virtual machine was stopped. Optionally set by user when shutting down the virtual machine.
| Name | Type | Summary |
|---|---|---|
|
| Optional. | |
|
| List of applications installed on the virtual machine. | |
|
| Reference to the ISO mounted to the CDROM. | |
|
| Reference to cluster the virtual machine belongs to. | |
|
| Reference to CPU profile used by this virtual machine. | |
|
| References the disks attached to the virtual machine. | |
|
| ||
|
| Reference to the ISO mounted to the floppy. | |
|
| List of graphics consoles configured for this virtual machine. | |
|
| Reference to the host the virtual machine is running on. | |
|
| References devices associated to this virtual machine. | |
|
| The virtual machine configuration can be optionally predefined via one of the instance types. | |
|
| Lists all the Katello errata assigned to the virtual machine. | |
|
| References the list of network interface devices on the virtual machine. | |
|
| Refers to the NUMA Nodes configuration used by this virtual machine. | |
|
| References the original template used to create the virtual machine. | |
|
| Permissions set for this virtual machine. | |
|
| Reference to quota configuration set for this virtual machine. | |
|
| ||
|
| List of user sessions opened for this virtual machine. | |
|
| Refers to all snapshots taken from the virtual machine. | |
|
| Statistics data collected from this virtual machine. | |
|
| Reference to storage domain the virtual machine belongs to. | |
|
| ||
|
| Reference to the template the virtual machine is based on. | |
|
| Reference to the pool the virtual machine is optionally member of. | |
|
| Refers to the Watchdog configuration. |
7.271.14. affinity_labels
Optional. Used for labeling of sub-clusters.
7.271.15. katello_errata
Lists all the Katello errata assigned to the virtual machine.
GET /ovirt-engine/api/vms/123/katelloerrata
GET /ovirt-engine/api/vms/123/katelloerrataYou will receive response in XML like this one:
7.271.16. original_template
References the original template used to create the virtual machine.
If the virtual machine is cloned from a template or another virtual machine, the template links to the Blank template, and the original_template is used to track history.
Otherwise the template and original_template are the same.
7.272. VmAffinity enum
| Name | Summary |
|---|---|
|
| |
|
| |
|
|
7.273. VmBase struct
Represents basic virtual machine configuration. This is used by virtual machines, templates and instance types.
| Name | Type | Summary |
|---|---|---|
|
| Reference to virtual machine’s BIOS configuration. | |
|
| Free text containing comments about this object. | |
|
| Console configured for this virtual machine. | |
|
| The configuration of the virtual machine CPU. | |
|
| ||
|
| The virtual machine creation date. | |
|
| Virtual machine custom compatibility version. | |
|
| ||
|
| ||
|
| Properties sent to VDSM to configure various hooks. | |
|
|
If | |
|
| A human-readable description in plain text. | |
|
| The virtual machine display configuration. | |
|
| Domain configured for this virtual machine. | |
|
| The virtual machine high availability configuration. | |
|
| A unique identifier. | |
|
| Reference to virtual machine’s initialization configuration. | |
|
| For performance tuning of IO threading. | |
|
| Virtual machine’s large icon. | |
|
| Reference to the storage domain this virtual machine/template lease reside on. | |
|
| The virtual machine’s memory, in bytes. | |
|
| Reference to virtual machine’s memory management configuration. | |
|
| Reference to configuration of migration of running virtual machine to another host. | |
|
| Maximum time the virtual machine can be non responsive during its live migration to another host in ms. | |
|
| A human-readable name in plain text. | |
|
| The origin of this virtual machine. | |
|
| Operating system type installed on the virtual machine. | |
|
| Random Number Generator device configuration for this virtual machine. | |
|
| Virtual machine’s serial number in a cluster. | |
|
| Virtual machine’s small icon. | |
|
|
If | |
|
| Reference to the Single Sign On configuration this virtual machine is configured for. | |
|
|
If | |
|
|
If | |
|
| The virtual machine’s time zone set by oVirt. | |
|
|
If | |
|
| Determines whether the virtual machine is optimized for desktop or server. | |
|
| Configuration of USB devices for this virtual machine (count, type). | |
|
| Reference to VirtIO SCSI configuration. |
7.273.1. cpu
The configuration of the virtual machine CPU.
The socket configuration can be updated without rebooting the virtual machine. The cores and the threads require a reboot.
For example, to change the number of sockets to 4 immediately, and the number of cores and threads to 2 after reboot, send the following request:
PUT /ovirt-engine/api/vms/123
PUT /ovirt-engine/api/vms/123With a request body:
7.273.2. custom_compatibility_version
Virtual machine custom compatibility version.
Enables a virtual machine to be customized to its own compatibility version. If custom_compatibility_version is set, it overrides the cluster’s compatibility version for this particular virtual machine.
The compatibility version of a virtual machine is limited by the data center the virtual machine resides in, and is checked against capabilities of the host the virtual machine is planned to run on.
7.273.3. high_availability
The virtual machine high availability configuration. If set, the virtual machine will be automatically restarted when it unexpectedly goes down.
7.273.4. large_icon
Virtual machine’s large icon. Either set by user or refers to image set according to operating system.
7.273.5. lease
Reference to the storage domain this virtual machine/template lease reside on.
A virtual machine running with a lease requires checking while running that the lease is not taken by another host, preventing another instance of this virtual machine from running on another host. This provides protection against split-brain in highly available virtual machines. A template can also have a storage domain defined for a lease in order to have the virtual machines created from this template to be preconfigured with this storage domain as the location of the leases.
7.273.6. memory
The virtual machine’s memory, in bytes.
For example, to update a virtual machine to contain 1 Gibibyte (GiB) of memory, send the following request:
PUT /ovirt-engine/api/vms/123
PUT /ovirt-engine/api/vms/123With the following request body:
<vm> <memory>1073741824</memory> </vm>
<vm>
<memory>1073741824</memory>
</vm>
Memory in the example is converted to bytes using the following formula:
1 GiB = 230 bytes = 1073741824 bytes.
Memory hot plug is supported from Red Hat Virtualization 3.6 onwards. You can use the example above to increase memory while the virtual machine is running.
7.273.7. migration_downtime
Maximum time the virtual machine can be non responsive during its live migration to another host in ms.
Set either explicitly for the virtual machine or by engine-config -s DefaultMaximumMigrationDowntime=[value]
7.273.8. origin
The origin of this virtual machine.
Possible values:
-
ovirt -
rhev -
vmware -
xen -
external -
hosted_engine -
managed_hosted_engine -
kvm -
physical_machine -
hyperv
7.273.9. small_icon
Virtual machine’s small icon. Either set by user or refers to image set according to operating system.
7.273.10. sso
Reference to the Single Sign On configuration this virtual machine is configured for. The user can be automatically signed in the virtual machine’s operating system when console is opened.
| Name | Type | Summary |
|---|---|---|
|
| Reference to cluster the virtual machine belongs to. | |
|
| Reference to CPU profile used by this virtual machine. | |
|
| Reference to quota configuration set for this virtual machine. | |
|
| Reference to storage domain the virtual machine belongs to. |
7.274. VmDeviceType enum
| Name | Summary |
|---|---|
|
| |
|
|
7.275. VmPlacementPolicy struct
| Name | Type | Summary |
|---|---|---|
|
|
| Name | Type | Summary |
|---|---|---|
|
|
7.276. VmPool struct
| Name | Type | Summary |
|---|---|---|
|
| Indicates if the pool should automatically distribute the disks of the virtual machines across the multiple storage domains where the template is copied. | |
|
| Free text containing comments about this object. | |
|
| A human-readable description in plain text. | |
|
| ||
|
| A unique identifier. | |
|
| ||
|
| A human-readable name in plain text. | |
|
| ||
|
| ||
|
| ||
|
| ||
|
| Virtual machine pool’s stateful flag. | |
|
| ||
|
|
7.276.1. auto_storage_select
Indicates if the pool should automatically distribute the disks of the virtual machines across the multiple storage domains where the template is copied.
When the template used by the pool is present in multiple storage domains, the disks of the virtual machines of the pool will be created in one of those storage domains. By default, or when the value of this attribute is false, that storage domain is selected when the pool is created, and all virtual machines will use the same. If this attribute is true, then, when a virtual machine is added to the pool, the storage domain that has more free space is selected.
7.276.2. stateful
Virtual machine pool’s stateful flag.
Virtual machines from a stateful virtual machine pool are always started in stateful mode (stateless snapshot is not created). The state of the virtual machine is preserved even when the virtual machine is passed to a different user.
| Name | Type | Summary |
|---|---|---|
|
| ||
|
| Reference to the instance type on which this pool is based. | |
|
| ||
|
| ||
|
|
7.276.3. instance_type
Reference to the instance type on which this pool is based. It can be set only on pool creation and cannot be edited.
7.277. VmPoolType enum
| Name | Summary |
|---|---|
|
| |
|
|
7.278. VmStatus enum
Type represeting a status of a virtual machine.
| Name | Summary |
|---|---|
|
| This status indicates that the virtual machine process is not running. |
|
| This status indicates that the virtual machine process is not running and there is some operation on the disks of the virtual machine that prevents it from being started. |
|
| This status indicates that the virtual machine process is running and the virtual machine is being migrated from one host to another. |
|
| This status indicates that the hypervisor detected that the virtual machine is not responding. |
|
| This status indicates that the virtual machine process is running and the virtual machine is paused. |
|
| This status indicates that the virtual machine process is running and it is about to stop running. |
|
| This status indicates that the virtual machine process is running and the guest operating system is being loaded. |
|
| This status indicates that the virtual machine process is running and the guest operating system is being rebooted. |
|
| This status indicates that the virtual machine process is about to run and the virtual machine is going to awake from hibernation. |
|
| This status indicates that the virtual machine process is running and the virtual machine is being hibernated. |
|
| This status indicates that the virtual machine process is not running and a running state of the virtual machine was saved. |
|
| This status is set when an invalid status is received. |
|
| This status indicates that the system failed to determine the status of the virtual machine. |
|
| This status indicates that the virtual machine process is running and the guest operating system is loaded. |
|
| This status indicates that the virtual machine process is about to run. |
7.278.1. paused
This status indicates that the virtual machine process is running and the virtual machine is paused. This may happen in two cases: when running a virtual machine is paused mode and when the virtual machine is being automatically paused due to an error.
7.278.2. powering_up
This status indicates that the virtual machine process is running and the guest operating system is being loaded. Note that if no guest-agent is installed, this status is set for a predefined period of time, that is by default 60 seconds, when running a virtual machine.
7.278.3. restoring_state
This status indicates that the virtual machine process is about to run and the virtual machine is going to awake from hibernation. In this status, the running state of the virtual machine is being restored.
7.278.4. saving_state
This status indicates that the virtual machine process is running and the virtual machine is being hibernated. In this status, the running state of the virtual machine is being saved. Note that this status does not mean that the guest operating system is being hibernated.
7.278.5. suspended
This status indicates that the virtual machine process is not running and a running state of the virtual machine was saved. This status is similar to Down, but when the VM is started in this status its saved running state is restored instead of being booted using the normal procedue.
7.278.6. unknown
This status indicates that the system failed to determine the status of the virtual machine. The virtual machine process may be running or not running in this status. For instance, when host becomes non-responsive the virtual machines that ran on it are set with this status.
7.278.7. up
This status indicates that the virtual machine process is running and the guest operating system is loaded. Note that if no guest-agent is installed, this status is set after a predefined period of time, that is by default 60 seconds, when running a virtual machine.
7.278.8. wait_for_launch
This status indicates that the virtual machine process is about to run. This status is set when a request to run a virtual machine arrives to the host. It is possible that the virtual machine process will fail to run.
7.279. VmSummary struct
7.280. VmType enum
Type representing what the virtual machine is optimized for.
| Name | Summary |
|---|---|
|
| The virtual machine is intended to be used as a desktop. |
|
| The virtual machine is intended to be used as a server. |
7.280.1. desktop
The virtual machine is intended to be used as a desktop. Currently, its implication is that a sound device will be automatically added to the virtual machine.
7.280.2. server
The virtual machine is intended to be used as a server. Currently, its implication is that a sound device will not be automatically added to the virtual machine.
7.281. VnicPassThrough struct
| Name | Type | Summary |
|---|---|---|
|
| Defines whether the vNIC will be implemented as a virtual device, or as a pass-through to a host device. |
7.282. VnicPassThroughMode enum
Describes whether the vNIC is to be implemented as a pass-through device or a virtual one.
| Name | Summary |
|---|---|
|
| To be implemented as a virtual device. |
|
| To be implemented as a pass-through device. |
7.283. VnicProfile struct
A vNIC profile is a collection of settings that can be applied to individual NIC.
| Name | Type | Summary |
|---|---|---|
|
| Free text containing comments about this object. | |
|
| Custom properties applied to the vNIC profile. | |
|
| A human-readable description in plain text. | |
|
| A unique identifier. | |
|
|
Marks, whether | |
|
| A human-readable name in plain text. | |
|
| Enables the passthrough to a SR-IOV-enabled host NIC. | |
|
| Enables port mirroring. |
7.283.1. migratable
Marks, whether pass_through NIC is migratable or not.
If pass_through.mode is set to disabled this option has no meaning, and it will be considered to be true. If you omit this option from request, by default, this will be set to true.
When migrating virtual machine, this virtual machine will be migrated only if all pass_through NICs are flagged as migratable.
7.283.2. pass_through
Enables the passthrough to a SR-IOV-enabled host NIC.
A vNIC profile enables a NIC to be directly connected to a virtual function (VF) of an SR-IOV-enabled host NIC, if passthrough is enabled. The NIC will then bypass the software network virtualization and connect directly to the VF for direct device assignment.
The passthrough cannot be enabled if the vNIC profile is already attached to a NIC. If a vNIC profile has passthrough enabled, qos and port_mirroring are disabled for the vNIC profile.
7.283.3. port_mirroring
Enables port mirroring.
Port mirroring copies layer 3 network traffic on a given logical networkand host to a NIC on a virtual machine. This virtual machine can be used for network debugging and tuning, intrusion detection, and monitoring the behavior of other virtual machine on the same host and logical network. The only traffic copied is internal to one logical network on one host. There is no increase on traffic on the network external to the host; however a virtual machine with port mirroring enabled uses more host CPU and RAM than other virtual machines.
Port mirroring has the following limitations:
- Hot plugging NIC with a vNIC profile that has port mirroring enabled is not supported.
- Port mirroring cannot be altered when the vNIC profile is attached to a virtual machine.
Given the above limitations, it is recommended that you enable port mirroring on an additional, dedicated vNIC profile.
Enabling port mirroring reduces the privacy of other network users.
| Name | Type | Summary |
|---|---|---|
|
| Reference to the network that the vNIC profile is applied to. | |
|
| Reference to the top-level network filter that apply to the NICs that use this profile. | |
|
| Permissions to allow usage of the vNIC profile. | |
|
| Reference to the quality of service attributes to apply to the vNIC profile. |
7.283.4. network_filter
Reference to the top-level network filter that apply to the NICs that use this profile.
Network filters will enhance the admin ability to manage the network packets traffic from/to the participated virtual machines. The network filter may either contain a references to other filters, rules for traffic filtering, or hold a combination of both.
7.283.5. qos
Reference to the quality of service attributes to apply to the vNIC profile.
Quality of Service attributes regulate inbound and outbound network traffic of the NIC.
7.284. VnicProfileMapping struct
Maps an external virtual NIC profile to one that exists in the Red Hat Virtualization Manager.
If, for example, the desired virtual NIC profile’s mapping includes the following two lines:
| Source network name | Source network profile name | Target virtual NIC profile ID |
|---|---|---|
|
|
|
|
|
|
|
|
It should be expressed in the following form:
| Name | Type | Summary |
|---|---|---|
|
| Specifies the name of the external network. | |
|
| Specifies the name of the external network profile. |
| Name | Type | Summary |
|---|---|---|
|
| Points to an existing virtual NIC profile. |
7.285. VolumeGroup struct
| Name | Type | Summary |
|---|---|---|
|
| ||
|
| ||
|
|
7.286. Watchdog struct
This type represents a watchdog configuration.
| Name | Type | Summary |
|---|---|---|
|
| Watchdog action to be performed when watchdog is triggered. | |
|
| Free text containing comments about this object. | |
|
| A human-readable description in plain text. | |
|
| A unique identifier. | |
|
| Model of watchdog device. | |
|
| A human-readable name in plain text. |
7.286.1. model
Model of watchdog device. Currently supported only I6300ESB.
| Name | Type | Summary |
|---|---|---|
|
| Optionally references to an instance type the device is used by. | |
|
| Optionally references to a template the device is used by. | |
|
|
Don’t use this element, use | |
|
| References to the virtual machines that are using this device. |
7.286.2. vms
References to the virtual machines that are using this device. A device may be used by several virtual machines; for example, a shared disk my be used simultaneously by two or more virtual machines.
7.287. WatchdogAction enum
This type describes available watchdog actions.
| Name | Summary |
|---|---|
|
| Virtual machine process will get core dumped to the default path on the host. |
|
| No action will be performed when watchdog action is triggered. |
|
| Virtual machine will be paused when watchdog action is triggered. |
|
| Virtual machine will be powered off when watchdog action is triggered. |
|
| Virtual machine will be rebooted when watchdog action is triggered. |
7.287.1. none
No action will be performed when watchdog action is triggered. However log message will still be generated.
7.288. WatchdogModel enum
This type represents the watchdog model.
| Name | Summary |
|---|---|
|
| Currently only model supported is model I6300ESB. |
7.289. Weight struct
| Name | Type | Summary |
|---|---|---|
|
| Free text containing comments about this object. | |
|
| A human-readable description in plain text. | |
|
| ||
|
| A unique identifier. | |
|
| A human-readable name in plain text. |
| Name | Type | Summary |
|---|---|---|
|
| ||
|
|
'%20d='M201.5%20305.5c-13.8%200-24.9-11.1-24.9-24.6%200-13.8%2011.1-24.9%2024.9-24.9%2013.6%200%2024.6%2011.1%2024.6%2024.9%200%2013.6-11.1%2024.6-24.6%2024.6zM504%20256c0%20137-111%20248-248%20248S8%20393%208%20256%20119%208%20256%208s248%20111%20248%20248zm-132.3-41.2c-9.4%200-17.7%203.9-23.8%2010-22.4-15.5-52.6-25.5-86.1-26.6l17.4-78.3%2055.4%2012.5c0%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.3%2024.9-24.9s-11.1-24.9-24.9-24.9c-9.7%200-18%205.8-22.1%2013.8l-61.2-13.6c-3-.8-6.1%201.4-6.9%204.4l-19.1%2086.4c-33.2%201.4-63.1%2011.3-85.5%2026.8-6.1-6.4-14.7-10.2-24.1-10.2-34.9%200-46.3%2046.9-14.4%2062.8-1.1%205-1.7%2010.2-1.7%2015.5%200%2052.6%2059.2%2095.2%20132%2095.2%2073.1%200%20132.3-42.6%20132.3-95.2%200-5.3-.6-10.8-1.9-15.8%2031.3-16%2019.8-62.5-14.9-62.5zM302.8%20331c-18.2%2018.2-76.1%2017.9-93.6%200-2.2-2.2-6.1-2.2-8.3%200-2.5%202.5-2.5%206.4%200%208.6%2022.8%2022.8%2087.3%2022.8%20110.2%200%202.5-2.2%202.5-6.1%200-8.6-2.2-2.2-6.1-2.2-8.3%200zm7.7-75c-13.6%200-24.6%2011.1-24.6%2024.9%200%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.1%2024.9-24.6%200-13.8-11-24.9-24.9-24.9z'/%3e%3c/svg%3e){kind=small}