Chapter 7. Types
This section enumerates all the data types that are available in the API.
7.1. AccessProtocol enum
Represents the access protocols supported by Gluster volumes. gluster
and nfs
are enabled by default.
Table 7.1. Values summary
Name | Summary |
---|---|
| CIFS access protocol. |
| Gluster access protocol. |
| NFS access protocol. |
7.2. Action struct
Table 7.2. Attributes summary
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.
Table 7.3. Attributes summary
Name | Type | Summary |
---|---|---|
| Specifies if the affinity group is broken. | |
| 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. | |
| Priority of the affinity group. | |
| Specifies the affinity rule applied to virtual machines that are members of this affinity group. |
7.3.1. broken
Specifies if the affinity group is broken. Affinity group is considered broken when any of its rules are not satisfied. Broken field is a computed field in the engine. Because of that, this field is only usable in GET requests.
7.3.2. 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.3. 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.
Table 7.4. Links summary
Name | Type | Summary |
---|---|---|
| A reference to the cluster to which the affinity group applies. | |
| A list of all host labels assigned to this affinity group. | |
| A list of all hosts assigned to this affinity group. | |
| A list of all virtual machine labels assigned to this affinity group. | |
| Vm[] | A list of all virtual machines assigned to this affinity group. |
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.
Table 7.5. Attributes summary
Name | Type | Summary |
---|---|---|
| Free text containing comments about this object. | |
| A human-readable description in plain text. | |
| This property enables the legacy behavior for labels. | |
| A unique identifier. | |
| A human-readable name in plain text. | |
|
The |
7.4.1. has_implicit_affinity_group
This property enables the legacy behavior for labels. If true
, the label acts also as a positive enforcing VM-to-host affinity group.
This parameter is only used for clusters with compatibility version 4.3 or lower.
7.4.2. 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.
Table 7.7. Attributes summary
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.
Table 7.8. Attributes summary
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. |
Table 7.9. Links summary
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
Deprecated Agent configuration settings.
Ignored, because the deployment of OpenStack Neutron agent is dropped since Red Hat Virtualization 4.4.0. The deployment of OpenStack hosts can be done by Red Hat OpenStack Platform Director or TripleO.
Table 7.10. Attributes summary
7.7.1. network_mappings
Not recommended to use, because the Open vSwitch interface mappings are managed by VDSM since Red Hat Virtualization 4.2.0.
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
The result will be like this:
<api> <link rel="hosts" href="/ovirt-engine/api/hosts"/> <link rel="vms" href="/ovirt-engine/api/vms"/> ... <product_info> <name>oVirt Engine</name> <vendor>ovirt.org</vendor> <version> <build>0</build> <full_version>4.1.0_master</full_version> <major>4</major> <minor>1</minor> <revision>0</revision> </version> </product_info> <special_objects> <link rel="templates/blank" href="..."/> <link rel="tags/root" href="..."/> </special_objects> <summary> <vms> <total>10</total> <active>3</active> </vms> <hosts> <total>2</total> <active>2</active> </hosts> <users> <total>8</total> <active>2</active> </users> <storage_domains> <total>2</total> <active>2</active> </storage_domains> </summary> <time>2016-12-12T12:22:25.866+01:00</time> </api>
Table 7.11. Attributes summary
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. |
Table 7.12. Links summary
7.8.1. authenticated_user
Reference to the authenticated user.
The authenticated user is the user whose credentials were verified in order to accept the current request. In the current version of the system the authenticated user and the effective user are always the same. In the future, when support for user impersonation is introduced, they will be potentially different.
7.8.2. effective_user
Reference to the effective user.
The effective user is the user whose permissions apply during the current request. In the current version of the system the authenticated user and the effective user are always the same. In the future, when support for user impersonation is introduced, they will be potentially different.
7.9. ApiSummary struct
A summary containing the total number of relevant objects, such as virtual machines, hosts, and storage domains.
Table 7.13. Attributes summary
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
Represents an application installed on a virtual machine. Applications are reported by the guest agent, if you deploy one on the virtual machine operating system.
To get that information send a request like this:
GET /ovirt-engine/api/vms/123/applications/456
The result will be like this:
<application href="/ovirt-engine/api/vms/123/applications/456" id="456"> <name>application-test-1.0.0-0.el7</name> <vm href="/ovirt-engine/api/vms/123" id="123"/> </application>
Table 7.15. Attributes summary
Table 7.16. Links summary
Name | Type | Summary |
---|---|---|
| A reference to the virtual machine the application is installed on. |
7.12. Architecture enum
Table 7.17. Values summary
Name | Summary |
---|---|
| AARCH64 CPU architecture. |
| |
| IBM S390X CPU architecture. |
| |
|
7.12.1. s390x
IBM S390X CPU architecture.
Needs to be specified for virtual machines and clusters running on the S390X architecture.
Note that S390 is often used in an ambiguous way to describe either the general machine architecture as such or its 31-bit variant. S390X is used specifically for the 64-bit architecture, which is in line with the other architectures, like X86_64 or PPC64.
7.13. AuthorizedKey struct
Table 7.18. Attributes summary
Table 7.19. Links summary
Name | Type | Summary |
---|---|---|
|
7.14. AutoNumaStatus enum
Table 7.20. Values summary
Name | Summary |
---|---|
| |
| |
|
7.15. AutoPinningPolicy enum
Type representing what the CPU and NUMA pinning policy is.
Since version 4.5 of the engine this operation is deprecated, and preserved only for backwards compatibility. It will be removed in the future. Instead please use CpuPinningPolicy.
Table 7.21. Values summary
Name | Summary |
---|---|
| The CPU and NUMA pinning will be configured by the dedicated host. |
| The CPU and NUMA pinning won’t be calculated. |
| The CPU and NUMA pinning will be configured by the virtual machine current state. |
7.15.1. adjust
The CPU and NUMA pinning will be configured by the dedicated host.
Currently, its implication is that the CPU and NUMA pinning will use the dedicated host CPU topology. The virtual machine configuration will automatically be set to fit the host to get the highest possible performance.
7.15.2. disabled
The CPU and NUMA pinning won’t be calculated.
Currently, its implication is that the CPU and NUMA pinning won’t be calculated to the current virtual machine configuration. By default the VM topology set with 1 Socket, 1 Core and 1 Thread.
7.15.3. existing
The CPU and NUMA pinning will be configured by the virtual machine current state.
Currently, its implication is that the CPU and NUMA pinning will use the provided virtual machine CPU topology. Without given CPU topology it will use the engine defaults (the VM topology set with 1 Socket, 1 Core and 1 Thread).
7.16. Backup struct
Table 7.22. Attributes summary
Name | Type | Summary |
---|---|---|
| Free text containing comments about this object. | |
| The backup creation date. | |
| A human-readable description in plain text. | |
| The checkpoint id at which to start the incremental backup. | |
| A unique identifier. | |
| The backup modification date. | |
| A human-readable name in plain text. | |
| The phase of the backup operation. | |
| The checkpoint id created by this backup operation. |
7.16.1. to_checkpoint_id
The checkpoint id created by this backup operation. This id can be used as the fromCheckpointId
in the next incremental backup.
Table 7.23. Links summary
7.17. BackupPhase enum
Table 7.24. Values summary
Name | Summary |
---|---|
| The final phase, indicates that the backup has failed. |
| In this phase, the backup is invoking 'stop_backup' operation in order to complete the backup and unlock the relevant disk. |
| The initial phase of the backup. |
| The phase means that the relevant disks' backup URLs are ready to be used and downloaded using image transfer. |
| The phase is set before invoking 'start_backup' operation in vdsm/libvirt (which means that 'stop_backup' should be invoked to complete the flow). |
| The final phase, indicates that the backup has finished successfully. |
7.17.1. initializing
The initial phase of the backup. It is set on entity creation.
7.18. Balance struct
Table 7.25. Attributes summary
Table 7.26. Links summary
Name | Type | Summary |
---|---|---|
| ||
|
7.19. Bios struct
7.20. BiosType enum
Type representing a chipset and a BIOS type combination.
Table 7.28. Values summary
Name | Summary |
---|---|
| Use the cluster-wide default. |
| i440fx chipset with SeaBIOS. |
| q35 chipset with OVMF (UEFI) BIOS. |
| q35 chipset with SeaBIOS. |
| q35 chipset with OVMF (UEFI) BIOS with SecureBoot enabled. |
7.20.1. cluster_default
Use the cluster-wide default.
This value cannot be used for cluster.
7.20.2. i440fx_sea_bios
i440fx chipset with SeaBIOS.
For non-x86 architectures this is the only non-default value allowed.
7.21. BlockStatistic struct
Table 7.29. Attributes summary
Name | Type | Summary |
---|---|---|
|
7.22. Bonding struct
Represents a network interfaces bond.
Table 7.30. Attributes summary
7.22.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.22.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.22.3. slaves
A list of slave NICs for a bonded interface. Only required when adding bonded interfaces.
Table 7.31. Links summary
Name | Type | Summary |
---|---|---|
|
The |
7.22.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
Will respond:
<host_nic href="/ovirt-engine/api/hosts/123/nics/321" id="321"> ... <bonding> <slaves> <host_nic href="/ovirt-engine/api/hosts/123/nics/456" id="456" /> ... </slaves> <active_slave href="/ovirt-engine/api/hosts/123/nics/456" id="456" /> </bonding> ... </host_nic>
7.23. Bookmark struct
Represents a bookmark in the system.
Table 7.32. Attributes summary
7.24. Boot struct
Configuration of the boot sequence of a virtual machine.
Table 7.33. Attributes summary
Name | Type | Summary |
---|---|---|
| Ordered list of boot devices. |
7.24.1. devices
Ordered list of boot devices. The virtual machine will try to boot from the given boot devices, in the given order.
7.25. BootDevice enum
Represents the kinds of devices that a virtual machine can boot from.
Table 7.34. Values summary
Name | Summary |
---|---|
| Boot from CD-ROM. |
| Boot from the hard drive. |
| Boot from the network, using PXE. |
7.25.1. cdrom
Boot from CD-ROM. The CD-ROM can be chosen from the list of ISO files available in an ISO domain attached to the ata center that the virtual machine belongs to.
7.25.2. network
Boot from the network, using PXE. It is necessary to have PXE configured on the network that the virtual machine is connected to.
7.26. BootMenu struct
Represents boot menu configuration for virtual machines and templates.
Table 7.35. Attributes summary
Name | Type | Summary |
---|---|---|
| Whether the boot menu is enabled for this virtual machine (or template), or not. |
7.27. BootProtocol enum
Defines the options of the IP address assignment method to a NIC.
Table 7.36. Values summary
Name | Summary |
---|---|
| Stateless address auto-configuration. |
| Dynamic host configuration protocol. |
| No address configuration. |
| DHCP alongside Stateless address auto-configuration (SLAAC). |
| Statically-defined address, mask and gateway. |
7.27.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.27.2. dhcp
Dynamic host configuration protocol.
Please refer to this wikipedia article for more information.
7.27.3. poly_dhcp_autoconf
DHCP alongside Stateless address auto-configuration (SLAAC).
The SLAAC mechanism is defined by RFC 4862. Please refer to the Stateless address auto-configuration article and the DHCP article for more information.
The value is valid for IPv6 addresses only.
7.28. BrickProfileDetail struct
Table 7.37. Attributes summary
Name | Type | Summary |
---|---|---|
|
Table 7.38. Links summary
Name | Type | Summary |
---|---|---|
|
7.29. Cdrom struct
Table 7.39. Attributes summary
Table 7.40. Links summary
Name | Type | Summary |
---|---|---|
| Optionally references to an instance type the device is used by. | |
| Optionally references to a template the device is used by. | |
|
Do not use this element, use | |
| Vm[] | References to the virtual machines that are using this device. |
7.29.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.30. Certificate struct
Table 7.41. Attributes summary
7.31. Checkpoint struct
Table 7.42. Attributes summary
Name | Type | Summary |
---|---|---|
| Free text containing comments about this object. | |
| The checkpoint creation date. | |
| A human-readable description in plain text. | |
| A unique identifier. | |
| A human-readable name in plain text. | |
| The parent checkpoint id. | |
| The state of the checkpoint. |
7.32. CheckpointState enum
Table 7.44. Values summary
Name | Summary |
---|---|
| The initial state of the checkpoint. |
| The INVALID state set when a checkpoint cannot be used anymore for incremental backup and should be removed (For example, after committing to an older VM snapshot). |
7.32.1. created
The initial state of the checkpoint. It is set on entity creation.
7.33. CloudInit struct
Deprecated type to specify cloud-init configuration.
This type has been deprecated and replaced by alternative attributes inside the Initialization type. See the cloud_init attribute documentation for details.
Table 7.45. Attributes summary
Name | Type | Summary |
---|---|---|
| ||
| ||
| ||
| ||
| ||
| ||
|
7.34. CloudInitNetworkProtocol enum
Defines the values for the cloud-init protocol. This protocol decides how the cloud-init network parameters are formatted before being passed to the virtual machine in order to be processed by cloud-init.
Protocols supported are cloud-init version dependent. For more information, see Network Configuration Sources
Table 7.46. Values summary
Name | Summary |
---|---|
| Legacy protocol. |
| Successor of the ENI protocol, with support for IPv6 and more. |
7.34.1. eni
Legacy protocol. Does not support IPv6. For more information, see Network Configuration ENI (Legacy)
7.34.2. openstack_metadata
Successor of the ENI protocol, with support for IPv6 and more. This is the default value. For more information, see API: Proxy neutron configuration to guest instance
7.35. Cluster struct
Type representation of a cluster.
A JSON representation of a cluster:
{ "cluster" : [ { "ballooning_enabled" : "false", "cpu" : { "architecture" : "x86_64", "type" : "Intel SandyBridge Family" }, "custom_scheduling_policy_properties" : { "property" : [ { "name" : "HighUtilization", "value" : "80" }, { "name" : "CpuOverCommitDurationMinutes", "value" : "2" } ] }, "error_handling" : { "on_error" : "migrate" }, "fencing_policy" : { "enabled" : "true", "skip_if_connectivity_broken" : { "enabled" : "false", "threshold" : "50" }, "skip_if_gluster_bricks_up" : "false", "skip_if_gluster_quorum_not_met" : "false", "skip_if_sd_active" : { "enabled" : "false" } }, "gluster_service" : "false", "firewall_type" : "iptables", "ha_reservation" : "false", "ksm" : { "enabled" : "true", "merge_across_nodes" : "true" }, "memory_policy" : { "over_commit" : { "percent" : "100" }, "transparent_hugepages" : { "enabled" : "true" } }, "migration" : { "auto_converge" : "inherit", "bandwidth" : { "assignment_method" : "auto" }, "compressed" : "inherit", "policy" : { "id" : "00000000-0000-0000-0000-000000000000" } }, "required_rng_sources" : { "required_rng_source" : [ "random" ] }, "switch_type" : "legacy", "threads_as_cores" : "false", "trusted_service" : "false", "tunnel_migration" : "false", "version" : { "major" : "4", "minor" : "1" }, "virt_service" : "true", "data_center" : { "href" : "/ovirt-engine/api/datacenters/123", "id" : "123" }, "mac_pool" : { "href" : "/ovirt-engine/api/macpools/456", "id" : "456" }, "scheduling_policy" : { "href" : "/ovirt-engine/api/schedulingpolicies/789", "id" : "789" }, "actions" : { "link" : [ { "href" : "/ovirt-engine/api/clusters/234/resetemulatedmachine", "rel" : "resetemulatedmachine" } ] }, "name" : "Default", "description" : "The default server cluster", "href" : "/ovirt-engine/api/clusters/234", "id" : "234", "link" : [ { "href" : "/ovirt-engine/api/clusters/234/permissions", "rel" : "permissions" }, { "href" : "/ovirt-engine/api/clusters/234/cpuprofiles", "rel" : "cpuprofiles" }, { "href" : "/ovirt-engine/api/clusters/234/networkfilters", "rel" : "networkfilters" }, { "href" : "/ovirt-engine/api/clusters/234/networks", "rel" : "networks" }, { "href" : "/ovirt-engine/api/clusters/234/affinitygroups", "rel" : "affinitygroups" }, { "href" : "/ovirt-engine/api/clusters/234/glusterhooks", "rel" : "glusterhooks" }, { "href" : "/ovirt-engine/api/clusters/234/glustervolumes", "rel" : "glustervolumes" }, { "href" : "/ovirt-engine/api/clusters/234/enabledfeatures", "rel" : "enabledfeatures" }, { "href" : "/ovirt-engine/api/clusters/234/externalnetworkproviders", "rel" : "externalnetworkproviders" } ] } ] }
Table 7.47. Attributes summary
Name | Type | Summary |
---|---|---|
| ||
| Chipset and BIOS type combination. | |
| Free text containing comments about this object. | |
| ||
| Custom scheduling policy properties of the cluster. | |
| A human-readable description in plain text. | |
| ||
| ||
| A custom fencing policy can be defined for a cluster. | |
| FIPS mode of the cluster. | |
| The type of firewall to be used on hosts in this cluster. | |
| ||
| The name of the tuned profile. | |
| ||
| A unique identifier. | |
| ||
| The memory consumption threshold for logging audit log events. | |
| The memory consumption threshold type for logging audit log events. | |
| This property has no longer any relevance and has been deprecated. | |
| ||
| Reference to cluster-wide configuration of migration of a running virtual machine to another host. | |
| A human-readable name in plain text. | |
| This property has no longer any relevance and has been deprecated. | |
| Set of random number generator (RNG) sources required from each host in the cluster. | |
| ||
| ||
| The type of switch to be used by all networks in given cluster. | |
| ||
| ||
| ||
| The upgrade correlation identifier. | |
| Indicates if an upgrade has been started for the cluster. | |
| If an upgrade is in progress, the upgrade’s reported percent complete. | |
| The compatibility version of the cluster. | |
| ||
| Enable VNC encryption. |
7.35.1. bios_type
Chipset and BIOS type combination.
This value is used as default for all virtual machines in the cluster having biosType
set to CLUSTER_DEFAULT
.
7.35.2. 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
With a request body:
<cluster> <custom_scheduling_policy_properties> <property> <name>HighUtilization</name> <value>70</value> </property> </custom_scheduling_policy_properties> </cluster>
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.35.3. fencing_policy
A custom fencing policy can be defined for a cluster.
For example:
PUT /ovirt-engine/api/cluster/123
With request body like this:
<cluster> <fencing_policy> <enabled>true</enabled> <skip_if_sd_active> <enabled>false</enabled> </skip_if_sd_active> <skip_if_connectivity_broken> <enabled>false</enabled> <threshold>50</threshold> </skip_if_connectivity_broken> </fencing_policy> </cluster>
7.35.4. fips_mode
FIPS mode of the cluster.
FIPS mode represents the cluster’s policy towards hosts. Hosts added to the cluster will be checked to fulfill the cluster’s FIPS mode, making them non-operational if they do not. Unless a value is explicity provided, new clusters are initialized by default to UNDEFINED
. This value changes automatically to the FIPS mode of the first host added to the cluster.
7.35.5. gluster_tuned_profile
The name of the tuned profile.
Tuned profile to set on all the hosts in the cluster. This is not mandatory and relevant only for clusters with Gluster service.
7.35.6. log_max_memory_used_threshold
The memory consumption threshold for logging audit log events.
For percentage, an audit log event is logged if the used memory is more that the value specified. For absolute value, an audit log event is logged when the the free memory falls below the value specified in MB.
7.35.7. log_max_memory_used_threshold_type
The memory consumption threshold type for logging audit log events.
You can choose between 'percentage' and 'absolute_value_in_mb'.
7.35.8. maintenance_reason_required
This property has no longer any relevance and has been deprecated. Its default value is true,
7.35.9. migration
Reference to cluster-wide configuration of migration of a running virtual machine to another host.
API for querying migration policy by ID returned by this method is not implemented yet. Use /ovirt-engine/api/options/MigrationPolicies
to get a list of all migration policies with their IDs.
7.35.10. optional_reason
This property has no longer any relevance and has been deprecated. Its default value is true.
7.35.11. 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.35.12. upgrade_correlation_id
The upgrade correlation identifier. Use to correlate events detailing the cluster upgrade to the upgrade itself.
7.35.13. 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
Will respond with:
<cluster> ... <version> <major>4</major> <minor>0</minor> </version> ... </cluster>
To update the compatibility version, use:
PUT /ovirt-engine/api/clusters/123
With a request body like this:
<cluster> <version> <major>4</major> <minor>1</minor> </version> </cluster>
In order to update the cluster compatibility version, all hosts in the cluster must support the new compatibility version.
7.35.14. vnc_encryption
Enable VNC encryption. Default value for this property is false.
Table 7.48. Links summary
Name | Type | Summary |
---|---|---|
| ||
| ||
| ||
| Custom features that are enabled for the cluster. | |
| A reference to the external network provider available in the cluster. | |
| ||
| ||
| A reference to the MAC pool used by this cluster. | |
| ||
| ||
| ||
| ||
| Reference to the default scheduling policy used by this cluster. |
7.35.15. external_network_providers
A reference to the external network provider available in the cluster.
If the automatic deployment of the external network provider is supported, the networks of the referenced network provider are available on every host in the cluster. External network providers of a cluster can only be set during adding the cluster. This value may be overwritten for individual hosts during adding the host.
7.35.16. 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.36. ClusterFeature struct
Type represents an additional feature that is available at a cluster level.
Table 7.49. Attributes summary
Table 7.50. Links summary
Name | Type | Summary |
---|---|---|
| Reference to the cluster level. |
7.37. ClusterLevel struct
Describes the capabilities supported by a specific cluster level.
Table 7.51. Attributes summary
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. |
Table 7.52. Links summary
Name | Type | Summary |
---|---|---|
| The additional features supported by this cluster level. |
7.38. ClusterUpgradeAction enum
The action type for cluster upgrade action.
Table 7.53. Values summary
Name | Summary |
---|---|
| The upgrade action to be passed to finish the cluster upgrade process by marking the cluster’s upgrade_running flag to false. |
| The upgrade action to be passed to start the cluster upgrade process by marking the cluster’s upgrade_running flag to true. |
| The upgrade action to be passed to update the cluster upgrade progress. |
7.38.1. finish
The upgrade action to be passed to finish the cluster upgrade process by marking the cluster’s upgrade_running flag to false. This should be used at the end of the cluster upgrade process.
7.38.2. start
The upgrade action to be passed to start the cluster upgrade process by marking the cluster’s upgrade_running flag to true. This should used at the beginning of the cluster upgrade process.
7.38.3. update_progress
The upgrade action to be passed to update the cluster upgrade progress. This should be used as the upgrade progresses.
7.39. Configuration struct
Table 7.54. Attributes summary
Name | Type | Summary |
---|---|---|
| The document describing the virtual machine. | |
|
7.39.1. data
The document describing the virtual machine.
Example of the OVF document:
<?xml version='1.0' encoding='UTF-8'?> <ovf:Envelope xmlns:ovf="http://schemas.dmtf.org/ovf/envelope/1/" xmlns:rasd="http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/CIM_ResourceAllocationSettingData" xmlns:vssd="http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/CIM_VirtualSystemSettingData" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" ovf:version="3.5.0.0"> <References/> <Section xsi:type="ovf:NetworkSection_Type"> <Info>List of networks</Info> <Network ovf:name="Network 1"/> </Section> <Section xsi:type="ovf:DiskSection_Type"> <Info>List of Virtual Disks</Info> </Section> <Content ovf:id="out" xsi:type="ovf:VirtualSystem_Type"> <CreationDate>2014/12/03 04:25:45</CreationDate> <ExportDate>2015/02/09 14:12:24</ExportDate> <DeleteProtected>false</DeleteProtected> <SsoMethod>guest_agent</SsoMethod> <IsSmartcardEnabled>false</IsSmartcardEnabled> <TimeZone>Etc/GMT</TimeZone> <default_boot_sequence>0</default_boot_sequence> <Generation>1</Generation> <VmType>1</VmType> <MinAllocatedMem>1024</MinAllocatedMem> <IsStateless>false</IsStateless> <IsRunAndPause>false</IsRunAndPause> <AutoStartup>false</AutoStartup> <Priority>1</Priority> <CreatedByUserId>fdfc627c-d875-11e0-90f0-83df133b58cc</CreatedByUserId> <IsBootMenuEnabled>false</IsBootMenuEnabled> <IsSpiceFileTransferEnabled>true</IsSpiceFileTransferEnabled> <IsSpiceCopyPasteEnabled>true</IsSpiceCopyPasteEnabled> <Name>VM_export</Name> <TemplateId>00000000-0000-0000-0000-000000000000</TemplateId> <TemplateName>Blank</TemplateName> <IsInitilized>false</IsInitilized> <Origin>3</Origin> <DefaultDisplayType>1</DefaultDisplayType> <TrustedService>false</TrustedService> <OriginalTemplateId>00000000-0000-0000-0000-000000000000</OriginalTemplateId> <OriginalTemplateName>Blank</OriginalTemplateName> <UseLatestVersion>false</UseLatestVersion> <Section ovf:id="70b4d9a7-4f73-4def-89ca-24fc5f60e01a" ovf:required="false" xsi:type="ovf:OperatingSystemSection_Type"> <Info>Guest Operating System</Info> <Description>other</Description> </Section> <Section xsi:type="ovf:VirtualHardwareSection_Type"> <Info>1 CPU, 1024 Memory</Info> <System> <vssd:VirtualSystemType>ENGINE 3.5.0.0</vssd:VirtualSystemType> </System> <Item> <rasd:Caption>1 virtual cpu</rasd:Caption> <rasd:Description>Number of virtual CPU</rasd:Description> <rasd:InstanceId>1</rasd:InstanceId> <rasd:ResourceType>3</rasd:ResourceType> <rasd:num_of_sockets>1</rasd:num_of_sockets> <rasd:cpu_per_socket>1</rasd:cpu_per_socket> </Item> <Item> <rasd:Caption>1024 MB of memory</rasd:Caption> <rasd:Description>Memory Size</rasd:Description> <rasd:InstanceId>2</rasd:InstanceId> <rasd:ResourceType>4</rasd:ResourceType> <rasd:AllocationUnits>MegaBytes</rasd:AllocationUnits> <rasd:VirtualQuantity>1024</rasd:VirtualQuantity> </Item> <Item> <rasd:Caption>USB Controller</rasd:Caption> <rasd:InstanceId>3</rasd:InstanceId> <rasd:ResourceType>23</rasd:ResourceType> <rasd:UsbPolicy>DISABLED</rasd:UsbPolicy> </Item> </Section> </Content> </ovf:Envelope>
7.40. ConfigurationType enum
Configuration format types.
Table 7.55. Values summary
Name | Summary |
---|---|
| ConfigurationType of type standard OVF. |
| ConfigurationType of type oVirt-compatible OVF. |
7.40.1. ova
ConfigurationType of type standard OVF.
The provided virtual machine configuration conforms with the Open Virtualization Format (OVF) standard. This value should be used for an OVF configuration that is extracted from an Open Virtual Appliance (OVA) that was generated by oVirt or by other vendors. See the OVF specification.
7.40.2. ovf
ConfigurationType of type oVirt-compatible OVF.
The provided virtual machine configuration conforms with the oVirt-compatible form of the Open Virtualization Format (OVF). Note that the oVirt-compatible form of the OVF may differ from the OVF standard that is used by other vendors. This value should be used for an OVF configuration that is taken from a storage domain.
7.41. Console struct
Representation for serial console device.
Table 7.56. Attributes summary
Name | Type | Summary |
---|---|---|
| Enable/disable the serial console device. |
7.42. Core struct
7.43. Cpu struct
Table 7.58. Attributes summary
Name | Type | Summary |
---|---|---|
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
|
7.44. CpuMode enum
Table 7.59. Values summary
Name | Summary |
---|---|
| |
| |
|
7.45. CpuPinningPolicy enum
Type representing the CPU and NUMA pinning policy.
Table 7.60. Values summary
Name | Summary |
---|---|
| The CPU pinning will be automatically calculated by the engine when a vm starts and it will be dropped when the vm stops. |
| The CPU pinning will be automatically calculated by the engine when a vm starts, and it will be dropped when the vm stops. |
| The CPU pinning will be manually configured. |
| The CPU pinning won’t be configured. |
| The CPU and NUMA pinning will be configured by the dedicated host. |
7.45.1. dedicated
The CPU pinning will be automatically calculated by the engine when a vm starts and it will be dropped when the vm stops.
The pinning is exclusive, that means that no other VM can use the pinned physical CPU.
7.45.2. isolate_threads
The CPU pinning will be automatically calculated by the engine when a vm starts, and it will be dropped when the vm stops.
The pinning is exclusive, each virtual thread will get an exclusive physical core. That means that no other VM can use the pinned physical CPU.
7.45.3. manual
The CPU pinning will be manually configured.
Currently, this means that the CPU pinning will be manually configured to the current virtual machine configuration. The VM needs to be pinned to at least one host. The Pinning is provided within the CPU configuration, using CpuTune.
7.45.4. none
The CPU pinning won’t be configured.
Currently, this means that the CPU pinning won’t be configured to the current virtual machine configuration. By default, the VM topology is set with 1 Socket, 1 Core and 1 Thread.
7.45.5. resize_and_pin_numa
The CPU and NUMA pinning will be configured by the dedicated host.
The CPU and NUMA pinning will use the dedicated host CPU topology. The virtual machine configuration will automatically be set to fit the host to get the highest possible performance.
7.46. CpuProfile struct
Table 7.61. Attributes summary
Table 7.62. Links summary
Name | Type | Summary |
---|---|---|
| ||
| ||
|
7.47. CpuTopology struct
7.48. CpuTune struct
Table 7.64. Attributes summary
Name | Type | Summary |
---|---|---|
|
7.49. CpuType struct
Describes a supported CPU type.
Table 7.65. Attributes summary
Name | Type | Summary |
---|---|---|
| The architecture of the CPU. | |
| The level of the CPU type. | |
|
The name of the CPU type, for example |
7.50. CreationStatus enum
Table 7.66. Values summary
Name | Summary |
---|---|
| |
| |
| |
|
7.51. CustomProperty struct
Custom property representation.
7.52. DataCenter struct
Table 7.68. Attributes summary
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.52.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
Will respond:
<data_center> ... <version> <major>4</major> <minor>0</minor> </version> ... </data_center>
To update the compatibility version, use:
PUT /ovirt-engine/api/datacenters/123
With a request body:
<data_center> <version> <major>4</major> <minor>1</minor> </version> </data_center>
Table 7.69. Links summary
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. | |
| Qos[] | 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.53. DataCenterStatus enum
Table 7.70. Values summary
Name | Summary |
---|---|
| |
| |
| |
| |
| |
|
7.54. Device struct
A device wraps links to potential parents of a device.
Table 7.71. Attributes summary
Table 7.72. Links summary
Name | Type | Summary |
---|---|---|
| Optionally references to an instance type the device is used by. | |
| Optionally references to a template the device is used by. | |
|
Do not use this element, use | |
| Vm[] | References to the virtual machines that are using this device. |
7.54.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.55. Disk struct
Represents a virtual disk device.
Table 7.73. Attributes summary
Name | Type | Summary |
---|---|---|
| Indicates if the disk is visible to the virtual machine. | |
| The actual size of the disk, in bytes. | |
| ||
| The backup behavior supported by the disk. | |
| The type of the disk backup (full/incremental), visible only when the disk backup is in progress. | |
| Indicates if the disk is marked as bootable. | |
| Free text containing comments about this object. | |
| Indicates the actual content residing on the disk. | |
| A human-readable description in plain text. | |
| Use external disk. | |
| 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 cause virtual machine to be paused or if disk errors should be propagated to the the guest operating system instead. | |
| 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 whether SCSI passthrough is enable and its policy. | |
| 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. | |
| ||
| The total size of the disk including all of its snapshots, in bytes. | |
| ||
| 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.55.1. active
Indicates if the disk is visible to the virtual machine.
When adding a disk attachment to a virtual machine, if the server accepts requests that do not contain this attribute the result is undefined. In some cases the disk will be automatically activated and in other cases it will not. To avoid issues it is strongly recommended to always include the this attribute with the desired value.
7.55.2. actual_size
The actual size of the disk, in bytes.
The actual size is the number of bytes actually used by the disk. It will be smaller than the provisioned size for disks that use the cow
format.
7.55.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.55.4. external_disk
Use external disk.
An external disk can be a path to a local file or a block device, or a URL supported by QEMU such as:
- nbd:<host>:<port>[:exportname=<export>]
- nbd:unix:</path>[:exportname=<export>]
- http://[<username>[:<password>]@]<host>/<path>
- https://[<username>[:<password>]@]<host>/<path>
- ftp://[<username>[:<password>]@]<host>/<path>
- ftps://[<username>[:<password>]@]<host>/<path>
See the QEMU manual for additional supported protocols and more info.
7.55.5. 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.55.6. 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.55.7. provisioned_size
The virtual size of the disk, in bytes.
This attribute is mandatory when creating a new disk.
7.55.8. 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 version of the storage domain that the disk is created on. Storage domains with a version lower than V4 support QCOW2 volumes. V4 storage domains also support QCOW2v3. For more information about features of the different QCOW versions, see QCOW3.
7.55.9. read_only
Indicates if the disk is in read-only mode.
Since version 4.0 this attribute is not shown in the API and was moved to DiskAttachment.
Since version 4.1.2 of Red Hat Virtualization Manager this attribute is deprecated, and it will be removed in the future. In order to attach a disk in read only mode use the read_only
attribute of the DiskAttachment type. For example:
POST /ovirt-engine/api/vms/123/diskattachments
<disk_attachment> <read_only>true</read_only> ... </disk_attachment>
7.55.10. sgio
Indicates whether SCSI passthrough is enable and its policy.
Setting a value of filtered
/unfiltered
will enable SCSI passthrough for a LUN disk with unprivileged/privileged SCSI I/O. To disable SCSI passthrough the value should be set to disabled
7.55.11. shareable
Indicates if the disk can be attached to multiple virtual machines.
7.55.12. total_size
The total size of the disk including all of its snapshots, in bytes.
The total size is the number of bytes actually used by the disk plus the size of its snapshots. It won’t be populated for direct LUN and Cinder disks. For disks without snapshots the total size is equal to the actual size.
7.55.13. 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.
Table 7.74. Links summary
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. | |
|
Do not use this element, use | |
| Vm[] | References to the virtual machines that are using this device. |
7.55.14. statistics
Statistics exposed by the disk. For example:
<statistics> <statistic href="/ovirt-engine/api/disks/123/statistics/456" id="456"> <name>data.current.read</name> <description>Read data rate</description> <kind>gauge</kind> <type>decimal</type> <unit>bytes_per_second</unit> <values> <value> <datum>1052</datum> </value> </values> <disk href="/ovirt-engine/api/disks/123" id="123"/> </statistic> ... </statistics>
These statistics are not directly included when the disk is retrieved, only a link. To obtain the statistics follow the included link:
GET /ovirt-engine/api/disks/123/statistics
7.55.15. 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.55.16. 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.56. DiskAttachment struct
Describes how a disk is attached to a virtual machine.
Table 7.75. Attributes summary
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.56.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.56.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>
If the guest operating system is Windows, the logical name will be reported as \\.\PHYSICALDRIVE0
.
7.56.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>
7.56.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.57. DiskBackup enum
Represents an enumeration of the backup mechanism that is enabled on the disk.
Table 7.77. Values summary
Name | Summary |
---|---|
| Incremental backup support. |
| No backup support. |
7.58. DiskBackupMode enum
Represents an enumeration of backup modes
Table 7.78. Values summary
Name | Summary |
---|---|
| This disk supports full backup. |
| This disk supports incremental backup. |
7.58.1. full
This disk supports full backup. You can query zero extents and download all disk data.
7.58.2. incremental
This disk supports incremental backup. You can query dirty extents and download changed blocks.
7.59. DiskContentType enum
The actual content residing on the disk.
Table 7.79. Values summary
Name | Summary |
---|---|
| The disk contains protected VM backup data. |
| The disk contains data. |
| The disk contains the Hosted Engine VM disk. |
| The disk contains the Hosted Engine configuration disk. |
| The disk contains the Hosted Engine metadata disk. |
| The disk contains the Hosted Engine Sanlock disk. |
| The disk contains an ISO image to be used a CDROM device. |
| The disk contains a memory dump from a live snapshot. |
| The disk contains memory metadata from a live snapshot. |
| The disk is an OVF store. |
7.60. DiskFormat enum
The underlying storage format of disks.
Table 7.80. Values summary
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.61. DiskInterface enum
The underlying storage interface of disks communication with controller.
Table 7.81. Values summary
Name | Summary |
---|---|
| Legacy controller device. |
| SATA controller device. |
| Para-virtualized device supported by the IBM pSeries family of machines, using the SCSI protocol. |
| Virtualization interface where just the guest’s device driver knows it is running in a virtual environment. |
| Para-virtualized SCSI controller device. |
7.61.1. ide
Legacy controller device. Works with almost all guest operating systems, so it is good for compatibility. Performance is lower than with the other alternatives.
7.61.2. virtio
Virtualization interface where just the guest’s device driver knows it is running in a virtual environment. Enables guests to get high performance disk operations.
7.61.3. virtio_scsi
Para-virtualized SCSI controller device. Fast interface with the guest via direct physical storage device address, using the SCSI protocol.
7.62. DiskProfile struct
Table 7.82. Attributes summary
Table 7.83. Links summary
Name | Type | Summary |
---|---|---|
| ||
| ||
|
7.63. DiskSnapshot struct
Table 7.84. Attributes summary
Name | Type | Summary |
---|---|---|
| Indicates if the disk is visible to the virtual machine. | |
| The actual size of the disk, in bytes. | |
| ||
| The backup behavior supported by the disk. | |
| The type of the disk backup (full/incremental), visible only when the disk backup is in progress. | |
| Indicates if the disk is marked as bootable. | |
| Free text containing comments about this object. | |
| Indicates the actual content residing on the disk. | |
| A human-readable description in plain text. | |
| Use external disk. | |
| 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 cause virtual machine to be paused or if disk errors should be propagated to the the guest operating system instead. | |
| 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 whether SCSI passthrough is enable and its policy. | |
| 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. | |
| ||
| The total size of the disk including all of its snapshots, in bytes. | |
| ||
| 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.63.1. active
Indicates if the disk is visible to the virtual machine.
When adding a disk attachment to a virtual machine, if the server accepts requests that do not contain this attribute the result is undefined. In some cases the disk will be automatically activated and in other cases it will not. To avoid issues it is strongly recommended to always include the this attribute with the desired value.
7.63.2. actual_size
The actual size of the disk, in bytes.
The actual size is the number of bytes actually used by the disk. It will be smaller than the provisioned size for disks that use the cow
format.
7.63.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.63.4. external_disk
Use external disk.
An external disk can be a path to a local file or a block device, or a URL supported by QEMU such as:
- nbd:<host>:<port>[:exportname=<export>]
- nbd:unix:</path>[:exportname=<export>]
- http://[<username>[:<password>]@]<host>/<path>
- https://[<username>[:<password>]@]<host>/<path>
- ftp://[<username>[:<password>]@]<host>/<path>
- ftps://[<username>[:<password>]@]<host>/<path>
See the QEMU manual for additional supported protocols and more info.
7.63.5. 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.63.6. 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.63.7. provisioned_size
The virtual size of the disk, in bytes.
This attribute is mandatory when creating a new disk.
7.63.8. 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 version of the storage domain that the disk is created on. Storage domains with a version lower than V4 support QCOW2 volumes. V4 storage domains also support QCOW2v3. For more information about features of the different QCOW versions, see QCOW3.
7.63.9. read_only
Indicates if the disk is in read-only mode.
Since version 4.0 this attribute is not shown in the API and was moved to DiskAttachment.
Since version 4.1.2 of Red Hat Virtualization Manager this attribute is deprecated, and it will be removed in the future. In order to attach a disk in read only mode use the read_only
attribute of the DiskAttachment type. For example:
POST /ovirt-engine/api/vms/123/diskattachments
<disk_attachment> <read_only>true</read_only> ... </disk_attachment>
7.63.10. sgio
Indicates whether SCSI passthrough is enable and its policy.
Setting a value of filtered
/unfiltered
will enable SCSI passthrough for a LUN disk with unprivileged/privileged SCSI I/O. To disable SCSI passthrough the value should be set to disabled
7.63.11. shareable
Indicates if the disk can be attached to multiple virtual machines.
7.63.12. total_size
The total size of the disk including all of its snapshots, in bytes.
The total size is the number of bytes actually used by the disk plus the size of its snapshots. It won’t be populated for direct LUN and Cinder disks. For disks without snapshots the total size is equal to the actual size.
7.63.13. 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.
Table 7.85. Links summary
Name | Type | Summary |
---|---|---|
| ||
| ||
| ||
| Optionally references to an instance type the device is used by. | |
| ||
| Parent disk snapshot. | |
| ||
| ||
| ||
| Statistics exposed by the disk. | |
| ||
| The storage domains associated with this disk. | |
| Optionally references to a template the device is used by. | |
|
Do not use this element, use | |
| Vm[] | References to the virtual machines that are using this device. |
7.63.14. statistics
Statistics exposed by the disk. For example:
<statistics> <statistic href="/ovirt-engine/api/disks/123/statistics/456" id="456"> <name>data.current.read</name> <description>Read data rate</description> <kind>gauge</kind> <type>decimal</type> <unit>bytes_per_second</unit> <values> <value> <datum>1052</datum> </value> </values> <disk href="/ovirt-engine/api/disks/123" id="123"/> </statistic> ... </statistics>
These statistics are not directly included when the disk is retrieved, only a link. To obtain the statistics follow the included link:
GET /ovirt-engine/api/disks/123/statistics
7.63.15. 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.63.16. 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.64. DiskStatus enum
Current status representation for disk.
Table 7.86. Values summary
Name | Summary |
---|---|
| Disk cannot be accessed by the virtual machine, and the user needs to take action to resolve the issue. |
| The disk is being used by the system, therefore it cannot be accessed by virtual machines at this point. |
| The disk status is normal and can be accessed by the virtual machine. |
7.64.1. locked
The disk is being used by the system, therefore it cannot be accessed by virtual machines at this point. This is usually a temporary status, until the disk is freed.
7.65. DiskStorageType enum
Table 7.87. Values summary
Name | Summary |
---|---|
| |
| |
| |
| A storage type, used for a storage domain that was created using a cinderlib driver. |
7.66. DiskType enum
Table 7.88. Values summary
Name | Summary |
---|---|
| |
|
7.67. Display struct
Represents a graphic console configuration.
Table 7.89. Attributes summary
Name | Type | Summary |
---|---|---|
| The IP address of the guest to connect the graphic console client to. | |
| Indicates if to override the display address per host. | |
| The TLS certificate in case of a TLS connection. | |
| Indicates whether a user is able to copy and paste content from an external host into the graphic console. | |
| Returns the action that will take place when the graphic console is disconnected. | |
| Delay (in minutes) before the graphic console disconnect action is carried out. | |
| Indicates if a user is able to drag and drop files from an external host into the graphic console. | |
| The keyboard layout to use with this graphic console. | |
| The number of monitors opened for this graphic console. | |
| The port address on the guest to connect the graphic console client to. | |
| The proxy IP which will be used by the graphic console client to connect to the guest. | |
| The secured port address on the guest, in case of using TLS, to connect the graphic console client to. | |
| The engine now sets it automatically according to the operating system. | |
| Indicates if to use smart card authentication. | |
| The graphic console protocol type. |
7.67.1. allow_override
Indicates if to override the display address per host. Relevant only for the Host.display
attribute. If set, the graphical console address of a virtual machine will be overridden by the host specified display address. if not set, the graphical console address of a virtual machine will not be overridden.
7.67.2. certificate
The TLS certificate in case of a TLS connection. If TLS isn’t enabled then it won’t be reported.
7.67.3. copy_paste_enabled
Indicates whether a user is able to copy and paste content from an external host into the graphic console. This option is only available for the SPICE console type.
7.67.4. disconnect_action
Returns the action that will take place when the graphic console is disconnected. The options are:
- none
- No action is taken.
- lock_screen
- Locks the currently active user session.
- logout
- Logs out the currently active user session.
- reboot
- Initiates a graceful virtual machine reboot.
- shutdown
- Initiates a graceful virtual machine shutdown.
This option is only available for the SPICE console type.
7.67.5. disconnect_action_delay
Delay (in minutes) before the graphic console disconnect action is carried out. This option is only available for Shutdown disconnect action.
7.67.6. file_transfer_enabled
Indicates if a user is able to drag and drop files from an external host into the graphic console. This option is only available for the SPICE console type.
7.67.7. keyboard_layout
The keyboard layout to use with this graphic console. This option is only available for the VNC console type. If no keyboard is enabled then it won’t be reported.
7.67.8. monitors
The number of monitors opened for this graphic console. This option is only available for the SPICE console type. Possible values are 1, 2 or 4.
7.67.9. proxy
The proxy IP which will be used by the graphic console client to connect to the guest. It is useful when the client is outside the guest’s network. This option is only available for the SPICE console type. This proxy can be set in global configuration, cluster level, virtual machine pool level or disabled per virtual machine. If the proxy is set in any of this mentioned places and not disabled for the virtual machine, it will be returned by this method. If the proxy is not set, nothing will be reported.
7.67.10. secure_port
The secured port address on the guest, in case of using TLS, to connect the graphic console client to. If TLS isn’t enabled then it won’t be reported.
7.67.11. single_qxl_pci
The engine now sets it automatically according to the operating system. Therefore, it has been deprecated since 4.4.5. Indicates if to use one PCI slot for each monitor or to use a single PCI channel for all multiple monitors. This option is only available for the SPICE console type and only for connecting a guest Linux based OS.
7.67.12. smartcard_enabled
Indicates if to use smart card authentication. This option is only available for the SPICE console type.
7.68. DisplayType enum
Represents an enumeration of the protocol used to connect to the graphic console of the virtual machine.
Table 7.90. Values summary
Name | Summary |
---|---|
| Display of type SPICE. |
| Display of type VNC. |
7.68.1. spice
Display of type SPICE. See SPICE documentation for more details.
7.68.2. vnc
Display of type VNC. VNC stands for Virtual Network Computing, and it is a graphical desktop sharing system that uses RFB (Remote Frame Buffer) protocol to remotely control another machine.
7.69. Dns struct
Represents the DNS resolver configuration.
7.70. DnsResolverConfiguration struct
Represents the DNS resolver configuration.
Table 7.92. Attributes summary
Name | Type | Summary |
---|---|---|
| Array of addresses of name servers. |
7.70.1. name_servers
Array of addresses of name servers. Either IPv4 or IPv6 addresses may be specified.
7.71. Domain struct
This type represents a directory service domain.
Table 7.93. Attributes summary
Table 7.94. Links summary
7.71.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.72. DynamicCpu struct
Configuration of the Dynamic CPUs of a virtual machine.
Table 7.95. Attributes summary
Name | Type | Summary |
---|---|---|
| ||
|
7.73. EntityExternalStatus enum
Type representing an external entity status.
Table 7.96. Values summary
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.73.1. error
The external entity status is erroneous. This might require a moderate attention.
7.73.2. failure
The external entity has an issue that causes failures. This might require immediate attention.
7.74. EntityProfileDetail struct
Table 7.97. Attributes summary
Name | Type | Summary |
---|---|---|
|
7.75. ErrorHandling struct
Table 7.98. Attributes summary
Name | Type | Summary |
---|---|---|
|
7.76. Event struct
Type representing an event.
Table 7.99. Attributes summary
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. | |
| The numeric index of this event. | |
| Specifies whether the event should also be written to the ${hypervisor. | |
| A human-readable name in plain text. | |
| Free text identifying the origin of the event. | |
| The event severity. | |
| The event time. |
7.76.1. correlation_id
The event correlation identifier. Used in order to correlate several events together.
7.76.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.
7.76.3. index
The numeric index of this event. The indexes of events are always increasing, so events with higher indexes are guaranteed to be older than events with lower indexes.
In the current implementation of the engine, the id
attribute has the same value as this index
attribute. That is an implementation detail that the user of the API should not rely on. In the future the id
attribute may be changed to an arbitrary string, containing non numeric characters and no implicit order. On the other hand this index
attribute is guaranteed to stay as integer and ordered.
7.76.4. log_on_host
Specifies whether the event should also be written to the ${hypervisor.name} log. If no host is specified the event description will be written to all hosts. Default is false.
Table 7.100. Links summary
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.76.5. cluster
Reference to the cluster service. Event can be associated with a cluster.
7.76.6. data_center
Reference to the data center service. Event can be associated with a data center.
7.76.7. host
Reference to the host service. Event can be associated with a host.
7.76.8. storage_domain
Reference to the storage domain service. Event can be associated with a storage domain.
7.76.9. template
Reference to the template service. Event can be associated with a template.
7.76.10. user
Reference to the user service. Event can be associated with a user.
7.76.11. vm
Reference to the virtual machine service. Event can be associated with a virtual machine.
7.77. EventSubscription struct
Table 7.101. Attributes summary
Name | Type | Summary |
---|---|---|
| The email address to which notifications should be sent. | |
| Free text containing comments about this object. | |
| A human-readable description in plain text. | |
| The subscribed-for event. | |
| A unique identifier. | |
| A human-readable name in plain text. | |
| The notification method: SMTP or SNMP. | |
| The subscribing user. |
7.77.1. address
The email address to which notifications should be sent.
When not provided, notifications are sent to the user’s email. Only a single address per user is currently supported. If a subscription with a different email address to that of existing subscriptions is added, a 409 (CONFLICT) status is returned with an explanation that the provided address conflicts with an existing address of an event-subscription for this user.
This field might be deprecated in the future, and notifications will always be sent on the user’s email address.
7.77.2. event
The subscribed-for event.
(Combined with the user, Uniquely identifies the event-subscription).
7.77.3. notification_method
The notification method: SMTP or SNMP.
Currently only SMTP supported by API. Support for SNMP will be added in the future.
7.77.4. user
The subscribing user.
Combined with the event-name, uniquely identifies the event-subscription.
7.78. ExternalComputeResource struct
Table 7.102. Attributes summary
Table 7.103. Links summary
Name | Type | Summary |
---|---|---|
|
7.79. ExternalDiscoveredHost struct
Table 7.104. Attributes summary
Table 7.105. Links summary
Name | Type | Summary |
---|---|---|
|
7.80. ExternalHost struct
Represents a host provisioned by a host provider (such as Foreman/Satellite).
See Foreman documentation for more details. See Satellite documentation for more details on Red Hat Satellite.
Table 7.106. Attributes summary
Name | Type | Summary |
---|---|---|
| The address of the host, either IP address of FQDN (Fully Qualified Domain Name). | |
| Free text containing comments about this object. | |
| A human-readable description in plain text. | |
| A unique identifier. | |
| A human-readable name in plain text. |
Table 7.107. Links summary
Name | Type | Summary |
---|---|---|
| A reference to the external host provider that the host is managed by. |
7.81. ExternalHostGroup struct
Table 7.108. Attributes summary
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. | |
| ||
|
Table 7.109. Links summary
Name | Type | Summary |
---|---|---|
|
7.82. ExternalHostProvider struct
Represents an external host provider, such as Foreman or Satellite.
See Foreman documentation for more details. See Satellite documentation for more details on Red Hat Satellite.
Table 7.110. Attributes summary
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.82.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.
Table 7.111. Links summary
Name | Type | Summary |
---|---|---|
| A reference to the certificates the engine supports for this provider. | |
| A reference to the compute resource as represented in the host provider. | |
| A reference to the discovered hosts in the host provider. | |
| A reference to the host groups in the host provider. | |
| A reference to the hosts provisioned by the host provider. |
7.82.2. compute_resources
A reference to the compute resource as represented in the host provider. Each host provider optionally has the engine defined as a compute resource, which allows to create virtual machines in the engine. This compute resource details are used in the Bare-Metal provisioning use-case, in order to deploy the hypervisor.
7.82.3. discovered_hosts
A reference to the discovered hosts in the host provider. Discovered hosts are hosts that were not provisioned yet.
7.82.4. host_groups
A reference to the host groups in the host provider. Host group contains different properties that the host provider applies on all hosts that are member of this group. Such as installed software, system definitions, passwords and more.
7.83. ExternalNetworkProviderConfiguration struct
Describes how an external network provider is provisioned on a host.
Table 7.112. Attributes summary
Table 7.113. Links summary
Name | Type | Summary |
---|---|---|
| Link to the external network provider. | |
| Link to the host. |
7.84. ExternalProvider struct
Represents an external provider.
Table 7.114. Attributes summary
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.84.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.85. ExternalStatus enum
Represents an external status. This status is currently used for hosts and storage domains, and allows an external system to update status of objects it is aware of.
Table 7.115. Values summary
Name | Summary |
---|---|
| Error status. |
| Failure status. |
| Info status. |
| OK status. |
| Warning status. |
7.85.1. error
Error status. There is some kind of error in the relevant object.
7.85.2. failure
Failure status. The relevant object is failing.
7.85.3. info
Info status. The relevant object is in OK status, but there is an information available that might be relevant for the administrator.
7.85.4. ok
OK status. The relevant object is working well.
7.85.5. warning
Warning status. The relevant object is working well, but there is some warning that might be relevant for the administrator.
7.86. ExternalSystemType enum
Represents the type of the external system that is associated with the step
.
Table 7.116. Values summary
Name | Summary |
---|---|
|
Represents |
|
Represents |
7.87. ExternalTemplateImport struct
Describes the parameters for the template import operation from an external system. Currently supports OVA only.
Table 7.117. Attributes summary
7.87.1. clone
Optional. Indicates if the identifiers of the imported template should be regenerated.
By default when a template is imported the identifiers are preserved. This means that the same template can’t be imported multiple times, as that identifiers needs to be unique. To allow importing the same template multiple times set this parameter to true
, as the default is false
.
7.87.2. url
The URL to be passed to the engine.
Example:
ova:///mnt/ova/ova_file.ova
Table 7.118. Links summary
Name | Type | Summary |
---|---|---|
| Specifies the target cluster for the resulting template. | |
| Optional. | |
| Specifies the host that the OVA file exists on. | |
| Optional. | |
| Specifies the target storage domain for disks. | |
| The template entity used to specify a name for the newly created template. |
7.87.3. cpu_profile
Optional. Specifies the CPU profile of the resulting template.
7.87.4. quota
Optional. Specifies the quota that will be applied to the resulting template.
7.87.5. template
The template entity used to specify a name for the newly created template.
If a name is not specified, the source template name will be used.
7.88. ExternalVmImport struct
Describes the parameters for the virtual machine import operation from an external system.
Table 7.119. Attributes summary
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. | |
| Optional. | |
|
The URL to be passed to the | |
| The username to authenticate against the external hypervisor system. |
7.88.1. sparse
Optional. Specifies the disk allocation policy of the resulting virtual machine: true
for sparse, false
for preallocated.
If not specified: - When importing an OVA that was produced by oVirt, it will be determined according to the configuration of the disk within the OVF. - Otherwise, it will be set to true.
7.88.2. 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
More examples can be found at http://libguestfs.org/virt-v2v.1.html.
Table 7.120. Links summary
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.88.3. cpu_profile
Optional. Specifies the CPU profile of the resulting virtual machine.
7.88.4. drivers_iso
Optional. The name of the ISO containing drivers that can be used during the virt-v2v
conversion process.
7.88.5. host
Optional. Specifies the host (using host’s ID) to be used for the conversion process. If not specified, one is selected automatically.
7.88.6. quota
Optional. Specifies the quota that will be applied to the resulting virtual machine.
7.88.7. 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.89. ExternalVmProviderType enum
Describes the type of external hypervisor system.
Table 7.121. Values summary
Name | Summary |
---|---|
| |
| |
|
7.90. Fault struct
7.91. FenceType enum
Type representing the type of the fence operation.
Table 7.123. Values summary
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.92. FencingPolicy struct
Type representing a cluster fencing policy.
Table 7.124. Attributes summary
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.92.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.92.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.92.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.92.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.93. File struct
Table 7.125. Attributes summary
Table 7.126. Links summary
Name | Type | Summary |
---|---|---|
|
7.94. Filter struct
Table 7.127. Attributes summary
Table 7.128. Links summary
Name | Type | Summary |
---|---|---|
|
7.95. FipsMode enum
Representation of the FIPS mode to the cluster.
Table 7.129. Values summary
Name | Summary |
---|---|
| The FIPS mode is disabled. |
| The FIPS mode is enabled. |
| The FIPS mode is not yet evaluated. |
7.95.1. disabled
The FIPS mode is disabled.
Its implication is that the FIPS mode is disabled and the hosts within should be with FIPS mode disabled, otherwise they would be non-operational.
7.95.2. enabled
The FIPS mode is enabled.
Its implication is that the FIPS mode is enabled and the hosts within should be with FIPS mode enabled, otherwise they should be non-operational.
7.95.3. undefined
The FIPS mode is not yet evaluated.
Currently, its implication is that the FIPS mode is undetermined. Once a host is added, this value will switch according to the host settings.
7.96. FirewallType enum
Describes all firewall types supported by the system.
Table 7.130. Values summary
Name | Summary |
---|---|
| FirewallD firewall type. |
| IPTables firewall type. |
7.96.1. firewalld
FirewallD firewall type.
When a cluster has the firewall type set to firewalld
, the firewalls of all hosts in the cluster will be configured using firewalld
. FirewallD replaced IPTables in version 4.2. It simplifies configuration using a command line program and dynamic configuration.
7.96.2. iptables
IPTables firewall type.
iptables
is deprecated.
7.97. Floppy struct
The underlying representation of a floppy file.
Table 7.131. Attributes summary
Name | Type | Summary |
---|---|---|
| Free text containing comments about this object. | |
| A human-readable description in plain text. | |
| File object that represent the Floppy device’s content and its type. | |
| A unique identifier. | |
| A human-readable name in plain text. |
Table 7.132. Links summary
Name | Type | Summary |
---|---|---|
| Optionally references to an instance type the device is used by. | |
| Optionally references to a template the device is used by. | |
|
Do not use this element, use | |
| Vm[] | References to the virtual machines that are using this device. |
7.97.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.98. FopStatistic struct
Table 7.133. Attributes summary
Name | Type | Summary |
---|---|---|
| ||
|
7.99. GlusterBrick struct
Table 7.134. Attributes summary
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. | |
| ||
| ||
| ||
|
Table 7.135. Links summary
Name | Type | Summary |
---|---|---|
| ||
| Optionally references to an instance type the device is used by. | |
| ||
| Optionally references to a template the device is used by. | |
|
Do not use this element, use | |
| Vm[] | References to the virtual machines that are using this device. |
7.99.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.100. GlusterBrickAdvancedDetails struct
Table 7.136. Attributes summary
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. | |
| ||
|
Table 7.137. Links summary
Name | Type | Summary |
---|---|---|
| Optionally references to an instance type the device is used by. | |
| Optionally references to a template the device is used by. | |
|
Do not use this element, use | |
| Vm[] | References to the virtual machines that are using this device. |
7.100.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.101. GlusterBrickMemoryInfo struct
Table 7.138. Attributes summary
Name | Type | Summary |
---|---|---|
|
7.102. GlusterBrickStatus enum
Table 7.139. Values summary
Name | Summary |
---|---|
|
Brick is in |
| When the status cannot be determined due to host being non-responsive. |
|
Brick is in |
7.103. GlusterClient struct
7.104. GlusterHook struct
Table 7.141. Attributes summary
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. | |
| ||
|
Table 7.142. Links summary
Name | Type | Summary |
---|---|---|
| ||
|
7.105. GlusterHookStatus enum
Table 7.143. Values summary
Name | Summary |
---|---|
| Hook is disabled in the cluster. |
| Hook is enabled in the cluster. |
| Unknown/missing hook status. |
7.106. GlusterMemoryPool struct
Table 7.144. Attributes summary
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.107. GlusterServerHook struct
Table 7.145. Attributes summary
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. | |
|
Table 7.146. Links summary
Name | Type | Summary |
---|---|---|
|
7.108. GlusterState enum
Table 7.147. Values summary
Name | Summary |
---|---|
| |
| |
|
7.109. GlusterVolume struct
Table 7.148. Attributes summary
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. | |
| ||
| ||
| ||
| ||
| ||
| ||
|
Table 7.149. Links summary
Name | Type | Summary |
---|---|---|
| ||
| ||
|
7.110. GlusterVolumeProfileDetails struct
Table 7.150. Attributes summary
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.111. GlusterVolumeStatus enum
Table 7.151. Values summary
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.112. GlusterVolumeType enum
Type representing the type of Gluster Volume.
Table 7.152. Values summary
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.112.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.112.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.112.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.112.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.112.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.112.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.112.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.112.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.112.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.113. GracePeriod struct
Table 7.153. Attributes summary
Name | Type | Summary |
---|---|---|
|
7.114. GraphicsConsole struct
Table 7.154. Attributes summary
Table 7.155. Links summary
Name | Type | Summary |
---|---|---|
| ||
| ||
|
7.115. GraphicsType enum
The graphics protocol used to connect to the graphic console.
Table 7.156. Values summary
Name | Summary |
---|---|
| Graphics protocol of type SPICE. |
| Graphics protocol of type VNC. |
7.115.1. spice
Graphics protocol of type SPICE. See SPICE documentation for more details.
7.115.2. vnc
Graphics protocol of type VNC. VNC stands for Virtual Network Computing, and it is a graphical desktop sharing system that uses RFB (Remote Frame Buffer) protocol to remotely control another machine.
7.116. Group struct
This type represents all groups in the directory service.
Table 7.157. Attributes summary
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. |
Table 7.158. Links summary
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. | |
| Tag[] | A link to the tags sub-collection for tags attached to this group. |
7.116.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.117. GuestOperatingSystem struct
Represents an operating system installed on the virtual machine.
To get that information send a request like this:
GET /ovirt-engine/api/vms/123
The result will be like this:
<vm href="/ovirt-engine/api/vms/123" id="123"> ... <guest_operating_system> <architecture>x86_64</architecture> <codename>Maipo</codename> <distribution>Red Hat Enterprise Linux Server</distribution> <family>Linux</family> <kernel> <version> <build>0</build> <full_version>3.10.0-514.10.2.el7.x86_64</full_version> <major>3</major> <minor>10</minor> <revision>514</revision> </version> </kernel> <version> <full_version>7.3</full_version> <major>7</major> <minor>3</minor> </version> </guest_operating_system> </vm>
Table 7.159. Attributes summary
Name | Type | Summary |
---|---|---|
| The architecture of the operating system, such as x86_64. | |
|
Code name of the operating system, such as | |
| Full name of operating system distribution. | |
|
Family of operating system, such as | |
| Kernel version of the operating system. | |
| Version of the installed operating system. |
7.118. HardwareInformation struct
Represents hardware information of host.
To get that information send a request like this:
GET /ovirt-engine/api/hosts/123
The result will be like this:
<host href="/ovirt-engine/api/hosts/123" id="123"> ... <hardware_information> <family>Red Hat Enterprise Linux</family> <manufacturer>Red Hat</manufacturer> <product_name>RHEV Hypervisor</product_name> <serial_number>01234567-89AB-CDEF-0123-456789ABCDEF</serial_number> <supported_rng_sources> <supported_rng_source>random</supported_rng_source> </supported_rng_sources> <uuid>12345678-9ABC-DEF0-1234-56789ABCDEF0</uuid> <version>1.2-34.5.el7ev</version> </hardware_information> ... </application>
Table 7.160. Attributes summary
Name | Type | Summary |
---|---|---|
| Type of host’s CPU. | |
| Manufacturer of the host’s machine and hardware vendor. | |
|
Host’s product name (for example | |
| Unique ID for host’s chassis. | |
| Supported sources of random number generator. | |
| Unique ID for each host. | |
| Unique name for each of the manufacturer. |
7.119. HighAvailability struct
Type representing high availability of a virtual machine.
Table 7.161. Attributes summary
7.119.1. enabled
Define if the virtual machine is considered highly available. Configuring a VM lease is highly recommended (refer to that section) in order to prevent split-brain scenarios. Use a boot disk’s storage-domain or any other active storage-domain.
7.119.2. 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.120. Hook struct
Represents a hook.
Table 7.162. Attributes summary
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. |
Table 7.163. Links summary
Name | Type | Summary |
---|---|---|
| Reference to the host the hook belongs to. |
7.121. HookContentType enum
Represents content type of hook script.
Table 7.164. Values summary
Name | Summary |
---|---|
| Binary content type of the hook. |
| Text content type of the hook. |
7.122. HookStage enum
Type represents a stage of volume event at which hook executes.
Table 7.165. Values summary
Name | Summary |
---|---|
| Stage after start of volume. |
| Stage before start of volume. |
7.123. HookStatus enum
Type represents the status of a hook.
Table 7.166. Values summary
Name | Summary |
---|---|
| Hook is disabled. |
| Hook is enabled. |
| Hook is missing. |
7.124. Host struct
Type representing a host.
Table 7.167. Attributes summary
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 self-hosted engine status of 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 a network-related operation, such as 'setup networks', 'sync networks', or 'refresh capabilities', is currently being executed on this host. | |
| 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. | |
| Indicates if the host has correctly configured OVN. | |
| The host port. | |
| The host power management definitions. | |
| The protocol that the engine uses to communicate with the host. | |
| Specifies whether the host should be reinstalled. | |
| 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. | |
| Specifies the vGPU placement strategy. |
7.124.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.124.2. hosted_engine
The self-hosted engine status of this host.
7.124.3. kdump_status
The host KDUMP status. KDUMP happens when the host kernel has crashed and it is now going through memory dumping.
7.124.4. 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
With a request body like this:
<host> <ksm> <enabled>true</enabled> </ksm> </host>
7.124.5. libvirt_version
The host libvirt version. For more information on libvirt please go to libvirt.
7.124.6. network_operation_in_progress
Specifies whether a network-related operation, such as 'setup networks', 'sync networks', or 'refresh capabilities', is currently being executed on this host.
The header All-Content:true
must be added to the request in order for this attribute to be included in the response.
7.124.7. override_iptables
Specifies whether we should override firewall definitions. This applies only when the host is installed or re-installed.
7.124.8. 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.124.9. 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.124.10. 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.124.11. status_detail
The host status details. Relevant for Gluster hosts.
7.124.12. 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
With a request body like this:
<host> <transparent_hugepages> <enabled>true</enabled> </transparent_hugepages> </host>
7.124.13. version
The version of VDSM.
For example:
GET /ovirt-engine/api/hosts/123
This GET
request will return the following output:
<host> ... <version> <build>999</build> <full_version>vdsm-4.18.999-419.gitcf06367.el7</full_version> <major>4</major> <minor>18</minor> <revision>0</revision> </version> ... </host>
Table 7.168. Links summary
Name | Type | Summary |
---|---|---|
| ||
| ||
| ||
| List of all host’s CPUs with detailed information about the topology (socket, core) and with information about the current CPU pinning. | |
| ||
| ||
| External network providers provisioned on the host. | |
| ||
| Lists all the Katello errata assigned to the host. | |
| ||
| ||
| ||
| ||
| Each host resource exposes a statistics sub-collection for host-specific statistics. | |
| ||
| ||
| Tag[] | |
|
7.124.14. cpu_units
List of all host’s CPUs with detailed information about the topology (socket, core) and with information about the current CPU pinning.
GET /ovirt-engine/api/hosts/123/cpuunits
You will receive response in XML like this one:
<host_cpu_units> <host_cpu_unit> <core_id>0</core_id> <cpu_id>0</cpu_id> <socket_id>0</socket_id> <vms> <vm href="/ovirt-engine/api/vms/def" id="def" /> </vms> </host_cpu_unit> <host_cpu_unit> <core_id>0</core_id> <cpu_id>1</cpu_id> <socket_id>1</socket_id> <runs_vdsm>true</runs_vdsm> </host_cpu_unit> <host_cpu_unit> <core_id>0</core_id> <cpu_id>2</cpu_id> <socket_id>2</socket_id> </host_cpu_unit> </host_cpu_units>
7.124.15. external_network_provider_configurations
External network providers provisioned on the host.
This attribute is read-only. Setting it will have no effect on the host. The value of this parameter reflects the Default Network Provider of the cluster.
7.124.16. katello_errata
Lists all the Katello errata assigned to the host.
GET /ovirt-engine/api/hosts/123/katelloerrata
You will receive response in XML like this one:
<katello_errata> <katello_erratum href="/ovirt-engine/api/katelloerrata/456" id="456"> <name>RHBA-2013:XYZ</name> <description>The description of the erratum</description> <title>some bug fix update</title> <type>bugfix</type> <issued>2013-11-20T02:00:00.000+02:00</issued> <solution>Few guidelines regarding the solution</solution> <summary>Updated packages that fix one bug are now available for XYZ</summary> <packages> <package> <name>libipa_hbac-1.9.2-82.11.el6_4.i686</name> </package> ... </packages> </katello_erratum> ... </katello_errata>
7.124.17. statistics
Each host resource exposes a statistics sub-collection for host-specific statistics.
An example of an XML representation:
<statistics> <statistic href="/ovirt-engine/api/hosts/123/statistics/456" id="456"> <name>memory.total</name> <description>Total memory</description> <kind>gauge</kind> <type>integer</type> <unit>bytes</unit> <values> <value> <datum>25165824000</datum> </value> </values> <host href="/ovirt-engine/api/hosts/123" id="123"/> </statistic> ... </statistics>
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.125. HostCpuUnit struct
Type representing a physical CPU of a host with the current pinning status.
Table 7.169. Attributes summary
Name | Type | Summary |
---|---|---|
| Free text containing comments about this object. | |
| The id of the core the CPU belongs to. | |
| The id of the CPU. | |
| A human-readable description in plain text. | |
| A unique identifier. | |
| A human-readable name in plain text. | |
| A flag indicating that the CPU runs the VDSM | |
| The id of the socket the CPU belongs to. |
Table 7.170. Links summary
Name | Type | Summary |
---|---|---|
| Vm[] | A list of VMs that has its virtual CPU pinned to this physical CPU. |
7.126. HostDevice struct
Table 7.171. Attributes summary
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. | |
| ||
| List of all supported mdev types on the physical device, | |
| A human-readable name in plain text. | |
| ||
| ||
| ||
| ||
|
7.126.1. driver
The name of the driver this device is bound to.
For example: pcieport
or uhci_hcd
.
Table 7.172. Links summary
Name | Type | Summary |
---|---|---|
| ||
| ||
|
7.127. HostDevicePassthrough struct
Table 7.173. Attributes summary
Name | Type | Summary |
---|---|---|
|
7.128. HostNic struct
Represents a host NIC.
For example, the XML representation of a host NIC looks like this:
<host_nic href="/ovirt-engine/api/hosts/123/nics/456" id="456"> <name>eth0</name> <boot_protocol>static</boot_protocol> <bridged>true</bridged> <custom_configuration>true</custom_configuration> <ip> <address>192.168.122.39</address> <gateway>192.168.122.1</gateway> <netmask>255.255.255.0</netmask> <version>v4</version> </ip> <ipv6> <gateway>::</gateway> <version>v6</version> </ipv6> <ipv6_boot_protocol>none</ipv6_boot_protocol> <mac> <address>52:54:00:0c:79:1d</address> </mac> <mtu>1500</mtu> <status>up</status> </host_nic>
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:
<host_nic href="/ovirt-engine/api/hosts/123/nics/456" id="456"> <name>bond0</name> <mac address="00:00:00:00:00:00"/> <ip> <address>192.168.122.39</address> <gateway>192.168.122.1</gateway> <netmask>255.255.255.0</netmask> <version>v4</version> </ip> <boot_protocol>dhcp</boot_protocol> <bonding> <options> <option> <name>mode</name> <value>4</value> <type>Dynamic link aggregation (802.3ad)</type> </option> <option> <name>miimon</name> <value>100</value> </option> </options> <slaves> <host_nic id="123"/> <host_nic id="456"/> </slaves> </bonding> <mtu>1500</mtu> <bridged>true</bridged> <custom_configuration>false</custom_configuration> </host_nic>
Table 7.174. Attributes summary
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. | |
| ||
| ||
| ||
| ||
| Describes the virtual functions configuration of a physical function NIC. | |
|
7.128.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.128.2. bridged
Defines the bridged network status. Set to true
for a bridged network and false
for a bridgeless network.
Table 7.175. Links summary
Name | Type | Summary |
---|---|---|
| ||
| A reference to the network to which the interface should be connected. | |
| The labels that are applied to this NIC. | |
| 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. | |
| A link to the statistics of the NIC. |
7.128.3. network
A reference to the network to which the interface should be connected. A blank network ID is allowed.
7.128.4. 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.current.rx.bps - The rate in bits per second of data received (since version 4.2).
- data.current.tx.bps - The rate in bits per second of data transmitted (since version 4.2).
- 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.
7.129. HostNicVirtualFunctionsConfiguration struct
Describes the virtual functions configuration of an SR-IOV-enabled physical function NIC.
Table 7.176. Attributes summary
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.129.1. max_number_of_virtual_functions
The maximum number of virtual functions the NIC supports. This property is read-only.
7.129.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.130. 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.
Table 7.177. Values summary
Name | Summary |
---|---|
| JSON-RPC protocol on top of STOMP. |
| XML-RPC protocol. |
7.131. HostStatus enum
Type representing a host status.
Table 7.178. Values summary
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.131.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.131.2. initializing
The host is initializing. This is an intermediate step before moving the host to 'up' status.
7.131.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.131.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.131.5. maintenance
The host is in maintenance status. When a host is in maintenance it cannot run virtual machines.
7.131.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.131.7. non_responsive
The host is not responsive. This means that the engine is not able to communicate with the host.
7.131.8. pending_approval
The host is pending administrator approval. This is relevant only for vintage ovirt-node / RHV-H. This property is no longer relevant since Vintage Node is no longer supported, and has been deprecated.
7.131.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.132. HostStorage struct
Table 7.179. Attributes summary
Name | Type | Summary |
---|---|---|
| ||
| Free text containing comments about this object. | |
| A human-readable description in plain text. | |
| The options to be passed when creating a storage domain using a cinder driver. | |
| Parameters containing sensitive information, to be passed when creating a storage domain using a cinder driver. | |
| 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.132.1. driver_options
The options to be passed when creating a storage domain using a cinder driver.
For example (Kaminario backend):
POST /ovirt-engine/api/storagedomains/
<storage_domain> <name>kamniraio-cinder</name> <type>managed_block_storage</type> <storage> <type>managed_block_storage</type> <driver_options> <property> <name>san_ip</name> <value>192.168.1.1</value> </property> <property> <name>san_login</name> <value>username</value> </property> <property> <name>san_password</name> <value>password</value> </property> <property> <name>use_multipath_for_image_xfer</name> <value>true</value> </property> <property> <name>volume_driver</name> <value>cinder.volume.drivers.kaminario.kaminario_iscsi.KaminarioISCSIDriver</value> </property> </driver_options> </storage> <host> <name>host</name> </host> </storage_domain>
7.132.2. driver_sensitive_options
Parameters containing sensitive information, to be passed when creating a storage domain using a cinder driver. These parameters are encrypted when they are saved.
For example, the following XML encrypts and saves a username, password and SAN IP address:
POST /ovirt-engine/api/storagedomains/
<storage_domain> <name>kamniraio-cinder</name> <type>managed_block_storage</type> <storage> <type>managed_block_storage</type> <driver_options> <property> <name>san_ip</name> <value>192.168.1.1</value> </property> <property> <name>san_login</name> <value>username</value> </property> <property> <name>san_password</name> <value>password</value> </property> <property> <name>use_multipath_for_image_xfer</name> <value>true</value> </property> <property> <name>volume_driver</name> <value>cinder.volume.drivers.kaminario.kaminario_iscsi.KaminarioISCSIDriver</value> </property> </driver_options> <driver_sensitive_options> <property> <name>username</name> <value>admin</value> </property> <property> <name>password</name> <value>123</value> </property> <property> <name>san_ip</name> <value>192.168.1.1</value> </property> </driver_sensitive_options> </storage> <host> <name>host</name> </host> </storage_domain>
7.132.3. 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.132.4. 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.
Table 7.180. Links summary
Name | Type | Summary |
---|---|---|
|
7.133. HostType enum
This enumerated type is used to determine which type of operating system is used by the host.
Table 7.181. Values summary
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.133.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.133.2. rhev_h
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.
This property is no longer relevant since Vintage Node is no longer supported, and has been deprecated.
7.134. HostedEngine struct
7.135. Icon struct
Icon of virtual machine or template.
Table 7.183. Attributes summary
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.135.1. media_type
Format of icon file.
One of:
-
image/jpeg
-
image/png
-
image/gif
7.136. Identified struct
This interface is the base model for all types that represent objects with an identifier.
7.137. Image struct
Represents an image entity.
Table 7.185. Attributes summary
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 size of the image file. | |
| The type of the image file. |
Table 7.186. Links summary
Name | Type | Summary |
---|---|---|
| The storage domain associated with this image. |
7.138. ImageFileType enum
Represents the file type of an image.
Table 7.187. Values summary
Name | Summary |
---|---|
| The image is a disk format that can be used as a virtual machine’s disk. |
| The image is a floppy disk that can be attached to a virtual machine, for example to install the VirtIO drivers in Windows. |
| The image is a `. |
7.138.1. iso
The image is a .iso
file that can be used as a CD-ROM to boot and install a virtual machine.
7.139. ImageTransfer struct
This type contains information regarding an image transfer being performed.
Table 7.188. Attributes summary
Name | Type | Summary |
---|---|---|
| Indicates whether there’s at least one active session for this transfer, i,e there’s at least one live transfer session between the client and the daemon. | |
| Free text containing comments about this object. | |
| A human-readable description in plain text. | |
|
The direction indicates whether the transfer is sending image data ( | |
| The format of the data sent during upload or received during download. | |
| A unique identifier. | |
| The timeout in seconds of client inactivity, after which the transfer is aborted by the Red Hat Virtualization Manager. | |
| 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. | |
| Download only the specified image instead of the entire image chain. | |
| Timeout policy determines how the system handles the transfer when a client is idle for more than inactivityTimeout. | |
| The URL of the daemon server that the user can input or output to directly. | |
| Indicates the amount of transferred bytes. |
7.139.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.139.2. format
The format of the data sent during upload or received during download. If not specified, defaults to disk’s format.
7.139.3. inactivity_timeout
The timeout in seconds of client inactivity, after which the transfer is aborted by the Red Hat Virtualization Manager. To disable the inactivity timeout specify '0'. If not specified, the value is defaulted to the engine-config
value: TransferImageClientInactivityTimeoutInSeconds.
7.139.4. 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.139.5. proxy_url
The URL of the proxy server that the user inputs or outputs to. This attribute is available only if the image transfer is in the transferring phase. See phase
for details.
7.139.6. shallow
Download only the specified image instead of the entire image chain.
If true, when using format="raw" and direction="download", the transfer includes data only from the specified disk snapshot, and unallocated areas are reported as holes. By default, the transfer includes data from all disk snapshots.
When specifying a disk snapshot, the transfer includes only data for the specified disk snapshot. When specifying a disk, the transfer includes only data from the active disk snaphost.
This parameter has no effect when not using format="raw" or for direction="upload".
Example: Downloading a single snapshot:
<image_transfer> <snapshot id="2fb24fa2-a5db-446b-b733-4654661cd56d"/> <direction>download</direction> <format>raw</format> <shallow>true</shallow> </image_transfer>
To download the active snapshot disk image (which is not accessible as a disk snapshot), specify the disk:
<image_transfer> <disk id="ff6be46d-ef5d-41d6-835c-4a68e8956b00"/> <direction>download</direction> <format>raw</format> <shallow>true</shallow> </image_transfer>
In both cases you can now download a qcow2 image using imageio client:
from ovirt_imageio import client client.download( transfer.transfer_url, "51275e7d-42e9-491f-9d65-b9211c897eac", backing_file="07c0ccac-0845-4665-9097-d0a3b16cf43b", backing_format="qcow2")
7.139.7. transfer_url
The URL of the daemon server that the user can input or output to directly.
This is as an alternative to the proxy_url
. I.e. if the client has access to the host machine, it could bypass the proxy and transfer directly to the host, potentially improving the throughput performance. This attribute is available only if the image transfer is in the transferring phase. See phase
for details.
Table 7.189. Links summary
Name | Type | Summary |
---|---|---|
| The backup associated with the image transfer. | |
| The disk which is targeted for input or output. | |
| The host which will be used to write to the image which is targeted for input or output. | |
| The image which is targeted for input or output. | |
| The disk snapshot which is targeted for input or output. |
7.139.8. backup
The backup associated with the image transfer. Specify when initiating an image transfer for a disk that is part of a backup.
7.139.9. host
The host which will be used to write to the image which is targeted for input or output. If not specified, an active host will be randomly selected from the data center.
7.139.10. image
The image which is targeted for input or output.
This attribute is deprecated since version 4.2 of the engine. Use the disk
or snapshot
attributes instead.
7.140. 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.
Table 7.190. Values summary
Name | Summary |
---|---|
|
The user must choose |
|
The user can choose |
7.141. 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.
Table 7.191. Values summary
Name | Summary |
---|---|
| This phase will be set as a result of the user cancelling the transfer. |
| This phase will be set as a result of the system cancelling the transfer. |
| This phase will be set as a result of the user cancelling the transfer. |
| This phase indicates that the user cancelled the transfer, and necessary cleanup is being done. |
| 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. |
| This phase indicates that the user cancelled the transfer, and necessary cleanup is done. |
| 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 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.141.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.141.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.141.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. System cancelling the transfer will also result in this.
7.141.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.141.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.141.6. paused_system
This phase means the session timed out, or some other error occurred with this transfer; for example ovirt-imageio 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.141.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.141.8. unknown
An unknown phase. This will only be set in cases of unpredictable errors.
7.142. ImageTransferTimeoutPolicy enum
The image transfer timeout policy.
Define how the system handles a transfer when the client is inactive for inactivityTimeout seconds.
Please refer to image transfer for further documentation.
Table 7.192. Values summary
Name | Summary |
---|---|
| Cancel the transfer and unlock the disk. |
| LEGACY policy will preserve the legacy functionality which is the default. |
| Pause the transfer. |
7.142.1. cancel
Cancel the transfer and unlock the disk. For image transfer using upload direction, the disk is deleted.
7.142.2. legacy
LEGACY policy will preserve the legacy functionality which is the default. The default behaviour will cancel the transfer if the direction is download, and pause it if its upload.
7.142.3. pause
Pause the transfer. The transfer can be resumed or canceled by the user. The disk will remain locked while the transfer is paused.
7.143. InheritableBoolean enum
Enum representing the boolean value that can be either set, or inherited from a higher level. The inheritance order is virtual machine → cluster → engine-config.
Table 7.193. Values summary
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.144. Initialization struct
Table 7.194. Attributes summary
Name | Type | Summary |
---|---|---|
| ||
| ||
| Deprecated attribute to specify cloud-init configuration. | |
| Attribute specifying the cloud-init protocol to use for formatting the cloud-init network parameters. | |
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
|
7.144.1. cloud_init
Deprecated attribute to specify cloud-init configuration.
This attribute and the CloudInit type have been deprecated and will be removed in the future. To specify the cloud-init configuration, use the attributes inside the Initialization type. The mapping between the attributes of these two types are as follows:
CloudInit | Initialization |
---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
For more details on how to use cloud-init see the examples in Python and Java.
7.144.2. cloud_init_network_protocol
Attribute specifying the cloud-init protocol to use for formatting the cloud-init network parameters. If omitted, a default value is used, as described in the CloudInitNetworkProtocol
7.145. 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.
Table 7.195. Attributes summary
Name | Type | Summary |
---|---|---|
| Specifies if and how the auto CPU and NUMA configuration is applied. | |
| 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. | |
| Specifies if and how the CPU and NUMA configuration is applied. | |
| ||
| 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 the 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 a running virtual machine to another host. | |
| Maximum time the virtual machine can be non responsive during its live migration to another host in ms. | |
|
If | |
| A human-readable name in plain text. | |
| The origin of this virtual machine. | |
| Operating system type installed on the virtual machine. | |
| The configuration of the virtual machine’s placement policy. | |
| 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. | |
| Determines how the virtual machine will be resumed after storage error. | |
| The virtual machine’s time zone set by oVirt. | |
|
If | |
|
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 the base version or a sub-version of another template. | |
| Reference to VirtIO SCSI configuration. | |
| Number of queues for a Virtio-SCSI contoller this field requires virtioScsiMultiQueuesEnabled to be true see virtioScsiMultiQueuesEnabled for more info | |
|
If | |
| The virtual machine configuration associated with this template. |
7.145.1. auto_pinning_policy
Specifies if and how the auto CPU and NUMA configuration is applied.
Since version 4.5 of the engine this operation is deprecated, and preserved only for backwards compatibility. It might be removed in the future. Please use CpuPinningPolicy instead.
7.145.2. 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
With a request body:
<vm> <cpu> <topology> <sockets>4</sockets> <cores>2</cores> <threads>2</threads> </topology> </cpu> </vm>
7.145.3. cpu_pinning_policy
Specifies if and how the CPU and NUMA configuration is applied. When not specified the previous behavior of CPU pinning string will determine CpuPinningPolicy to None or Manual.
7.145.4. 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.145.5. high_availability
The virtual machine high availability configuration. If set, the virtual machine will be automatically restarted when it unexpectedly goes down.
7.145.6. initialization
Reference to the virtual machine’s initialization configuration.
Since Red Hat Virtualization 4.1.8 this property can be cleared by sending an empty tag.
For example, to clear the initialization
attribute send a request like this:
PUT /ovirt-engine/api/vms/123
With a request body like this:
<vm> <initialization/> </vm>
The response to such a request, and requests with the header All-Content: true
will still contain this attribute.
7.145.7. large_icon
Virtual machine’s large icon. Either set by user or refers to image set according to operating system.
7.145.8. 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.145.9. 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
With the following request body:
<vm> <memory>1073741824</memory> </vm>
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 in state up. The size increment must be dividable by the value of the HotPlugMemoryBlockSizeMb
configuration value (256 MiB by default). If the memory size increment is not dividable by this value, the memory size change is only stored to next run configuration. Each successful memory hot plug operation creates one or two new memory devices.
Memory hot unplug is supported since Red Hat Virtualization 4.2 onwards. Memory hot unplug can only be performed when the virtual machine is in state up. Only previously hot plugged memory devices can be removed by the hot unplug operation. The requested memory decrement is rounded down to match sizes of a combination of previously hot plugged memory devices. The requested memory value is stored to next run configuration without rounding.
Memory in the example is converted to bytes using the following formula:
1 GiB = 230 bytes = 1073741824 bytes.
Red Hat Virtualization Manager internally rounds values down to whole MiBs (1MiB = 220 bytes)
7.145.10. migration
Reference to configuration of migration of a running virtual machine to another host.
API for querying migration policy by ID returned by this method is not implemented yet. Use /ovirt-engine/api/options/MigrationPolicies
to get a list of all migration policies with their IDs.
7.145.11. 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.145.12. origin
The origin of this virtual machine.
Possible values:
-
ovirt
-
rhev
-
vmware
-
xen
-
external
-
hosted_engine
-
managed_hosted_engine
-
kvm
-
physical_machine
-
hyperv
7.145.13. 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
With a request body like this:
<vm> <high_availability> <enabled>true</enabled> <priority>1</priority> </high_availability> <placement_policy> <hosts> <host> <name>Host1</name> </host> <host> <name>Host2</name> </host> </hosts> <affinity>pinned</affinity> </placement_policy> </vm>
7.145.14. small_icon
Virtual machine’s small icon. Either set by user or refers to image set according to operating system.
7.145.15. 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.145.16. tpm_enabled
If true
, a TPM device is added to the virtual machine. By default the value is false
. This property is only visible when fetching if "All-Content=true" header is set.
Table 7.196. Links summary
Name | Type | Summary |
---|---|---|
| Reference 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. | |
| Reference to the disks attached to the template. | |
| Reference to the graphic consoles attached to the template. | |
| Mediated devices configuration. | |
| Nic[] | Reference to the network interfaces attached to the template. |
| Reference 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. | |
| Tag[] | Reference to the tags attached to the template. |
| Reference to the watchdog devices attached to the template. |
7.146. Io struct
Table 7.197. Attributes summary
Name | Type | Summary |
---|---|---|
|
7.147. Ip struct
Represents the IP configuration of a network interface.
Table 7.198. Attributes summary
7.147.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>
An IPv6 address will be represented as follows:
<ip> <address>2620:52:0:20f0:4216:7eff:feaa:1b50</address> ... </ip>
7.147.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.147.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.148. 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.
Table 7.199. Attributes summary
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.149. IpVersion enum
Defines the values for the IP protocol version.
Table 7.200. Values summary
Name | Summary |
---|---|
| IPv4. |
| IPv6. |
7.150. IscsiBond struct
Table 7.201. Attributes summary
Table 7.202. Links summary
Name | Type | Summary |
---|---|---|
| ||
| ||
|
7.151. IscsiDetails struct
Table 7.203. Attributes summary
7.152. 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.
Table 7.204. Attributes summary
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.152.1. external
Indicates if the job is originated by an external system. External jobs are managed externally, by the creator of the job.
7.153. JobStatus enum
Represents the status of the job.
Table 7.206. Values summary
Name | Summary |
---|---|
| The aborted job status. |
| The failed job status. |
| The finished job status. |
| The started job status. |
| The unknown job status. |
7.153.1. aborted
The aborted job status. This status is applicable for an external job that was forcibly aborted.
7.153.2. finished
The finished job status. This status describes a completed job execution.
7.153.3. started
The started job status. This status represents a job which is currently being executed.
7.153.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.154. KatelloErratum struct
Type representing a Katello erratum.
Table 7.207. Attributes summary
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.154.1. severity
The severity of the Katello erratum.
The supported severities are moderate
, important
or critical
.
7.154.2. type
The type of the Katello erratum.
The supported types are bugfix
, enhancement
or security
.
7.155. KdumpStatus enum
Table 7.209. Values summary
Name | Summary |
---|---|
| |
| |
|
7.156. Kernel struct
Table 7.210. Attributes summary
Name | Type | Summary |
---|---|---|
|
7.157. Ksm struct
7.158. LinkLayerDiscoveryProtocolElement struct
Represents an information element received by Link Layer Discovery Protocol (LLDP). IEEE 802.1AB defines type, length, value (TLV) as a "short, variable length encoding of an information element". This type represents such an information element.
The attribute name
is a human-readable string used to describe what the value is about, and may not be unique. The name is redundant, because it could be created from type
and the optional oui
and subtype
. The purpose of name
is to simplify the reading of the information element. The name
of a property is exactly the same string which is used in IEEE 802.1AB chapter 8.
Organizationally-specific information elements have the type
of 127
and the attributes oui
and subtype
.
For example, the XML representation of an information element may look like this:
<link_layer_discovery_protocol_element> <name>Port VLAN Id</name> <oui>32962</oui> <properties> <property> <name>vlan id</name> <value>488</value> </property> <property> <name>vlan name</name> <value>v2-0488-03-0505</value> </property> </properties> <subtype>3</subtype> <type>127</type> </link_layer_discovery_protocol_element>
Table 7.212. Attributes summary
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 organizationally-unique identifier (OUI) encoded as an integer. | |
| Represents structured data transported by the information element as a list of name/value pairs. | |
| The organizationally-defined subtype encoded as an integer. | |
| The type of the LinkLayerDiscoveryProtocolElement encoded as an integer. |
7.158.1. oui
The organizationally-unique identifier (OUI) encoded as an integer. Only available if type
is 127
.
7.158.2. subtype
The organizationally-defined subtype encoded as an integer. Only available if type
is 127
.
7.159. LogMaxMemoryUsedThresholdType enum
Describes all maximum memory threshold types supported by the system.
Table 7.213. Values summary
Name | Summary |
---|---|
| Absolute value threshold type. |
| Percentage threshold type. |
7.159.1. absolute_value_in_mb
Absolute value threshold type.
When an absolute value is specified, an audit log event is logged if the free memory in MB falls below the value specified in LogMaxMemoryUsedThreshold
.
7.159.2. percentage
Percentage threshold type.
When a percentage is specified, an audit log event is logged if the memory used is above the value specified in LogMaxMemoryUsedThreshold
.
7.160. LogSeverity enum
Enum representing a severity of an event.
Table 7.214. Values summary
Name | Summary |
---|---|
| Alert severity. |
| Error severity. |
| Normal severity. |
| Warning severity. |
7.160.1. alert
Alert severity. Used to specify a condition that requires an immediate attention.
7.160.2. error
Error severity. Used to specify that there is an error that needs to be examined.
7.160.3. normal
Normal severity. Used for information events.
7.160.4. warning
Warning severity. Used to warn something might be wrong.
7.161. LogicalUnit struct
Table 7.215. Attributes summary
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.161.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 queue-sysfs
documentation for discard_max_bytes
.
7.161.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 queue-sysfs
documentation for discard_zeroes_data
.
Since version 4.2.1 of the system, the support for this attribute has been removed as the sysfs file, discard_zeroes_data
, was deprecated in the kernel. It is preserved for backwards compatibility, but the value will always be false
.
7.162. LunStatus enum
Table 7.216. Values summary
Name | Summary |
---|---|
| |
| |
|
7.163. MDevType struct
Mediated device is a software device that allows to divide physical device’s resources.
See Libvirt-MDEV for further details.
7.164. Mac struct
Represents a MAC address of a virtual network interface.
Table 7.218. Attributes summary
Name | Type | Summary |
---|---|---|
| MAC address. |
7.165. MacPool struct
Represents a MAC address pool.
Example of an XML representation of a MAC address pool:
<mac_pool href="/ovirt-engine/api/macpools/123" id="123"> <name>Default</name> <description>Default MAC pool</description> <allow_duplicates>false</allow_duplicates> <default_pool>true</default_pool> <ranges> <range> <from>00:1A:4A:16:01:51</from> <to>00:1A:4A:16:01:E6</to> </range> </ranges> </mac_pool>
Table 7.219. Attributes summary
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.165.1. allow_duplicates
Defines whether duplicate MAC addresses are permitted in the pool. If not specified, defaults to false
.
7.165.2. default_pool
Defines whether this is the default pool. If not specified, defaults to false
.
7.165.3. ranges
Defines the range of MAC addresses for the pool. Multiple ranges can be defined.
Table 7.220. Links summary
Name | Type | Summary |
---|---|---|
| Returns a reference to the permissions that are associated with the MacPool. |
7.166. MemoryOverCommit struct
Table 7.221. Attributes summary
Name | Type | Summary |
---|---|---|
|
7.167. MemoryPolicy struct
Logical grouping of memory-related properties of virtual machine-like entities.
Table 7.222. Attributes summary
Name | Type | Summary |
---|---|---|
| ||
| The amount of memory, in bytes, that is guaranteed to not be drained by the balloon mechanism. | |
| Maximum virtual machine memory, in bytes. | |
| ||
|
7.167.1. guaranteed
The amount of memory, in bytes, that is guaranteed to not be drained by the balloon mechanism.
The Red Hat Virtualization Manager internally rounds this value down to whole MiB (1MiB = 220 bytes).
7.167.2. max
Maximum virtual machine memory, in bytes.
The user provides the value in bytes, and the Red Hat Virtualization Manager 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.168. MessageBrokerType enum
Deprecated Message Broker type.
Ignored, because the deployment of OpenStack Neutron agent is dropped since Red Hat Virtualization 4.4.0.
Table 7.223. Values summary
Name | Summary |
---|---|
| |
|
7.169. Method struct
Table 7.224. Attributes summary
Name | Type | Summary |
---|---|---|
|
7.170. MigrateOnError enum
Table 7.225. Values summary
Name | Summary |
---|---|
| |
| |
|
7.171. MigrationBandwidth struct
Defines the bandwidth used by migration.
Table 7.226. Attributes summary
Name | Type | Summary |
---|---|---|
| The method used to assign the bandwidth. | |
| Custom bandwidth in Mbps. |
7.171.1. custom_value
Custom bandwidth in Mbps. Will be applied only if the assignmentMethod
attribute is custom
.
7.172. MigrationBandwidthAssignmentMethod enum
Defines how the migration bandwidth is assigned.
Table 7.227. Values summary
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.172.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.173. MigrationOptions struct
The type for migration options.
Table 7.228. Attributes summary
Name | Type | Summary |
---|---|---|
| ||
| The bandwidth that is allowed to be used by the migration. | |
| ||
| Specifies how many parallel migration connections to use. | |
| Specifies whether the migration should be encrypted or not. | |
| Specifies whether and how to use parallel migration connections. |
7.173.1. custom_parallel_migrations
Specifies how many parallel migration connections to use. May be specified only when ParallelMigrationsPolicy is CUSTOM. The valid range of values is 2-255. The recommended range of values is 2-16.
Table 7.229. Links summary
Name | Type | Summary |
---|---|---|
|
A reference to the migration policy, as defined using |
7.174. MigrationPolicy struct
A policy describing how the migration is treated, such as convergence or how many parallel migrations are allowed.
7.175. Network struct
The type for a logical network.
An example of the JSON representation of a logical network:
{ "network" : [ { "data_center" : { "href" : "/ovirt-engine/api/datacenters/123", "id" : "123" }, "stp" : "false", "mtu" : "0", "usages" : { "usage" : [ "vm" ] }, "name" : "ovirtmgmt", "description" : "Management Network", "href" : "/ovirt-engine/api/networks/456", "id" : "456", "link" : [ { "href" : "/ovirt-engine/api/networks/456/permissions", "rel" : "permissions" }, { "href" : "/ovirt-engine/api/networks/456/vnicprofiles", "rel" : "vnicprofiles" }, { "href" : "/ovirt-engine/api/networks/456/labels", "rel" : "labels" } ] } ] }
An example of the XML representation of the same logical network:
<network href="/ovirt-engine/api/networks/456" id="456"> <name>ovirtmgmt</name> <description>Management Network</description> <link href="/ovirt-engine/api/networks/456/permissions" rel="permissions"/> <link href="/ovirt-engine/api/networks/456/vnicprofiles" rel="vnicprofiles"/> <link href="/ovirt-engine/api/networks/456/labels" rel="labels"/> <data_center href="/ovirt-engine/api/datacenters/123" id="123"/> <stp>false</stp> <mtu>0</mtu> <usages> <usage>vm</usage> </usages> </network>
Table 7.231. Attributes summary
Name | Type | Summary |
---|---|---|
| Free text containing comments about this object. | |
| A human-readable description in plain text. | |
| Deprecated, 'usages' should be used to define network as a display network. | |
| The DNS resolver configuration will be reported when retrieving the network using GET. | |
| A unique identifier. | |
| Deprecated, not in use. | |
| Specifies the maximum transmission unit for the network. | |
| A human-readable name in plain text. | |
| Defines whether communication between VMs running on the same host is blocked on this network. | |
| Specifies whether upon creation of the network a virtual network interface profile should automatically be created. | |
| Defines whether the network is mandatory for all the hosts in the cluster. | |
| The status of the network. | |
| Specifies whether the spanning tree protocol is enabled for the network. | |
| Defines a set of usage elements for the network. | |
| The name of the network used on the host. | |
| A VLAN tag. |
7.175.1. dns_resolver_configuration
The DNS resolver configuration will be reported when retrieving the network using GET. It is optional both when creating a new network or updating existing one.
7.175.2. port_isolation
Defines whether communication between VMs running on the same host is blocked on this network. Applies only to VM networks. It is on the network administrator to ensure that the communication between multiple hosts is blocked. This attribute can be set only on network creation and cannot be edited. When the value is not set, communication between VMs running on the same host is allowed.
7.175.3. required
Defines whether the network is mandatory for all the hosts in the cluster. In case a 'required' operational
network is omitted from a host, the host will be marked as non_operational
,
7.175.4. status
The status of the network. non_operational
if the network defined as 'required' and omitted from any active cluster host. operational
otherwise.
7.175.5. 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.
7.175.6. vdsm_name
The name of the network used on the host. This alternative name is automatically generated by VDSM when the network name is found unsuitable to serve as a bridge name on the host. Unsuitable names contain spaces, special characters or are longer than 15 characters and are replaced with a UUID on the host. This parameter is read-only. Setting it will have no effect.
Table 7.232. Links summary
Name | Type | Summary |
---|---|---|
| A reference to the cluster this network is attached to. | |
| A reference to the data center that the network is a member of. | |
| An optional reference to the OpenStack network provider on which the network is created. | |
| An optional reference to a network that should be used for physical network access. | |
| A reference to the labels assigned to the network. | |
| A reference to the permissions of the network. | |
| Reference to quality of service. | |
| A reference to the profiles of the network. |
7.175.7. cluster
A reference to the cluster this network is attached to. Will be filled only if the network is accessed from the cluster level.
7.175.8. external_provider
An optional reference to the OpenStack network provider on which the network is created.
If it is specified when a network is created, a matching OpenStack network will be also created.
7.175.9. external_provider_physical_network
An optional reference to a network that should be used for physical network access. Valid only if external_provider
is specified.
7.176. NetworkAttachment struct
Describes how a host connects to a network.
An XML representation of a network attachment on a host:
<network_attachment href="/ovirt-engine/api/hosts/123/nics/456/networkattachments/789" id="789"> <network href="/ovirt-engine/api/networks/234" id="234"/> <host_nic href="/ovirt-engine/api/hosts/123/nics/123" id="123"/> <in_sync>true</in_sync> <ip_address_assignments> <ip_address_assignment> <assignment_method>static</assignment_method> <ip> <address>192.168.122.39</address> <gateway>192.168.122.1</gateway> <netmask>255.255.255.0</netmask> <version>v4</version> </ip> </ip_address_assignment> </ip_address_assignments> <reported_configurations> <reported_configuration> <name>mtu</name> <expected_value>1500</expected_value> <actual_value>1500</actual_value> <in_sync>true</in_sync> </reported_configuration> <reported_configuration> <name>bridged</name> <expected_value>true</expected_value> <actual_value>true</actual_value> <in_sync>true</in_sync> </reported_configuration> ... </reported_configurations> </network_attachment>
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
With a request body like this:
<networkattachment> <network id="234"/> </networkattachment>
To attach a network to a host, send a request like this:
POST /ovirt-engine/api/hosts/123/networkattachments
With a request body like this:
<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
With a request body like this:
<network_attachment> <ip_address_assignments> <ip_address_assignment> <assignment_method>static</assignment_method> <ip> <address>7.1.1.1</address> <gateway>7.1.1.2</gateway> <netmask>255.255.255.0</netmask> <version>v4</version> </ip> </ip_address_assignment> </ip_address_assignments> </network_attachment>
To detach a network from the network interface card send a request like this:
DELETE /ovirt-engine/api/hosts/123/nics/456/networkattachments/789
Changes to network attachment configuration must be explicitly committed.
An XML representation of a network attachment’s properties
sub-collection:
<network_attachment> <properties> <property> <name>bridge_opts</name> <value> forward_delay=1500 group_fwd_mask=0x0 multicast_snooping=1 </value> </property> </properties> ... </network_attachment>
Table 7.233. Attributes summary
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.176.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.176.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.177. NetworkConfiguration struct
7.178. 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.
The default Network Filter is based on network type and configuration. VM network’s default filter is vdsm-no-mac-spoof
if EnableMACAntiSpoofingFilterRules
is True, otherwise the filter is not configured, for OVN
networks the filter is not configured.
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:
<network_filter id="00000019-0019-0019-0019-00000000026c"> <name>example-filter</name> <version> <major>4</major> <minor>0</minor> <build>-1</build> <revision>-1</revision> </version> </network_filter>
If any part of the version is not present, it is represented by -1.
Table 7.236. Attributes summary
7.178.1. version
The minimum supported version of a specific NetworkFilter. This is the version that the NetworkFilter was first introduced in.
7.179. NetworkFilterParameter struct
Parameter for the network filter.
See Libvirt-Filters for further details. This is a example of the XML representation:
<network_filter_parameter id="123"> <name>IP</name> <value>10.0.1.2</value> </network_filter_parameter>
Table 7.237. Attributes summary
Table 7.238. Links summary
Name | Type | Summary |
---|---|---|
| The virtual machine NIC the parameter is assiciated to. |
7.180. NetworkLabel struct
Represents a label which can be added to a host network interface and to a network. The label binds the network to the host network interface by the label id
.
Table 7.239. Attributes summary
7.181. NetworkPluginType enum
Network plug-in type.
Specifies the provider driver implementation on the host.
Since version 4.2 of the Red Hat Virtualization Manager, this type has been deprecated in favour of the external_plugin_type
attribute of the OpenStackNetworkProvider
type.
Table 7.241. Values summary
Name | Summary |
---|---|
| Open vSwitch. |
7.181.1. open_vswitch
Open vSwitch.
Specifies that Open vSwitch based driver implementation should be used for this provider.
Since version 4.2 of the Red Hat Virtualization Manager, this value has been deprecated. Use the string open_vswitch
in the OpenStackNetworkProvider.external_plugin_type
attribute instead.
7.182. NetworkStatus enum
Table 7.242. Values summary
Name | Summary |
---|---|
| |
|
7.183. NetworkUsage enum
This type indicates the purpose that the network is used for in the cluster.
Table 7.243. Values summary
Name | Summary |
---|---|
| The default gateway and the DNS resolver configuration of the host will be taken from this network. |
| 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.183.1. default_route
The default gateway and the DNS resolver configuration of the host will be taken from this network.
If this network is attached to the host, then the DNS resolver configuration will be taken from the dns_resolver_configuration
attribute of the network attachment. If there is no dns_resolver_configuration
attribute in this network attachment, then they will be taken from the dns_resolver_configuration
of the network itself. If dns_resolver_configuration
attribute isn’t present even there, DNS resolver configuration won’t be set.
If you set this flag on a network, then the the default gateway for the host will be taken from the gateway
attribute of the ip_address_assignment
of the network attachment.
7.183.2. 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.184. NfsProfileDetail struct
Table 7.244. Attributes summary
Name | Type | Summary |
---|---|---|
| ||
|
7.185. NfsVersion enum
Table 7.245. Values summary
Name | Summary |
---|---|
| |
| |
| |
| NFS 4. |
| |
| NFS 4. |
7.185.1. v4_0
NFS 4.0.
7.185.2. v4_2
NFS 4.2.
7.186. Nic struct
Represents a virtual machine NIC.
For example, the XML representation of a NIC will look like this:
<nic href="/ovirt-engine/api/vms/123/nics/456" id="456"> <name>nic1</name> <vm href="/ovirt-engine/api/vms/123" id="123"/> <interface>virtio</interface> <linked>true</linked> <mac> <address>02:00:00:00:00:00</address> </mac> <plugged>true</plugged> <vnic_profile href="/ovirt-engine/api/vnicprofiles/789" id="789"/> </nic>
Table 7.246. Attributes summary
Name | Type | Summary |
---|---|---|
| Defines how an IP address is assigned to the NIC. | |
| 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 network interface should be activated upon operation system startup. | |
| Defines if the NIC is plugged in to the virtual machine. | |
| Defines if the NIC configuration on the virtual machine is synced with the configuration represented by engine. |
Table 7.247. Links summary
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 a collection of network attachments that are associated with the host NIC. | |
| A link to the network filter parameters. | |
| A link to a collection of network labels that are associated with the host NIC. | |
| A link to a collection of reported devices that are associated with the virtual network interface. | |
| A link to the statistics for the NIC. | |
| Optionally references to a template the device is used by. | |
| A link to a collection of network labels that are allowed to be attached to the virtual functions of an SR-IOV NIC. | |
| A link to a collection of networks that are allowed to be attached to the virtual functions of an SR-IOV NIC. | |
|
Do not use this element, use | |
| Vm[] | References to the virtual machines that are using this device. |
| A link to an associated virtual network interface profile. |
7.186.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.186.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.187. NicConfiguration struct
The type describes the configuration of a virtual network interface.
Table 7.248. Attributes summary
Name | Type | Summary |
---|---|---|
| IPv4 boot protocol. | |
| IPv4 address details. | |
| IPv6 address details. | |
| IPv6 boot protocol. | |
| Network interface name. | |
| Specifies whether the network interface should be activated on the virtual machine guest operating system boot. |
7.188. NicInterface enum
Defines the options for an emulated virtual network interface device model.
Table 7.249. Values summary
Name | Summary |
---|---|
| e1000. |
| e1000e. |
| PCI Passthrough. |
| rtl8139. |
| Dual mode rtl8139, VirtIO. |
| sPAPR VLAN. |
| VirtIO. |
7.189. NicStatus enum
Network interface card status.
Table 7.250. Values summary
Name | Summary |
---|---|
| The NIC is down and cannot be accessed. |
| The NIC is up and can be accessed. |
7.190. NotifiableEvent enum
Type representing a subset of events in the Red Hat Virtualization server: those which a user may subscribe to receive a notification about.
Table 7.251. Values summary
Name | Summary |
---|---|
| HA Reservation check has failed |
| HA Reservation check has passed |
| ETL Service Error |
| ETL Service Stopped |
| Engine backup completed successfully |
| Engine backup failed |
| Engine backup started |
| Engine CA’s certification has expired |
| Engine CA’s certification is about to expire |
| Engine’s certification has expired |
| Engine’s certification is about to expire |
| Engine has stopped |
| Faulty multipath paths on host |
| Detected change in status of brick |
| Failed to add Gluster Hook on conflicting servers |
| Added Gluster Hook |
| Detected conflict in Gluster Hook |
| Detected removal of Gluster Hook |
| Detected new Gluster Hook |
| Gluster Hook Disabled |
| Failed to Disable Gluster Hook |
| Gluster Hook Enabled |
| Failed to Enable Gluster Hook |
| Failed to remove Gluster Hook from cluster |
| Removed Gluster Hook |
| Failed to Add Gluster Server |
| Gluster Server Removed |
| Failed to Remove Gluster Server |
| Failed to re-start Gluster Service |
| Gluster Service re-started |
| Failed to start Gluster service |
| Gluster Service started |
| Failed to stop Gluster service |
| Gluster Service stopped |
| Gluster Volume brick(s) added |
| Failed to add brick(s) on Gluster Volume |
| Failed to delete snapshots on the volume |
| All the snapshots deleted on the volume |
| Gluster Volume Brick Replaced |
| Low space for volume confirmed |
| Gluster Volume Created |
| Gluster Volume could not be created |
| Gluster Volume deleted |
| Gluster Volume could not be deleted |
| Gluster Volume migration of data for remove brick finished |
| Gluster Volume Option added |
| Gluster Volume Option modified |
| Gluster Volume Option could not be set |
| Gluster Volume Options reset |
| All the Gluster Volume Options reset |
| Gluster Volume Options could not be reset |
| Gluster Volume Profile started |
| Failed to start Gluster Volume Profile |
| Gluster Volume Profile stopped |
| Failed to stop Gluster Volume Profile |
| Gluster Volume rebalance finished |
| Could not find information for rebalance on volume from CLI. |
| Gluster Volume Rebalance started |
| Detected start of rebalance on gluster volume from CLI |
| Gluster Volume Rebalance could not be started |
| Gluster Volume Rebalance stopped |
| Gluster Volume Rebalance could not be stopped |
| Gluster Volume Bricks Removed |
| Gluster Volume Bricks could not be removed |
| Stopped removing bricks from Gluster Volume |
| Failed to stop remove bricks from Gluster Volume |
| Gluster Volume Replace Brick Failed |
| Gluster Volume Replace Brick Started |
| Gluster Volume Replace Brick could not be started |
| Failed to activate snapshot on the volume |
| Snapshot activated on the volume |
| Could not create snapshot for volume ${glusterVolumeName} on cluster ${clusterName}. |
| Snapshot ${snapname} created for volume ${glusterVolumeName} on cluster ${clusterName}. |
| Failed to de-activate snapshot on the volume |
| Snapshot de-activated on the volume |
| Failed to delete snapshot on volume |
| Snapshot deleted on volume |
| Failed to restore snapshot on the volume |
| Snapshot restore on the volume |
| Gluster volume started |
| Gluster Volume could not be started |
| Gluster volume stopped |
| Gluster Volume could not be stopped |
| Highly-Available VM failed |
| Highly-Available VM restart failed |
| Failed to activate Host |
| Host was activated, but the Hosted Engine HA service may still be in maintenance mode |
| Failed to approve Host |
| Host’s slave of bond changed state to down |
| Host’s certificate contains invalid subject alternative name (SAN) |
| Host’s certification has expired |
| Host’s certification is about to expire |
| Host is non responsive |
| Host cpu usage exceeded defined threshold |
| Host memory usage exceeded defined threshold |
| Host swap memory usage exceeded defined threshold |
| Failed to restart VM on a different host |
| Host installation failed |
| Host network interface usage exceeded defined threshold |
| Host’s interface changed state to down |
| Host free memory is under defined threshold |
| Host free swap memory is under defined threshold |
| Host failed to recover |
| Host state was set to non-operational |
| Host state was set to non-operational due to inaccessible Storage Domain |
| Host state was set to non-operational due to a missing Interface |
| Slow storage response time |
| Host has time-drift |
| Host state was set to non-operational. |
| Host has available updates |
| Host has available packages to update |
| Template imported from trusted cluster into non-trusted cluster |
| Template imported from non-trusted cluster into trusted cluster |
| Import VM from trusted cluster into non-trusted cluster |
| Import VM from non-trusted cluster into trusted cluster |
| Confirmed low disk space |
| Low disk space |
| Critically low disk space |
| Failed to access Storage |
| VM with external MAC address |
| Multipath devices without valid paths on host |
| Display network was updated on cluster with an active VM |
| Display network was updated on host with an active VM |
| No faulty multipath paths on host |
| Storage Domain’s number of LVs exceeded threshold |
| Could not find information for remove brick on volume from CLI. |
| Started removing bricks from Volume |
| Detected start of brick removal for bricks on volume from CLI |
| Could not remove volume bricks |
| Failed electing an SPM for the Data-Center |
| Storage Domain state was set to inactive |
| A non-trusted VM was created from trusted Template |
| A trusted VM was created from non-trusted Template |
| A non-trusted Template was created from trusted VM |
| A trusted Template was created from non-trusted VM |
| Host was switched to Maintenance Mode |
| Host was switched to Maintenance Mode, but Hosted Engine HA maintenance mode could not be enabled |
| Failed to switch Host to Maintenance mode |
| VM moved from trusted cluster to non-trusted cluster |
| VM moved from non-trusted cluster to trusted cluster |
| Template moved from trusted cluster to non-trusted cluster |
| Template moved from a non-trusted cluster to a trusted cluster |
| VM console connected |
| VM console disconnected |
| VM is down with error |
| VM cannot be found on Host |
| Migration failed |
| Starting migration of VM |
| Migration of VM to a destination host failed |
| VM is not responding |
| VM has been paused |
| VM has been paused due to a storage I/O error |
| VM has been paused due to lack of storage space |
| VM has been paused due to storage read/write permissions problem |
| VM has been paused due to unknown storage error |
| VM has recovered from paused back to up |
| VM console session initiated |
| VM status restored |
7.190.1. gluster_volume_rebalance_not_found_from_cli
Could not find information for rebalance on volume from CLI. Marking it as unknown.
7.190.2. host_untrusted
Host state was set to non-operational. Host is untrusted by the attestation service
7.190.3. remove_gluster_volume_bricks_not_found_from_cli
Could not find information for remove brick on volume from CLI. Marking it as unknown.
7.191. NotificationMethod enum
Type representing the notification method for an event subscription. Currently only SMTP is supported by the API In the future support for SNMP notifications may be added.
Table 7.252. Values summary
Name | Summary |
---|---|
| Notification by e-mail. |
| Notification by SNMP. |
7.191.1. smtp
Notification by e-mail.
Event-subscriptions with SMTP notification method will contain an email address in the address field.
7.191.2. snmp
Notification by SNMP.
Event-subscriptions with SNMP notification method will contain an SNMP address in the address field.
7.192. NumaNode struct
Represents a physical NUMA node.
Example XML representation:
<host_numa_node href="/ovirt-engine/api/hosts/0923f1ea/numanodes/007cf1ab" id="007cf1ab"> <cpu> <cores> <core> <index>0</index> </core> </cores> </cpu> <index>0</index> <memory>65536</memory> <node_distance>40 20 40 10</node_distance> <host href="/ovirt-engine/api/hosts/0923f1ea" id="0923f1ea"/> </host_numa_node>
Table 7.253. Attributes summary
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. | |
|
Table 7.254. Links summary
Name | Type | Summary |
---|---|---|
| ||
| Each host NUMA node resource exposes a statistics sub-collection for host NUMA node specific statistics. |
7.192.1. statistics
Each host NUMA node resource exposes a statistics sub-collection for host NUMA node specific statistics.
An example of an XML representation:
<statistics> <statistic href="/ovirt-engine/api/hosts/123/numanodes/456/statistics/789" id="789"> <name>memory.total</name> <description>Total memory</description> <kind>gauge</kind> <type>integer</type> <unit>bytes</unit> <values> <value> <datum>25165824000</datum> </value> </values> <host_numa_node href="/ovirt-engine/api/hosts/123/numanodes/456" id="456" /> </statistic> ... </statistics>
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.193. NumaNodePin struct
Represents the pinning of a virtual NUMA node to a physical NUMA node.
Table 7.255. Attributes summary
7.193.1. host_numa_node
Deprecated. Has no function.
7.193.2. pinned
Deprecated. Should always be true
.
7.194. NumaTuneMode enum
Table 7.256. Values summary
Name | Summary |
---|---|
| |
| |
|
7.195. OpenStackImage struct
Table 7.257. Attributes summary
Table 7.258. Links summary
Name | Type | Summary |
---|---|---|
|
7.196. OpenStackImageProvider struct
Table 7.259. Attributes summary
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 the tenant name for OpenStack Identity API v2. | |
| Defines URL address of the external provider. | |
| Defines user name to be used during authentication process. |
7.196.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.196.2. tenant_name
Defines the tenant name for OpenStack Identity API v2.0.
Table 7.260. Links summary
Name | Type | Summary |
---|---|---|
| ||
|
7.197. OpenStackNetwork struct
Table 7.261. Attributes summary
Table 7.262. Links summary
Name | Type | Summary |
---|---|---|
|
7.198. OpenStackNetworkProvider struct
Table 7.263. Attributes summary
Name | Type | Summary |
---|---|---|
| Deprecated Agent configuration settings. | |
| Defines the external provider authentication URL address. | |
| Indicates if the networks of this provider are automatically synchronized. | |
| Free text containing comments about this object. | |
| A human-readable description in plain text. | |
| Network plug-in type. | |
| A unique identifier. | |
| A human-readable name in plain text. | |
| Defines password for the user during the authentication process. | |
| Network plug-in type. | |
| Defines the project’s domain name for OpenStack Identity API v3. | |
| Defines the project name for OpenStack Identity API v3. | |
| Array of provider name/value properties. | |
| Indicates whether the provider is read-only. | |
| Defines whether provider authentication is required or not. | |
| Defines the tenant name for OpenStack Identity API v2. | |
| The type of provider. | |
| Indicates whether the provider is unmanaged by Red Hat Virtualization. | |
| Defines URL address of the external provider. | |
|
Defines the domain name of the | |
| Defines user name to be used during authentication process. |
7.198.1. agent_configuration
Deprecated Agent configuration settings.
Ignored, because the deployment of OpenStack Neutron agent is dropped since Red Hat Virtualization 4.4.0.
7.198.2. auto_sync
Indicates if the networks of this provider are automatically synchronized.
If true
, the networks of this provider are automatically and cyclically synchronized to Red Hat Virtualization in the background. This means that all new networks of this provider are imported, and all discarded networks are removed from all clusters that have this external provider as the default provider. If the name of a network is changed on the provider, the change is synchronized to the network entity in Red Hat Virtualization. Furthermore, if a new cluster that has the provider as the default provider is added, already imported networks are attached to this new cluster during synchronization.
The automatically initiated import triggers the following steps:
- The networks of the external provider will be imported to every data center in the data centers of the clusters that have that external provider as the default provider.
- A vNIC profile will be created for each involved data center and network.
- The networks will be assigned to each cluster that has that external provider as the default provider.
All users are allowed to use the new vNIC Profile.
The default is false
for backwards compatibility.
7.198.3. external_plugin_type
Network plug-in type.
This attribute allows you to choose the correct provider driver on the host when an external NIC is added or modified. If automated installation of the driver is supported (only available for some predefined implementations, for example ovirt-provider-ovn
), this attribute will also allow the system to decide which driver implementation to install on newly added hosts.
7.198.4. plugin_type
Network plug-in type.
Since version 4.2 of the Red Hat Virtualization Manager, this attribute has been deprecated in favour of external_plugin_type
. This attribute is only valid for providers of type open_vswitch
, and will only be returned when the value of the external_plugin_type
attribute value is equal to open_vswitch
.
If both plugin_type
and external_plugin_type
are specified during an update, the value of plugin_type
will be ignored.
For external providers this value will not be shown and will be ignored during update requests.
7.198.5. 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.198.6. 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.198.7. tenant_name
Defines the tenant name for OpenStack Identity API v2.0.
7.198.8. unmanaged
Indicates whether the provider is unmanaged by Red Hat Virtualization.
If true
, authentication and subnet control are entirely left to the external provider and are unmanaged by Red Hat Virtualization.
The default is false
for backwards compatibility.
Table 7.264. Links summary
Name | Type | Summary |
---|---|---|
| Reference to the certificates list. | |
| Reference to the OpenStack networks list. | |
| Reference to the OpenStack networks subnets list. |
7.199. 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.
Table 7.265. Values summary
Name | Summary |
---|---|
| Indicates that the provider is an external one, implementing the OpenStack Neutron API. |
| Indicates that the provider is OpenStack Neutron. |
7.199.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.199.2. neutron
Indicates that the provider is OpenStack Neutron. The standard OpenStack Neutron agent is used as the virtual interface driver.
7.200. OpenStackProvider struct
Table 7.266. Attributes summary
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 the tenant name for OpenStack Identity API v2. | |
| Defines URL address of the external provider. | |
| Defines user name to be used during authentication process. |
7.200.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.200.2. tenant_name
Defines the tenant name for OpenStack Identity API v2.0.
7.201. OpenStackSubnet struct
Table 7.267. Attributes summary
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.201.1. ip_version
Defines IP version.
Values can be v4' for IPv4 or `v6
for IPv6.
Table 7.268. Links summary
Name | Type | Summary |
---|---|---|
| Reference to the service managing the OpenStack network. |
7.202. OpenStackVolumeProvider struct
Openstack Volume (Cinder) integration has been replaced by Managed Block Storage.
Table 7.269. Attributes summary
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 the tenant name for OpenStack Identity API v2. | |
| Defines URL address of the external provider. | |
| Defines user name to be used during authentication process. |
7.202.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.202.2. tenant_name
Defines the tenant name for OpenStack Identity API v2.0.
Table 7.270. Links summary
Name | Type | Summary |
---|---|---|
| ||
| ||
| ||
|
7.203. OpenStackVolumeType struct
Openstack Volume (Cinder) integration has been replaced by Managed Block Storage.
Table 7.271. Attributes summary
Table 7.272. Links summary
Name | Type | Summary |
---|---|---|
|
7.204. OpenstackVolumeAuthenticationKey struct
Openstack Volume (Cinder) integration has been replaced by Managed Block Storage.
Table 7.273. Attributes summary
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. | |
| ||
| ||
|
Table 7.274. Links summary
Name | Type | Summary |
---|---|---|
|
7.205. OpenstackVolumeAuthenticationKeyUsageType enum
Openstack Volume (Cinder) integration has been replaced by Managed Block Storage.
Table 7.275. Values summary
Name | Summary |
---|---|
|
7.206. OperatingSystem struct
Information describing the operating system. This is used for both virtual machines and hosts.
Table 7.276. Attributes summary
Name | Type | Summary |
---|---|---|
| Configuration of the boot sequence. | |
| Custom kernel parameters for starting the virtual machine if Linux operating system is used. | |
| A custom part of the host kernel command line. | |
| Path to custom initial ramdisk on ISO storage domain if Linux operating system is used. | |
| Path to custom kernel on ISO storage domain if Linux operating system is used. | |
| The host kernel command line as reported by a running host. | |
| Operating system name in human readable form. | |
|
7.206.1. boot
Configuration of the boot sequence.
Not used for hosts.
7.206.2. cmdline
Custom kernel parameters for starting the virtual machine if Linux operating system is used.
Not used for hosts.
7.206.3. 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.206.4. initrd
Path to custom initial ramdisk on ISO storage domain if Linux operating system is used.
For example iso://initramfs-3.10.0-514.6.1.el7.x86_64.img
.
Not used for hosts.
7.206.5. kernel
Path to custom kernel on ISO storage domain if Linux operating system is used.
For example iso://vmlinuz-3.10.0-514.6.1.el7.x86_64
.
Not used for hosts.
7.206.6. 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.206.7. type
Operating system name in human readable form.
For example Fedora
or RHEL
. In general one of the names returned by the operating system service.
Read only for hosts.
7.207. OperatingSystemInfo struct
Represents a guest operating system.
Table 7.277. Attributes summary
Name | Type | Summary |
---|---|---|
| Operating system architecture. | |
| Free text containing comments about this object. | |
| A human-readable description in plain text. | |
| A unique identifier. | |
| Large icon of the guest operating system. | |
| A human-readable name in plain text. | |
| Small icon of the guest operating system. | |
| TPM support status. |
7.207.1. large_icon
Large icon of the guest operating system. Maximum dimensions: width 150px, height 120px.
7.207.2. small_icon
Small icon of the guest operating system. Maximum dimensions: width 43px, height 43px.
7.208. Option struct
7.209. OsType enum
Type representing kind of operating system.
This type has been deprecated with the introduction of the OperatingSystemInfo type. Operating systems are available as a top-level collection in the API: operating_systems.
The end-user declares the type of the operating system installed in the virtual machine (guest operating system) by selecting one of these values. This declaration enables the system to tune the virtual machine configuration for better user experience. For example, the system chooses devices that are most suitable for the operating system. Note that the system rely on user’s selection and does not verify it by inspecting the actual guest operating system installed.
Table 7.279. Values summary
Name | Summary |
---|---|
| Other type of operating system, not specified by the other values. |
| Distribution of Linux other than those specified by the other values. |
| Red Hat Enterprise Linux 3 32-bit. |
| Red Hat Enterprise Linux 3 64-bit. |
| Red Hat Enterprise Linux 4 32-bit. |
| Red Hat Enterprise Linux 4 64-bit. |
| Red Hat Enterprise Linux 5 32-bit. |
| Red Hat Enterprise Linux 5 64-bit. |
| Red Hat Enterprise Linux 6 32-bit. |
| Red Hat Enterprise Linux 6 64-bit. |
|
This value is mapped to |
| Windows 2003 32-bit. |
| Windows 2003 64-bit. |
| Windows 2008 32-bit. |
| Windows 2008 R2 64-bit. |
| Windows 2008 64-bit. |
| Windows 2012 64-bit. |
| Windows 7 32-bit. |
| Windows 7 64-bit. |
| Windows 8 32-bit. |
| Windows 8 64-bit. |
| Windows XP. |
7.210. 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>
Table 7.280. Attributes summary
Name | Type | Summary |
---|---|---|
| The name of the package. |
7.211. ParallelMigrationsPolicy enum
Type representing parallel migration connections policy.
Table 7.281. Values summary
Name | Summary |
---|---|
| Choose automatically between parallel and non-parallel connections. |
| Use parallel connections and select their number automatically. |
| Use manually specified number of parallel connections. |
| Use non-parallel connections. |
| Use cluster value (applicable only to VMs). |
7.211.1. auto
Choose automatically between parallel and non-parallel connections. If parallel connections are used, select their number automatically.
7.211.2. custom
Use manually specified number of parallel connections. The number of parallel connections must be set in MigrationOptions.customParallelMigrations.
7.212. Payload struct
Table 7.282. Attributes summary
Name | Type | Summary |
---|---|---|
| ||
| ||
|
7.213. PayloadEncoding enum
Table 7.283. Values summary
Name | Summary |
---|---|
| |
|
7.214. Permission struct
Type represents a permission.
Table 7.284. Attributes summary
Table 7.285. Links summary
Name | Type | Summary |
---|---|---|
| Reference to cluster. | |
| Reference to data center. | |
| Reference to disk. | |
| Reference to group. | |
| Reference to host. | |
| Reference to role. | |
| Reference to storage domain. | |
| Reference to template. | |
| Reference to user. | |
| Reference to virtual machine. | |
| Reference to virtual machines pool. |
7.215. Permit struct
Type represents a permit.
Table 7.286. Attributes summary
Table 7.287. Links summary
Name | Type | Summary |
---|---|---|
| Reference to the role the permit belongs to. |
7.216. PmProxy struct
Table 7.288. Attributes summary
Name | Type | Summary |
---|---|---|
|
7.217. PmProxyType enum
Table 7.289. Values summary
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.218. PolicyUnitType enum
Holds the types of all internal policy unit types.
Table 7.290. Values summary
Name | Summary |
---|---|
| |
| |
|
7.219. PortMirroring struct
7.220. PowerManagement struct
Table 7.291. Attributes summary
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.220.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.220.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.220.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.220.4. type
Fencing device code.
A list of valid fencing device codes are available in the capabilities
collection.
7.221. PowerManagementStatus enum
Table 7.292. Values summary
Name | Summary |
---|---|
| Host is OFF. |
| Host is ON. |
| Unknown status. |
7.222. Product struct
7.223. 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:
<api> ... <product_info> <name>oVirt Engine</name> <vendor>ovirt.org</vendor> <version> <build>0</build> <full_version>4.1.0_master</full_version> <major>4</major> <minor>1</minor> <revision>0</revision> </version> </product_info> ... </api>
Table 7.294. Attributes summary
7.223.1. vendor
The name of the vendor, for example ovirt.org
.
7.224. ProfileDetail struct
Table 7.295. Attributes summary
Name | Type | Summary |
---|---|---|
| ||
| ||
| ||
| ||
|
7.225. Property struct
7.226. ProxyTicket struct
Table 7.297. Attributes summary
Name | Type | Summary |
---|---|---|
|
7.227. 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.
Table 7.298. Values summary
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.227.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.228. 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.
Table 7.299. Attributes summary
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 (Megabits per sec). | |
| The amount of data that can be delivered in a single burst, in MB. | |
| The maximum inbound rate in Mbps (Megabits per sec). | |
| 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 (Megabits per sec). | |
| Weighted share. | |
| The committed rate in Mbps (Megabits per sec). | |
| The maximum bandwidth to be used by a network in Mbps (Megabits per sec). | |
| The amount of data that can be sent in a single burst, in MB. | |
| The maximum outbound rate in Mbps (Megabits per sec). | |
| The kind of resources this entry can be assigned. |
7.228.1. cpu_limit
The maximum processing capability in %.
Used to configure computing resources.
7.228.2. inbound_average
The desired average inbound bit rate in Mbps (Megabits per sec).
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.228.3. inbound_burst
The amount of data that can be delivered in a single burst, in MB.
Used to configure virtual machine networks. If defined, inbound_average
and inbound_peak
must also be set.
See Libvirt-QOS for further details.
7.228.4. inbound_peak
The maximum inbound rate in Mbps (Megabits per sec).
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.228.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.228.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.228.7. max_read_throughput
Maximum permitted throughput for read operations.
Used to configure storage. Must not be set if max_throughput
is set.
7.228.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.228.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.228.10. max_write_throughput
Maximum permitted throughput for write operations.
Used to configure storage. Must not be set if max_throughput
is set.
7.228.11. outbound_average
The desired average outbound bit rate in Mbps (Megabits per sec).
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.228.12. outbound_average_linkshare
Weighted share.
Used to configure host networks. Signifies how much of the logical link’s capacity a specific network should be allocated, relative to the other networks attached to the same logical link. The exact share depends on the sum of shares of all networks on that link. By default this is a number in the range 1-100.
7.228.13. outbound_average_realtime
The committed rate in Mbps (Megabits per sec).
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.228.14. outbound_average_upperlimit
The maximum bandwidth to be used by a network in Mbps (Megabits per sec).
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.228.15. outbound_burst
The amount of data that can be sent in a single burst, in MB.
Used to configure virtual machine networks. If defined, outbound_average
and outbound_peak
must also be set.
See Libvirt-QOS for further details.
7.228.16. outbound_peak
The maximum outbound rate in Mbps (Megabits per sec).
Used to configure virtual machines networks. If defined, outbound_average
and outbound_burst
also has to be set.
See Libvirt-QOS for further details.
Table 7.300. Links summary
Name | Type | Summary |
---|---|---|
| The data center the QoS is assiciated to. |
7.229. QosType enum
This type represents the kind of resource the Quality of service (QoS) can be assigned to.
Table 7.301. Values summary
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.230. Quota struct
Represents a quota object.
An example XML representation of a quota:
<quota href="/ovirt-engine/api/datacenters/7044934e/quotas/dcad5ddc" id="dcad5ddc"> <name>My Quota</name> <description>A quota for my oVirt environment</description> <cluster_hard_limit_pct>0</cluster_hard_limit_pct> <cluster_soft_limit_pct>0</cluster_soft_limit_pct> <data_center href="/ovirt-engine/api/datacenters/7044934e" id="7044934e"/> <storage_hard_limit_pct>0</storage_hard_limit_pct> <storage_soft_limit_pct>0</storage_soft_limit_pct> </quota>
Table 7.302. Attributes summary
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. | |
| ||
| ||
| ||
| Vm[] |
Table 7.303. Links summary
Name | Type | Summary |
---|---|---|
| ||
| ||
|
7.231. QuotaClusterLimit struct
Table 7.304. Attributes summary
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. QuotaModeType enum
Table 7.306. Values summary
Name | Summary |
---|---|
| |
| |
|
7.233. QuotaStorageLimit struct
Table 7.307. Attributes summary
Table 7.308. Links summary
Name | Type | Summary |
---|---|---|
| ||
|
7.234. Range struct
7.235. Rate struct
Determines maximum speed of consumption of bytes from random number generator device.
7.236. RegistrationAffinityGroupMapping struct
This type describes how to map affinity groups as part of the object registration. An object can be a virtual machine, template, etc.
An example of an XML representation using this mapping:
<action> <registration_configuration> <affinity_group_mappings> <registration_affinity_group_mapping> <from> <name>affinity</name> </from> <to> <name>affinity2</name> </to> </registration_affinity_group_mapping> </affinity_group_mappings> </registration_configuration> </action>
Table 7.311. Links summary
Name | Type | Summary |
---|---|---|
| Reference to the original affinity group. | |
| Reference to the destination affinity group. |
7.236.1. from
Reference to the original affinity group. It can be specified using name
.
7.237. RegistrationAffinityLabelMapping struct
This type describes how to map affinity labels as part of the object registration. An object can be a virtual machine, template, etc.
An example of an XML representation using mapping:
<action> <registration_configuration> <affinity_label_mappings> <registration_affinity_label_mapping> <from> <name>affinity_label</name> </from> <to> <name>affinity_label2</name> </to> </registration_affinity_label_mapping> </affinity_label_mappings> </registration_configuration> </action>
Table 7.312. Links summary
Name | Type | Summary |
---|---|---|
| Reference to the original affinity label. | |
| Reference to the destination affinity label. |
7.237.1. from
Reference to the original affinity label. It can be specified using name
.
7.238. RegistrationClusterMapping struct
This type describes how to map clusters as part of the object registration. An object can be a virtual machine, template, etc.
An example of an XML representation using this mapping:
<action> <registration_configuration> <cluster_mappings> <registration_cluster_mapping> <from> <name>myoriginalcluster</name> </from> <to> <name>mynewcluster</name> </to> </registration_cluster_mapping> </cluster_mappings> </registration_configuration> </action>
Table 7.313. Links summary
7.238.1. from
Reference to the original cluster. It can be specified using the id
or the name
.
7.238.2. to
Reference to the destination cluster. It can be specified using the id
or the name
.
7.239. RegistrationConfiguration struct
This type describes how an object (virtual machine, template, etc) is registered, and is used for the implementation of disaster recovery solutions.
Each mapping contained in this type can be used to map objects in the original system to corresponding objects in the system where the virtual machine or template is being registered. For example, there could be a primary setup with a virtual machine configured on cluster A, and an active secondary setup with cluster B. Cluster B is compatible with that virtual machine, and in case of a disaster recovery scenario the storage domain can be imported to the secondary setup, and the user can register the virtual machine to cluster B.
In that case, we can automate the recovery process by defining a cluster mapping. After the entity is registered, its OVF will indicate it belongs to cluster A, but the mapping will indicate that cluster A will be replaced with cluster B. Red Hat Virtualization Manager should do the switch and register the virtual machine to cluster B in the secondary site.
Cluster mapping is just one example, there are different types of mappings:
- Cluster mapping.
- LUN mapping.
- Role mapping.
- Domain mapping.
- Permissions mapping.
- Affinity Group mapping.
- Affinity Label mapping.
- Virtual NIC profile mapping.
Each mapping will be used for its specific OVF’s data once the register operation takes place in the Red Hat Virtualization Manager.
An example of an XML representation using the mapping:
<action> <registration_configuration> <cluster_mappings> <registration_cluster_mapping> <from> <name>myoriginalcluster</name> </from> <to> <name>mynewcluster</name> </to> </registration_cluster_mapping> </cluster_mappings> <role_mappings> <registration_role_mapping> <from> <name>SuperUser</name> </from> <to> <name>UserVmRunTimeManager</name> </to> </registration_role_mapping> </role_mappings> <domain_mappings> <registration_domain_mapping> <from> <name>redhat</name> </from> <to> <name>internal</name> </to> </registration_domain_mapping> </domain_mappings> <lun_mappings> <registration_lun_mapping> <from id="111"> </from> <to id="222"> <alias>weTestLun</alias> <lun_storage> <type>iscsi</type> <logical_units> <logical_unit id="36001405fb1ddb4b91e44078f1fffcfef"> <address>44.33.11.22</address> <port>3260</port> <portal>1</portal> <target>iqn.2017-11.com.name.redhat:444</target> </logical_unit> </logical_units> </lun_storage> </to> </registration_lun_mapping> </lun_mappings> <affinity_group_mappings> <registration_affinity_group_mapping> <from> <name>affinity</name> </from> <to> <name>affinity2</name> </to> </registration_affinity_group_mapping> </affinity_group_mappings> <affinity_label_mappings> <registration_affinity_label_mapping> <from> <name>affinity_label</name> </from> <to> <name>affinity_label2</name> </to> </registration_affinity_label_mapping> </affinity_label_mappings> <vnic_profile_mappings> <registration_vnic_profile_mapping> <from> <name>gold</name> <network> <name>red</name> </network> </from> <to id="738dd914-8ec8-4a8b-8628-34672a5d449b"/> </registration_vnic_profile_mapping> <registration_vnic_profile_mapping> <from> <name>silver</name> <network> <name>blue</name> </network> </from> <to> <name>copper</name> <network> <name>orange</name> </network> </to> </registration_vnic_profile_mapping> </vnic_profile_mappings> </registration_configuration> </action>
Table 7.314. Attributes summary
Name | Type | Summary |
---|---|---|
| Describes how the affinity groups are mapped. | |
| Describes how the affinity labels are mapped. | |
| Describes how the clusters that the object references are mapped. | |
| Describes how the users' domains are mapped. | |
| Describes how the LUNs are mapped. | |
| Describes how the roles are mapped. | |
| Mapping rules for virtual NIC profiles that will be applied during the register process. |
7.240. RegistrationDomainMapping struct
This type describes how to map the users' domain as part of the object registration. An object can be a virtual machine, template, etc. NOTE: This is based on the assumption that user names will be the same, and that only the domain name will be changed.
An example of an XML representation using this mapping:
<action> <registration_configuration> <domain_mappings> <registration_domain_mapping> <from> <name>redhat</name> </from> <to> <name>internal</name> </to> </registration_domain_mapping> </domain_mappings> </registration_configuration> </action>
Table 7.315. Links summary
7.240.1. from
Reference to the original domain. It can be specified using name
.
7.241. RegistrationLunMapping struct
This type describes how to map LUNs as part of the object registration. An object can be a virtual machine, template, etc.
An external LUN disk is an entity which does not reside on a storage domain. It must be specified because it doesn’t need to exist in the environment where the object is registered. An example of an XML representation using this mapping:
<action> <registration_configuration> <lun_mappings> <registration_lun_mapping> <lun_mappings> <registration_lun_mapping> <from id="111"> </from> <to id="222"> <alias>weTestLun</alias> <lun_storage> <type>iscsi</type> <logical_units> <logical_unit id="36001405fb1ddb4b91e44078f1fffcfef"> <address>44.33.11.22</address> <port>3260</port> <portal>1</portal> <target>iqn.2017-11.com.name.redhat:444</target> </logical_unit> </logical_units> </lun_storage> </to> </registration_lun_mapping> </lun_mappings> </registration_configuration> </action>
Table 7.316. Links summary
7.241.1. from
Reference to the original LUN. This must be specified using the id
attribute.
7.242. RegistrationRoleMapping struct
This type describes how to map roles as part of the object registration. An object can be a virtual machine, template, etc.
A role mapping is intended to map correlating roles between the primary site and the secondary site. For example, there may be permissions with role UserVmRunTimeManager
for the virtual machine that is being registered. Therefore we can send a mapping that will register the virtual machine in the secondary setup using the SuperUser
role instead of UserVmRunTimeManager
An example of an XML representation using this mapping:
<action> <registration_configuration> <role_mappings> <registration_eole_mapping> <from> <name>SuperUser</name> </from> <to> <name>UserVmRunTimeManager</name> </to> </registration_role_mapping> </role_mappings> </registration_configuration> </action>
Table 7.317. Links summary
7.242.1. from
Reference to the original role. It can be specified using name
.
7.243. RegistrationVnicProfileMapping struct
Maps an external virtual NIC profile to one that exists in the Red Hat Virtualization Manager. The target may be specified as a profile ID or a pair of profile name and network name.
If, for example, the desired virtual NIC profile mapping includes the following lines:
Source network name | Source network profile name | Target virtual NIC profile ID\names |
---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Then the following snippet should be added to RegistrationConfiguration
<vnic_profile_mappings> <registration_vnic_profile_mapping> <from> <name>gold</name> <network> <name>red</name> </network> </from> <to id="738dd914-8ec8-4a8b-8628-34672a5d449b"/> </registration_vnic_profile_mapping> <registration_vnic_profile_mapping> <from> <name></name> <network> <name></name> </network> </from> <to id="892a12ec-2028-4451-80aa-ff3bf55d6bac"/> </registration_vnic_profile_mapping> <registration_vnic_profile_mapping> <from> <name>silver</name> <network> <name>blue</name> </network> </from> <to> <name>copper</name> <network> <name>orange</name> </network> </to> </registration_vnic_profile_mapping> <registration_vnic_profile_mapping> <from> <name>platinum</name> <network> <name>yellow</name> </network> </from> <to> <name></name> <network> <name></name> </network> </to> </registration_vnic_profile_mapping> <registration_vnic_profile_mapping> <from> <name>bronze</name> <network> <name>green</name> </network> </from> </registration_vnic_profile_mapping> </vnic_profile_mappings>
Table 7.318. Links summary
Name | Type | Summary |
---|---|---|
| References to the external network and the external network profile. | |
| Reference to to an existing virtual NIC profile. |
7.243.1. from
References to the external network and the external network profile. Both should be specified using their name
.
7.243.2. to
Reference to to an existing virtual NIC profile. It should be specified using its name
or id
. Either name
or id
should be specified but not both.
7.244. ReportedConfiguration struct
7.245. ReportedDevice struct
Table 7.320. Attributes summary
Table 7.321. Links summary
Name | Type | Summary |
---|---|---|
|
7.246. ReportedDeviceType enum
Table 7.322. Values summary
Name | Summary |
---|---|
|
7.247. ResolutionType enum
Table 7.323. Values summary
Name | Summary |
---|---|
| |
|
7.248. RngDevice struct
Random number generator (RNG) device model.
7.249. RngSource enum
Representing the random generator backend types.
Table 7.325. Values summary
Name | Summary |
---|---|
|
Obtains random data from the |
|
Obtains random data from the |
|
Obtains random data from the |
7.249.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.250. Role struct
Represents a system role.
Table 7.326. Attributes summary
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.250.1. mutable
Defines the ability to update or delete the role.
Roles with mutable set to false
are predefined roles.
7.251. 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.
Table 7.328. Values summary
Name | Summary |
---|---|
| Administrative role. |
| User role. |
7.252. SchedulingPolicy struct
Table 7.329. Attributes summary
7.253. SchedulingPolicyUnit struct
Table 7.331. Attributes summary
7.254. ScsiGenericIO enum
When a direct LUN disk is using SCSI passthrough the privileged I/O policy is determined by this enum.
Table 7.332. Values summary
Name | Summary |
---|---|
| Disable SCSI passthrough. |
| Disallow privileged SCSI I/O. |
| Allow privileged SCSI I/O. |
7.255. SeLinux struct
Represents SELinux in the system.
Table 7.333. Attributes summary
Name | Type | Summary |
---|---|---|
| SELinux current mode. |
7.256. SeLinuxMode enum
Represents an SELinux enforcement mode.
Table 7.334. Values summary
Name | Summary |
---|---|
| SELinux is disabled in the kernel. |
| SELinux is running and enforcing permissions. |
| SELinux is running and logging but not enforcing permissions. |
7.257. SerialNumber struct
Table 7.335. Attributes summary
Name | Type | Summary |
---|---|---|
| ||
|
7.258. SerialNumberPolicy enum
Type representing the policy of a Serial Number.
Table 7.336. Values summary
Name | Summary |
---|---|
| This policy allows the user to provide an arbitrary string as the Serial Number. |
| This policy is the legacy policy. |
| This policy is used to remove the Serial Number Policy, moving it to default: null. |
| This policy will use the Virtual Machine ID as the Serial Number. |
7.258.1. host
This policy is the legacy policy. It will use the Host ID as the Serial Number.
7.259. Session struct
Describes a user session to a virtual machine.
Table 7.337. Attributes summary
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.259.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.259.2. ip
The IP address the user is connected from.
Currently only available for console users.
7.259.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.259.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.260. SkipIfConnectivityBroken struct
Table 7.339. Attributes summary
7.260.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.260.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.261. SkipIfSdActive struct
This type represents the storage related configuration in the fencing policy.
Table 7.340. Attributes summary
Name | Type | Summary |
---|---|---|
| If enabled, we will skip fencing in case the host maintains its lease in the storage. |
7.261.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.262. Snapshot struct
Represents a snapshot object.
Example XML representation:
<snapshot id="456" href="/ovirt-engine/api/vms/123/snapshots/456"> <actions> <link rel="restore" href="/ovirt-engine/api/vms/123/snapshots/456/restore"/> </actions> <vm id="123" href="/ovirt-engine/api/vms/123"/> <description>Virtual Machine 1 - Snapshot A</description> <type>active</type> <date>2010-08-16T14:24:29</date> <persist_memorystate>false</persist_memorystate> </snapshot>
Table 7.341. Attributes summary
Name | Type | Summary |
---|---|---|
| Specifies if and how the auto CPU and NUMA configuration is applied. | |
| 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. | |
| Specifies if and how the CPU and NUMA configuration is applied. | |
| ||
| The virtual machine creation date. | |
| Virtual machine custom compatibility version. | |
| ||
| ||
| Properties sent to VDSM to configure various hooks. | |
| The date when this snapshot has been created. | |
|
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). | |
|
Indicates whether the virtual machine has snapshots with disks in | |
| The virtual machine high availability configuration. | |
| A unique identifier. | |
| Reference to the 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 a running virtual machine to another host. | |
| Maximum time the virtual machine can be non responsive during its live migration to another host in ms. | |
|
If | |
| 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. | |
| Status of the snapshot. | |
| Type of the snapshot. | |
|
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. | |
| Determines how the virtual machine will be resumed after storage error. | |
| The virtual machine’s time zone set by oVirt. | |
|
If | |
|
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. | |
| Number of queues for a Virtio-SCSI contoller this field requires virtioScsiMultiQueuesEnabled to be true see virtioScsiMultiQueuesEnabled for more info | |
|
If |
7.262.1. auto_pinning_policy
Specifies if and how the auto CPU and NUMA configuration is applied.
Since version 4.5 of the engine this operation is deprecated, and preserved only for backwards compatibility. It might be removed in the future. Please use CpuPinningPolicy instead.
7.262.2. 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
With a request body:
<vm> <cpu> <topology> <sockets>4</sockets> <cores>2</cores> <threads>2</threads> </topology> </cpu> </vm>
7.262.3. cpu_pinning_policy
Specifies if and how the CPU and NUMA configuration is applied. When not specified the previous behavior of CPU pinning string will determine CpuPinningPolicy to None or Manual.
7.262.4. 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.262.5. high_availability
The virtual machine high availability configuration. If set, the virtual machine will be automatically restarted when it unexpectedly goes down.
7.262.6. initialization
Reference to the virtual machine’s initialization configuration.
Since Red Hat Virtualization 4.1.8 this property can be cleared by sending an empty tag.
For example, to clear the initialization
attribute send a request like this:
PUT /ovirt-engine/api/vms/123
With a request body like this:
<vm> <initialization/> </vm>
The response to such a request, and requests with the header All-Content: true
will still contain this attribute.
7.262.7. large_icon
Virtual machine’s large icon. Either set by user or refers to image set according to operating system.
7.262.8. 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.262.9. 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
With the following request body:
<vm> <memory>1073741824</memory> </vm>
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 in state up. The size increment must be dividable by the value of the HotPlugMemoryBlockSizeMb
configuration value (256 MiB by default). If the memory size increment is not dividable by this value, the memory size change is only stored to next run configuration. Each successful memory hot plug operation creates one or two new memory devices.
Memory hot unplug is supported since Red Hat Virtualization 4.2 onwards. Memory hot unplug can only be performed when the virtual machine is in state up. Only previously hot plugged memory devices can be removed by the hot unplug operation. The requested memory decrement is rounded down to match sizes of a combination of previously hot plugged memory devices. The requested memory value is stored to next run configuration without rounding.
Memory in the example is converted to bytes using the following formula:
1 GiB = 230 bytes = 1073741824 bytes.
Red Hat Virtualization Manager internally rounds values down to whole MiBs (1MiB = 220 bytes)
7.262.10. migration
Reference to configuration of migration of a running virtual machine to another host.
API for querying migration policy by ID returned by this method is not implemented yet. Use /ovirt-engine/api/options/MigrationPolicies
to get a list of all migration policies with their IDs.
7.262.11. 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.262.12. 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.262.13. numa_tune_mode
How the NUMA topology is applied. Deprecated in favor of NUMA tune per vNUMA node.
7.262.14. origin
The origin of this virtual machine.
Possible values:
-
ovirt
-
rhev
-
vmware
-
xen
-
external
-
hosted_engine
-
managed_hosted_engine
-
kvm
-
physical_machine
-
hyperv
7.262.15. 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.262.16. 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
With a request body like this:
<vm> <high_availability> <enabled>true</enabled> <priority>1</priority> </high_availability> <placement_policy> <hosts> <host> <name>Host1</name> </host> <host> <name>Host2</name> </host> </hosts> <affinity>pinned</affinity> </placement_policy> </vm>
7.262.17. small_icon
Virtual machine’s small icon. Either set by user or refers to image set according to operating system.
7.262.18. 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.262.19. stop_reason
The reason the virtual machine was stopped. Optionally set by user when shutting down the virtual machine.
7.262.20. tpm_enabled
If true
, a TPM device is added to the virtual machine. By default the value is false
. This property is only visible when fetching if "All-Content=true" header is set.
Table 7.342. Links summary
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. | |
| List of disks linked to the snapshot. | |
| The dynamic configuration of the virtual machine CPU. | |
| ||
| 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. | |
| Mediated devices configuration. | |
| Nic[] | 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. | |
| Tag[] | |
| Reference to the template the virtual machine is based on. | |
| The virtual machine this snapshot has been taken for. | |
| Reference to the pool the virtual machine is optionally member of. | |
| Refers to the Watchdog configuration. |
7.262.21. affinity_labels
Optional. Used for labeling of sub-clusters.
7.262.22. katello_errata
Lists all the Katello errata assigned to the virtual machine.
GET /ovirt-engine/api/vms/123/katelloerrata
You will receive response in XML like this one:
<katello_errata> <katello_erratum href="/ovirt-engine/api/katelloerrata/456" id="456"> <name>RHBA-2013:XYZ</name> <description>The description of the erratum</description> <title>some bug fix update</title> <type>bugfix</type> <issued>2013-11-20T02:00:00.000+02:00</issued> <solution>Few guidelines regarding the solution</solution> <summary>Updated packages that fix one bug are now available for XYZ</summary> <packages> <package> <name>libipa_hbac-1.9.2-82.11.el6_4.i686</name> </package> ... </packages> </katello_erratum> ... </katello_errata>
7.262.23. 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.262.24. statistics
Statistics data collected from this virtual machine.
Note that some statistics, notably memory.buffered
and memory.cached
are available only when Red Hat Virtualization guest agent is installed in the virtual machine.
7.263. SnapshotStatus enum
Represents the current status of the snapshot.
Table 7.343. Values summary
Name | Summary |
---|---|
| The snapshot is being previewed. |
| The snapshot is locked. |
| The snapshot is OK. |
7.263.1. locked
The snapshot is locked.
The snapshot is locked when it is in process of being created, deleted, restored or previewed.
7.264. SnapshotType enum
Represents the type of the snapshot.
Table 7.344. Values summary
Name | Summary |
---|---|
| Reference to the current configuration of the virtual machines. |
|
The |
| Snapshot created by user. |
| Snapshot created internally for stateless virtual machines. |
7.264.1. preview
The active
snapshot will become preview
if some snapshot is being previewed.
In other words, this is the active
snapshot before preview.
7.264.2. stateless
Snapshot created internally for stateless virtual machines.
This snapshot is created when the virtual machine is started and it is restored when the virtual machine is shut down.
7.265. SpecialObjects struct
This type contains references to special objects, such as blank templates and the root of a hierarchy of tags.
7.266. Spm struct
7.267. SpmStatus enum
Table 7.347. Values summary
Name | Summary |
---|---|
| |
| |
|
7.268. Ssh struct
Table 7.348. Attributes summary
Name | Type | Summary |
---|---|---|
| ||
| Free text containing comments about this object. | |
| A human-readable description in plain text. | |
| Fingerprint of SSH public key for a host. | |
| A unique identifier. | |
| A human-readable name in plain text. | |
| ||
| SSH public key of the host using SSH public key format as defined in link:https://tools. | |
|
7.268.1. fingerprint
Fingerprint of SSH public key for a host. This field is deprecated since 4.4.5 and will be removed in the future.
Please use publicKey instead.
7.268.2. public_key
SSH public key of the host using SSH public key format as defined in RFC4253.
7.269. SshAuthenticationMethod enum
Table 7.349. Values summary
Name | Summary |
---|---|
| |
|
7.270. SshPublicKey struct
Table 7.350. Attributes summary
Table 7.351. Links summary
Name | Type | Summary |
---|---|---|
|
7.271. Sso struct
Table 7.352. Attributes summary
Name | Type | Summary |
---|---|---|
|
7.272. SsoMethod enum
Table 7.353. Values summary
Name | Summary |
---|---|
|
7.273. 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:
<statistics> <statistic id="1234" href="/ovirt-engine/api/hosts/1234/nics/1234/statistics/1234"> <name>data.current.rx</name> <description>Receive data rate</description> <values type="DECIMAL"> <value> <datum>0</datum> </value> </values> <type>GAUGE</type> <unit>BYTES_PER_SECOND</unit> <host_nic id="1234" href="/ovirt-engine/api/hosts/1234/nics/1234"/> </statistic> ... </statistics>
This statistics sub-collection is read-only.
Table 7.354. Attributes summary
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 |
Table 7.355. Links summary
Name | Type | Summary |
---|---|---|
| ||
|
A relationship to the containing | |
| ||
| ||
| A reference to the host NIC. | |
| ||
| ||
| ||
|
7.274. StatisticKind enum
Table 7.356. Values summary
Name | Summary |
---|---|
| |
|
7.275. StatisticUnit enum
Table 7.357. Values summary
Name | Summary |
---|---|
| |
| |
| |
| |
| |
| |
|
7.276. 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.
Table 7.358. Attributes summary
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.276.1. external
Indicates if the step is originated by an external system. External steps are managed externally, by the creator of the step.
Table 7.359. Links summary
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.277. StepEnum enum
Type representing a step type.
Table 7.360. Values summary
Name | Summary |
---|---|
| The executing step type. |
| The finalizing step type. |
|
The |
|
The |
| The unknown step type. |
| The validation step type. |
7.277.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.277.2. finalizing
The finalizing step type. Describes the post-execution steps requires to complete the job
.
7.277.3. rebalancing_volume
The rebalancing volume
step type. Describes a step type which is part of Gluster
flow.
7.277.4. removing_bricks
The removing bricks
step type. Describes a step type which is part of Gluster
flow.
7.277.5. unknown
The unknown step type. Describes a step type which its origin is unknown.
7.277.6. validating
The validation step type. Used to verify the correctness of parameters and the validity of the parameters prior to the execution.
7.278. StepStatus enum
Represents the status of the step.
Table 7.361. Values summary
Name | Summary |
---|---|
| The aborted step status. |
| The failed step status. |
| The finished step status. |
| The started step status. |
| The unknown step status. |
7.278.1. aborted
The aborted step status. This status is applicable for an external step that was forcibly aborted.
7.278.2. finished
The finished step status. This status describes a completed step execution.
7.278.3. started
The started step status. This status represents a step which is currently being executed.
7.278.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.279. 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>
Table 7.362. Attributes summary
Name | Type | Summary |
---|---|---|
| A storage server connection’s address. | |
| Free text containing comments about this object. | |
| A human-readable description in plain text. | |
| A unique identifier. | |
| The mount options of an NFS storage server connection. | |
| A human-readable name in plain text. | |
| The NFS retrans value of an NFS storage server connection. | |
| The NFS timeo value of an NFS storage server connection. | |
| The NFS version of an NFS storage server connection. | |
| The password of an iSCSI storage server connection. | |
| The path of an NFS storage server connection. | |
| The port of an iSCSI storage server connection. | |
| The portal of an iSCSI storage server connection. | |
| The target of an iSCSI storage server connection. | |
| A storage server connection’s type. | |
| The user name of an iSCSI storage server connection. | |
| The VFS type of an NFS storage server connection. |
Table 7.363. Links summary
Name | Type | Summary |
---|---|---|
| Link to the gluster volume, used by that storage domain. | |
|
7.280. StorageConnectionExtension struct
Table 7.364. Attributes summary
Table 7.365. Links summary
Name | Type | Summary |
---|---|---|
|
7.281. StorageDomain struct
Storage domain.
An XML representation of a NFS storage domain with identifier 123
:
<storage_domain href="/ovirt-engine/api/storagedomains/123" id="123"> <name>mydata</name> <description>My data</description> <available>38654705664</available> <committed>1073741824</committed> <critical_space_action_blocker>5</critical_space_action_blocker> <external_status>ok</external_status> <master>true</master> <storage> <address>mynfs.example.com</address> <nfs_version>v3</nfs_version> <path>/exports/mydata</path> <type>nfs</type> </storage> <storage_format>v3</storage_format> <type>data</type> <used>13958643712</used> <warning_low_space_indicator>10</warning_low_space_indicator> <wipe_after_delete>false</wipe_after_delete> <data_centers> <data_center href="/ovirt-engine/api/datacenters/456" id="456"/> </data_centers> </storage_domain>
Table 7.366. Attributes summary
Name | Type | Summary |
---|---|---|
| ||
| This attribute indicates whether a data storage domain is used as backup domain or not. | |
| Specifies block size in bytes for a storage domain. | |
| 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.281.1. backup
This attribute indicates whether a data storage domain is used as backup domain or not. If the domain is set to backup then it will be used to store virtual machines and templates for disaster recovery purposes in the same way we use export storage domain. This attribute is only available with data storage domain and not with ISO domain or export storage domain. User can use this functionality while creating a data storage domain or importing a data storage domain.
7.281.2. block_size
Specifies block size in bytes for a storage domain. Can be omitted and in that case will be defaulted to 512 bytes. Not all storage domains support all possible sizes.
7.281.3. 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
false
for non block storage types. -
Discard after delete can be set to
true
only if the storage domain supports discard.
7.281.4. 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.
7.281.5. 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.
Since version 4.2.1 of the system, the support for this attribute has been removed as the sysfs file, discard_zeroes_data
, was deprecated in the kernel. It is preserved for backwards compatibility, but the value will always be false
.
7.281.6. 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.
Table 7.367. Links summary
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. | |
| ||
| ||
| ||
| ||
| Vm[] |
7.281.7. 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.282. 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.
Table 7.368. Links summary
Name | Type | Summary |
---|---|---|
| Reference to the storage domain on which the lock resides on. |
7.283. StorageDomainStatus enum
Table 7.369. Values summary
Name | Summary |
---|---|
| |
| |
| |
| |
| |
| |
| |
| |
| |
|
7.284. StorageDomainType enum
Indicates the kind of data managed by a storage domain.
Table 7.370. Values summary
Name | Summary |
---|---|
| Data domains are used to store the disks and snapshots of the virtual machines and templates in the system. |
| Export domains are temporary storage repositories used to copy and move virtual machines and templates between data centers and Red Hat Virtualization environments. |
| Image domain store images that can be imported into from an external system. |
| ISO domains store ISO files (or logical CDs) used to install and boot operating systems and applications for the virtual machines. |
| Managed block storage domains are created on block storage devices. |
| Volume domains store logical volumes that can be used as disks for virtual machines. |
7.284.1. data
Data domains are used to store the disks and snapshots of the virtual machines and templates in the system. In addition, snapshots of the disks are also stored in data domains. Data domains cannot be shared across data centers.
7.284.2. export
Export domains are temporary storage repositories used to copy and move virtual machines and templates between data centers and Red Hat Virtualization environments. Export domains can also be used to backup virtual machines. An export domain can be moved between data centers but it can only be active in one data center at a time.
7.284.3. image
Image domain store images that can be imported into from an external system. For example, images from an OpenStack Glance image repository.
7.284.4. iso
ISO domains store ISO files (or logical CDs) used to install and boot operating systems and applications for the virtual machines. ISO domains remove the data center’s need for physical media. An ISO domain can be shared across different data centers.
7.284.5. managed_block_storage
Managed block storage domains are created on block storage devices. These domains are accessed and managed by cinder.
7.284.6. volume
Volume domains store logical volumes that can be used as disks for virtual machines. For example, volumes from an OpenStack Cincer block storage service.
7.285. StorageFormat enum
Type which represents a format of storage domain.
Table 7.371. Values summary
Name | Summary |
---|---|
| Version 1 of the storage domain format is applicable to NFS, iSCSI and FC storage domains. |
| Version 2 of the storage domain format is applicable to iSCSI and FC storage domains. |
| Version 3 of the storage domain format is applicable to NFS, POSIX, iSCSI and FC storage domains. |
| Version 4 of the storage domain format. |
| Version 5 of the storage domain format is applicable to NFS, POSIX, and Gluster storage domains. |
7.285.1. v1
Version 1 of the storage domain format is applicable to NFS, iSCSI and FC storage domains.
Each storage domain contains metadata describing its own structure, and all of the names of physical volumes that are used to back virtual machine disk images. Master domains additionally contain metadata for all the domains and physical volume names in the storage pool. The total size of this metadata is limited to 2 KiB, limiting the number of storage domains that can be in a pool. Template and virtual machine base images are read only.
7.285.2. v2
Version 2 of the storage domain format is applicable to iSCSI and FC storage domains.
All storage domain and pool metadata is stored as logical volume tags rather than written to a logical volume. Metadata about virtual machine disk volumes is still stored in a logical volume on the domains. Physical volume names are no longer included in the metadata. Template and virtual machine base images are read only.
7.285.3. v3
Version 3 of the storage domain format is applicable to NFS, POSIX, iSCSI and FC storage domains.
All storage domain and pool metadata is stored as logical volume tags rather than written to a logical volume. Metadata about virtual machine disk volumes is still stored in a logical volume on the domains. Virtual machine and template base images are no longer read only. This change enables live snapshots, live storage migration, and clone from snapshot. Support for Unicode metadata is added, for non-English volume names.
7.285.4. v5
Version 5 of the storage domain format is applicable to NFS, POSIX, and Gluster storage domains.
Added support for 4096 bytes block sizes and variable sanlock alignments.
7.286. StorageType enum
Type representing a storage domain type.
Table 7.372. Values summary
Name | Summary |
---|---|
| Cinder storage domain. |
| Fibre-Channel storage domain. |
| Glance storage domain. |
| Gluster-FS storage domain. |
| iSCSI storage domain. |
| Storage domain on Local storage. |
| Managed block storage domain. |
| NFS storage domain. |
| POSIX-FS storage domain. |
7.286.1. cinder
Cinder storage domain. For more details on Cinder please go to Cinder.
7.286.2. glance
Glance storage domain. For more details on Glance please go to Glance.
7.286.3. glusterfs
Gluster-FS storage domain. For more details on Gluster please go to Gluster.
7.286.4. managed_block_storage
Managed block storage domain. A storage domain managed using cinderlib. For supported storage drivers, see Available Drivers.
7.287. SwitchType enum
Describes all switch types supported by the Manager.
Table 7.373. Values summary
Name | Summary |
---|---|
| The native switch type. |
| The Open vSwitch type. |
7.288. SystemOption struct
Type representing a configuration option of the system.
Table 7.374. Attributes summary
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. | |
| Values of the option for various system versions. |
7.289. SystemOptionValue struct
Type representing a pair of value and version of a configuration option.
7.290. Tag struct
Represents a tag in the system.
Table 7.376. Attributes summary
Table 7.377. Links summary
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.291. Template struct
The type that represents a virtual machine template. Templates allow for a rapid instantiation of virtual machines with common configuration and disk states.
Table 7.378. Attributes summary
Name | Type | Summary |
---|---|---|
| Specifies if and how the auto CPU and NUMA configuration is applied. | |
| 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. | |
| Specifies if and how the CPU and NUMA configuration is applied. | |
| ||
| 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 the 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 a running virtual machine to another host. | |
| Maximum time the virtual machine can be non responsive during its live migration to another host in ms. | |
|
If | |
| A human-readable name in plain text. | |
| The origin of this virtual machine. | |
| Operating system type installed on the virtual machine. | |
| The configuration of the virtual machine’s placement policy. | |
| 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. | |
| Determines how the virtual machine will be resumed after storage error. | |
| The virtual machine’s time zone set by oVirt. | |
|
If | |
|
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 the base version or a sub-version of another template. | |
| Reference to VirtIO SCSI configuration. | |
| Number of queues for a Virtio-SCSI contoller this field requires virtioScsiMultiQueuesEnabled to be true see virtioScsiMultiQueuesEnabled for more info | |
|
If | |
| The virtual machine configuration associated with this template. |
7.291.1. auto_pinning_policy
Specifies if and how the auto CPU and NUMA configuration is applied.
Since version 4.5 of the engine this operation is deprecated, and preserved only for backwards compatibility. It might be removed in the future. Please use CpuPinningPolicy instead.
7.291.2. 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
With a request body:
<vm> <cpu> <topology> <sockets>4</sockets> <cores>2</cores> <threads>2</threads> </topology> </cpu> </vm>
7.291.3. cpu_pinning_policy
Specifies if and how the CPU and NUMA configuration is applied. When not specified the previous behavior of CPU pinning string will determine CpuPinningPolicy to None or Manual.
7.291.4. 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.291.5. high_availability
The virtual machine high availability configuration. If set, the virtual machine will be automatically restarted when it unexpectedly goes down.
7.291.6. initialization
Reference to the virtual machine’s initialization configuration.
Since Red Hat Virtualization 4.1.8 this property can be cleared by sending an empty tag.
For example, to clear the initialization
attribute send a request like this:
PUT /ovirt-engine/api/vms/123
With a request body like this:
<vm> <initialization/> </vm>
The response to such a request, and requests with the header All-Content: true
will still contain this attribute.
7.291.7. large_icon
Virtual machine’s large icon. Either set by user or refers to image set according to operating system.
7.291.8. 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.291.9. 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
With the following request body:
<vm> <memory>1073741824</memory> </vm>
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 in state up. The size increment must be dividable by the value of the HotPlugMemoryBlockSizeMb
configuration value (256 MiB by default). If the memory size increment is not dividable by this value, the memory size change is only stored to next run configuration. Each successful memory hot plug operation creates one or two new memory devices.
Memory hot unplug is supported since Red Hat Virtualization 4.2 onwards. Memory hot unplug can only be performed when the virtual machine is in state up. Only previously hot plugged memory devices can be removed by the hot unplug operation. The requested memory decrement is rounded down to match sizes of a combination of previously hot plugged memory devices. The requested memory value is stored to next run configuration without rounding.
Memory in the example is converted to bytes using the following formula:
1 GiB = 230 bytes = 1073741824 bytes.
Red Hat Virtualization Manager internally rounds values down to whole MiBs (1MiB = 220 bytes)
7.291.10. migration
Reference to configuration of migration of a running virtual machine to another host.
API for querying migration policy by ID returned by this method is not implemented yet. Use /ovirt-engine/api/options/MigrationPolicies
to get a list of all migration policies with their IDs.
7.291.11. 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.291.12. origin
The origin of this virtual machine.
Possible values:
-
ovirt
-
rhev
-
vmware
-
xen
-
external
-
hosted_engine
-
managed_hosted_engine
-
kvm
-
physical_machine
-
hyperv
7.291.13. 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
With a request body like this:
<vm> <high_availability> <enabled>true</enabled> <priority>1</priority> </high_availability> <placement_policy> <hosts> <host> <name>Host1</name> </host> <host> <name>Host2</name> </host> </hosts> <affinity>pinned</affinity> </placement_policy> </vm>
7.291.14. small_icon
Virtual machine’s small icon. Either set by user or refers to image set according to operating system.
7.291.15. 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.291.16. tpm_enabled
If true
, a TPM device is added to the virtual machine. By default the value is false
. This property is only visible when fetching if "All-Content=true" header is set.
Table 7.379. Links summary
Name | Type | Summary |
---|---|---|
| Reference 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. | |
| Reference to the disks attached to the template. | |
| Reference to the graphic consoles attached to the template. | |
| Mediated devices configuration. | |
| Nic[] | Reference to the network interfaces attached to the template. |
| Reference 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. | |
| Tag[] | Reference to the tags attached to the template. |
| Reference to the watchdog devices attached to the template. |
7.292. TemplateStatus enum
Type representing a status of a virtual machine template.
Table 7.380. Values summary
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.293. TemplateVersion struct
Type representing a version of a virtual machine template.
Table 7.381. Attributes summary
7.293.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.
Table 7.382. Links summary
Name | Type | Summary |
---|---|---|
| References the template that this version is associated with. |
7.294. Ticket struct
Type representing a ticket that allows virtual machine access.
7.295. TimeZone struct
Time zone representation.
Table 7.384. Attributes summary
7.295.1. utc_offset
UTC offset.
Offset from UTC.
7.296. TpmSupport enum
Table 7.385. Values summary
Name | Summary |
---|---|
| TPM is required by the operating system |
| TPM is supported but optional |
|
7.297. TransparentHugePages struct
Type representing a transparent huge pages (THP) support.
Table 7.386. Attributes summary
Name | Type | Summary |
---|---|---|
| Enable THP support. |
7.298. TransportType enum
Protocol used to access a Gluster volume.
Table 7.387. Values summary
Name | Summary |
---|---|
| Remote direct memory access. |
| TCP. |
7.299. UnmanagedNetwork struct
Table 7.388. Attributes summary
7.300. Usb struct
Configuration of the USB device of a virtual machine.
7.301. UsbType enum
Type of USB device redirection.
Table 7.391. Values summary
Name | Summary |
---|---|
| Legacy USB redirection. |
| Native USB redirection. |
7.301.1. legacy
Legacy USB redirection.
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.301.2. native
Native USB redirection.
Native USB redirection allows KVM/SPICE USB redirection for Linux and Windows virtual machines. Virtual (guest) machines require no guest-installed agents or drivers for native USB. On Linux clients, all packages required for USB redirection are provided by the virt-viewer
package. On Windows clients, you must also install the usbdk
package.
7.302. User struct
Represents a user in the system.
Table 7.392. Attributes summary
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. | |
| User options allow you to save key/value properties which are used to customize the settings per individual user. |
7.302.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 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 oVirt Engine extension - AAA - JDBC for more information.
7.302.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.302.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.
7.302.4. user_options
User options allow you to save key/value properties which are used to customize the settings per individual user. Note that since version 4.4.5 this property is deprecated and preserved only for backwards compatibility. It will be removed in the future. Please use the options endpoint instead.
Table 7.393. Links summary
Name | Type | Summary |
---|---|---|
| ||
| ||
| ||
| ||
| A link to the roles sub-collection for user resources. | |
| ||
| Tag[] | A link to the tags sub-collection for user resources. |
7.303. UserOption struct
User options allow you to save key/value properties which are used to customize the settings per individual user.
Table 7.394. Attributes summary
7.303.1. content
JSON content encoded as string. Any valid JSON is supported.
Table 7.395. Links summary
Name | Type | Summary |
---|---|---|
|
7.304. Value struct
7.305. ValueType enum
Table 7.397. Values summary
Name | Summary |
---|---|
| |
| |
|
7.306. VcpuPin struct
7.307. Vendor struct
7.308. Version struct
Table 7.400. Attributes summary
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.309. VgpuPlacement enum
The vGPU placement strategy.
It can either put vGPUs on the first available physical cards, or spread them over multiple physical cards.
Table 7.401. Values summary
Name | Summary |
---|---|
| Use consolidated placement. |
| Use separated placement. |
7.309.1. consolidated
Use consolidated placement. Each vGPU is placed on the first physical card with available space.
This is the default placement, utilizing all available space on the physical cards.
7.309.2. separated
Use separated placement. Each vGPU is placed on a separate physical card, if possible.
This can be useful for improving vGPU performance.
7.310. VirtioScsi struct
Type representing the support of virtio-SCSI. If it supported we use virtio driver for SCSI guest device.
Table 7.402. Attributes summary
Name | Type | Summary |
---|---|---|
| Enable Virtio SCSI support. |
7.311. VirtualNumaNode struct
Represents the virtual NUMA node.
An example XML representation:
<vm_numa_node href="/ovirt-engine/api/vms/123/numanodes/456" id="456"> <cpu> <cores> <core> <index>0</index> </core> </cores> </cpu> <index>0</index> <memory>1024</memory> <numa_node_pins> <numa_node_pin> <index>0</index> </numa_node_pin> </numa_node_pins> <vm href="/ovirt-engine/api/vms/123" id="123" /> </vm_numa_node>
Table 7.403. Attributes summary
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. | |
| ||
| ||
| How the NUMA topology is applied. |
Table 7.404. Links summary
Name | Type | Summary |
---|---|---|
| ||
| Each host NUMA node resource exposes a statistics sub-collection for host NUMA node specific statistics. | |
|
7.311.1. statistics
Each host NUMA node resource exposes a statistics sub-collection for host NUMA node specific statistics.
An example of an XML representation:
<statistics> <statistic href="/ovirt-engine/api/hosts/123/numanodes/456/statistics/789" id="789"> <name>memory.total</name> <description>Total memory</description> <kind>gauge</kind> <type>integer</type> <unit>bytes</unit> <values> <value> <datum>25165824000</datum> </value> </values> <host_numa_node href="/ovirt-engine/api/hosts/123/numanodes/456" id="456" /> </statistic> ... </statistics>
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.312. Vlan struct
Type representing a Virtual LAN (VLAN) type.
Table 7.405. Attributes summary
Name | Type | Summary |
---|---|---|
| Virtual LAN ID. |
7.313. Vm struct
Represents a virtual machine.
Table 7.406. Attributes summary
Name | Type | Summary |
---|---|---|
| Specifies if and how the auto CPU and NUMA configuration is applied. | |
| 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. | |
| Specifies if and how the CPU and NUMA configuration is applied. | |
| ||
| 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). | |
|
Indicates whether the virtual machine has snapshots with disks in | |
| The virtual machine high availability configuration. | |
| A unique identifier. | |
| Reference to the 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 a running virtual machine to another host. | |
| Maximum time the virtual machine can be non responsive during its live migration to another host in ms. | |
|
If | |
| 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. | |
| Determines how the virtual machine will be resumed after storage error. | |
| The virtual machine’s time zone set by oVirt. | |
|
If | |
|
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. | |
| Number of queues for a Virtio-SCSI contoller this field requires virtioScsiMultiQueuesEnabled to be true see virtioScsiMultiQueuesEnabled for more info | |
|
If |
7.313.1. auto_pinning_policy
Specifies if and how the auto CPU and NUMA configuration is applied.
Since version 4.5 of the engine this operation is deprecated, and preserved only for backwards compatibility. It might be removed in the future. Please use CpuPinningPolicy instead.
7.313.2. 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
With a request body:
<vm> <cpu> <topology> <sockets>4</sockets> <cores>2</cores> <threads>2</threads> </topology> </cpu> </vm>
7.313.3. cpu_pinning_policy
Specifies if and how the CPU and NUMA configuration is applied. When not specified the previous behavior of CPU pinning string will determine CpuPinningPolicy to None or Manual.
7.313.4. 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.313.5. high_availability
The virtual machine high availability configuration. If set, the virtual machine will be automatically restarted when it unexpectedly goes down.
7.313.6. initialization
Reference to the virtual machine’s initialization configuration.
Since Red Hat Virtualization 4.1.8 this property can be cleared by sending an empty tag.
For example, to clear the initialization
attribute send a request like this:
PUT /ovirt-engine/api/vms/123
With a request body like this:
<vm> <initialization/> </vm>
The response to such a request, and requests with the header All-Content: true
will still contain this attribute.
7.313.7. large_icon
Virtual machine’s large icon. Either set by user or refers to image set according to operating system.
7.313.8. 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.313.9. 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
With the following request body:
<vm> <memory>1073741824</memory> </vm>
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 in state up. The size increment must be dividable by the value of the HotPlugMemoryBlockSizeMb
configuration value (256 MiB by default). If the memory size increment is not dividable by this value, the memory size change is only stored to next run configuration. Each successful memory hot plug operation creates one or two new memory devices.
Memory hot unplug is supported since Red Hat Virtualization 4.2 onwards. Memory hot unplug can only be performed when the virtual machine is in state up. Only previously hot plugged memory devices can be removed by the hot unplug operation. The requested memory decrement is rounded down to match sizes of a combination of previously hot plugged memory devices. The requested memory value is stored to next run configuration without rounding.
Memory in the example is converted to bytes using the following formula:
1 GiB = 230 bytes = 1073741824 bytes.
Red Hat Virtualization Manager internally rounds values down to whole MiBs (1MiB = 220 bytes)
7.313.10. migration
Reference to configuration of migration of a running virtual machine to another host.
API for querying migration policy by ID returned by this method is not implemented yet. Use /ovirt-engine/api/options/MigrationPolicies
to get a list of all migration policies with their IDs.
7.313.11. 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.313.12. 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.313.13. numa_tune_mode
How the NUMA topology is applied. Deprecated in favor of NUMA tune per vNUMA node.
7.313.14. origin
The origin of this virtual machine.
Possible values:
-
ovirt
-
rhev
-
vmware
-
xen
-
external
-
hosted_engine
-
managed_hosted_engine
-
kvm
-
physical_machine
-
hyperv
7.313.15. 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
With a request body like this:
<vm> <high_availability> <enabled>true</enabled> <priority>1</priority> </high_availability> <placement_policy> <hosts> <host> <name>Host1</name> </host> <host> <name>Host2</name> </host> </hosts> <affinity>pinned</affinity> </placement_policy> </vm>
7.313.16. small_icon
Virtual machine’s small icon. Either set by user or refers to image set according to operating system.
7.313.17. 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.313.18. stop_reason
The reason the virtual machine was stopped. Optionally set by user when shutting down the virtual machine.
7.313.19. tpm_enabled
If true
, a TPM device is added to the virtual machine. By default the value is false
. This property is only visible when fetching if "All-Content=true" header is set.
Table 7.407. Links summary
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. | |
| The dynamic configuration of the virtual machine CPU. | |
| ||
| 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. | |
| Mediated devices configuration. | |
| Nic[] | 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. | |
| Tag[] | |
| 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.313.20. affinity_labels
Optional. Used for labeling of sub-clusters.
7.313.21. katello_errata
Lists all the Katello errata assigned to the virtual machine.
GET /ovirt-engine/api/vms/123/katelloerrata
You will receive response in XML like this one:
<katello_errata> <katello_erratum href="/ovirt-engine/api/katelloerrata/456" id="456"> <name>RHBA-2013:XYZ</name> <description>The description of the erratum</description> <title>some bug fix update</title> <type>bugfix</type> <issued>2013-11-20T02:00:00.000+02:00</issued> <solution>Few guidelines regarding the solution</solution> <summary>Updated packages that fix one bug are now available for XYZ</summary> <packages> <package> <name>libipa_hbac-1.9.2-82.11.el6_4.i686</name> </package> ... </packages> </katello_erratum> ... </katello_errata>
7.313.22. 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.313.23. statistics
Statistics data collected from this virtual machine.
Note that some statistics, notably memory.buffered
and memory.cached
are available only when Red Hat Virtualization guest agent is installed in the virtual machine.
7.314. VmAffinity enum
Table 7.408. Values summary
Name | Summary |
---|---|
| |
| |
|
7.315. VmBase struct
Represents basic virtual machine configuration. This is used by virtual machines, templates and instance types.
Table 7.409. Attributes summary
Name | Type | Summary |
---|---|---|
| Specifies if and how the auto CPU and NUMA configuration is applied. | |
| 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. | |
| Specifies if and how the CPU and NUMA configuration is applied. | |
| ||
| 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 the 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 a running virtual machine to another host. | |
| Maximum time the virtual machine can be non responsive during its live migration to another host in ms. | |
|
If | |
| A human-readable name in plain text. | |
| The origin of this virtual machine. | |
| Operating system type installed on the virtual machine. | |
| The configuration of the virtual machine’s placement policy. | |
| 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 | |
| Determines how the virtual machine will be resumed after storage error. | |
| The virtual machine’s time zone set by oVirt. | |
|
If | |
|
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. | |
| Number of queues for a Virtio-SCSI contoller this field requires virtioScsiMultiQueuesEnabled to be true see virtioScsiMultiQueuesEnabled for more info | |
|
If |
7.315.1. auto_pinning_policy
Specifies if and how the auto CPU and NUMA configuration is applied.
Since version 4.5 of the engine this operation is deprecated, and preserved only for backwards compatibility. It might be removed in the future. Please use CpuPinningPolicy instead.
7.315.2. 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
With a request body:
<vm> <cpu> <topology> <sockets>4</sockets> <cores>2</cores> <threads>2</threads> </topology> </cpu> </vm>
7.315.3. cpu_pinning_policy
Specifies if and how the CPU and NUMA configuration is applied. When not specified the previous behavior of CPU pinning string will determine CpuPinningPolicy to None or Manual.
7.315.4. 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.315.5. high_availability
The virtual machine high availability configuration. If set, the virtual machine will be automatically restarted when it unexpectedly goes down.
7.315.6. initialization
Reference to the virtual machine’s initialization configuration.
Since Red Hat Virtualization 4.1.8 this property can be cleared by sending an empty tag.
For example, to clear the initialization
attribute send a request like this:
PUT /ovirt-engine/api/vms/123
With a request body like this:
<vm> <initialization/> </vm>
The response to such a request, and requests with the header All-Content: true
will still contain this attribute.
7.315.7. large_icon
Virtual machine’s large icon. Either set by user or refers to image set according to operating system.
7.315.8. 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.315.9. 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
With the following request body:
<vm> <memory>1073741824</memory> </vm>
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 in state up. The size increment must be dividable by the value of the HotPlugMemoryBlockSizeMb
configuration value (256 MiB by default). If the memory size increment is not dividable by this value, the memory size change is only stored to next run configuration. Each successful memory hot plug operation creates one or two new memory devices.
Memory hot unplug is supported since Red Hat Virtualization 4.2 onwards. Memory hot unplug can only be performed when the virtual machine is in state up. Only previously hot plugged memory devices can be removed by the hot unplug operation. The requested memory decrement is rounded down to match sizes of a combination of previously hot plugged memory devices. The requested memory value is stored to next run configuration without rounding.
Memory in the example is converted to bytes using the following formula:
1 GiB = 230 bytes = 1073741824 bytes.
Red Hat Virtualization Manager internally rounds values down to whole MiBs (1MiB = 220 bytes)
7.315.10. migration
Reference to configuration of migration of a running virtual machine to another host.
API for querying migration policy by ID returned by this method is not implemented yet. Use /ovirt-engine/api/options/MigrationPolicies
to get a list of all migration policies with their IDs.
7.315.11. 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.315.12. origin
The origin of this virtual machine.
Possible values:
-
ovirt
-
rhev
-
vmware
-
xen
-
external
-
hosted_engine
-
managed_hosted_engine
-
kvm
-
physical_machine
-
hyperv
7.315.13. 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
With a request body like this:
<vm> <high_availability> <enabled>true</enabled> <priority>1</priority> </high_availability> <placement_policy> <hosts> <host> <name>Host1</name> </host> <host> <name>Host2</name> </host> </hosts> <affinity>pinned</affinity> </placement_policy> </vm>
7.315.14. small_icon
Virtual machine’s small icon. Either set by user or refers to image set according to operating system.
7.315.15. 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.315.16. tpm_enabled
If true
, a TPM device is added to the virtual machine. By default the value is false
. This property is only visible when fetching if "All-Content=true" header is set.
Table 7.410. Links summary
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.316. VmDeviceType enum
Table 7.411. Values summary
Name | Summary |
---|---|
| |
|
7.317. VmMediatedDevice struct
VM mediated device is a fake device specifying properties of vGPU mediated devices. It is not an actual device, it just serves as a specification how to configure a part of a host device.
Table 7.412. Attributes summary
Table 7.413. Links summary
Name | Type | Summary |
---|---|---|
| Optionally references to an instance type the device is used by. | |
| Optionally references to a template the device is used by. | |
|
Do not use this element, use | |
| Vm[] | References to the virtual machines that are using this device. |
7.317.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.318. VmPlacementPolicy struct
Table 7.414. Attributes summary
Name | Type | Summary |
---|---|---|
|
Table 7.415. Links summary
Name | Type | Summary |
---|---|---|
|
7.319. VmPool struct
Type representing a virtual machines pool.
Table 7.416. Attributes summary
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. | |
| The display settings configured for virtual machines in the pool. | |
| A unique identifier. | |
| The maximum number of virtual machines in the pool that could be assigned to a particular user. | |
| A human-readable name in plain text. | |
| The system attempts to prestart the specified number of virtual machines from the pool. | |
| The random number generator device configured for virtual machines in the pool. | |
| The number of virtual machines in the pool. | |
| Indicates if sound card should be configured for virtual machines in the pool. | |
| Virtual machine pool’s stateful flag. | |
|
If | |
| The deallocation policy of virtual machines in the pool. | |
| Indicates if virtual machines in the pool are updated to newer versions of the template the pool is based on. |
7.319.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.319.2. display
The display settings configured for virtual machines in the pool.
Please note that this attribute is not working and is now deprecated. Please use Vm.display
instead.
7.319.3. prestarted_vms
The system attempts to prestart the specified number of virtual machines from the pool.
These virtual machines are started without being attached to any user. That way, users can acquire virtual machines from the pool faster.
7.319.4. 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.
7.319.5. tpm_enabled
If true
, a TPM device is added to the virtual machine. By default the value is false
. This property is only visible when fetching if "All-Content=true" header is set.
Table 7.417. Links summary
Name | Type | Summary |
---|---|---|
| Reference to the cluster the pool resides in. | |
| Reference to the instance type on which this pool is based. | |
| Permissions set for this virtual machine pool. | |
| Reference to the template the pool is based on. | |
| Reference to an arbitrary virtual machine that is part of the pool. |
7.319.6. 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.319.7. vm
Reference to an arbitrary virtual machine that is part of the pool.
Note that this virtual machine may not be based to the latest version of the pool’s template.
7.320. VmPoolType enum
Type representing the deallocation policy of virtual machines in a virtual machines pool.
Table 7.418. Values summary
Name | Summary |
---|---|
| This policy indicates that virtual machines in the pool are automcatically deallocated by the system. |
| This policy indicates that virtual machines in the pool are deallocated manually by the administrator. |
7.320.1. automatic
This policy indicates that virtual machines in the pool are automcatically deallocated by the system.
With this policy, when a virtual machine that is part of the pool and is assigned to a user is shut-down, it is detached from the user, its state is restored to the pool’s default state, and the virtual machine returns to pool (i.e., the virtual machine can then be assigned to another user).
7.320.2. manual
This policy indicates that virtual machines in the pool are deallocated manually by the administrator.
With this policy, a virtual machine that is part of the pool remains assigned to its user and preserves its state on shut-down. In order to return the virtual machine back to the pool, the administrator needs to deallocate it explicitly by removing the user’s permissions on that virtual machine.
7.321. VmStatus enum
Type representing a status of a virtual machine.
Table 7.419. Values summary
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.321.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.321.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.321.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.321.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.321.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.321.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.321.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.321.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.322. VmStorageErrorResumeBehaviour enum
If the storage, on which this virtual machine has some disks gets unresponsive, the virtual machine gets paused.
This are the possible options, what should happen with the virtual machine in the moment the storage gets available again.
Table 7.420. Values summary
Name | Summary |
---|---|
| The virtual machine gets resumed automatically in the moment the storage is available again. |
| The virtual machine will be killed after a timeout (configurable on the hypervisor). |
| Do nothing with the virtual machine. |
7.322.1. auto_resume
The virtual machine gets resumed automatically in the moment the storage is available again.
This is the only behavior available before 4.2.
7.322.2. kill
The virtual machine will be killed after a timeout (configurable on the hypervisor).
This is the only option supported for highly available virtual machines with leases. The reason is that the highly available virtual machine is restarted using the infrastructure and any kind of resume risks split brains.
7.322.3. leave_paused
Do nothing with the virtual machine.
Useful if there is a custom failover implemented and the user does not want the virtual machine to get resumed.
7.323. VmSummary struct
Type containing information related to virtual machines on a particular host.
7.324. VmType enum
Type representing what the virtual machine is optimized for.
Table 7.422. Values summary
Name | Summary |
---|---|
| The virtual machine is intended to be used as a desktop. |
| The virtual machine is intended to be used as a high performance virtual machine. |
| The virtual machine is intended to be used as a server. |
7.324.1. desktop
The virtual machine is intended to be used as a desktop.
Currently, its implication is that a sound device will automatically be added to the virtual machine.
7.324.2. high_performance
The virtual machine is intended to be used as a high performance virtual machine.
Currently, its implication is that the virtual machine configuration will automatically be set for running with the highest possible performance, and with performance metrics as close to bare metal as possible.
Some of the recommended configuration settings for the highest possible performance cannot be set automatically; manually setting them before running the virtual machine is recommended.
The following configuration changes are set automatically:
- Enable headless mode.
- Enable serial console.
- Enable pass-through host CPU.
- Enable I/O threads.
- Enable I/O threads pinning and set the pinning topology.
- Enable the paravirtualized random number generator PCI (virtio-rng) device.
- Disable all USB devices.
- Disable the soundcard device.
- Disable the smartcard device.
- Disable the memory balloon device.
- Disable the watchdog device.
- Disable migration.
- Disable high availability.
The following recommended configuration changes have to be set manually by the user:
- Enable CPU pinning topology.
- Enable non-uniform memory access (NUMA) pinning topology.
- Enable and set huge pages configuration.
- Disable kernel same-page merging (KSM).
7.324.3. server
The virtual machine is intended to be used as a server.
Currently, its implication is that a sound device will not automatically be added to the virtual machine.
7.325. VnicPassThrough struct
Table 7.423. Attributes summary
Name | Type | Summary |
---|---|---|
| Defines whether the vNIC will be implemented as a virtual device, or as a pass-through to a host device. |
7.326. VnicPassThroughMode enum
Describes whether the vNIC is to be implemented as a pass-through device or a virtual one.
Table 7.424. Values summary
Name | Summary |
---|---|
| To be implemented as a virtual device. |
| To be implemented as a pass-through device. |
7.327. VnicProfile struct
A vNIC profile is a collection of settings that can be applied to individual NIC.
Table 7.425. Attributes summary
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 passthrough to an SR-IOV-enabled host NIC. | |
| Enables port mirroring. |
7.327.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 a request, by default, this will be set to true
.
When migrating a virtual machine, this virtual machine will be migrated only if all pass_through
NICs are flagged as migratable
.
7.327.2. pass_through
Enables passthrough to an 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.
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.327.3. port_mirroring
Enables port mirroring.
Port mirroring copies layer 3 network traffic on a given logical network and 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 machines on the same host and logical network. The only traffic copied is internal to one logical network on one host. There is no increase in 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 linking a 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.
Table 7.426. Links summary
Name | Type | Summary |
---|---|---|
| Failover vNIC profile for SR-IOV migration without downtime | |
| Reference to the network that the vNIC profile is applied to. | |
| Reference to the top-level network filter that applies 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.327.4. network_filter
Reference to the top-level network filter that applies to the NICs that use this profile.
Network filters enhance the ability to manage the network packets traffic to and from virtual machines. The network filter may either contain a reference to other filters, rules for traffic filtering, or a combination of both.
7.327.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.328. VnicProfileMapping struct
Deprecated type that 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 |
---|---|---|
|
|
|
|
|
|
The following form is deprecated since 4.2.1 and will be removed in the future:
<vnic_profile_mappings> <vnic_profile_mapping> <source_network_name>red</source_network_name> <source_network_profile_name>gold</source_network_profile_name> <target_vnic_profile id="738dd914-8ec8-4a8b-8628-34672a5d449b"/> </vnic_profile_mapping> <vnic_profile_mapping> <source_network_name>blue</source_network_name> <source_network_profile_name>silver</source_network_profile_name> <target_vnic_profile id="892a12ec-2028-4451-80aa-ff3bf55d6bac"/> </vnic_profile_mapping> </vnic_profile_mappings>
Table 7.427. Attributes summary
7.328.1. source_network_name
Deprecated attribute describing the name of the external network.
Please note that this attribute has been deprecated since version 4.2.1 of the engine, and preserved only for backward compatibility. It will be removed in the future.
7.328.2. source_network_profile_name
Deprecated attribute describing the name of the external network profile.
Please note that this attribute has been deprecated since version 4.2.1 of the engine, and preserved only for backward compatibility. It will be removed in the future.
Table 7.428. Links summary
Name | Type | Summary |
---|---|---|
| Deprecated attribute describing an existing virtual NIC profile. |
7.328.3. target_vnic_profile
Deprecated attribute describing an existing virtual NIC profile.
Please note that this attribute has been deprecated since version 4.2.1 of the engine, and preserved only for backward compatibility. It will be removed in the future.
7.329. VolumeGroup struct
Table 7.429. Attributes summary
Name | Type | Summary |
---|---|---|
| ||
| ||
|
7.330. Watchdog struct
This type represents a watchdog configuration.
Table 7.430. Attributes summary
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.330.1. model
Model of watchdog device. Currently supported only I6300ESB.
Table 7.431. Links summary
Name | Type | Summary |
---|---|---|
| Optionally references to an instance type the device is used by. | |
| Optionally references to a template the device is used by. | |
|
Do not use this element, use | |
| Vm[] | References to the virtual machines that are using this device. |
7.330.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.331. WatchdogAction enum
This type describes available watchdog actions.
Table 7.432. Values summary
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.331.1. none
No action will be performed when watchdog action is triggered. However log message will still be generated.
7.332. WatchdogModel enum
This type represents the watchdog model.
Table 7.433. Values summary
Name | Summary |
---|---|
| The watchdog model for S390X machines. |
| PCI based watchdog model. |
7.332.1. diag288
The watchdog model for S390X machines.
S390X has an integrated watchdog facility that is controlled via the DIAG288 instruction. Use this model for S390X virtual machines.
7.332.2. i6300esb
PCI based watchdog model.
Use the I6300ESB watchdog for x86_64 and PPC64 virtual machines.
7.333. Weight struct
Table 7.434. Attributes summary
Table 7.435. Links summary
Name | Type | Summary |
---|---|---|
| ||
|