Chapter 6. Types - Red Hat Customer Portal

6.1. AccessProtocol enum

Table 6.1. Values summary

Name	Summary
`cifs`
`gluster`
`nfs`

6.2. Action struct

Table 6.2. Attributes summary

Name	Type	Summary
`async`	Boolean
`bricks`	GlusterBrick[]
`certificates`	Certificate[]
`check_connectivity`	Boolean
`clone`	Boolean
`cluster`	Cluster
`collapse_snapshots`	Boolean
`comment`	String	Free text containing comments about this object.
`connectivity_timeout`	Integer
`data_center`	DataCenter
`deploy_hosted_engine`	Boolean
`description`	String	A human-readable description in plain text.
`details`	GlusterVolumeProfileDetails
`discard_snapshots`	Boolean
`disk`	Disk
`disks`	Disk[]
`exclusive`	Boolean
`fault`	Fault
`fence_type`	String
`filter`	Boolean
`fix_layout`	Boolean
`force`	Boolean
`grace_period`	GracePeriod
`host`	Host
`id`	String	A unique identifier.
`image`	String
`import_as_template`	Boolean
`is_attached`	Boolean
`iscsi`	IscsiDetails
`iscsi_targets`	String[]
`job`	Job
`logical_units`	LogicalUnit[]
`maintenance_enabled`	Boolean
`modified_bonds`	HostNic[]
`modified_labels`	NetworkLabel[]
`modified_network_attachments`	NetworkAttachment[]
`name`	String	A human-readable name in plain text.
`option`	Option
`pause`	Boolean
`power_management`	PowerManagement
`proxy_ticket`	ProxyTicket
`reason`	String
`removed_bonds`	HostNic[]
`removed_labels`	NetworkLabel[]
`removed_network_attachments`	NetworkAttachment[]
`resolution_type`	String
`restore_memory`	Boolean
`root_password`	String
`snapshot`	Snapshot
`ssh`	Ssh
`status`	String
`stop_gluster_service`	Boolean
`storage_domain`	StorageDomain
`storage_domains`	StorageDomain[]
`succeeded`	Boolean
`synchronized_network_attachments`	NetworkAttachment[]
`template`	Template
`ticket`	Ticket
`undeploy_hosted_engine`	Boolean
`use_cloud_init`	Boolean
`use_sysprep`	Boolean
`virtual_functions_configuration`	HostNicVirtualFunctionsConfiguration
`vm`	Vm

6.3. AffinityGroup struct

An affinity group represents a group of virtual machines with a defined relationship.

Table 6.3. Attributes summary

Name	Type	Summary
`comment`	String	Free text containing comments about this object.
`description`	String	A human-readable description in plain text.
`enforcing`	Boolean	Specifies whether the affinity group uses hard or soft enforcement of the affinity applied to virtual machines that are members of that affinity group.
`id`	String	A unique identifier.
`name`	String	A human-readable name in plain text.
`positive`	Boolean	Specifies whether the affinity group applies positive affinity or negative affinity to virtual machines that are members of that affinity group.

Table 6.4. Links summary

Name	Type	Summary
`cluster`	Cluster	A reference to the cluster to which the affinity group applies.
`vms`	Vm[]	A list of all virtual machines assigned to this affinity group.

6.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 6.5. Attributes summary

Name	Type	Summary
`comment`	String	Free text containing comments about this object.
`description`	String	A human-readable description in plain text.
`id`	String	A unique identifier.
`name`	String	A human-readable name in plain text.
`read_only`	Boolean	The `read_only` property marks a label that can not be modified.

6.4.1. read_only

The read_only property marks a label that can not be modified. This is usually the case when listing internally-generated labels.

Table 6.6. Links summary

Name	Type	Summary
`hosts`	Host[]	A list of hosts that were labeled using this scheduling label.
`vms`	Vm[]	A list of virtual machines that were labeled using this scheduling label.

6.5. Agent struct

Type representing a fence agent.

Table 6.7. Attributes summary

Name	Type	Summary
`address`	String	Fence agent address.
`comment`	String	Free text containing comments about this object.
`concurrent`	Boolean	Specifies whether the agent should be used concurrently or sequentially.
`description`	String	A human-readable description in plain text.
`encrypt_options`	Boolean	Specifies whether the options should be encrypted.
`id`	String	A unique identifier.
`name`	String	A human-readable name in plain text.
`options`	Option[]	Fence agent options (comma-delimited list of key-value pairs).
`order`	Integer	The order of this agent if used with other agents.
`password`	String	Fence agent password.
`port`	Integer	Fence agent port.
`type`	String	Fence agent type.
`username`	String	Fence agent user name.

Table 6.8. Links summary

Name	Type	Summary
`host`	Host	Reference to the host service.

6.5.1. host

Reference to the host service. Each fence agent belongs to a single host.

6.6. AgentConfiguration struct

Table 6.9. Attributes summary

Name	Type	Summary
`address`	String
`broker_type`	MessageBrokerType
`network_mappings`	String
`password`	String
`port`	Integer
`username`	String

6.7. 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 6.10. Attributes summary

Name	Type	Summary
`product_info`	ProductInfo	Information about the product, such as its name, the name of the vendor, and the version.
`special_objects`	SpecialObjects	References to special objects, such as the blank template and the root of the hierarchy of tags.
`summary`	ApiSummary	A summary containing the total number of relevant objects, such as virtual machines, hosts, and storage domains.
`time`	Date	The date and time when this information was generated.

6.8. ApiSummary struct

A summary containing the total number of relevant objects, such as virtual machines, hosts, and storage domains.

Table 6.11. Attributes summary

Name	Type	Summary
`hosts`	ApiSummaryItem	The summary of hosts.
`storage_domains`	ApiSummaryItem	The summary of storage domains.
`users`	ApiSummaryItem	The summary of users.
`vms`	ApiSummaryItem	The summary of virtual machines.

6.9. ApiSummaryItem struct

This type contains an item of the API summary. Each item contains the total and active number of some kind of object.

Table 6.12. Attributes summary

Name	Type	Summary
`active`	Integer	The total number of active objects.
`total`	Integer	The total number of objects.

6.10. Application struct

Table 6.13. Attributes summary

Name	Type	Summary
`comment`	String	Free text containing comments about this object.
`description`	String	A human-readable description in plain text.
`id`	String	A unique identifier.
`name`	String	A human-readable name in plain text.

Table 6.14. Links summary

Name	Type	Summary
`vm`	Vm

6.11. Architecture enum

Table 6.15. Values summary

Name	Summary
`ppc64`
`undefined`
`x86_64`

6.12. AuthorizedKey struct

Table 6.16. Attributes summary

Name	Type	Summary
`comment`	String	Free text containing comments about this object.
`description`	String	A human-readable description in plain text.
`id`	String	A unique identifier.
`key`	String
`name`	String	A human-readable name in plain text.

Table 6.17. Links summary

Name	Type	Summary
`user`	User

6.13. AutoNumaStatus enum

Table 6.18. Values summary

Name	Summary
`disable`
`enable`
`unknown`

6.14. Balance struct

Table 6.19. Attributes summary

Name	Type	Summary
`comment`	String	Free text containing comments about this object.
`description`	String	A human-readable description in plain text.
`id`	String	A unique identifier.
`name`	String	A human-readable name in plain text.

Table 6.20. Links summary

Name	Type	Summary
`scheduling_policy`	SchedulingPolicy
`scheduling_policy_unit`	SchedulingPolicyUnit

6.15. Bios struct

Table 6.21. Attributes summary

Name	Type	Summary
`boot_menu`	BootMenu

6.16. BlockStatistic struct

Table 6.22. Attributes summary

Name	Type	Summary
`statistics`	Statistic[]

6.17. Bonding struct

Represents a network interfaces bond.

Table 6.23. Attributes summary

Name	Type	Summary
`ad_partner_mac`	Mac	The `ad_partner_mac` property of the partner bond in mode 4.
`options`	Option[]	A list of option elements for a bonded interface.
`slaves`	HostNic[]	A list of slave NICs for a bonded interface.

6.17.1. ad_partner_mac

The ad_partner_mac property of the partner bond in mode 4. Bond mode 4 is the 802.3ad standard, also called dynamic link aggregation - Wikipedia, Presentation. 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.

6.17.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.

6.17.3. slaves

A list of slave NICs for a bonded interface. Only required when adding bonded interfaces.

6.18. Bookmark struct

Table 6.24. Attributes summary

Name	Type	Summary
`comment`	String	Free text containing comments about this object.
`description`	String	A human-readable description in plain text.
`id`	String	A unique identifier.
`name`	String	A human-readable name in plain text.
`value`	String

6.19. Boot struct

Table 6.25. Attributes summary

Name	Type	Summary
`devices`	BootDevice[]

6.20. BootDevice enum

Table 6.26. Values summary

Name	Summary
`cdrom`
`hd`
`network`

6.21. BootMenu struct

Table 6.27. Attributes summary

Name	Type	Summary
`enabled`	Boolean

6.22. BootProtocol enum

Defines the options of the IP address assignment method to a NIC.

Table 6.28. Values summary

Name	Summary
`autoconf`	Stateless address auto-configuration.
`dhcp`	Dynamic host configuration protocol.
`none`	No address configuration.
`static`	Statically-defined address, mask and gateway.

6.22.1. autoconf

Stateless address auto-configuration.

The mechanism is defined by RFC 4862. Please refer to this wikipedia article for more information.

Note

The value is valid for IPv6 addresses only.

6.22.2. dhcp

Dynamic host configuration protocol.

Please refer to this wikipedia article for more information.

6.23. BrickProfileDetail struct

Table 6.29. Attributes summary

Name	Type	Summary
`profile_details`	ProfileDetail[]

Table 6.30. Links summary

Name	Type	Summary
`brick`	GlusterBrick

6.24. Cdrom struct

Table 6.31. Attributes summary

Name	Type	Summary
`comment`	String	Free text containing comments about this object.
`description`	String	A human-readable description in plain text.
`file`	File
`id`	String	A unique identifier.
`name`	String	A human-readable name in plain text.

Table 6.32. Links summary

Name	Type	Summary
`instance_type`	InstanceType	Optionally references to an instance type the device is used by.
`template`	Template	Optionally references to a template the device is used by.
`vm`	Vm	Don’t use this element, use `vms` instead.
`vms`	Vm[]	References to the virtual machines that are using this device.

6.24.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.

6.25. Certificate struct

Table 6.33. Attributes summary

Name	Type	Summary
`comment`	String	Free text containing comments about this object.
`content`	String
`description`	String	A human-readable description in plain text.
`id`	String	A unique identifier.
`name`	String	A human-readable name in plain text.
`organization`	String
`subject`	String

6.26. CloudInit struct

Table 6.34. Attributes summary

Name	Type	Summary
`authorized_keys`	AuthorizedKey[]
`files`	File[]
`host`	Host
`network_configuration`	NetworkConfiguration
`regenerate_ssh_keys`	Boolean
`timezone`	String
`users`	User[]

6.27. 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",
    "ha_reservation" : "false",
    "ksm" : {
      "enabled" : "true",
      "merge_across_nodes" : "true"
    },
    "maintenance_reason_required" : "false",
    "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"
      }
    },
    "optional_reason" : "false",
    "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"
    } ]
  } ]
}

Table 6.35. Attributes summary

Name	Type	Summary
`ballooning_enabled`	Boolean
`comment`	String	Free text containing comments about this object.
`cpu`	Cpu
`custom_scheduling_policy_properties`	Property[]	Custom scheduling policy properties of the cluster.
`description`	String	A human-readable description in plain text.
`display`	Display
`error_handling`	ErrorHandling
`fencing_policy`	FencingPolicy	Custom fencing policy can be defined for a cluster.
`gluster_service`	Boolean
`ha_reservation`	Boolean
`id`	String	A unique identifier.
`ksm`	Ksm
`maintenance_reason_required`	Boolean
`memory_policy`	MemoryPolicy
`migration`	MigrationOptions
`name`	String	A human-readable name in plain text.
`optional_reason`	Boolean
`required_rng_sources`	RngSource[]
`serial_number`	SerialNumber
`supported_versions`	Version[]
`switch_type`	SwitchType	Type of switch to be used by all networks in given cluster.
`threads_as_cores`	Boolean
`trusted_service`	Boolean
`tunnel_migration`	Boolean
`version`	Version	The compatibility version of the cluster.
`virt_service`	Boolean

6.27.1. custom_scheduling_policy_properties

Custom scheduling policy properties of the cluster. These optional properties override the properties of the scheduling policy specified by the scheduling_policy link, and apply only for this specific cluster.

For example, to update the custom properties of the cluster, send a request:

PUT /ovirt-engine/api/clusters/123

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.

6.27.2. fencing_policy

Custom fencing policy can be defined for a cluster.

Here is an example:

PUT /ovirt-engine/api/cluster/123

With request body:

<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>

6.27.3. 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:

<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:

<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.

Table 6.36. Links summary

Name	Type	Summary
`affinity_groups`	AffinityGroup[]
`cpu_profiles`	CpuProfile[]
`data_center`	DataCenter
`gluster_hooks`	GlusterHook[]
`gluster_volumes`	GlusterVolume[]
`management_network`	Network
`network_filters`	NetworkFilter[]
`networks`	Network[]
`permissions`	Permission[]
`scheduling_policy`	SchedulingPolicy	Reference to the default scheduling policy used by this cluster.

6.27.4. scheduling_policy

Reference to the default scheduling policy used by this cluster.

Note

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.

6.28. ClusterLevel struct

Describes the capabilities supported by a specific cluster level.

Table 6.37. Attributes summary

Name	Type	Summary
`comment`	String	Free text containing comments about this object.
`cpu_types`	CpuType[]	The CPU types supported by this cluster level.
`description`	String	A human-readable description in plain text.
`id`	String	A unique identifier.
`name`	String	A human-readable name in plain text.
`permits`	Permit[]	The permits supported by this cluster level.

6.29. Configuration struct

Table 6.38. Attributes summary

Name	Type	Summary
`data`	String	The document describing the virtual machine.
`type`	ConfigurationType

6.29.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>

6.30. ConfigurationType enum

Table 6.39. Values summary

Name	Summary
`ovf`

6.31. Console struct

Table 6.40. Attributes summary

Name	Type	Summary
`enabled`	Boolean

6.32. Core struct

Table 6.41. Attributes summary

Name	Type	Summary
`index`	Integer
`socket`	Integer

6.33. Cpu struct

Table 6.42. Attributes summary

Name	Type	Summary
`architecture`	Architecture
`cores`	Core[]
`cpu_tune`	CpuTune
`level`	Integer
`mode`	CpuMode
`name`	String
`speed`	Decimal
`topology`	CpuTopology
`type`	String

6.34. CpuMode enum

Table 6.43. Values summary

Name	Summary
`custom`
`host_model`
`host_passthrough`

6.35. CpuProfile struct

Table 6.44. Attributes summary

Name	Type	Summary
`comment`	String	Free text containing comments about this object.
`description`	String	A human-readable description in plain text.
`id`	String	A unique identifier.
`name`	String	A human-readable name in plain text.

Table 6.45. Links summary

Name	Type	Summary
`cluster`	Cluster
`permissions`	Permission[]
`qos`	Qos

6.36. CpuTopology struct

Table 6.46. Attributes summary

Name	Type	Summary
`cores`	Integer
`sockets`	Integer
`threads`	Integer

6.37. CpuTune struct

Table 6.47. Attributes summary

Name	Type	Summary
`vcpu_pins`	VcpuPin[]

6.38. CpuType struct

Describes a supported CPU type.

Table 6.48. Attributes summary

Name	Type	Summary
`architecture`	Architecture	The architecture of the CPU.
`level`	Integer	The level of the CPU type.
`name`	String	The name of the CPU type, for example `Intel Conroe Family`.

6.39. CreationStatus enum

Table 6.49. Values summary

Name	Summary
`complete`
`failed`
`in_progress`
`pending`

6.40. CustomProperty struct

Table 6.50. Attributes summary

Name	Type	Summary
`name`	String
`regexp`	String
`value`	String

6.41. DataCenter struct

Table 6.51. Attributes summary

Name	Type	Summary
`comment`	String	Free text containing comments about this object.
`description`	String	A human-readable description in plain text.
`id`	String	A unique identifier.
`local`	Boolean
`name`	String	A human-readable name in plain text.
`quota_mode`	QuotaModeType
`status`	DataCenterStatus
`storage_format`	StorageFormat
`supported_versions`	Version[]
`version`	Version	The compatibility version of the data center.

6.41.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 6.52. Links summary

Name	Type	Summary
`clusters`	Cluster[]	Reference to clusters inside this data center.
`iscsi_bonds`	IscsiBond[]	Reference to ISCSI bonds used by this data center.
`mac_pool`	MacPool	Reference to the MAC pool used by this data center.
`networks`	Network[]	Reference to networks attached to this data center.
`permissions`	Permission[]	Reference to permissions assigned to this data center.
`qoss`	Qos[]	Reference to quality of service used by this data center.
`quotas`	Quota[]	Reference to quotas assigned to this data center.
`storage_domains`	StorageDomain[]	Reference to storage domains attached to this data center.

6.42. DataCenterStatus enum

Table 6.53. Values summary

Name	Summary
`contend`
`maintenance`
`not_operational`
`problematic`
`uninitialized`
`up`

6.43. Device struct

A device wraps links to potential parents of a device.

Table 6.54. Attributes summary

Name	Type	Summary
`comment`	String	Free text containing comments about this object.
`description`	String	A human-readable description in plain text.
`id`	String	A unique identifier.
`name`	String	A human-readable name in plain text.

Table 6.55. Links summary

Name	Type	Summary
`instance_type`	InstanceType	Optionally references to an instance type the device is used by.
`template`	Template	Optionally references to a template the device is used by.
`vm`	Vm	Don’t use this element, use `vms` instead.
`vms`	Vm[]	References to the virtual machines that are using this device.

6.43.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.

6.44. Disk struct

Represents a virtual disk device.

Table 6.56. Attributes summary

Name	Type	Summary
`active`	Boolean	Indicates if the disk is visible to the virtual machine.
`actual_size`	Integer	The actual size of the disk, in bytes.
`alias`	String
`bootable`	Boolean	Indicates if the disk is marked as bootable.
`comment`	String	Free text containing comments about this object.
`description`	String	A human-readable description in plain text.
`format`	DiskFormat	The underlying storage format.
`id`	String	A unique identifier.
`image_id`	String
`interface`	DiskInterface	The type of interface driver used to connect the disk device to the virtual machine.
`logical_name`	String
`lun_storage`	HostStorage
`name`	String	A human-readable name in plain text.
`propagate_errors`	Boolean	Indicates if disk errors should not cause virtual machine to be paused and, instead, disk errors should be propagated to the the guest operating system.
`provisioned_size`	Integer	The virtual size of the disk, in bytes.
`read_only`	Boolean	Indicates if the disk is in read-only mode.
`sgio`	ScsiGenericIO
`shareable`	Boolean	Indicates if the disk can be attached to multiple virtual machines.
`sparse`	Boolean	Indicates if the physical storage for the disk should not be preallocated.
`status`	DiskStatus	The status of the disk device.
`storage_type`	DiskStorageType
`uses_scsi_reservation`	Boolean
`wipe_after_delete`	Boolean	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.

6.44.1. active

Indicates if the disk is visible to the virtual machine.

Important

When adding a disk attachment to a virtual machine, the server accepts requests that don’t contain this attribute, but the effect is then undefined. In some cases the disk will be automatically activated and in other cases it won’t. To avoid issues it is strongly recommended to always include the this attribute with the desired value.

6.44.2. actual_size

The actual size of the disk, in bytes.

The actual size is the number of bytes actually used by the disk, and it will be smaller than the provisioned size for disks that use the cow format.

6.44.3. bootable

Indicates if the disk is marked as bootable.

Important

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.

6.44.4. interface

The type of interface driver used to connect the disk device to the virtual machine.

Important

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.

6.44.5. provisioned_size

The virtual size of the disk, in bytes.

This attribute is mandatory when creating a new disk.

6.44.6. shareable

Indicates if the disk can be attached to multiple virtual machines.

Important

When a disk is attached to multiple virtual machines it is the responsibility of the guest operating systems of those virtual machines to coordinate access to it, to avoid corruption of the data, for example using a shared file system like GlusterFS or GFS.

6.44.7. 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 6.57. Links summary

Name	Type	Summary
`disk_profile`	DiskProfile
`instance_type`	InstanceType	Optionally references to an instance type the device is used by.
`openstack_volume_type`	OpenStackVolumeType
`permissions`	Permission[]
`quota`	Quota
`snapshot`	Snapshot
`statistics`	Statistic[]	Statistics exposed by the disk.
`storage_domain`	StorageDomain
`storage_domains`	StorageDomain[]	The storage domains associated with this disk.
`template`	Template	Optionally references to a template the device is used by.
`vm`	Vm	Don’t use this element, use `vms` instead.
`vms`	Vm[]	References to the virtual machines that are using this device.

6.44.8. 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 aren’t directly included when the disk is retrieved, only a link. To obtain the statistics follow that link:

GET /ovirt-engine/api/disks/123/statistics

6.44.9. storage_domains

The storage domains associated with this disk.

Note

Only required when the first disk is being added to a virtual machine that was not itself created from a template.

6.44.10. 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.

6.45. DiskAttachment struct

Describes how a disk is attached to a virtual machine.

Table 6.58. Attributes summary

Name	Type	Summary
`active`	Boolean	This flag indicates if the disk is active in the virtual machine it’s attached to.
`bootable`	Boolean	Defines whether the disk is bootable.
`comment`	String	Free text containing comments about this object.
`description`	String	A human-readable description in plain text.
`id`	String	A unique identifier.
`interface`	DiskInterface	The type of interface driver used to connect the disk device to the virtual machine.
`logical_name`	String	The logical name of the virtual machine’s disk, as seen from inside the virtual machine.
`name`	String	A human-readable name in plain text.

6.45.1. active

This flag indicates if 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.

6.45.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.

Table 6.59. Links summary

Name	Type	Summary
`disk`	Disk	The reference to the disk.
`template`	Template	The reference to the template.
`vm`	Vm	The reference to the virtual machine.

6.46. DiskFormat enum

The underlying storage format of disks.

Table 6.60. Values summary

Name	Summary
`cow`	The Copy On Write format allows snapshots, with a small performance overhead.
`raw`	The raw format does not allow snapshots, but offers improved performance.

6.47. DiskInterface enum

Table 6.61. Values summary

Name	Summary
`ide`
`spapr_vscsi`
`virtio`
`virtio_scsi`

6.48. DiskProfile struct

Table 6.62. Attributes summary

Name	Type	Summary
`comment`	String	Free text containing comments about this object.
`description`	String	A human-readable description in plain text.
`id`	String	A unique identifier.
`name`	String	A human-readable name in plain text.

Table 6.63. Links summary

Name	Type	Summary
`permissions`	Permission[]
`qos`	Qos
`storage_domain`	StorageDomain

6.49. DiskSnapshot struct

Table 6.64. Attributes summary

Name	Type	Summary
`active`	Boolean	Indicates if the disk is visible to the virtual machine.
`actual_size`	Integer	The actual size of the disk, in bytes.
`alias`	String
`bootable`	Boolean	Indicates if the disk is marked as bootable.
`comment`	String	Free text containing comments about this object.
`description`	String	A human-readable description in plain text.
`format`	DiskFormat	The underlying storage format.
`id`	String	A unique identifier.
`image_id`	String
`interface`	DiskInterface	The type of interface driver used to connect the disk device to the virtual machine.
`logical_name`	String
`lun_storage`	HostStorage
`name`	String	A human-readable name in plain text.
`propagate_errors`	Boolean	Indicates if disk errors should not cause virtual machine to be paused and, instead, disk errors should be propagated to the the guest operating system.
`provisioned_size`	Integer	The virtual size of the disk, in bytes.
`read_only`	Boolean	Indicates if the disk is in read-only mode.
`sgio`	ScsiGenericIO
`shareable`	Boolean	Indicates if the disk can be attached to multiple virtual machines.
`sparse`	Boolean	Indicates if the physical storage for the disk should not be preallocated.
`status`	DiskStatus	The status of the disk device.
`storage_type`	DiskStorageType
`uses_scsi_reservation`	Boolean
`wipe_after_delete`	Boolean	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.

6.49.1. active

Indicates if the disk is visible to the virtual machine.

Important

When adding a disk attachment to a virtual machine, the server accepts requests that don’t contain this attribute, but the effect is then undefined. In some cases the disk will be automatically activated and in other cases it won’t. To avoid issues it is strongly recommended to always include the this attribute with the desired value.

6.49.2. actual_size

The actual size of the disk, in bytes.

The actual size is the number of bytes actually used by the disk, and it will be smaller than the provisioned size for disks that use the cow format.

6.49.3. bootable

Indicates if the disk is marked as bootable.

Important

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.

6.49.4. interface

The type of interface driver used to connect the disk device to the virtual machine.

Important

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.

6.49.5. provisioned_size

The virtual size of the disk, in bytes.

This attribute is mandatory when creating a new disk.

6.49.6. shareable

Indicates if the disk can be attached to multiple virtual machines.

Important

When a disk is attached to multiple virtual machines it is the responsibility of the guest operating systems of those virtual machines to coordinate access to it, to avoid corruption of the data, for example using a shared file system like GlusterFS or GFS.

6.49.7. 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 6.65. Links summary

Name	Type	Summary
`disk`	Disk
`disk_profile`	DiskProfile
`instance_type`	InstanceType	Optionally references to an instance type the device is used by.
`openstack_volume_type`	OpenStackVolumeType
`permissions`	Permission[]
`quota`	Quota
`snapshot`	Snapshot
`statistics`	Statistic[]	Statistics exposed by the disk.
`storage_domain`	StorageDomain
`storage_domains`	StorageDomain[]	The storage domains associated with this disk.
`template`	Template	Optionally references to a template the device is used by.
`vm`	Vm	Don’t use this element, use `vms` instead.
`vms`	Vm[]	References to the virtual machines that are using this device.

6.49.8. 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 aren’t directly included when the disk is retrieved, only a link. To obtain the statistics follow that link:

GET /ovirt-engine/api/disks/123/statistics

6.49.9. storage_domains

The storage domains associated with this disk.

Note

Only required when the first disk is being added to a virtual machine that was not itself created from a template.

6.49.10. 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.

6.50. DiskStatus enum

Table 6.66. Values summary

Name	Summary
`illegal`
`locked`
`ok`

6.51. DiskStorageType enum

Table 6.67. Values summary

Name	Summary
`cinder`
`image`
`lun`

6.52. DiskType enum

Table 6.68. Values summary

Name	Summary
`data`
`system`

6.53. Display struct

Table 6.69. Attributes summary

Name	Type	Summary
`address`	String
`allow_override`	Boolean
`certificate`	Certificate
`copy_paste_enabled`	Boolean
`disconnect_action`	String
`file_transfer_enabled`	Boolean
`keyboard_layout`	String
`monitors`	Integer
`port`	Integer
`proxy`	String
`secure_port`	Integer
`single_qxl_pci`	Boolean
`smartcard_enabled`	Boolean
`type`	DisplayType

6.54. DisplayType enum

Table 6.70. Values summary

Name	Summary
`spice`
`vnc`

6.55. Dns struct

Represents the DNS resolver configuration.

Table 6.71. Attributes summary

Name	Type	Summary
`search_domains`	Host[]	Array of hosts serving as search domains.
`servers`	Host[]	Array of hosts serving as DNS servers.

6.56. Domain struct

This type represents a directory service domain.

Table 6.72. Attributes summary

Name	Type	Summary
`comment`	String	Free text containing comments about this object.
`description`	String	A human-readable description in plain text.
`id`	String	A unique identifier.
`name`	String	A human-readable name in plain text.
`user`	User

Table 6.73. Links summary

Name	Type	Summary
`groups`	Group[]	A reference to all groups in the directory service.
`users`	User[]	A reference to a list of all users in the directory service.

6.56.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.

6.57. EntityExternalStatus enum

Type representing an external entity status.

Table 6.74. Values summary

Name	Summary
`error`	The external entity status is erroneous.
`failure`	The external entity has an issue that causes failures.
`info`	There external entity status is okay but with some information that might be relevant.
`ok`	The external entity status is okay.
`warning`	The external entity status is okay but with an issue that might require attention.

6.57.1. error

The external entity status is erroneous. This might require a moderate attention.

6.57.2. failure

The external entity has an issue that causes failures. This might require immediate attention.

6.58. EntityProfileDetail struct

Table 6.75. Attributes summary

Name	Type	Summary
`profile_details`	ProfileDetail[]

6.59. ErrorHandling struct

Table 6.76. Attributes summary

Name	Type	Summary
`on_error`	MigrateOnError

6.60. Event struct

Type representing an event.

Table 6.77. Attributes summary

Name	Type	Summary
`code`	Integer	The event code.
`comment`	String	Free text containing comments about this object.
`correlation_id`	String	The event correlation identifier.
`custom_data`	String	Free text representing custom event data.
`custom_id`	Integer	A custom event identifier.
`description`	String	A human-readable description in plain text.
`flood_rate`	Integer	Defines the flood rate.
`id`	String	A unique identifier.
`name`	String	A human-readable name in plain text.
`origin`	String	Free text identifying the origin of the event.
`severity`	LogSeverity	The event severity.
`time`	Date	The event time.

6.60.1. correlation_id

The event correlation identifier. Used in order to correlate several events together.

6.60.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.

Table 6.78. Links summary

Name	Type	Summary
`cluster`	Cluster	Reference to the cluster service.
`data_center`	DataCenter	Reference to the data center service.
`host`	Host	Reference to the host service.
`storage_domain`	StorageDomain	Reference to the storage domain service.
`template`	Template	Reference to the template service.
`user`	User	Reference to the user service.
`vm`	Vm	Reference to the virtual machine service.

6.60.3. cluster

Reference to the cluster service. Event can be associated with a cluster.

6.60.4. data_center

Reference to the data center service. Event can be associated with a data center.

6.60.5. host

Reference to the host service. Event can be associated with a host.

6.60.6. storage_domain

Reference to the storage domain service. Event can be associated with a storage domain.

6.60.7. template

Reference to the template service. Event can be associated with a template.

6.60.8. user

Reference to the user service. Event can be associated with a user.

6.60.9. vm

Reference to the virtual machine service. Event can be associated with a virtual machine.

6.61. ExternalComputeResource struct

Table 6.79. Attributes summary

Name	Type	Summary
`comment`	String	Free text containing comments about this object.
`description`	String	A human-readable description in plain text.
`id`	String	A unique identifier.
`name`	String	A human-readable name in plain text.
`provider`	String
`url`	String
`user`	String

Table 6.80. Links summary

Name	Type	Summary
`external_host_provider`	ExternalHostProvider

6.62. ExternalDiscoveredHost struct

Table 6.81. Attributes summary

Name	Type	Summary
`comment`	String	Free text containing comments about this object.
`description`	String	A human-readable description in plain text.
`id`	String	A unique identifier.
`ip`	String
`last_report`	String
`mac`	String
`name`	String	A human-readable name in plain text.
`subnet_name`	String

Table 6.82. Links summary

Name	Type	Summary
`external_host_provider`	ExternalHostProvider

6.63. ExternalHost struct

Table 6.83. Attributes summary

Name	Type	Summary
`address`	String
`comment`	String	Free text containing comments about this object.
`description`	String	A human-readable description in plain text.
`id`	String	A unique identifier.
`name`	String	A human-readable name in plain text.

Table 6.84. Links summary

Name	Type	Summary
`external_host_provider`	ExternalHostProvider

6.64. ExternalHostGroup struct

Table 6.85. Attributes summary

Name	Type	Summary
`architecture_name`	String
`comment`	String	Free text containing comments about this object.
`description`	String	A human-readable description in plain text.
`domain_name`	String
`id`	String	A unique identifier.
`name`	String	A human-readable name in plain text.
`operating_system_name`	String
`subnet_name`	String

Table 6.86. Links summary

Name	Type	Summary
`external_host_provider`	ExternalHostProvider

6.65. ExternalHostProvider struct

Table 6.87. Attributes summary

Name	Type	Summary
`authentication_url`	String	Defines the external provider authentication URL address.
`comment`	String	Free text containing comments about this object.
`description`	String	A human-readable description in plain text.
`id`	String	A unique identifier.
`name`	String	A human-readable name in plain text.
`password`	String	Defines password for the user during the authentication process.
`properties`	Property[]	Array of provider name/value properties.
`requires_authentication`	Boolean	Defines whether provider authentication is required or not.
`url`	String	Defines URL address of the external provider.
`username`	String	Defines user name to be used during authentication process.

6.65.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 6.88. Links summary

Name	Type	Summary
`certificates`	Certificate[]
`compute_resources`	ExternalComputeResource[]
`discovered_hosts`	ExternalDiscoveredHost[]
`host_groups`	ExternalHostGroup[]
`hosts`	Host[]

6.66. ExternalProvider struct

Represents an external provider.

Table 6.89. Attributes summary

Name	Type	Summary
`authentication_url`	String	Defines the external provider authentication URL address.
`comment`	String	Free text containing comments about this object.
`description`	String	A human-readable description in plain text.
`id`	String	A unique identifier.
`name`	String	A human-readable name in plain text.
`password`	String	Defines password for the user during the authentication process.
`properties`	Property[]	Array of provider name/value properties.
`requires_authentication`	Boolean	Defines whether provider authentication is required or not.
`url`	String	Defines URL address of the external provider.
`username`	String	Defines user name to be used during authentication process.

6.66.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.

6.67. ExternalStatus enum

Table 6.90. Values summary

Name	Summary
`error`
`failure`
`info`
`ok`
`warning`

6.68. ExternalSystemType enum

Represents the type of the external system that is associated with the step.

Table 6.91. Values summary

Name	Summary
`gluster`	Represents `Gluster` as the external system which is associated with the `step`.
`vdsm`	Represents `VDSM` as the external system which is associated with the `step`.

6.69. ExternalVmImport struct

Describes parameters of virtual machine import operation from external system.

Table 6.92. Attributes summary

Name	Type	Summary
`name`	String	Name of the virtual machine to be imported as is defined within the external system.
`password`	String	Password to authenticate against external hypervisor system.
`provider`	ExternalVmProviderType	Type of external virtual machine provider.
`sparse`	Boolean	Specifies the disk allocation policy of resulting virtual machine: `true` for sparse, `false` for preallocated.
`url`	String	URL to be passed to the `virt-v2v` tool for conversion.
`username`	String	Username to authenticate against external hypervisor system.

6.69.1. url

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 6.93. Links summary

Name	Type	Summary
`cluster`	Cluster	Specifies the target cluster of the resulting virtual machine.
`cpu_profile`	CpuProfile	Optionally specifies the cpu profile of the resulting virtual machine.
`drivers_iso`	File	Optional name of ISO carrying drivers that can be used during the virt-v2v conversion process.
`host`	Host	Optional specification of host (using host’s ID) to be used for the conversion process.
`quota`	Quota	Optionally specifies the quota that will be applied to the resulting virtual machine.
`storage_domain`	StorageDomain	Specifies the target storage domain for converted disks.
`vm`	Vm	Virtual machine entity used to specify the name of the newly created virtual machine.

6.69.2. host

Optional specification of host (using host’s ID) to be used for the conversion process. If not specified, one is selected automatically.

6.69.3. vm

Virtual machine entity used to specify the name of the newly created virtual machine.

If name is not specified, the source virtual machine name will be used.

6.70. ExternalVmProviderType enum

Describes type of external hypervisor system.

Table 6.94. Values summary

Name	Summary
`kvm`
`vmware`
`xen`

6.71. Fault struct

Table 6.95. Attributes summary

Name	Type	Summary
`detail`	String
`reason`	String

6.72. FenceType enum

Type representing the type of the fence operation.

Table 6.96. Values summary

Name	Summary
`manual`	Manual host fencing via power management.
`restart`	Restart the host via power management.
`start`	Start the host via power management.
`status`	Check the host power status via power management.
`stop`	Stop the host via power management.

6.73. FencingPolicy struct

Type representing a cluster fencing policy.

Table 6.97. Attributes summary

Name	Type	Summary
`enabled`	Boolean	Enable or disable fencing on this cluster.
`skip_if_connectivity_broken`	SkipIfConnectivityBroken	If enabled, we will not fence a host in case more than a configurable percentage of hosts in the cluster lost connectivity as well.
`skip_if_sd_active`	SkipIfSdActive	If enabled, we will skip fencing in case the host maintains its lease in the storage.

6.73.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.

6.73.2. 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.

6.74. File struct

Table 6.98. Attributes summary

Name	Type	Summary
`comment`	String	Free text containing comments about this object.
`content`	String
`description`	String	A human-readable description in plain text.
`id`	String	A unique identifier.
`name`	String	A human-readable name in plain text.
`type`	String

Table 6.99. Links summary

Name	Type	Summary
`storage_domain`	StorageDomain

6.75. Filter struct

Table 6.100. Attributes summary

Name	Type	Summary
`comment`	String	Free text containing comments about this object.
`description`	String	A human-readable description in plain text.
`id`	String	A unique identifier.
`name`	String	A human-readable name in plain text.
`position`	Integer

Table 6.101. Links summary

Name	Type	Summary
`scheduling_policy_unit`	SchedulingPolicyUnit

6.76. Floppy struct

Table 6.102. Attributes summary

Name	Type	Summary
`comment`	String	Free text containing comments about this object.
`description`	String	A human-readable description in plain text.
`file`	File
`id`	String	A unique identifier.
`name`	String	A human-readable name in plain text.

Table 6.103. Links summary

Name	Type	Summary
`instance_type`	InstanceType	Optionally references to an instance type the device is used by.
`template`	Template	Optionally references to a template the device is used by.
`vm`	Vm	Don’t use this element, use `vms` instead.
`vms`	Vm[]	References to the virtual machines that are using this device.

6.76.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.

6.77. FopStatistic struct

Table 6.104. Attributes summary

Name	Type	Summary
`name`	String
`statistics`	Statistic[]

6.78. GlusterBrick struct

Table 6.105. Attributes summary

Name	Type	Summary
`brick_dir`	String
`comment`	String	Free text containing comments about this object.
`description`	String	A human-readable description in plain text.
`device`	String
`fs_name`	String
`gluster_clients`	GlusterClient[]
`id`	String	A unique identifier.
`memory_pools`	GlusterMemoryPool[]
`mnt_options`	String
`name`	String	A human-readable name in plain text.
`pid`	Integer
`port`	Integer
`server_id`	String
`status`	GlusterBrickStatus

Table 6.106. Links summary

Name	Type	Summary
`gluster_volume`	GlusterVolume
`instance_type`	InstanceType	Optionally references to an instance type the device is used by.
`statistics`	Statistic[]
`template`	Template	Optionally references to a template the device is used by.
`vm`	Vm	Don’t use this element, use `vms` instead.
`vms`	Vm[]	References to the virtual machines that are using this device.

6.78.1. vms

References to the virtual machines that are using this device. A device may be used by several virtual machines; for example, a shared disk my be used simultaneously by two or more virtual machines.

6.79. GlusterBrickAdvancedDetails struct

Table 6.107. Attributes summary

Name	Type	Summary
`comment`	String	Free text containing comments about this object.
`description`	String	A human-readable description in plain text.
`device`	String
`fs_name`	String
`gluster_clients`	GlusterClient[]
`id`	String	A unique identifier.
`memory_pools`	GlusterMemoryPool[]
`mnt_options`	String
`name`	String	A human-readable name in plain text.
`pid`	Integer
`port`	Integer

Table 6.108. Links summary

Name	Type	Summary
`instance_type`	InstanceType	Optionally references to an instance type the device is used by.
`template`	Template	Optionally references to a template the device is used by.
`vm`	Vm	Don’t use this element, use `vms` instead.
`vms`	Vm[]	References to the virtual machines that are using this device.

6.79.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.

6.80. GlusterBrickMemoryInfo struct

Table 6.109. Attributes summary

Name	Type	Summary
`memory_pools`	GlusterMemoryPool[]

6.81. GlusterBrickStatus enum

Table 6.110. Values summary

Name	Summary
`down`	Brick is in `down` state, the data cannot be stored or retrieved from it.
`unknown`	When the status cannot be determined due to host being non-responsive.
`up`	Brick is in `up` state, the data can be stored or retrieved from it.

6.82. GlusterClient struct

Table 6.111. Attributes summary

Name	Type	Summary
`bytes_read`	Integer
`bytes_written`	Integer
`client_port`	Integer
`host_name`	String

6.83. GlusterHook struct

Table 6.112. Attributes summary

Name	Type	Summary
`checksum`	String
`comment`	String	Free text containing comments about this object.
`conflict_status`	Integer
`conflicts`	String
`content`	String
`content_type`	HookContentType
`description`	String	A human-readable description in plain text.
`gluster_command`	String
`id`	String	A unique identifier.
`name`	String	A human-readable name in plain text.
`stage`	HookStage
`status`	GlusterHookStatus

Table 6.113. Links summary

Name	Type	Summary
`cluster`	Cluster
`server_hooks`	GlusterServerHook[]

6.84. GlusterHookStatus enum

Table 6.114. Values summary

Name	Summary
`disabled`	Hook is disabled in the cluster.
`enabled`	Hook is enabled in the cluster.
`missing`	Unknown/missing hook status.

6.85. GlusterMemoryPool struct

Table 6.115. Attributes summary

Name	Type	Summary
`alloc_count`	Integer
`cold_count`	Integer
`comment`	String	Free text containing comments about this object.
`description`	String	A human-readable description in plain text.
`hot_count`	Integer
`id`	String	A unique identifier.
`max_alloc`	Integer
`max_stdalloc`	Integer
`name`	String	A human-readable name in plain text.
`padded_size`	Integer
`pool_misses`	Integer
`type`	String

6.86. GlusterServerHook struct

Table 6.116. Attributes summary

Name	Type	Summary
`checksum`	String
`comment`	String	Free text containing comments about this object.
`content_type`	HookContentType
`description`	String	A human-readable description in plain text.
`id`	String	A unique identifier.
`name`	String	A human-readable name in plain text.
`status`	GlusterHookStatus

Table 6.117. Links summary

Name	Type	Summary
`host`	Host

6.87. GlusterState enum

Table 6.118. Values summary

Name	Summary
`down`
`unknown`
`up`

6.88. GlusterVolume struct

Table 6.119. Attributes summary

Name	Type	Summary
`comment`	String	Free text containing comments about this object.
`description`	String	A human-readable description in plain text.
`disperse_count`	Integer
`id`	String	A unique identifier.
`name`	String	A human-readable name in plain text.
`options`	Option[]
`redundancy_count`	Integer
`replica_count`	Integer
`status`	GlusterVolumeStatus
`stripe_count`	Integer
`transport_types`	TransportType[]
`volume_type`	GlusterVolumeType

Table 6.120. Links summary

Name	Type	Summary
`bricks`	GlusterBrick[]
`cluster`	Cluster
`statistics`	Statistic[]

6.89. GlusterVolumeProfileDetails struct

Table 6.121. Attributes summary

Name	Type	Summary
`brick_profile_details`	BrickProfileDetail[]
`comment`	String	Free text containing comments about this object.
`description`	String	A human-readable description in plain text.
`id`	String	A unique identifier.
`name`	String	A human-readable name in plain text.
`nfs_profile_details`	NfsProfileDetail[]

6.90. GlusterVolumeStatus enum

Table 6.122. Values summary

Name	Summary
`down`	Volume needs to be started, for clients to be able to mount and use it.
`unknown`	When the status cannot be determined due to host being non-responsive.
`up`	Volume is started, and can be mounted and used by clients.

6.91. GlusterVolumeType enum

Type representing the type of Gluster Volume.

Table 6.123. Values summary

Name	Summary
`disperse`	Dispersed volumes are based on erasure codes, providing space-efficient protection against disk or server failures.
`distribute`	Distributed volumes distributes files throughout the bricks in the volume.
`distributed_disperse`	Distributed dispersed volumes distribute files across dispersed subvolumes.
`distributed_replicate`	Distributed replicated volumes distributes files across replicated bricks in the volume.
`distributed_stripe`	Distributed striped volumes stripe data across two or more nodes in the cluster.
`distributed_striped_replicate`	Distributed striped replicated volumes distributes striped data across replicated bricks in the cluster.
`replicate`	Replicated volumes replicates files across bricks in the volume.
`stripe`	Striped volumes stripes data across bricks in the volume.
`striped_replicate`	Striped replicated volumes stripes data across replicated bricks in the cluster.

6.91.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.

6.91.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.

6.91.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.

6.91.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.

6.91.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.

6.91.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.

6.91.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.

6.91.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.

6.91.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.

6.92. GracePeriod struct

Table 6.124. Attributes summary

Name	Type	Summary
`expiry`	Integer

6.93. GraphicsConsole struct

Table 6.125. Attributes summary

Name	Type	Summary
`address`	String
`comment`	String	Free text containing comments about this object.
`description`	String	A human-readable description in plain text.
`id`	String	A unique identifier.
`name`	String	A human-readable name in plain text.
`port`	Integer
`protocol`	GraphicsType
`tls_port`	Integer

Table 6.126. Links summary

Name	Type	Summary
`instance_type`	InstanceType
`template`	Template
`vm`	Vm

6.94. GraphicsType enum

Table 6.127. Values summary

Name	Summary
`spice`
`vnc`

6.95. Group struct

This type represents all groups in the directory service.

Table 6.128. Attributes summary

Name	Type	Summary
`comment`	String	Free text containing comments about this object.
`description`	String	A human-readable description in plain text.
`domain_entry_id`	String	The containing directory service domain id.
`id`	String	A unique identifier.
`name`	String	A human-readable name in plain text.
`namespace`	String	Namespace where group resides.

Table 6.129. Links summary

Name	Type	Summary
`domain`	Domain	A link to the domain containing this group.
`permissions`	Permission[]	A link to the permissions sub-collection for permissions attached to this group.
`roles`	Role[]	A link to the roles sub-collection for roles attached to this group.
`tags`	Tag[]	A link to the tags sub-collection for tags attached to this group.

6.95.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 are only supported via the roles sub-collection.

6.96. GuestOperatingSystem struct

Table 6.130. Attributes summary

Name	Type	Summary
`architecture`	String
`codename`	String
`distribution`	String
`family`	String
`kernel`	Kernel
`version`	Version

6.97. HardwareInformation struct

Table 6.131. Attributes summary

Name	Type	Summary
`family`	String
`manufacturer`	String
`product_name`	String
`serial_number`	String
`supported_rng_sources`	RngSource[]
`uuid`	String
`version`	String

6.98. HighAvailability struct

Table 6.132. Attributes summary

Name	Type	Summary
`enabled`	Boolean
`priority`	Integer

6.99. Hook struct

Table 6.133. Attributes summary

Name	Type	Summary
`comment`	String	Free text containing comments about this object.
`description`	String	A human-readable description in plain text.
`event_name`	String
`id`	String	A unique identifier.
`md5`	String
`name`	String	A human-readable name in plain text.

Table 6.134. Links summary

Name	Type	Summary
`host`	Host

6.100. HookContentType enum

Represents content type of hook script.

Table 6.135. Values summary

Name	Summary
`binary`	Binary content type of the hook.
`text`	Text content type of the hook.

6.101. HookStage enum

Table 6.136. Values summary

Name	Summary
`post`
`pre`

6.102. HookStatus enum

Type represents the status of a hook.

Table 6.137. Values summary

Name	Summary
`disabled`	Hook is disabled.
`enabled`	Hook is enabled.
`missing`	Hook is missing.

6.103. Host struct

Type representing a host.

Table 6.138. Attributes summary

Name	Type	Summary
`address`	String	The host address (FQDN/IP).
`auto_numa_status`	AutoNumaStatus	The host auto non uniform memory access (NUMA) status.
`certificate`	Certificate	The host certificate.
`comment`	String	Free text containing comments about this object.
`cpu`	Cpu	The CPU type of this host.
`description`	String	A human-readable description in plain text.
`device_passthrough`	HostDevicePassthrough	Specifies whether host device passthrough is enabled on this host.
`display`	Display	Optionally specify the display address of this host explicitly.
`external_status`	ExternalStatus	The host external status.
`hardware_information`	HardwareInformation	The host hardware information.
`hosted_engine`	HostedEngine	The hosted engine status on this host.
`id`	String	A unique identifier.
`iscsi`	IscsiDetails	The host iSCSI details.
`kdump_status`	KdumpStatus	The host KDUMP status.
`ksm`	Ksm	Kernel SamePage Merging (KSM) reduces references to memory pages from multiple identical pages to a single page reference.
`libvirt_version`	Version	The host libvirt version.
`max_scheduling_memory`	Integer	The max scheduling memory on this host in bytes.
`memory`	Integer	The amount of physical memory on this host in bytes.
`name`	String	A human-readable name in plain text.
`numa_supported`	Boolean	Specifies whether non uniform memory access (NUMA) is supported on this host.
`os`	OperatingSystem	The operating system on this host.
`override_iptables`	Boolean	Specifies whether we should override firewall definitions.
`port`	Integer	The host port.
`power_management`	PowerManagement	The host power management definitions.
`protocol`	HostProtocol	The protocol that the engine uses to communicate with the host.
`root_password`	String	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.
`se_linux`	SeLinux	The host SElinux status.
`spm`	Spm	The host storage pool manager (SPM) status and definition.
`ssh`	Ssh	The SSH definitions.
`status`	HostStatus	The host status.
`status_detail`	String	The host status details.
`summary`	VmSummary	The virtual machine summary - how many are active, migrating and total.
`transparent_huge_pages`	TransparentHugePages	Transparent huge page support expands the size of memory pages beyond the standard 4 KiB limit.
`type`	HostType	Indicates if the host contains a full installation of the operating system or a scaled-down version intended only to host virtual machines.
`update_available`	Boolean	Specifies whether there is an oVirt-related update on this host.
`version`	Version	The version of VDSM.

6.103.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.

6.103.2. kdump_status

The host KDUMP status. KDUMP happens when the host kernel has crashed and it is now going through memory dumping.

6.103.3. ksm

Kernel SamePage Merging (KSM) reduces references to memory pages from multiple identical pages to a single page reference. This helps with optimization for memory density.

For example, to enable KSM for host 123, send a request like this:

PUT /ovirt-engine/api/hosts/123

With a request body like this:

<host>
  <ksm>
    <enabled>true</enabled>
  </ksm>
</host>

6.103.4. libvirt_version

The host libvirt version. For more information on libvirt please go to libvirt.

6.103.5. override_iptables

Specifies whether we should override firewall definitions. This applies only when the host is installed or re-installed.

6.103.6. 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.

6.103.7. 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.

6.103.8. status_detail

The host status details. Relevant for Gluster hosts.

6.103.9. 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>

6.103.10. 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 6.139. Links summary

Name	Type	Summary
`affinity_labels`	AffinityLabel[]
`agents`	Agent[]
`cluster`	Cluster
`devices`	Device[]
`external_host_provider`	ExternalHostProvider
`hooks`	Hook[]
`katello_errata`	KatelloErratum[]	Lists all the Katello errata assigned to the host.
`network_attachments`	NetworkAttachment[]
`nics`	Nic[]
`numa_nodes`	NumaNode[]
`permissions`	Permission[]
`statistics`	Statistic[]	Each host resource exposes a statistics sub-collection for host-specific statistics.
`storage_connection_extensions`	StorageConnectionExtension[]
`storages`	HostStorage[]
`tags`	Tag[]
`unmanaged_networks`	UnmanagedNetwork[]

6.103.11. 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>

6.103.12. 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>

Note

This statistics sub-collection is read-only.

The following list shows the statistic types for hosts:

Name	Description
`memory.total`	Total memory in bytes on the host.
`memory.used`	Memory in bytes used on the host.
`memory.free`	Memory in bytes free on the host.
`memory.shared`	Memory in bytes shared on the host.
`memory.buffers`	I/O buffers in bytes.
`memory.cached`	OS caches in bytes.
`swap.total`	Total swap memory in bytes on the host.
`swap.free`	Swap memory in bytes free on the host.
`swap.used`	Swap memory in bytes used on the host.
`swap.cached`	Swap memory in bytes also cached in host’s memory.
`ksm.cpu.current`	Percentage of CPU usage for Kernel SamePage Merging.
`cpu.current.user`	Percentage of CPU usage for user slice.
`cpu.current.system`	Percentage of CPU usage for system.
`cpu.current.idle`	Percentage of idle CPU usage.
`cpu.load.avg.5m`	CPU load average per five minutes.
`boot.time`	Boot time of the machine.

6.104. HostDevice struct

Table 6.140. Attributes summary

Name	Type	Summary
`capability`	String
`comment`	String	Free text containing comments about this object.
`description`	String	A human-readable description in plain text.
`id`	String	A unique identifier.
`iommu_group`	Integer
`name`	String	A human-readable name in plain text.
`physical_function`	HostDevice
`placeholder`	Boolean
`product`	Product
`vendor`	Vendor
`virtual_functions`	Integer

Table 6.141. Links summary

Name	Type	Summary
`host`	Host
`parent_device`	HostDevice
`vm`	Vm

6.105. HostDevicePassthrough struct

Table 6.142. Attributes summary

Name	Type	Summary
`enabled`	Boolean

6.106. 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 6.143. Attributes summary

Name	Type	Summary
`ad_aggregator_id`	Integer	The `ad_aggregator_id` property of a bond or bond slave, for bonds in mode 4.
`base_interface`	String	The base interface of the NIC.
`bonding`	Bonding	The bonding parameters of the NIC.
`boot_protocol`	BootProtocol	The IPv4 boot protocol configuration of the NIC.
`bridged`	Boolean	Defines the bridged network status.
`check_connectivity`	Boolean
`comment`	String	Free text containing comments about this object.
`custom_configuration`	Boolean
`description`	String	A human-readable description in plain text.
`id`	String	A unique identifier.
`ip`	Ip	The IPv4 address of the NIC.
`ipv6`	Ip	The IPv6 address of the NIC.
`ipv6_boot_protocol`	BootProtocol	The IPv6 boot protocol configuration of the NIC.
`mac`	Mac	The MAC address of the NIC.
`mtu`	Integer	The maximum transmission unit for the interface.
`name`	String	A human-readable name in plain text.
`network_labels`	NetworkLabel[]	The labels that are applied to this NIC.
`override_configuration`	Boolean
`properties`	Property[]
`speed`	Integer
`statistics`	Statistic[]	A link to the statistics of the NIC.
`status`	NicStatus
`virtual_functions_configuration`	HostNicVirtualFunctionsConfiguration	For a SR-IOV physical function NIC describes its virtual functions configuration.
`vlan`	Vlan

6.106.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 - Wikipedia Presentation. This is only valid for bonds in mode 4, or NICs (NIC - network interface card) which are part of a bond. It is not present for bonds in other modes, or NICs which are not part in 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 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 /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.

6.106.2. bridged

Defines the bridged network status. Set to true for a bridged network and false for a bridgeless network.

6.106.3. statistics

A link to the statistics of the NIC.

The data types for HostNic statistical values:

data.current.rx - The rate in bytes per second of data received.
data.current.tx - The rate in bytes per second of data transmitted.
data.total.rx - Total received data.
data.total.tx - Total transmitted data.
errors.total.rx - Total errors from receiving data.
errors.total.tx - Total errors from transmitting data.

Table 6.144. Links summary

Name	Type	Summary
`host`	Host
`network`	Network	A reference to the network which the interface should be connected.
`physical_function`	HostNic	For a SR-IOV virtual function NIC references to its physical function NIC.
`qos`	Qos	A link to the quality-of-service configuration of the interface.

6.106.4. network

A reference to the network which the interface should be connected. A blank network id is allowed.

6.107. HostNicVirtualFunctionsConfiguration struct

Describes virtual functions configuration for an SR-IOV enabled physical function NIC.

Table 6.145. Attributes summary

Name	Type	Summary
`all_networks_allowed`	Boolean	Defines whether all networks are allowed to be defined on the related virtual functions or specified ones only.
`max_number_of_virtual_functions`	Integer	Maximum number of virtual functions the NIC supports.
`number_of_virtual_functions`	Integer	Number of currently defined virtual functions.

6.107.1. max_number_of_virtual_functions

Maximum number of virtual functions the NIC supports. Read-only property.

6.107.2. number_of_virtual_functions

Number of currently defined virtual functions. User-defined value between 0 and maxNumberOfVirtualFunctions.

6.108. HostProtocol enum

The protocol used by the engine to communicate with a host.

Table 6.146. Values summary

Name	Summary
`stomp`	JSON-RPC protocol on top of STOMP.
`xml`	XML-RPC protocol.

6.109. HostStatus enum

Type representing a host status.

Table 6.147. Values summary

Name	Summary
`connecting`	The engine cannot communicate with the host for a specific threshold so it is now trying to connect before going through fencing.
`down`	The host is down.
`error`	The host is in error status.
`initializing`	The host is initializing.
`install_failed`	The host installation failed.
`installing`	The host is being installed.
`installing_os`	The host operating system is now installing.
`kdumping`	The host kernel has crashed and it is now going through memory dumping.
`maintenance`	The host is in maintenance status.
`non_operational`	The host is non operational.
`non_responsive`	The host is not responsive.
`pending_approval`	The host is pending administrator approval.
`preparing_for_maintenance`	The host is preparing for maintenance.
`reboot`	The host is being rebooted.
`unassigned`	The host is in activation process.
`up`	The host is up.

6.109.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.

6.109.2. initializing

The host is initializing. This is an intermediate step before moving the host to 'up' status.

6.109.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.

6.109.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).

6.109.5. maintenance

The host is in maintenance status. When a host is in maintenance it cannot run virtual machines.

6.109.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.

6.109.7. non_responsive

The host is not responsive. This means that the engine is not able to communicate with the host.

6.109.8. pending_approval

The host is pending administrator approval. This is relevant only for vintage ovirt-node / RHV-H.

6.109.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.

6.110. HostStorage struct

Table 6.148. Attributes summary

Name	Type	Summary
`address`	String
`comment`	String	Free text containing comments about this object.
`description`	String	A human-readable description in plain text.
`id`	String	A unique identifier.
`logical_units`	LogicalUnit[]
`mount_options`	String
`name`	String	A human-readable name in plain text.
`nfs_retrans`	Integer	The number of times to retry a request before attempting further recovery actions.
`nfs_timeo`	Integer	The time in tenths of a second to wait for a response before retrying NFS requests.
`nfs_version`	NfsVersion
`override_luns`	Boolean
`password`	String
`path`	String
`port`	Integer
`portal`	String
`target`	String
`type`	StorageType
`username`	String
`vfs_type`	String
`volume_group`	VolumeGroup

6.110.1. nfs_retrans

The number of times to retry a request before attempting further recovery actions. The value must be in the range of 0 to 65535. For more details see the description of the retrans mount option in the nfs man page.

6.110.2. nfs_timeo

The time in tenths of a second to wait for a response before retrying NFS requests. The value must be in the range of 0 to 65535. For more details see the description of the timeo mount option in the nfs man page.

Table 6.149. Links summary

Name	Type	Summary
`host`	Host

6.111. HostType enum

This enumerated type is used to what type of operating system is used by the host.

Table 6.150. Values summary

Name	Summary
`ovirt_node`	The host is NGN (Next Generation Node) - a new implementation of RHEV_H which is like RHEL, CentOS or Fedora installation.
`rhel`	The host contains a full RHEL, CentOS or Fedora installation.
`rhev_h`	The host contains a small scaled version of RHEL, CentOS or Fedora, used solely to host virtual machines.

6.111.1. ovirt_node

The host is NGN (Next Generation Node) - a new implementation of RHEV_H which is like RHEL, CentOS or Fedora installation. The main difference between NGN and legacy RHEV-H is that NGN has a writeable file system and will handle its installation instead of pushing RPMs to it by the engine in legacy RHEV-H.

6.112. HostedEngine struct

Table 6.151. Attributes summary

Name	Type	Summary
`active`	Boolean
`configured`	Boolean
`global_maintenance`	Boolean
`local_maintenance`	Boolean
`score`	Integer

6.113. Icon struct

Icon of virtual machine or template.

Table 6.152. Attributes summary

Name	Type	Summary
`comment`	String	Free text containing comments about this object.
`data`	String	Base64 encode content of the icon file.
`description`	String	A human-readable description in plain text.
`id`	String	A unique identifier.
`media_type`	String	Format of icon file.
`name`	String	A human-readable name in plain text.

6.113.1. media_type

Format of icon file.

One of:

image/jpeg
image/png
image/gif

6.114. Identified struct

This interface is the base model for all types that represent objects with an identifier.

Table 6.153. Attributes summary

Name	Type	Summary
`comment`	String	Free text containing comments about this object.
`description`	String	A human-readable description in plain text.
`id`	String	A unique identifier.
`name`	String	A human-readable name in plain text.

6.115. Image struct

Table 6.154. Attributes summary

Name	Type	Summary
`comment`	String	Free text containing comments about this object.
`description`	String	A human-readable description in plain text.
`id`	String	A unique identifier.
`name`	String	A human-readable name in plain text.

Table 6.155. Links summary

Name	Type	Summary
`storage_domain`	StorageDomain

6.116. ImageTransfer struct

This type contains information regarding an image transfer being performed.

Table 6.156. Attributes summary

Name	Type	Summary
`comment`	String	Free text containing comments about this object.
`description`	String	A human-readable description in plain text.
`id`	String	A unique identifier.
`name`	String	A human-readable name in plain text.
`phase`	ImageTransferPhase	The current phase of the image transfer in progress.
`proxy_url`	String	The URL of the proxy server that the user inputs or outputs to.
`signed_ticket`	String	The signed ticket that should be attached as an `Authentication` header in the HTTPS request for the proxy server to input or output to (See the `proxy_url` attribute).

6.116.1. 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.

6.116.2. proxy_url

The URL of the proxy server that the user inputs or outputs to. This attribute is available only if the image transfer entity is in the transferring phase. See phase for details.

Table 6.157. Links summary

Name	Type	Summary
`host`	Host	The host which will be used to write to the image which is targeted for input or output.
`image`	Image	The image which is targeted for I/O.

6.117. 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 6.158. Values summary

Name	Summary
`cancelled`	This phase will be set as a result of the user cancelling the transfer.
`finalizing_failure`	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.
`finalizing_success`	This phase will be set when the user calls finalize.
`finished_failure`	Indicates that the targeted image failed the verification, and cannot be used.
`finished_success`	Indicates that the transfer session was successfully closed, and the targeted image was verified and ready to be used.
`initializing`	The initial phase of an image transfer.
`paused_system`	This phase means the session timed out, or some other error occurred with this transfer; for example ovirt-imageio-daemon is not running in the selected host.
`paused_user`	This phase is a result of a pause call by the user, using pause.
`resuming`	The phase where the transfer has been resumed by the client calling resume.
`transferring`	The phase where the transfer session is open, and the client can input or output the desired image using the preferred tools.
`unknown`	An unknown phase.

6.117.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.

6.117.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.

6.117.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.

6.117.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.

6.117.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

6.117.6. paused_system

This phase means the session timed out, or some other error occurred with this transfer; for example ovirt-imageio-daemon is not running in the selected host. To resume the session, the client should call resume. After resuming, the phase will change to resuming.

6.117.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.

6.117.8. unknown

An unknown phase. This will only be set in cases of unpredictable errors.

6.118. 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 6.159. Values summary

Name	Summary
`false`	Set the value to false on this level.
`inherit`	Inherit the value from higher level.
`true`	Set the value to true on this level.

6.119. Initialization struct

Table 6.160. Attributes summary

Name	Type	Summary
`active_directory_ou`	String
`authorized_ssh_keys`	String
`cloud_init`	CloudInit
`configuration`	Configuration
`custom_script`	String
`dns_search`	String
`dns_servers`	String
`domain`	String
`host_name`	String
`input_locale`	String
`nic_configurations`	NicConfiguration[]
`org_name`	String
`regenerate_ids`	Boolean
`regenerate_ssh_keys`	Boolean
`root_password`	String
`system_locale`	String
`timezone`	String
`ui_language`	String
`user_locale`	String
`user_name`	String
`windows_license_key`	String

6.120. 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

Note

An instance type inherits it’s attributes from the template entity although most template attributes are not used in instance types.

Table 6.161. Attributes summary

Name	Type	Summary
`bios`	Bios	Reference to virtual machine’s BIOS configuration.
`comment`	String	Free text containing comments about this object.
`console`	Console	Console configured for this virtual machine.
`cpu`	Cpu	The configuration of the virtual machine CPU.
`cpu_shares`	Integer
`creation_time`	Date	The virtual machine creation date.
`custom_compatibility_version`	Version	Virtual machine custom compatibility version.
`custom_cpu_model`	String
`custom_emulated_machine`	String
`custom_properties`	CustomProperty[]	Properties sent to VDSM to configure various hooks.
`delete_protected`	Boolean	If `true`, the virtual machine cannot be deleted.
`description`	String	A human-readable description in plain text.
`display`	Display	The virtual machine display configuration.
`domain`	Domain	Domain configured for this virtual machine.
`high_availability`	HighAvailability	The virtual machine high availability configuration.
`id`	String	A unique identifier.
`initialization`	Initialization	Reference to virtual machine’s initialization configuration.
`io`	Io	For performance tuning of IO threading.
`large_icon`	Icon	Virtual machine’s large icon.
`memory`	Integer	The virtual machine’s memory, in bytes.
`memory_policy`	MemoryPolicy	Reference to virtual machine’s memory management configuration.
`migration`	MigrationOptions	Reference to configuration of migration of running virtual machine to another host.
`migration_downtime`	Integer	Maximum time the virtual machine can be non responsive during its live migration to another host in ms.
`name`	String	A human-readable name in plain text.
`origin`	String	The origin of this virtual machine.
`os`	OperatingSystem	Operating system type installed on the virtual machine.
`rng_device`	RngDevice	Random Number Generator device configuration for this virtual machine.
`serial_number`	SerialNumber	Virtual machine’s serial number in a cluster.
`small_icon`	Icon	Virtual machine’s small icon.
`soundcard_enabled`	Boolean	If `true`, the sound card is added to the virtual machine.
`sso`	Sso	Reference to the Single Sign On configuration this virtual machine is configured for.
`start_paused`	Boolean	If `true`, the virtual machine will be initially in 'paused' state after start.
`stateless`	Boolean	If `true`, the virtual machine is stateless - it’s state (disks) are rolled-back after shutdown.
`status`	TemplateStatus	The status of the template.
`time_zone`	TimeZone	The virtual machine’s time zone set by oVirt.
`tunnel_migration`	Boolean	If `true`, the network data transfer will be encrypted during virtual machine live migration.
`type`	VmType	Determines whether the virtual machine is optimized for desktop or server.
`usb`	Usb	Configuration of USB devices for this virtual machine (count, type).
`version`	TemplateVersion	Indicates whether this is a base version or a sub version of another template.
`virtio_scsi`	VirtioScsi	Reference to VirtIO SCSI configuration.
`vm`	Vm	The virtual machine configuration associated with this template.

6.120.1. cpu

The configuration of the virtual machine CPU.

The socket configuration can be updated without rebooting the virtual machine. The cores and the threads require a reboot.

For example, to change the number of sockets to 4 immediately, and the number of cores and threads to 2 after reboot, send the following request:

PUT /ovirt-engine/api/vms/123

With a request body:

<vm>
  <cpu>
    <topology>
      <sockets>4</sockets>
      <cores>2</cores>
      <threads>2</threads>
    </topology>
  </cpu>
</vm>

6.120.2. custom_compatibility_version

Virtual machine custom compatibility version.

Enables a virtual machine to be customized to its own compatibility version. If custom_compatibility_version is set, it overrides the cluster’s compatibility version for this particular virtual machine.

The compatibility version of a virtual machine is limited by the data center the virtual machine resides in, and is checked against capabilities of the host the virtual machine is planned to run on.

6.120.3. high_availability

The virtual machine high availability configuration. If set, the virtual machine will be automatically restarted when it unexpectedly goes down.

6.120.4. large_icon

Virtual machine’s large icon. Either set by user or refers to image set according to operating system.

6.120.5. 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>

Note

Memory in the example is converted to bytes using the following formula:
1 GiB = 2³⁰ bytes = 1073741824 bytes.

Note

Memory hot plug is supported from Red Hat Virtualization 3.6 onwards. You can use the example above to increase memory while the virtual machine is running.

6.120.6. 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]

6.120.7. origin

The origin of this virtual machine.

Possible values:

ovirt
rhev
vmware
xen
external
hosted_engine
managed_hosted_engine
kvm
physical_machine
hyperv

6.120.8. small_icon

Virtual machine’s small icon. Either set by user or refers to image set according to operating system.

6.120.9. 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.

Table 6.162. Links summary

Name	Type	Summary
`cdroms`	Cdrom[]	References to the CD-ROM devices attached to the template.
`cluster`	Cluster	Reference to cluster the virtual machine belongs to.
`cpu_profile`	CpuProfile	Reference to CPU profile used by this virtual machine.
`disk_attachments`	DiskAttachment[]	References to the disks attached to the template.
`graphics_consoles`	GraphicsConsole[]	References to the graphic consoles attached to the template.
`nics`	Nic[]	References to the network interfaces attached to the template.
`permissions`	Permission[]	References to the user permissions attached to the template.
`quota`	Quota	Reference to quota configuration set for this virtual machine.
`storage_domain`	StorageDomain	Reference to storage domain the virtual machine belongs to.
`tags`	Tag[]	References to the tags attached to the template.
`watchdogs`	Watchdog[]	References to the watchdog devices attached to the template.

6.121. Io struct

Table 6.163. Attributes summary

Name	Type	Summary
`threads`	Integer

6.122. Ip struct

Represents the IP configuration of a network interface.

Table 6.164. Attributes summary

Name	Type	Summary
`address`	String	The text representation of the IP address.
`gateway`	String	The address of the default gateway.
`netmask`	String	The network mask.
`version`	IpVersion	The version of the IP protocol.

6.122.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>

6.122.2. version

The version of the IP protocol.

Note

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.

6.123. IpAddressAssignment struct

Table 6.165. Attributes summary

Name	Type	Summary
`assignment_method`	BootProtocol
`ip`	Ip

6.124. IpVersion enum

Defines the values for the IP protocol version.

Table 6.166. Values summary

Name	Summary
`v4`	IPv4.
`v6`	IPv6.

6.125. IscsiBond struct

Table 6.167. Attributes summary

Name	Type	Summary
`comment`	String	Free text containing comments about this object.
`description`	String	A human-readable description in plain text.
`id`	String	A unique identifier.
`name`	String	A human-readable name in plain text.

Table 6.168. Links summary

Name	Type	Summary
`data_center`	DataCenter
`networks`	Network[]
`storage_connections`	StorageConnection[]

6.126. IscsiDetails struct

Table 6.169. Attributes summary

Name	Type	Summary
`address`	String
`disk_id`	String
`initiator`	String
`lun_mapping`	Integer
`password`	String
`paths`	Integer
`port`	Integer
`portal`	String
`product_id`	String
`serial`	String
`size`	Integer
`status`	String
`storage_domain_id`	String
`target`	String
`username`	String
`vendor_id`	String
`volume_group_id`	String

6.127. 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 6.170. Attributes summary

Name	Type	Summary
`auto_cleared`	Boolean	Indicates if the job should be cleared automatically after it was completed by the system.
`comment`	String	Free text containing comments about this object.
`description`	String	A human-readable description in plain text.
`end_time`	Date	The end time of the job.
`external`	Boolean	Indicates if the job is originated by an external system.
`id`	String	A unique identifier.
`last_updated`	Date	The last update date of the job.
`name`	String	A human-readable name in plain text.
`start_time`	Date	The start time of the job.
`status`	JobStatus	The status of the job.

6.127.1. external

Indicates if the job is originated by an external system. External jobs are managed externally, by the creator of the job.

Table 6.171. Links summary

Name	Type	Summary
`owner`	User	The user who is the owner of the job.
`steps`	Step[]	The steps of the job.

6.128. JobStatus enum

Represents the status of the job.

Table 6.172. Values summary

Name	Summary
`aborted`	The aborted job status.
`failed`	The failed job status.
`finished`	The finished job status.
`started`	The started job status.
`unknown`	The unknown job status.

6.128.1. aborted

The aborted job status. This status is applicable for an external job that was forcibly aborted.

6.128.2. finished

The finished job status. This status describes a completed job execution.

6.128.3. started

The started job status. This status represents a job which is currently being executed.

6.128.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.

6.129. KatelloErratum struct

Type representing a Katello erratum.

Table 6.173. Attributes summary

Name	Type	Summary
`comment`	String	Free text containing comments about this object.
`description`	String	A human-readable description in plain text.
`id`	String	A unique identifier.
`issued`	Date	The date when the Katello erratum was issued.
`name`	String	A human-readable name in plain text.
`packages`	Package[]	The list of packages which solve the issue reported by the Katello erratum.
`severity`	String	The severity of the Katello erratum.
`solution`	String	The solution for the issue described by the Katello erratum.
`summary`	String	The summary of the Katello erratum.
`title`	String	The title of the Katello erratum.
`type`	String	The type of the Katello erratum.

6.129.1. severity

The severity of the Katello erratum.

The supported severities are moderate, important or critical.

6.129.2. type

The type of the Katello erratum.

The supported types are bugfix, enhancement or security.

Table 6.174. Links summary

Name	Type	Summary
`host`	Host	Reference to the host that the Katello erratum is assigned to.
`vm`	Vm	Reference to the virtual machine that the Katello erratum is assigned to.

6.130. KdumpStatus enum

Table 6.175. Values summary

Name	Summary
`disabled`
`enabled`
`unknown`

6.131. Kernel struct

Table 6.176. Attributes summary

Name	Type	Summary
`version`	Version

6.132. Ksm struct

Table 6.177. Attributes summary

Name	Type	Summary
`enabled`	Boolean
`merge_across_nodes`	Boolean

6.133. LogSeverity enum

Enum representing a severity of an event.

Table 6.178. Values summary

Name	Summary
`alert`	Alert severity.
`error`	Error severity.
`normal`	Normal severity.
`warning`	Warning severity.

6.133.1. alert

Alert severity. Used to specify a condition that requires an immediate attention.

6.133.2. error

Error severity. Used to specify that there is an error that needs to be examined.

6.133.3. normal

Normal severity. Used for information events.

6.133.4. warning

Warning severity. Used to warn something might be wrong.

6.134. LogicalUnit struct

Table 6.179. Attributes summary

Name	Type	Summary
`address`	String
`disk_id`	String
`id`	String
`lun_mapping`	Integer
`password`	String
`paths`	Integer
`port`	Integer
`portal`	String
`product_id`	String
`serial`	String
`size`	Integer
`status`	LunStatus
`storage_domain_id`	String
`target`	String
`username`	String
`vendor_id`	String
`volume_group_id`	String

6.135. LunStatus enum

Table 6.180. Values summary

Name	Summary
`free`
`unusable`
`used`

6.136. Mac struct

Table 6.181. Attributes summary

Name	Type	Summary
`address`	String

6.137. 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 6.182. Attributes summary

Name	Type	Summary
`allow_duplicates`	Boolean	Defines whether duplicate MAC addresses are permitted in the pool.
`comment`	String	Free text containing comments about this object.
`default_pool`	Boolean	Defines whether this is the default pool.
`description`	String	A human-readable description in plain text.
`id`	String	A unique identifier.
`name`	String	A human-readable name in plain text.
`ranges`	Range[]	Defines the range of MAC addresses for the pool.

6.137.1. allow_duplicates

Defines whether duplicate MAC addresses are permitted in the pool. If not specified, defaults to false.

6.137.2. default_pool

Defines whether this is the default pool. If not specified, defaults to false.

6.137.3. ranges

Defines the range of MAC addresses for the pool. Multiple ranges can be defined.

6.138. MemoryOverCommit struct

Table 6.183. Attributes summary

Name	Type	Summary
`percent`	Integer

6.139. MemoryPolicy struct

Table 6.184. Attributes summary

Name	Type	Summary
`ballooning`	Boolean
`guaranteed`	Integer
`over_commit`	MemoryOverCommit
`transparent_huge_pages`	TransparentHugePages

6.140. MessageBrokerType enum

Table 6.185. Values summary

Name	Summary
`qpid`
`rabbit_mq`

6.141. Method struct

Table 6.186. Attributes summary

Name	Type	Summary
`id`	SsoMethod

6.142. MigrateOnError enum

Table 6.187. Values summary

Name	Summary
`do_not_migrate`
`migrate`
`migrate_highly_available`

6.143. MigrationBandwidth struct

Defines the bandwidth used by migration.

Table 6.188. Attributes summary

Name	Type	Summary
`assignment_method`	MigrationBandwidthAssignmentMethod	The method used to assign the bandwidth.
`custom_value`	Integer	Custom bandwidth in Mbps.

6.143.1. custom_value

Custom bandwidth in Mbps. Will be applied only if the assignmentMethod attribute is custom.

6.144. MigrationBandwidthAssignmentMethod enum

Defines the method how the migration bandwidth is assigned.

Table 6.189. Values summary

Name	Summary
`auto`	Takes the bandwidth from QoS if QoS defined.
`custom`	Custom defined bandwidth in Mbit/s.
`hypervisor_default`	Takes the value as configured on the hypervisor.

6.144.1. auto

Takes the bandwidth from QoS if QoS defined. If not, taken from detected link speed being used. If nothing detected, falls back to hypervisor_default value.

6.145. MigrationOptions struct

Table 6.190. Attributes summary

Name	Type	Summary
`auto_converge`	InheritableBoolean
`bandwidth`	MigrationBandwidth	The bandwidth which is allowed to be used by the migrations.
`compressed`	InheritableBoolean

Table 6.191. Links summary

Name	Type	Summary
`policy`	MigrationPolicy	Reference to the migration policy as defined using `engine-config`.

6.146. MigrationPolicy struct

A policy describing how the migration is going to be treated (convergence, how many parallel migrations allowed).

Table 6.192. Attributes summary

Name	Type	Summary
`comment`	String	Free text containing comments about this object.
`description`	String	A human-readable description in plain text.
`id`	String	A unique identifier.
`name`	String	A human-readable name in plain text.

6.147. Network struct

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 6.193. Attributes summary

Name	Type	Summary
`comment`	String	Free text containing comments about this object.
`description`	String	A human-readable description in plain text.
`display`	Boolean
`id`	String	A unique identifier.
`ip`	Ip
`mtu`	Integer	Specifies the maximum transmission unit for the network.
`name`	String	A human-readable name in plain text.
`profile_required`	Boolean
`required`	Boolean
`status`	NetworkStatus
`stp`	Boolean	Specifies whether spanning tree protocol is enabled for the network.
`usages`	NetworkUsage[]	Defines a set of usage elements for the network.
`vlan`	Vlan

6.147.1. usages

Defines a set of usage elements for the network.

Users can, for example, specify that the network is to be used for virtual machine traffic and also for display traffic with the vm and display values.

Table 6.194. Links summary

Name	Type	Summary
`cluster`	Cluster
`data_center`	DataCenter	A reference to the data center of which the network is a member.
`network_labels`	NetworkLabel[]	A reference to the labels assigned to the network.
`permissions`	Permission[]	A reference to the permissions of the network.
`qos`	Qos
`vnic_profiles`	VnicProfile[]	A reference to the profiles of the network.

6.148. 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>

When attaching a network to a network interface card, the network element is required, with either an id or a name.

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 newtwork 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 newtork 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

Important

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 6.195. Attributes summary

Name	Type	Summary
`comment`	String	Free text containing comments about this object.
`description`	String	A human-readable description in plain text.
`id`	String	A unique identifier.
`in_sync`	Boolean
`ip_address_assignments`	IpAddressAssignment[]	The IP configuration of the network.
`name`	String	A human-readable name in plain text.
`properties`	Property[]	Defines custom properties for the network configuration.
`reported_configurations`	ReportedConfiguration[]	A read-only list of configuration properties.

6.148.1. 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
`forward_delay`	`1500`
`gc_timer`	`3765`
`group_addr`	`1:80:c2:0:0:0`
`group_fwd_mask`	`0x0`
`hash_elasticity`	`4`
`hash_max`	`512`
`hello_time`	`200`
`hello_timer`	`70`
`max_age`	`2000`
`multicast_last_member_count`	`2`
`multicast_last_member_interval`	`100`
`multicast_membership_interval`	`26000`
`multicast_querier`	`0`
`multicast_querier_interval`	`25500`
`multicast_query_interval`	`13000`
`multicast_query_response_interval`	`1000`
`multicast_query_use_ifaddr`	`0`
`multicast_router`	`1`
`multicast_snooping`	`1`
`multicast_startup_query_count`	`2`
`multicast_startup_query_interval`	`3125`

Table 6.196. Links summary

Name	Type	Summary
`host`	Host
`host_nic`	HostNic	A reference to the host network interface.
`network`	Network	A reference to the network to which the interface is attached.
`qos`	Qos

6.149. NetworkConfiguration struct

Table 6.197. Attributes summary

Name	Type	Summary
`dns`	Dns
`nics`	Nic[]

6.150. NetworkFilter struct

Network filter enables to filter packets send to/from the VM’s nic according to defined rules.

There are several types of network filters supported based on libvirt. More details about the different network filters can be found here.

In addition to libvirt’s network filters, there are two additional network filters: The first called vdsm-no-mac-spoofing, composed of no-mac-spoofing and no-arp-mac-spoofing. The second called ovirt-no-filter is used when no network filter is to be defined for the VM’s nic. ovirt-no-filter network filter is only used for internal implementation, and doesn’t 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 6.198. Attributes summary

Name	Type	Summary
`comment`	String	Free text containing comments about this object.
`description`	String	A human-readable description in plain text.
`id`	String	A unique identifier.
`name`	String	A human-readable name in plain text.
`version`	Version	Represent the minimal supported version of the specific NetworkFilter for which it was first introduced.

6.151. NetworkLabel struct

Represents a label which can be added to a host network interface.

Table 6.199. Attributes summary

Name	Type	Summary
`comment`	String	Free text containing comments about this object.
`description`	String	A human-readable description in plain text.
`id`	String	A unique identifier.
`name`	String	A human-readable name in plain text.

Table 6.200. Links summary

Name	Type	Summary
`host_nic`	HostNic
`network`	Network

6.152. NetworkPluginType enum

Table 6.201. Values summary

Name	Summary
`open_vswitch`

6.153. NetworkStatus enum

Table 6.202. Values summary

Name	Summary
`non_operational`
`operational`

6.154. NetworkUsage enum

Table 6.203. Values summary

Name	Summary
`display`
`gluster`	The network will be used for Gluster(bricks) data traffic.
`management`
`migration`
`vm`

6.155. NfsProfileDetail struct

Table 6.204. Attributes summary

Name	Type	Summary
`nfs_server_ip`	String
`profile_details`	ProfileDetail[]

6.156. NfsVersion enum

Table 6.205. Values summary

Name	Summary
`auto`
`v3`
`v4`
`v4_1`

6.157. Nic struct

Represents a NIC of a virtual machine.

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 6.206. Attributes summary

Name	Type	Summary
`boot_protocol`	BootProtocol
`comment`	String	Free text containing comments about this object.
`description`	String	A human-readable description in plain text.
`id`	String	A unique identifier.
`interface`	NicInterface	The type of driver used for the NIC.
`linked`	Boolean	Defines if the NIC is linked to the virtual machine.
`mac`	Mac	The MAC address of the interface.
`name`	String	A human-readable name in plain text.
`on_boot`	Boolean
`plugged`	Boolean	Defines if the NIC is plugged in to the virtual machine.

Table 6.207. Links summary

Name	Type	Summary
`instance_type`	InstanceType	Optionally references to an instance type the device is used by.
`network`	Network	A reference to the network which the interface should be connected to.
`network_attachments`	NetworkAttachment[]
`network_labels`	NetworkLabel[]
`reported_devices`	ReportedDevice[]
`statistics`	Statistic[]	A link to the statistics for the NIC.
`template`	Template	Optionally references to a template the device is used by.
`virtual_function_allowed_labels`	NetworkLabel[]
`virtual_function_allowed_networks`	Network[]
`vm`	Vm	Don’t use this element, use `vms` instead.
`vms`	Vm[]	References to the virtual machines that are using this device.
`vnic_profile`	VnicProfile

6.157.1. network

A reference to the network which 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.

6.157.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.

6.158. NicConfiguration struct

Table 6.208. Attributes summary

Name	Type	Summary
`boot_protocol`	BootProtocol
`ip`	Ip
`name`	String
`on_boot`	Boolean

6.159. NicInterface enum

Table 6.209. Values summary

Name	Summary
`e1000`
`pci_passthrough`
`rtl8139`
`rtl8139_virtio`
`spapr_vlan`
`virtio`

6.160. NicStatus enum

Table 6.210. Values summary

Name	Summary
`down`
`up`

6.161. 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 6.211. Attributes summary

Name	Type	Summary
`comment`	String	Free text containing comments about this object.
`cpu`	Cpu
`description`	String	A human-readable description in plain text.
`id`	String	A unique identifier.
`index`	Integer
`memory`	Integer	Memory of the NUMA node in MB.
`name`	String	A human-readable name in plain text.
`node_distance`	String

Table 6.212. Links summary

Name	Type	Summary
`host`	Host
`statistics`	Statistic[]

6.162. NumaNodePin struct

Represents pinning of a virtual NUMA node to a physical NUMA node.

Table 6.213. Attributes summary

Name	Type	Summary
`host_numa_node`	NumaNode	Deprecated - has no function.
`index`	Integer	Index of a physical NUMA node to which the virtual NUMA node is pinned.
`pinned`	Boolean	Deprecated - should always be true.

6.163. NumaTuneMode enum

Table 6.214. Values summary

Name	Summary
`interleave`
`preferred`
`strict`

6.164. OpenStackImage struct

Table 6.215. Attributes summary

Name	Type	Summary
`comment`	String	Free text containing comments about this object.
`description`	String	A human-readable description in plain text.
`id`	String	A unique identifier.
`name`	String	A human-readable name in plain text.

Table 6.216. Links summary

Name	Type	Summary
`openstack_image_provider`	OpenStackImageProvider

6.165. OpenStackImageProvider struct

Table 6.217. Attributes summary

Name	Type	Summary
`authentication_url`	String	Defines the external provider authentication URL address.
`comment`	String	Free text containing comments about this object.
`description`	String	A human-readable description in plain text.
`id`	String	A unique identifier.
`name`	String	A human-readable name in plain text.
`password`	String	Defines password for the user during the authentication process.
`properties`	Property[]	Array of provider name/value properties.
`requires_authentication`	Boolean	Defines whether provider authentication is required or not.
`tenant_name`	String
`url`	String	Defines URL address of the external provider.
`username`	String	Defines user name to be used during authentication process.

6.165.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 6.218. Links summary

Name	Type	Summary
`certificates`	Certificate[]
`images`	OpenStackImage[]

6.166. OpenStackNetwork struct

Table 6.219. Attributes summary

Name	Type	Summary
`comment`	String	Free text containing comments about this object.
`description`	String	A human-readable description in plain text.
`id`	String	A unique identifier.
`name`	String	A human-readable name in plain text.

Table 6.220. Links summary

Name	Type	Summary
`openstack_network_provider`	OpenStackNetworkProvider

6.167. OpenStackNetworkProvider struct

Table 6.221. Attributes summary

Name	Type	Summary
`agent_configuration`	AgentConfiguration	Agent configuration settings.
`authentication_url`	String	Defines the external provider authentication URL address.
`comment`	String	Free text containing comments about this object.
`description`	String	A human-readable description in plain text.
`id`	String	A unique identifier.
`name`	String	A human-readable name in plain text.
`password`	String	Defines password for the user during the authentication process.
`plugin_type`	NetworkPluginType	Network plugin type.
`properties`	Property[]	Array of provider name/value properties.
`read_only`	Boolean	Indicates whether the provider is read-only.
`requires_authentication`	Boolean	Defines whether provider authentication is required or not.
`tenant_name`	String
`type`	OpenStackNetworkProviderType	The type of provider.
`url`	String	Defines URL address of the external provider.
`username`	String	Defines user name to be used during authentication process.

6.167.1. read_only

Indicates whether the provider is read-only.

A read-only provider does not allow adding, modifying or deleting of networks or subnets. Port-related operations are allowed, as they are required for the provisioning of virtual NICs.

6.167.2. requires_authentication

Defines whether provider authentication is required or not.

If authentication is required, both username and password attributes will be used during authentication.

Table 6.222. Links summary

Name	Type	Summary
`certificates`	Certificate[]	Reference to the certificates list.
`networks`	OpenStackNetwork[]	Reference to OpenStack networks list.
`subnets`	OpenStackSubnet[]	Reference to OpenStack networks subnets list.

6.168. 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 will be a custom solution installed manually.

Table 6.223. Values summary

Name	Summary
`external`	Indicates that the provider is an external one, implementing the OpenStack Neutron API.
`neutron`	Indicates that the provider is OpenStack Neutron.

6.168.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.

6.168.2. neutron

Indicates that the provider is OpenStack Neutron. The standard OpenStack Neutron agent will be used as the virtual interface driver.

6.169. OpenStackProvider struct

Table 6.224. Attributes summary

Name	Type	Summary
`authentication_url`	String	Defines the external provider authentication URL address.
`comment`	String	Free text containing comments about this object.
`description`	String	A human-readable description in plain text.
`id`	String	A unique identifier.
`name`	String	A human-readable name in plain text.
`password`	String	Defines password for the user during the authentication process.
`properties`	Property[]	Array of provider name/value properties.
`requires_authentication`	Boolean	Defines whether provider authentication is required or not.
`tenant_name`	String
`url`	String	Defines URL address of the external provider.
`username`	String	Defines user name to be used during authentication process.

6.169.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.

6.170. OpenStackSubnet struct

Table 6.225. Attributes summary

Name	Type	Summary
`cidr`	String	Defines network CIDR.
`comment`	String	Free text containing comments about this object.
`description`	String	A human-readable description in plain text.
`dns_servers`	String[]	Defines a list of DNS servers.
`gateway`	String	Defines IP gateway.
`id`	String	A unique identifier.
`ip_version`	String	Defines IP version.
`name`	String	A human-readable name in plain text.

6.170.1. ip_version

Defines IP version.

Values can be v4' for IPv4 or `v6 for IPv6.

Table 6.226. Links summary

Name	Type	Summary
`openstack_network`	OpenStackNetwork	Reference to the service managing the OpenStack network.

6.171. OpenStackVolumeProvider struct

Table 6.227. Attributes summary

Name	Type	Summary
`authentication_url`	String	Defines the external provider authentication URL address.
`comment`	String	Free text containing comments about this object.
`description`	String	A human-readable description in plain text.
`id`	String	A unique identifier.
`name`	String	A human-readable name in plain text.
`password`	String	Defines password for the user during the authentication process.
`properties`	Property[]	Array of provider name/value properties.
`requires_authentication`	Boolean	Defines whether provider authentication is required or not.
`tenant_name`	String
`url`	String	Defines URL address of the external provider.
`username`	String	Defines user name to be used during authentication process.

6.171.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 6.228. Links summary

Name	Type	Summary
`authentication_keys`	OpenstackVolumeAuthenticationKey[]
`certificates`	Certificate[]
`data_center`	DataCenter
`volume_types`	OpenStackVolumeType[]

6.172. OpenStackVolumeType struct

Table 6.229. Attributes summary

Name	Type	Summary
`comment`	String	Free text containing comments about this object.
`description`	String	A human-readable description in plain text.
`id`	String	A unique identifier.
`name`	String	A human-readable name in plain text.
`properties`	Property[]

Table 6.230. Links summary

Name	Type	Summary
`openstack_volume_provider`	OpenStackVolumeProvider

6.173. OpenstackVolumeAuthenticationKey struct

Table 6.231. Attributes summary

Name	Type	Summary
`comment`	String	Free text containing comments about this object.
`creation_date`	Date
`description`	String	A human-readable description in plain text.
`id`	String	A unique identifier.
`name`	String	A human-readable name in plain text.
`usage_type`	OpenstackVolumeAuthenticationKeyUsageType
`uuid`	String
`value`	String

Table 6.232. Links summary

Name	Type	Summary
`openstack_volume_provider`	OpenStackVolumeProvider

6.174. OpenstackVolumeAuthenticationKeyUsageType enum

Table 6.233. Values summary

Name	Summary
`ceph`

6.175. OperatingSystem struct

Information describing the operating system. Used for virtual machines and hosts.

Table 6.234. Attributes summary

Name	Type	Summary
`boot`	Boot
`cmdline`	String
`custom_kernel_cmdline`	String	A custom part of the host kernel command line.
`initrd`	String
`kernel`	String
`reported_kernel_cmdline`	String	Host kernel command line as reported by a running host.
`type`	String
`version`	Version

6.175.1. custom_kernel_cmdline

A custom part of the host kernel command line. This will be merged with the existing kernel command line.

You must re-install and then reboot the host to apply the changes implemented by this attribute.

Parameters merging: 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 Engine internally keeps track of the last applied kernel parameters customization.

Note

This attribute is currently only used for hosts.

6.175.2. reported_kernel_cmdline

Host kernel command line as reported by a running host.

Read-only attribute. Attempts to change this attribute are silently ignored.

Note

This attribute is currently only used for hosts.

6.176. OperatingSystemInfo struct

Table 6.235. Attributes summary

Name	Type	Summary
`comment`	String	Free text containing comments about this object.
`description`	String	A human-readable description in plain text.
`id`	String	A unique identifier.
`large_icon`	Icon
`name`	String	A human-readable name in plain text.
`small_icon`	Icon

6.177. Option struct

Table 6.236. Attributes summary

Name	Type	Summary
`name`	String
`type`	String
`value`	String

6.178. OsType enum

Table 6.237. Values summary

Name	Summary
`other`
`other_linux`
`rhel_3`
`rhel_3x64`
`rhel_4`
`rhel_4x64`
`rhel_5`
`rhel_5x64`
`rhel_6`
`rhel_6x64`
`unassigned`
`windows_2003`
`windows_2003x64`
`windows_2008`
`windows_2008r2x64`
`windows_2008x64`
`windows_2012x64`
`windows_7`
`windows_7x64`
`windows_8`
`windows_8x64`
`windows_xp`

6.179. 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 6.238. Attributes summary

Name	Type	Summary
`name`	String	The name of the package.

6.180. Payload struct

Table 6.239. Attributes summary

Name	Type	Summary
`files`	File[]
`type`	VmDeviceType
`volume_id`	String

6.181. PayloadEncoding enum

Table 6.240. Values summary

Name	Summary
`base64`
`plaintext`

6.182. Permission struct

Table 6.241. Attributes summary

Name	Type	Summary
`comment`	String	Free text containing comments about this object.
`description`	String	A human-readable description in plain text.
`id`	String	A unique identifier.
`name`	String	A human-readable name in plain text.

Table 6.242. Links summary

Name	Type	Summary
`cluster`	Cluster
`data_center`	DataCenter
`disk`	Disk
`group`	Group
`host`	Host
`role`	Role
`storage_domain`	StorageDomain
`template`	Template
`user`	User
`vm`	Vm
`vm_pool`	VmPool

6.183. Permit struct

Type represents a permit.

Table 6.243. Attributes summary

Name	Type	Summary
`administrative`	Boolean	Specifies whether permit is administrative or not.
`comment`	String	Free text containing comments about this object.
`description`	String	A human-readable description in plain text.
`id`	String	A unique identifier.
`name`	String	A human-readable name in plain text.

Table 6.244. Links summary

Name	Type	Summary
`role`	Role	Reference to the role the permit belongs to.

6.184. PmProxy struct

Table 6.245. Attributes summary

Name	Type	Summary
`type`	PmProxyType

6.185. PmProxyType enum

Table 6.246. Values summary

Name	Summary
`cluster`	Fence proxy is selected from the same cluster as fenced host.
`dc`	Fence proxy is selected from the same data center as fenced host.
`other_dc`	Fence proxy is selected from a different data center than fenced host.

6.186. PolicyUnitType enum

This enum holds the types of all internal policy units types

Table 6.247. Values summary

Name	Summary
`filter`
`load_balancing`
`weight`

6.187. PortMirroring struct

6.188. PowerManagement struct

Table 6.248. Attributes summary

Name	Type	Summary
`address`	String	The host name or IP address of the host.
`agents`	Agent[]	Specifies fence agent options when multiple fences are used.
`automatic_pm_enabled`	Boolean	Toggles the automated power control of the host in order to save energy.
`enabled`	Boolean	Indicates whether power management configuration is enabled or disabled.
`kdump_detection`	Boolean	Toggles whether to determine if kdump is running on the host before it is shut down.
`options`	Option[]	Fencing options for the selected type= specified with the option name="" and value="" strings.
`password`	String	A valid, robust password for power management.
`pm_proxies`	PmProxy[]	Determines the power management proxy.
`status`	PowerManagementStatus	Determines the power status of the host.
`type`	String	Fencing device code.
`username`	String	A valid user name for power management.

6.188.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.

6.188.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.

6.188.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.

6.188.4. type

Fencing device code.

A list of valid fencing device codes are available in the capabilities collection.

6.189. PowerManagementStatus enum

Table 6.249. Values summary

Name	Summary
`off`	Host is OFF.
`on`	Host is ON.
`unknown`	Unknown status.

6.190. Product struct

Table 6.250. Attributes summary

Name	Type	Summary
`comment`	String	Free text containing comments about this object.
`description`	String	A human-readable description in plain text.
`id`	String	A unique identifier.
`name`	String	A human-readable name in plain text.

6.191. 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 6.251. Attributes summary

Name	Type	Summary
`name`	String	The name of the product, for example `oVirt Engine`.
`vendor`	String	The name of the vendor, for example `ovirt.
`version`	Version	The version number of the product.

6.191.1. vendor

The name of the vendor, for example ovirt.org.

6.192. ProfileDetail struct

Table 6.252. Attributes summary

Name	Type	Summary
`block_statistics`	BlockStatistic[]
`duration`	Integer
`fop_statistics`	FopStatistic[]
`profile_type`	String
`statistics`	Statistic[]

6.193. Property struct

Table 6.253. Attributes summary

Name	Type	Summary
`name`	String
`value`	String

6.194. ProxyTicket struct

Table 6.254. Attributes summary

Name	Type	Summary
`value`	String

6.195. 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 6.255. Attributes summary

Name	Type	Summary
`comment`	String	Free text containing comments about this object.
`cpu_limit`	Integer	The maximum processing capability in %.
`description`	String	A human-readable description in plain text.
`id`	String	A unique identifier.
`inbound_average`	Integer	The desired average inbound bit rate in Mbps.
`inbound_burst`	Integer	The amount of data that can be delivered in a single burst in MiB.
`inbound_peak`	Integer	The maximum inbound rate in Mbps.
`max_iops`	Integer	Maximum permitted number of input and output operations per second.
`max_read_iops`	Integer	Maximum permitted number of input operations per second.
`max_read_throughput`	Integer	Maximum permitted throughput for read operations.
`max_throughput`	Integer	Maximum permitted total throughput.
`max_write_iops`	Integer	Maximum permitted number of output operations per second.
`max_write_throughput`	Integer	Maximum permitted throughput for write operations.
`name`	String	A human-readable name in plain text.
`outbound_average`	Integer	The desired average outbound bit rate in Mbps.
`outbound_average_linkshare`	Integer	Weighted share.
`outbound_average_realtime`	Integer	The committed rate in Mbps.
`outbound_average_upperlimit`	Integer	The maximum bandwidth to be used by a network in Mbps.
`outbound_burst`	Integer	The amount of data that can be sent in a single burst in MiB.
`outbound_peak`	Integer	The maximum outbound rate in Mbps.
`type`	QosType	The kind of resources this entry can be assigned.

6.195.1. cpu_limit

The maximum processing capability in %.

Used to configure computing resources.

6.195.2. inbound_average

The desired average inbound bit rate in Mbps.

Used to configure virtual machines networks. If defined, inbound_peak and inbound_burst also has to be set.

See Libvirt-QOS for further details.

6.195.3. inbound_burst

The amount of data that can be delivered in a single burst in MiB.

Used to configure virtual machines networks. If defined, inbound_average and inbound_peak also has to be set.

See Libvirt-QOS for further details.

6.195.4. inbound_peak

The maximum inbound rate in Mbps.

Used to configure virtual machines networks. If defined, inbound_average and inbound_burst also has to be set.

See Libvirt-QOS for further details.

6.195.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.

6.195.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.

6.195.7. max_read_throughput

Maximum permitted throughput for read operations.

Used to configure storage. Must not be set if max_throughput is set.

6.195.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.

6.195.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.

6.195.10. max_write_throughput

Maximum permitted throughput for write operations.

Used to configure storage. Must not be set if max_throughput is set.

6.195.11. outbound_average

The desired average outbound bit rate in Mbps.

Used to configure virtual machines networks. If defined, outbound_peak and outbound_burst also has to be set.

See Libvirt-QOS for further details.

6.195.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.

6.195.13. outbound_average_realtime

The committed rate in Mbps.

Used to configure host networks. The minimum bandwidth required by a network. The committed rate requested is not guaranteed and will vary depending on the network infrastructure and the committed rate requested by other networks on the same logical link.

6.195.14. outbound_average_upperlimit

The maximum bandwidth to be used by a network in Mbps.

Used to configure host networks. If outboundAverageUpperlimit and outbound_average_realtime are provided, the outbound_averageUpperlimit must not be lower than the outbound_average_realtime.

See Libvirt-QOS for further details.

6.195.15. outbound_burst

The amount of data that can be sent in a single burst in MiB.

Used to configure virtual machines networks. If defined, outbound_average and outbound_peak also has to be set.

See Libvirt-QOS for further details.

6.195.16. outbound_peak

The maximum outbound rate in Mbps.

Used to configure virtual machines networks. If defined, outbound_average and outbound_burst also has to be set.

See Libvirt-QOS for further details.

Table 6.256. Links summary

Name	Type	Summary
`data_center`	DataCenter	The data center the QoS is assiciated to.

6.196. QosType enum

This type represents the kind of resource the Quality of service (QoS) can be assigned to.

Table 6.257. Values summary

Name	Summary
`cpu`	The Quality of service (QoS) can be assigned to resources with computing capabilities.
`hostnetwork`	The Quality of service (QoS) can be assigned to host networks.
`network`	The Quality of service (QoS) can be assigned to virtual machines networks.
`storage`	The Quality of service (QoS) can be assigned to storage.

6.197. 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 6.258. Attributes summary

Name	Type	Summary
`cluster_hard_limit_pct`	Integer
`cluster_soft_limit_pct`	Integer
`comment`	String	Free text containing comments about this object.
`data_center`	DataCenter
`description`	String	A human-readable description in plain text.
`disks`	Disk[]
`id`	String	A unique identifier.
`name`	String	A human-readable name in plain text.
`storage_hard_limit_pct`	Integer
`storage_soft_limit_pct`	Integer
`users`	User[]
`vms`	Vm[]

Table 6.259. Links summary

Name	Type	Summary
`permissions`	Permission[]
`quota_cluster_limits`	QuotaClusterLimit[]
`quota_storage_limits`	QuotaStorageLimit[]

6.198. QuotaClusterLimit struct

Table 6.260. Attributes summary

Name	Type	Summary
`comment`	String	Free text containing comments about this object.
`description`	String	A human-readable description in plain text.
`id`	String	A unique identifier.
`memory_limit`	Decimal
`memory_usage`	Decimal
`name`	String	A human-readable name in plain text.
`vcpu_limit`	Integer
`vcpu_usage`	Integer

Table 6.261. Links summary

Name	Type	Summary
`cluster`	Cluster
`quota`	Quota

6.199. QuotaModeType enum

Table 6.262. Values summary

Name	Summary
`audit`
`disabled`
`enabled`

6.200. QuotaStorageLimit struct

Table 6.263. Attributes summary

Name	Type	Summary
`comment`	String	Free text containing comments about this object.
`description`	String	A human-readable description in plain text.
`id`	String	A unique identifier.
`limit`	Integer
`name`	String	A human-readable name in plain text.
`usage`	Decimal

Table 6.264. Links summary

Name	Type	Summary
`quota`	Quota
`storage_domain`	StorageDomain

6.201. Range struct

Table 6.265. Attributes summary

Name	Type	Summary
`from`	String
`to`	String

6.202. Rate struct

Determines maximum speed of consumption of bytes from random number generator device.

Table 6.266. Attributes summary

Name	Type	Summary
`bytes`	Integer	Number of bytes allowed to consume per period.
`period`	Integer	Duration of one period in milliseconds.

6.203. ReportedConfiguration struct

Table 6.267. Attributes summary

Name	Type	Summary
`actual_value`	String
`expected_value`	String
`in_sync`	Boolean	`false` when the network attachment contains uncommitted network configuration.
`name`	String

6.204. ReportedDevice struct

Table 6.268. Attributes summary

Name	Type	Summary
`comment`	String	Free text containing comments about this object.
`description`	String	A human-readable description in plain text.
`id`	String	A unique identifier.
`ips`	Ip[]
`mac`	Mac
`name`	String	A human-readable name in plain text.
`type`	ReportedDeviceType

Table 6.269. Links summary

Name	Type	Summary
`vm`	Vm

6.205. ReportedDeviceType enum

Table 6.270. Values summary

Name	Summary
`network`

6.206. ResolutionType enum

Table 6.271. Values summary

Name	Summary
`add`
`copy`

6.207. RngDevice struct

Random number generator (RNG) device model.

Table 6.272. Attributes summary

Name	Type	Summary
`rate`	Rate	Determines maximum speed of consumption of bytes from random number generator device.
`source`	RngSource	Backend of the random number generator device.

6.208. RngSource enum

Representing the random generator backend types.

Table 6.273. Values summary

Name	Summary
`hwrng`	Obtains random data from the `/dev/hwrng` (usually specialized HW generator) device.
`random`	Obtains random data from the `/dev/random` device.

6.209. Role struct

Represents a system role.

Table 6.274. Attributes summary

Name	Type	Summary
`administrative`	Boolean	Defines the role as administrative-only or not.
`comment`	String	Free text containing comments about this object.
`description`	String	A human-readable description in plain text.
`id`	String	A unique identifier.
`mutable`	Boolean	Defines the ability to update or delete the role.
`name`	String	A human-readable name in plain text.

6.209.1. mutable

Defines the ability to update or delete the role.

Roles with mutable set to false are predefined roles.

Table 6.275. Links summary

Name	Type	Summary
`permits`	Permit[]	A link to the permits sub-collection for role permits.
`user`	User

6.210. 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 6.276. Values summary

Name	Summary
`admin`	Administrative role.
`user`	User role.

6.211. SchedulingPolicy struct

Table 6.277. Attributes summary

Name	Type	Summary
`comment`	String	Free text containing comments about this object.
`default_policy`	Boolean
`description`	String	A human-readable description in plain text.
`id`	String	A unique identifier.
`locked`	Boolean
`name`	String	A human-readable name in plain text.
`properties`	Property[]

Table 6.278. Links summary

Name	Type	Summary
`balances`	Balance[]
`filters`	Filter[]
`weight`	Weight[]

6.212. SchedulingPolicyUnit struct

Table 6.279. Attributes summary

Name	Type	Summary
`comment`	String	Free text containing comments about this object.
`description`	String	A human-readable description in plain text.
`enabled`	Boolean
`id`	String	A unique identifier.
`internal`	Boolean
`name`	String	A human-readable name in plain text.
`properties`	Property[]
`type`	PolicyUnitType

6.213. ScsiGenericIO enum

Table 6.280. Values summary

Name	Summary
`filtered`
`unfiltered`

6.214. SeLinux struct

Table 6.281. Attributes summary

Name	Type	Summary
`mode`	SeLinuxMode

6.215. SeLinuxMode enum

Table 6.282. Values summary

Name	Summary
`disabled`
`enforcing`
`permissive`

6.216. SerialNumber struct

Table 6.283. Attributes summary

Name	Type	Summary
`policy`	SerialNumberPolicy
`value`	String

6.217. SerialNumberPolicy enum

Table 6.284. Values summary

Name	Summary
`custom`
`host`
`vm`

6.218. Session struct

Describes user session to a virtual machine.

Table 6.285. Attributes summary

Name	Type	Summary
`comment`	String	Free text containing comments about this object.
`console_user`	Boolean	Indicates if this is a console session.
`description`	String	A human-readable description in plain text.
`id`	String	A unique identifier.
`ip`	Ip	IP address user is connected from.
`name`	String	A human-readable name in plain text.
`protocol`	String	Protocol used by the session.

6.218.1. console_user

Indicates if this is a console session.

The value will be true for console users: SPICE or VNC, false for others: e.g. RDP, SSH.

6.218.2. ip

IP address user is connected from.

Currently only available for console users.

6.218.3. protocol

Protocol used by the session.

Currently not used, intended for info about how is user connected: SPICE, VNC, SSH, RDP.

Table 6.286. Links summary

Name	Type	Summary
`user`	User	User related to this session.
`vm`	Vm	Link to virtual machine related to this session.

6.218.4. user

User related to this session.

If user is a console user, it is a link to real oVirt user. Otherwise only username is provided.

6.219. SkipIfConnectivityBroken struct

Table 6.287. Attributes summary

Name	Type	Summary
`enabled`	Boolean	If enabled, we will not fence a host in case more than a configurable percentage of hosts in the cluster lost connectivity as well.
`threshold`	Integer	Threshold for connectivity testing.

6.219.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.

6.219.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.

6.220. SkipIfSdActive struct

This type represents the storage related configuration in the fencing policy.

Table 6.288. Attributes summary

Name	Type	Summary
`enabled`	Boolean	If enabled, we will skip fencing in case the host maintains its lease in the storage.

6.220.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.

6.221. Snapshot struct

Represents a snapshot object.

<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 6.289. Attributes summary

Name	Type	Summary
`bios`	Bios	Reference to virtual machine’s BIOS configuration.
`comment`	String	Free text containing comments about this object.
`console`	Console	Console configured for this virtual machine.
`cpu`	Cpu	The configuration of the virtual machine CPU.
`cpu_shares`	Integer
`creation_time`	Date	The virtual machine creation date.
`custom_compatibility_version`	Version	Virtual machine custom compatibility version.
`custom_cpu_model`	String
`custom_emulated_machine`	String
`custom_properties`	CustomProperty[]	Properties sent to VDSM to configure various hooks.
`date`	Date
`delete_protected`	Boolean	If `true`, the virtual machine cannot be deleted.
`description`	String	A human-readable description in plain text.
`display`	Display	The virtual machine display configuration.
`domain`	Domain	Domain configured for this virtual machine.
`fqdn`	String	Fully qualified domain name of the virtual machine.
`guest_operating_system`	GuestOperatingSystem	What operating system is installed on the virtual machine.
`guest_time_zone`	TimeZone	What time zone is used by the virtual machine (as returned by guest agent).
`high_availability`	HighAvailability	The virtual machine high availability configuration.
`id`	String	A unique identifier.
`initialization`	Initialization	Reference to virtual machine’s initialization configuration.
`io`	Io	For performance tuning of IO threading.
`large_icon`	Icon	Virtual machine’s large icon.
`memory`	Integer	The virtual machine’s memory, in bytes.
`memory_policy`	MemoryPolicy	Reference to virtual machine’s memory management configuration.
`migration`	MigrationOptions	Reference to configuration of migration of running virtual machine to another host.
`migration_downtime`	Integer	Maximum time the virtual machine can be non responsive during its live migration to another host in ms.
`name`	String	A human-readable name in plain text.
`next_run_configuration_exists`	Boolean	Virtual machine configuration has been changed and requires restart of the virtual machine.
`numa_tune_mode`	NumaTuneMode	How the NUMA topology is applied.
`origin`	String	The origin of this virtual machine.
`os`	OperatingSystem	Operating system type installed on the virtual machine.
`payloads`	Payload[]	Optional payloads of the virtual machine, used for ISOs to configure it.
`persist_memorystate`	Boolean
`placement_policy`	VmPlacementPolicy	The configuration of the virtual machine’s placement policy.
`rng_device`	RngDevice	Random Number Generator device configuration for this virtual machine.
`run_once`	Boolean	If `true`, the virtual machine has been started using the run once command, meaning it’s configuration might differ from the stored one for the purpose of this single run.
`serial_number`	SerialNumber	Virtual machine’s serial number in a cluster.
`small_icon`	Icon	Virtual machine’s small icon.
`snapshot_status`	SnapshotStatus
`snapshot_type`	SnapshotType
`soundcard_enabled`	Boolean	If `true`, the sound card is added to the virtual machine.
`sso`	Sso	Reference to the Single Sign On configuration this virtual machine is configured for.
`start_paused`	Boolean	If `true`, the virtual machine will be initially in 'paused' state after start.
`start_time`	Date	The date in which the virtual machine was started.
`stateless`	Boolean	If `true`, the virtual machine is stateless - it’s state (disks) are rolled-back after shutdown.
`status`	VmStatus	The current status of the virtual machine.
`status_detail`	String	Human readable detail of current status.
`stop_reason`	String	The reason the virtual machine was stopped.
`stop_time`	Date	The date in which the virtual machine was stopped.
`time_zone`	TimeZone	The virtual machine’s time zone set by oVirt.
`tunnel_migration`	Boolean	If `true`, the network data transfer will be encrypted during virtual machine live migration.
`type`	VmType	Determines whether the virtual machine is optimized for desktop or server.
`usb`	Usb	Configuration of USB devices for this virtual machine (count, type).
`use_latest_template_version`	Boolean	If `true`, the virtual machine is reconfigured to the latest version of it’s template when it is started.
`virtio_scsi`	VirtioScsi	Reference to VirtIO SCSI configuration.

6.221.1. cpu

The configuration of the virtual machine CPU.

The socket configuration can be updated without rebooting the virtual machine. The cores and the threads require a reboot.

For example, to change the number of sockets to 4 immediately, and the number of cores and threads to 2 after reboot, send the following request:

PUT /ovirt-engine/api/vms/123

With a request body:

<vm>
  <cpu>
    <topology>
      <sockets>4</sockets>
      <cores>2</cores>
      <threads>2</threads>
    </topology>
  </cpu>
</vm>

6.221.2. custom_compatibility_version

Virtual machine custom compatibility version.

Enables a virtual machine to be customized to its own compatibility version. If custom_compatibility_version is set, it overrides the cluster’s compatibility version for this particular virtual machine.

The compatibility version of a virtual machine is limited by the data center the virtual machine resides in, and is checked against capabilities of the host the virtual machine is planned to run on.

6.221.3. high_availability

The virtual machine high availability configuration. If set, the virtual machine will be automatically restarted when it unexpectedly goes down.

6.221.4. large_icon

Virtual machine’s large icon. Either set by user or refers to image set according to operating system.

6.221.5. 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>

Note

Memory in the example is converted to bytes using the following formula:
1 GiB = 2³⁰ bytes = 1073741824 bytes.

Note

Memory hot plug is supported from Red Hat Virtualization 3.6 onwards. You can use the example above to increase memory while the virtual machine is running.

6.221.6. 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]

6.221.7. 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.

6.221.8. origin

The origin of this virtual machine.

Possible values:

ovirt
rhev
vmware
xen
external
hosted_engine
managed_hosted_engine
kvm
physical_machine
hyperv

6.221.9. 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.

Note

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>

6.221.10. small_icon

Virtual machine’s small icon. Either set by user or refers to image set according to operating system.

6.221.11. 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.

6.221.12. stop_reason

The reason the virtual machine was stopped. Optionally set by user when shutting down the virtual machine.

Table 6.290. Links summary

Name	Type	Summary
`affinity_labels`	AffinityLabel[]	Optional.
`applications`	Application[]	List of applications installed on the virtual machine.
`cdroms`	Cdrom[]	Reference to the ISO mounted to the CDROM.
`cluster`	Cluster	Reference to cluster the virtual machine belongs to.
`cpu_profile`	CpuProfile	Reference to CPU profile used by this virtual machine.
`disk_attachments`	DiskAttachment[]	References the disks attached to the virtual machine.
`external_host_provider`	ExternalHostProvider
`floppies`	Floppy[]	Reference to the ISO mounted to the floppy.
`graphics_consoles`	GraphicsConsole[]	List of graphics consoles configured for this virtual machine.
`host`	Host	Reference to the host the virtual machine is running on.
`host_devices`	HostDevice[]	References devices associated to this virtual machine.
`instance_type`	InstanceType	The virtual machine configuration can be optionally predefined via one of the instance types.
`katello_errata`	KatelloErratum[]	Lists all the Katello errata assigned to the virtual machine.
`nics`	Nic[]	References the list of network interface devices on the virtual machine.
`numa_nodes`	NumaNode[]	Refers to the NUMA Nodes configuration used by this virtual machine.
`permissions`	Permission[]	Permissions set for this virtual machine.
`quota`	Quota	Reference to quota configuration set for this virtual machine.
`reported_devices`	ReportedDevice[]
`sessions`	Session[]	List of user sessions opened for this virtual machine.
`snapshots`	Snapshot[]	Refers to all snapshots taken from the virtual machine.
`statistics`	Statistic[]	Statistics data collected from this virtual machine.
`storage_domain`	StorageDomain	Reference to storage domain the virtual machine belongs to.
`tags`	Tag[]
`template`	Template	Reference to the template the virtual machine is based on.
`vm`	Vm
`vm_pool`	VmPool	Reference to the pool the virtual machine is optionally member of.
`watchdogs`	Watchdog[]	Refers to the Watchdog configuration.

6.221.13. affinity_labels

Optional. Used for labeling of sub-clusters.

6.221.14. 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>

6.222. SnapshotStatus enum

Table 6.291. Values summary

Name	Summary
`in_preview`
`locked`
`ok`

6.223. SnapshotType enum

Table 6.292. Values summary

Name	Summary
`active`
`preview`
`regular`
`stateless`

6.224. SpecialObjects struct

This type contains references to special objects, like the blank template and the root of the hierarchy of tags.

Table 6.293. Links summary

Name	Type	Summary
`blank_template`	Template	Reference to the blank template.
`root_tag`	Tag	Reference to the root of the hierarchy of tags.

6.225. Spm struct

Table 6.294. Attributes summary

Name	Type	Summary
`priority`	Integer
`status`	SpmStatus

6.226. SpmStatus enum

Table 6.295. Values summary

Name	Summary
`contending`
`none`
`spm`

6.227. Ssh struct

Table 6.296. Attributes summary

Name	Type	Summary
`authentication_method`	SshAuthenticationMethod
`comment`	String	Free text containing comments about this object.
`description`	String	A human-readable description in plain text.
`fingerprint`	String
`id`	String	A unique identifier.
`name`	String	A human-readable name in plain text.
`port`	Integer
`user`	User

6.228. SshAuthenticationMethod enum

Table 6.297. Values summary

Name	Summary
`password`
`publickey`

6.229. SshPublicKey struct

Table 6.298. Attributes summary

Name	Type	Summary
`comment`	String	Free text containing comments about this object.
`content`	String
`description`	String	A human-readable description in plain text.
`id`	String	A unique identifier.
`name`	String	A human-readable name in plain text.

Table 6.299. Links summary

Name	Type	Summary
`user`	User

6.230. Sso struct

Table 6.300. Attributes summary

Name	Type	Summary
`methods`	Method[]

6.231. SsoMethod enum

Table 6.301. Values summary

Name	Summary
`guest_agent`

6.232. 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>

Note

This statistics sub-collection is read-only.

Table 6.302. Attributes summary

Name	Type	Summary
`comment`	String	Free text containing comments about this object.
`description`	String	A human-readable description in plain text.
`id`	String	A unique identifier.
`kind`	StatisticKind	The type of statistic measures.
`name`	String	A human-readable name in plain text.
`type`	ValueType	The data type for the statistical values that follow.
`unit`	StatisticUnit	The unit or rate to measure of the statistical values.
`values`	Value[]	A data set that contains `datum`.

Table 6.303. Links summary

Name	Type	Summary
`brick`	GlusterBrick
`disk`	Disk	A relationship to the containing `disk` resource.
`gluster_volume`	GlusterVolume
`host`	Host
`host_nic`	HostNic	A reference to the host NIC.
`host_numa_node`	NumaNode
`nic`	Nic
`step`	Step
`vm`	Vm

6.233. StatisticKind enum

Table 6.304. Values summary

Name	Summary
`counter`
`gauge`

6.234. StatisticUnit enum

Table 6.305. Values summary

Name	Summary
`bits_per_second`
`bytes`
`bytes_per_second`
`count_per_second`
`none`
`percent`
`seconds`

6.235. 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 6.306. Attributes summary

Name	Type	Summary
`comment`	String	Free text containing comments about this object.
`description`	String	A human-readable description in plain text.
`end_time`	Date	The end time of the step.
`external`	Boolean	Indicates if the step is originated by an external system.
`external_type`	ExternalSystemType	The external system which is referenced by the step.
`id`	String	A unique identifier.
`name`	String	A human-readable name in plain text.
`number`	Integer	The order of the step in current hierarchy level.
`start_time`	Date	The start time of the step.
`status`	StepStatus	The status of the step.
`type`	StepEnum	The type of the step.

6.235.1. external

Indicates if the step is originated by an external system. External steps are managed externally, by the creator of the step.

Table 6.307. Links summary

Name	Type	Summary
`job`	Job	References the `job` which is the top of the current step hierarchy.
`parent_step`	Step	References the parent step of the current step in the hierarchy.
`statistics`	Statistic[]

6.236. StepEnum enum

Type representing a step type.

Table 6.308. Values summary

Name	Summary
`executing`	The executing step type.
`finalizing`	The finalizing step type.
`rebalancing_volume`	The `rebalancing volume` step type.
`removing_bricks`	The `removing bricks` step type.
`unknown`	The unknown step type.
`validating`	The validation step type.

6.236.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.

6.236.2. finalizing

The finalizing step type. Describes the post-execution steps requires to complete the job.

6.236.3. rebalancing_volume

The rebalancing volume step type. Describes a step type which is part of Gluster flow.

6.236.4. removing_bricks

The removing bricks step type. Describes a step type which is part of Gluster flow.

6.236.5. unknown

The unknown step type. Describes a step type which its origin is unknown.

6.236.6. validating

The validation step type. Used to verify the correctness of parameters and the validity of the parameters prior to the execution.

6.237. StepStatus enum

Represents the status of the step.

Table 6.309. Values summary

Name	Summary
`aborted`	The aborted step status.
`failed`	The failed step status.
`finished`	The finished step status.
`started`	The started step status.
`unknown`	The unknown step status.

6.237.1. aborted

The aborted step status. This status is applicable for an external step that was forcibly aborted.

6.237.2. finished

The finished step status. This status describes a completed step execution.

6.237.3. started

The started step status. This status represents a step which is currently being executed.

6.237.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.

6.238. StorageConnection struct

Represents a storage server connection.

Example:

<storage_connection id="123">
  <address>mynfs.example.com</address>
  <type>nfs</type>
  <path>/exports/mydata</path>
</storage_connection>

Table 6.310. Attributes summary

Name	Type	Summary
`address`	String
`comment`	String	Free text containing comments about this object.
`description`	String	A human-readable description in plain text.
`id`	String	A unique identifier.
`mount_options`	String
`name`	String	A human-readable name in plain text.
`nfs_retrans`	Integer
`nfs_timeo`	Integer
`nfs_version`	NfsVersion
`password`	String
`path`	String
`port`	Integer
`portal`	String
`target`	String
`type`	StorageType
`username`	String
`vfs_type`	String

Table 6.311. Links summary

Name	Type	Summary
`host`	Host

6.239. StorageConnectionExtension struct

Table 6.312. Attributes summary

Name	Type	Summary
`comment`	String	Free text containing comments about this object.
`description`	String	A human-readable description in plain text.
`id`	String	A unique identifier.
`name`	String	A human-readable name in plain text.
`password`	String
`target`	String
`username`	String

Table 6.313. Links summary

Name	Type	Summary
`host`	Host

6.240. 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 6.314. Attributes summary

Name	Type	Summary
`available`	Integer
`comment`	String	Free text containing comments about this object.
`committed`	Integer
`critical_space_action_blocker`	Integer
`description`	String	A human-readable description in plain text.
`external_status`	ExternalStatus
`id`	String	A unique identifier.
`import`	Boolean
`master`	Boolean
`name`	String	A human-readable name in plain text.
`status`	StorageDomainStatus
`storage`	HostStorage
`storage_format`	StorageFormat
`type`	StorageDomainType
`used`	Integer
`warning_low_space_indicator`	Integer
`wipe_after_delete`	Boolean	Serves as the default value of `wipe_after_delete` for disks on this storage domain.

6.240.1. 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 6.315. Links summary

Name	Type	Summary
`data_center`	DataCenter	This is used to link to the data center that the storage domain is attached to.
`data_centers`	DataCenter[]	This is a set of links to the data centers that the storage domain is attached to.
`disk_profiles`	DiskProfile[]
`disk_snapshots`	DiskSnapshot[]
`disks`	Disk[]
`files`	File[]
`host`	Host	Host is only relevant at creation time.
`images`	Image[]
`permissions`	Permission[]
`storage_connections`	StorageConnection[]
`templates`	Template[]
`vms`	Vm[]

6.240.2. data_center

This is used to link to the data center that the storage domain is attached to. It is preserved for backwards compatibility, as the storage domain may be attached to multiple data centers (if it is an ISO domain). Use the dataCenters element instead.

6.241. StorageDomainStatus enum

Table 6.316. Values summary

Name	Summary
`activating`
`active`
`detaching`
`inactive`
`locked`
`maintenance`
`mixed`
`preparing_for_maintenance`
`unattached`
`unknown`

6.242. StorageDomainType enum

Table 6.317. Values summary

Name	Summary
`data`
`export`
`image`
`iso`
`volume`

6.243. StorageFormat enum

Table 6.318. Values summary

Name	Summary
`v1`
`v2`
`v3`

6.244. StorageType enum

Type representing a storage domain type.

Table 6.319. Values summary

Name	Summary
`cinder`	Cinder storage domain.
`fcp`	Fibre-Channel storage domain.
`glance`	Glance storage domain.
`glusterfs`	Gluster-FS storage domain.
`iscsi`	iSCSI storage domain.
`localfs`	Storage domain on Local storage.
`nfs`	NFS storage domain.
`posixfs`	POSIX-FS storage domain.

6.244.1. cinder

Cinder storage domain. For more details on Cinder please go to Cinder.

6.244.2. glance

Glance storage domain. For more details on Glance please go to Glance.

6.244.3. glusterfs

Gluster-FS storage domain. For more details on Gluster please go to Gluster.

6.245. SwitchType enum

Describes all switch types supported by the Manager.

Table 6.320. Values summary

Name	Summary
`legacy`	The native switch type.
`ovs`	The Open vSwitch type.

6.246. Tag struct

Represents a tag in the system.

Table 6.321. Attributes summary

Name	Type	Summary
`comment`	String	Free text containing comments about this object.
`description`	String	A human-readable description in plain text.
`id`	String	A unique identifier.
`name`	String	A human-readable name in plain text.

Table 6.322. Links summary

Name	Type	Summary
`group`	Group	Reference to the group which has this tag assigned.
`host`	Host	Reference to the host which has this tag assigned.
`parent`	Tag	Reference to the parent tag of this tag.
`template`	Template	Reference to the template which has this tag assigned.
`user`	User	Reference to the user who has this tag assigned.
`vm`	Vm	Reference to the virtual machine which has this tag assigned.

6.247. Template struct

Type representing a virtual machine template. This allows a rapid instanstiation of virtual machines with common configuration and disk states.

Table 6.323. Attributes summary

Name	Type	Summary
`bios`	Bios	Reference to virtual machine’s BIOS configuration.
`comment`	String	Free text containing comments about this object.
`console`	Console	Console configured for this virtual machine.
`cpu`	Cpu	The configuration of the virtual machine CPU.
`cpu_shares`	Integer
`creation_time`	Date	The virtual machine creation date.
`custom_compatibility_version`	Version	Virtual machine custom compatibility version.
`custom_cpu_model`	String
`custom_emulated_machine`	String
`custom_properties`	CustomProperty[]	Properties sent to VDSM to configure various hooks.
`delete_protected`	Boolean	If `true`, the virtual machine cannot be deleted.
`description`	String	A human-readable description in plain text.
`display`	Display	The virtual machine display configuration.
`domain`	Domain	Domain configured for this virtual machine.
`high_availability`	HighAvailability	The virtual machine high availability configuration.
`id`	String	A unique identifier.
`initialization`	Initialization	Reference to virtual machine’s initialization configuration.
`io`	Io	For performance tuning of IO threading.
`large_icon`	Icon	Virtual machine’s large icon.
`memory`	Integer	The virtual machine’s memory, in bytes.
`memory_policy`	MemoryPolicy	Reference to virtual machine’s memory management configuration.
`migration`	MigrationOptions	Reference to configuration of migration of running virtual machine to another host.
`migration_downtime`	Integer	Maximum time the virtual machine can be non responsive during its live migration to another host in ms.
`name`	String	A human-readable name in plain text.
`origin`	String	The origin of this virtual machine.
`os`	OperatingSystem	Operating system type installed on the virtual machine.
`rng_device`	RngDevice	Random Number Generator device configuration for this virtual machine.
`serial_number`	SerialNumber	Virtual machine’s serial number in a cluster.
`small_icon`	Icon	Virtual machine’s small icon.
`soundcard_enabled`	Boolean	If `true`, the sound card is added to the virtual machine.
`sso`	Sso	Reference to the Single Sign On configuration this virtual machine is configured for.
`start_paused`	Boolean	If `true`, the virtual machine will be initially in 'paused' state after start.
`stateless`	Boolean	If `true`, the virtual machine is stateless - it’s state (disks) are rolled-back after shutdown.
`status`	TemplateStatus	The status of the template.
`time_zone`	TimeZone	The virtual machine’s time zone set by oVirt.
`tunnel_migration`	Boolean	If `true`, the network data transfer will be encrypted during virtual machine live migration.
`type`	VmType	Determines whether the virtual machine is optimized for desktop or server.
`usb`	Usb	Configuration of USB devices for this virtual machine (count, type).
`version`	TemplateVersion	Indicates whether this is a base version or a sub version of another template.
`virtio_scsi`	VirtioScsi	Reference to VirtIO SCSI configuration.
`vm`	Vm	The virtual machine configuration associated with this template.

6.247.1. cpu

The configuration of the virtual machine CPU.

The socket configuration can be updated without rebooting the virtual machine. The cores and the threads require a reboot.

For example, to change the number of sockets to 4 immediately, and the number of cores and threads to 2 after reboot, send the following request:

PUT /ovirt-engine/api/vms/123

With a request body:

<vm>
  <cpu>
    <topology>
      <sockets>4</sockets>
      <cores>2</cores>
      <threads>2</threads>
    </topology>
  </cpu>
</vm>

6.247.2. custom_compatibility_version

Virtual machine custom compatibility version.

Enables a virtual machine to be customized to its own compatibility version. If custom_compatibility_version is set, it overrides the cluster’s compatibility version for this particular virtual machine.

The compatibility version of a virtual machine is limited by the data center the virtual machine resides in, and is checked against capabilities of the host the virtual machine is planned to run on.

6.247.3. high_availability

The virtual machine high availability configuration. If set, the virtual machine will be automatically restarted when it unexpectedly goes down.

6.247.4. large_icon

Virtual machine’s large icon. Either set by user or refers to image set according to operating system.

6.247.5. 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>

Note

Memory in the example is converted to bytes using the following formula:
1 GiB = 2³⁰ bytes = 1073741824 bytes.

Note

Memory hot plug is supported from Red Hat Virtualization 3.6 onwards. You can use the example above to increase memory while the virtual machine is running.

6.247.6. 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]

6.247.7. origin

The origin of this virtual machine.

Possible values:

ovirt
rhev
vmware
xen
external
hosted_engine
managed_hosted_engine
kvm
physical_machine
hyperv

6.247.8. small_icon

Virtual machine’s small icon. Either set by user or refers to image set according to operating system.

6.247.9. 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.

Table 6.324. Links summary

Name	Type	Summary
`cdroms`	Cdrom[]	References to the CD-ROM devices attached to the template.
`cluster`	Cluster	Reference to cluster the virtual machine belongs to.
`cpu_profile`	CpuProfile	Reference to CPU profile used by this virtual machine.
`disk_attachments`	DiskAttachment[]	References to the disks attached to the template.
`graphics_consoles`	GraphicsConsole[]	References to the graphic consoles attached to the template.
`nics`	Nic[]	References to the network interfaces attached to the template.
`permissions`	Permission[]	References to the user permissions attached to the template.
`quota`	Quota	Reference to quota configuration set for this virtual machine.
`storage_domain`	StorageDomain	Reference to storage domain the virtual machine belongs to.
`tags`	Tag[]	References to the tags attached to the template.
`watchdogs`	Watchdog[]	References to the watchdog devices attached to the template.

6.248. TemplateStatus enum

Type representing a status of a virtual machine template.

Table 6.325. Values summary

Name	Summary
`illegal`	This status indicates that at least one of the disks of the template is illegal.
`locked`	This status indicates that some operation that prevents other operations with the template is being executed.
`ok`	This status indicates that the template is valid and ready for use.

6.249. TemplateVersion struct

Type representing a version of a virtual machine template.

Table 6.326. Attributes summary

Name	Type	Summary
`version_name`	String	The name of this version.
`version_number`	Integer	The index of this version in the versions hierarchy of the template.

6.249.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 6.327. Links summary

Name	Type	Summary
`base_template`	Template	References the template that this version is associated with.

6.250. Ticket struct

Type representing a ticket that allows virtual machine access.

Table 6.328. Attributes summary

Name	Type	Summary
`expiry`	Integer	Time to live for the ticket in seconds.
`value`	String	The virtual machine access ticket.

6.251. TimeZone struct

Time zone representation.

Table 6.329. Attributes summary

Name	Type	Summary
`name`	String	Name of the time zone.
`utc_offset`	String	Offset from https://en.

6.251.1. utc_offset

Offset from UTC.

6.252. TransparentHugePages struct

Type representing a transparent huge pages (THP) support.

Table 6.330. Attributes summary

Name	Type	Summary
`enabled`	Boolean	Enable THP support.

6.253. TransportType enum

Protocol used to access a Gluster volume.

Table 6.331. Values summary

Name	Summary
`rdma`	Remote direct memory access.
`tcp`	TCP.

6.254. UnmanagedNetwork struct

Table 6.332. Attributes summary

Name	Type	Summary
`comment`	String	Free text containing comments about this object.
`description`	String	A human-readable description in plain text.
`id`	String	A unique identifier.
`name`	String	A human-readable name in plain text.

Table 6.333. Links summary

Name	Type	Summary
`host`	Host
`host_nic`	HostNic

6.255. Usb struct

Table 6.334. Attributes summary

Name	Type	Summary
`enabled`	Boolean
`type`	UsbType

6.256. UsbType enum

Table 6.335. Values summary

Name	Summary
`legacy`
`native`

6.257. User struct

Represents a user in the system.

Table 6.336. Attributes summary

Name	Type	Summary
`comment`	String	Free text containing comments about this object.
`department`	String
`description`	String	A human-readable description in plain text.
`domain_entry_id`	String
`email`	String
`id`	String	A unique identifier.
`last_name`	String
`logged_in`	Boolean
`name`	String	A human-readable name in plain text.
`namespace`	String	Namespace where user resides.
`password`	String
`principal`	String	Same as `user_name` principal has different formats based on LDAP provider.
`user_name`	String	Username of the user.

6.257.1. namespace

Namespace where user resides. When using the authorization provider that stores users in the LDAP (see here for details) this attribute equals to naming context of the LDAP. When using the built-in authorization provider that stores users in the database (see here for details) this attribute is ignored.

6.257.2. principal

Same as user_name principal has different formats based on LDAP provider. In case of most LDAP providers it is value of the uid LDAP attribute. In case of Active Directory it is the user principal name (UPN).

6.257.3. user_name

Username of the user. The format depends on authorization provider type. In case of most LDAP providers it is value of the uid LDAP attribute. In case of Active Directory it is the user principal name (UPN). UPN or uid must be followed by authorization provider name. For example in case of LDAP using uid attribute it is: myuser@myextension-authz. In case of Active Directory using UPN it is: myuser@mysubdomain.mydomain.com@myextension-authz. This attribute is required parameter when adding new user.

Table 6.337. Links summary

Name	Type	Summary
`domain`	Domain
`groups`	Group[]
`permissions`	Permission[]
`roles`	Role[]	A link to the roles sub-collection for user resources.
`ssh_public_keys`	SshPublicKey[]
`tags`	Tag[]	A link to the tags sub-collection for user resources.

6.258. Value struct

Table 6.338. Attributes summary

Name	Type	Summary
`datum`	Decimal
`detail`	String

6.259. ValueType enum

Table 6.339. Values summary

Name	Summary
`decimal`
`integer`
`string`

6.260. VcpuPin struct

Table 6.340. Attributes summary

Name	Type	Summary
`cpu_set`	String
`vcpu`	Integer

6.261. Vendor struct

Table 6.341. Attributes summary

Name	Type	Summary
`comment`	String	Free text containing comments about this object.
`description`	String	A human-readable description in plain text.
`id`	String	A unique identifier.
`name`	String	A human-readable name in plain text.

6.262. Version struct

Table 6.342. Attributes summary

Name	Type	Summary
`build`	Integer
`comment`	String	Free text containing comments about this object.
`description`	String	A human-readable description in plain text.
`full_version`	String
`id`	String	A unique identifier.
`major`	Integer
`minor`	Integer
`name`	String	A human-readable name in plain text.
`revision`	Integer

6.263. VirtioScsi struct

Type representing the support of virtio-SCSI. If it supported we use virtio driver for SCSI guest device.

Table 6.343. Attributes summary

Name	Type	Summary
`enabled`	Boolean	Enable Virtio SCSI support.

6.264. 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 6.344. Attributes summary

Name	Type	Summary
`comment`	String	Free text containing comments about this object.
`cpu`	Cpu
`description`	String	A human-readable description in plain text.
`id`	String	A unique identifier.
`index`	Integer
`memory`	Integer	Memory of the NUMA node in MB.
`name`	String	A human-readable name in plain text.
`node_distance`	String
`numa_node_pins`	NumaNodePin[]

Table 6.345. Links summary

Name	Type	Summary
`host`	Host
`statistics`	Statistic[]
`vm`	Vm

6.265. Vlan struct

Type representing a Virtual LAN (VLAN) type.

Table 6.346. Attributes summary

Name	Type	Summary
`id`	Integer	Virtual LAN ID.

6.266. Vm struct

Represents a virtual machine.

Table 6.347. Attributes summary

Name	Type	Summary
`bios`	Bios	Reference to virtual machine’s BIOS configuration.
`comment`	String	Free text containing comments about this object.
`console`	Console	Console configured for this virtual machine.
`cpu`	Cpu	The configuration of the virtual machine CPU.
`cpu_shares`	Integer
`creation_time`	Date	The virtual machine creation date.
`custom_compatibility_version`	Version	Virtual machine custom compatibility version.
`custom_cpu_model`	String
`custom_emulated_machine`	String
`custom_properties`	CustomProperty[]	Properties sent to VDSM to configure various hooks.
`delete_protected`	Boolean	If `true`, the virtual machine cannot be deleted.
`description`	String	A human-readable description in plain text.
`display`	Display	The virtual machine display configuration.
`domain`	Domain	Domain configured for this virtual machine.
`fqdn`	String	Fully qualified domain name of the virtual machine.
`guest_operating_system`	GuestOperatingSystem	What operating system is installed on the virtual machine.
`guest_time_zone`	TimeZone	What time zone is used by the virtual machine (as returned by guest agent).
`high_availability`	HighAvailability	The virtual machine high availability configuration.
`id`	String	A unique identifier.
`initialization`	Initialization	Reference to virtual machine’s initialization configuration.
`io`	Io	For performance tuning of IO threading.
`large_icon`	Icon	Virtual machine’s large icon.
`memory`	Integer	The virtual machine’s memory, in bytes.
`memory_policy`	MemoryPolicy	Reference to virtual machine’s memory management configuration.
`migration`	MigrationOptions	Reference to configuration of migration of running virtual machine to another host.
`migration_downtime`	Integer	Maximum time the virtual machine can be non responsive during its live migration to another host in ms.
`name`	String	A human-readable name in plain text.
`next_run_configuration_exists`	Boolean	Virtual machine configuration has been changed and requires restart of the virtual machine.
`numa_tune_mode`	NumaTuneMode	How the NUMA topology is applied.
`origin`	String	The origin of this virtual machine.
`os`	OperatingSystem	Operating system type installed on the virtual machine.
`payloads`	Payload[]	Optional payloads of the virtual machine, used for ISOs to configure it.
`placement_policy`	VmPlacementPolicy	The configuration of the virtual machine’s placement policy.
`rng_device`	RngDevice	Random Number Generator device configuration for this virtual machine.
`run_once`	Boolean	If `true`, the virtual machine has been started using the run once command, meaning it’s configuration might differ from the stored one for the purpose of this single run.
`serial_number`	SerialNumber	Virtual machine’s serial number in a cluster.
`small_icon`	Icon	Virtual machine’s small icon.
`soundcard_enabled`	Boolean	If `true`, the sound card is added to the virtual machine.
`sso`	Sso	Reference to the Single Sign On configuration this virtual machine is configured for.
`start_paused`	Boolean	If `true`, the virtual machine will be initially in 'paused' state after start.
`start_time`	Date	The date in which the virtual machine was started.
`stateless`	Boolean	If `true`, the virtual machine is stateless - it’s state (disks) are rolled-back after shutdown.
`status`	VmStatus	The current status of the virtual machine.
`status_detail`	String	Human readable detail of current status.
`stop_reason`	String	The reason the virtual machine was stopped.
`stop_time`	Date	The date in which the virtual machine was stopped.
`time_zone`	TimeZone	The virtual machine’s time zone set by oVirt.
`tunnel_migration`	Boolean	If `true`, the network data transfer will be encrypted during virtual machine live migration.
`type`	VmType	Determines whether the virtual machine is optimized for desktop or server.
`usb`	Usb	Configuration of USB devices for this virtual machine (count, type).
`use_latest_template_version`	Boolean	If `true`, the virtual machine is reconfigured to the latest version of it’s template when it is started.
`virtio_scsi`	VirtioScsi	Reference to VirtIO SCSI configuration.

6.266.1. cpu

The configuration of the virtual machine CPU.

The socket configuration can be updated without rebooting the virtual machine. The cores and the threads require a reboot.

For example, to change the number of sockets to 4 immediately, and the number of cores and threads to 2 after reboot, send the following request:

PUT /ovirt-engine/api/vms/123

With a request body:

<vm>
  <cpu>
    <topology>
      <sockets>4</sockets>
      <cores>2</cores>
      <threads>2</threads>
    </topology>
  </cpu>
</vm>

6.266.2. custom_compatibility_version

Virtual machine custom compatibility version.

Enables a virtual machine to be customized to its own compatibility version. If custom_compatibility_version is set, it overrides the cluster’s compatibility version for this particular virtual machine.

The compatibility version of a virtual machine is limited by the data center the virtual machine resides in, and is checked against capabilities of the host the virtual machine is planned to run on.

6.266.3. high_availability

The virtual machine high availability configuration. If set, the virtual machine will be automatically restarted when it unexpectedly goes down.

6.266.4. large_icon

Virtual machine’s large icon. Either set by user or refers to image set according to operating system.

6.266.5. 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>

Note

Memory in the example is converted to bytes using the following formula:
1 GiB = 2³⁰ bytes = 1073741824 bytes.

Note

Memory hot plug is supported from Red Hat Virtualization 3.6 onwards. You can use the example above to increase memory while the virtual machine is running.

6.266.6. 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]

6.266.7. 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.

6.266.8. origin

The origin of this virtual machine.

Possible values:

ovirt
rhev
vmware
xen
external
hosted_engine
managed_hosted_engine
kvm
physical_machine
hyperv

6.266.9. 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.

Note

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>

6.266.10. small_icon

Virtual machine’s small icon. Either set by user or refers to image set according to operating system.

6.266.11. 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.

6.266.12. stop_reason

The reason the virtual machine was stopped. Optionally set by user when shutting down the virtual machine.

Table 6.348. Links summary

Name	Type	Summary
`affinity_labels`	AffinityLabel[]	Optional.
`applications`	Application[]	List of applications installed on the virtual machine.
`cdroms`	Cdrom[]	Reference to the ISO mounted to the CDROM.
`cluster`	Cluster	Reference to cluster the virtual machine belongs to.
`cpu_profile`	CpuProfile	Reference to CPU profile used by this virtual machine.
`disk_attachments`	DiskAttachment[]	References the disks attached to the virtual machine.
`external_host_provider`	ExternalHostProvider
`floppies`	Floppy[]	Reference to the ISO mounted to the floppy.
`graphics_consoles`	GraphicsConsole[]	List of graphics consoles configured for this virtual machine.
`host`	Host	Reference to the host the virtual machine is running on.
`host_devices`	HostDevice[]	References devices associated to this virtual machine.
`instance_type`	InstanceType	The virtual machine configuration can be optionally predefined via one of the instance types.
`katello_errata`	KatelloErratum[]	Lists all the Katello errata assigned to the virtual machine.
`nics`	Nic[]	References the list of network interface devices on the virtual machine.
`numa_nodes`	NumaNode[]	Refers to the NUMA Nodes configuration used by this virtual machine.
`permissions`	Permission[]	Permissions set for this virtual machine.
`quota`	Quota	Reference to quota configuration set for this virtual machine.
`reported_devices`	ReportedDevice[]
`sessions`	Session[]	List of user sessions opened for this virtual machine.
`snapshots`	Snapshot[]	Refers to all snapshots taken from the virtual machine.
`statistics`	Statistic[]	Statistics data collected from this virtual machine.
`storage_domain`	StorageDomain	Reference to storage domain the virtual machine belongs to.
`tags`	Tag[]
`template`	Template	Reference to the template the virtual machine is based on.
`vm_pool`	VmPool	Reference to the pool the virtual machine is optionally member of.
`watchdogs`	Watchdog[]	Refers to the Watchdog configuration.

6.266.13. affinity_labels

Optional. Used for labeling of sub-clusters.

6.266.14. 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>

6.267. VmAffinity enum

Table 6.349. Values summary

Name	Summary
`migratable`
`pinned`
`user_migratable`

6.268. VmBase struct

Represents basic virtual machine configuration. This is used by virtual machines, templates and instance types.

Table 6.350. Attributes summary

Name	Type	Summary
`bios`	Bios	Reference to virtual machine’s BIOS configuration.
`comment`	String	Free text containing comments about this object.
`console`	Console	Console configured for this virtual machine.
`cpu`	Cpu	The configuration of the virtual machine CPU.
`cpu_shares`	Integer
`creation_time`	Date	The virtual machine creation date.
`custom_compatibility_version`	Version	Virtual machine custom compatibility version.
`custom_cpu_model`	String
`custom_emulated_machine`	String
`custom_properties`	CustomProperty[]	Properties sent to VDSM to configure various hooks.
`delete_protected`	Boolean	If `true`, the virtual machine cannot be deleted.
`description`	String	A human-readable description in plain text.
`display`	Display	The virtual machine display configuration.
`domain`	Domain	Domain configured for this virtual machine.
`high_availability`	HighAvailability	The virtual machine high availability configuration.
`id`	String	A unique identifier.
`initialization`	Initialization	Reference to virtual machine’s initialization configuration.
`io`	Io	For performance tuning of IO threading.
`large_icon`	Icon	Virtual machine’s large icon.
`memory`	Integer	The virtual machine’s memory, in bytes.
`memory_policy`	MemoryPolicy	Reference to virtual machine’s memory management configuration.
`migration`	MigrationOptions	Reference to configuration of migration of running virtual machine to another host.
`migration_downtime`	Integer	Maximum time the virtual machine can be non responsive during its live migration to another host in ms.
`name`	String	A human-readable name in plain text.
`origin`	String	The origin of this virtual machine.
`os`	OperatingSystem	Operating system type installed on the virtual machine.
`rng_device`	RngDevice	Random Number Generator device configuration for this virtual machine.
`serial_number`	SerialNumber	Virtual machine’s serial number in a cluster.
`small_icon`	Icon	Virtual machine’s small icon.
`soundcard_enabled`	Boolean	If `true`, the sound card is added to the virtual machine.
`sso`	Sso	Reference to the Single Sign On configuration this virtual machine is configured for.
`start_paused`	Boolean	If `true`, the virtual machine will be initially in 'paused' state after start.
`stateless`	Boolean	If `true`, the virtual machine is stateless - it’s state (disks) are rolled-back after shutdown.
`time_zone`	TimeZone	The virtual machine’s time zone set by oVirt.
`tunnel_migration`	Boolean	If `true`, the network data transfer will be encrypted during virtual machine live migration.
`type`	VmType	Determines whether the virtual machine is optimized for desktop or server.
`usb`	Usb	Configuration of USB devices for this virtual machine (count, type).
`virtio_scsi`	VirtioScsi	Reference to VirtIO SCSI configuration.

6.268.1. cpu

The configuration of the virtual machine CPU.

The socket configuration can be updated without rebooting the virtual machine. The cores and the threads require a reboot.

For example, to change the number of sockets to 4 immediately, and the number of cores and threads to 2 after reboot, send the following request:

PUT /ovirt-engine/api/vms/123

With a request body:

<vm>
  <cpu>
    <topology>
      <sockets>4</sockets>
      <cores>2</cores>
      <threads>2</threads>
    </topology>
  </cpu>
</vm>

6.268.2. custom_compatibility_version

Virtual machine custom compatibility version.

Enables a virtual machine to be customized to its own compatibility version. If custom_compatibility_version is set, it overrides the cluster’s compatibility version for this particular virtual machine.

The compatibility version of a virtual machine is limited by the data center the virtual machine resides in, and is checked against capabilities of the host the virtual machine is planned to run on.

6.268.3. high_availability

The virtual machine high availability configuration. If set, the virtual machine will be automatically restarted when it unexpectedly goes down.

6.268.4. large_icon

Virtual machine’s large icon. Either set by user or refers to image set according to operating system.

6.268.5. 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>

Note

Memory in the example is converted to bytes using the following formula:
1 GiB = 2³⁰ bytes = 1073741824 bytes.

Note

Memory hot plug is supported from Red Hat Virtualization 3.6 onwards. You can use the example above to increase memory while the virtual machine is running.

6.268.6. 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]

6.268.7. origin

The origin of this virtual machine.

Possible values:

ovirt
rhev
vmware
xen
external
hosted_engine
managed_hosted_engine
kvm
physical_machine
hyperv

6.268.8. small_icon

Virtual machine’s small icon. Either set by user or refers to image set according to operating system.

6.268.9. 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.

Table 6.351. Links summary

Name	Type	Summary
`cluster`	Cluster	Reference to cluster the virtual machine belongs to.
`cpu_profile`	CpuProfile	Reference to CPU profile used by this virtual machine.
`quota`	Quota	Reference to quota configuration set for this virtual machine.
`storage_domain`	StorageDomain	Reference to storage domain the virtual machine belongs to.

6.269. VmDeviceType enum

Table 6.352. Values summary

Name	Summary
`cdrom`
`floppy`

6.270. VmPlacementPolicy struct

Table 6.353. Attributes summary

Name	Type	Summary
`affinity`	VmAffinity

Table 6.354. Links summary

Name	Type	Summary
`hosts`	Host[]

6.271. VmPool struct

Table 6.355. Attributes summary

Name	Type	Summary
`comment`	String	Free text containing comments about this object.
`description`	String	A human-readable description in plain text.
`display`	Display
`id`	String	A unique identifier.
`max_user_vms`	Integer
`name`	String	A human-readable name in plain text.
`prestarted_vms`	Integer
`rng_device`	RngDevice
`size`	Integer
`soundcard_enabled`	Boolean
`stateful`	Boolean	Virtual machine pool’s stateful flag.
`type`	VmPoolType
`use_latest_template_version`	Boolean

6.271.1. 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.

Table 6.356. Links summary

Name	Type	Summary
`cluster`	Cluster
`instance_type`	InstanceType	Reference to the instance type on which this pool is based.
`permissions`	Permission[]
`template`	Template
`vm`	Vm

6.271.2. 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.

6.272. VmPoolType enum

Table 6.357. Values summary

Name	Summary
`automatic`
`manual`

6.273. VmStatus enum

Type represeting a status of a virtual machine.

Table 6.358. Values summary

Name	Summary
`down`	This status indicates that the virtual machine process is not running.
`image_locked`	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.
`migrating`	This status indicates that the virtual machine process is running and the virtual machine is being migrated from one host to another.
`not_responding`	This status indicates that the hypervisor detected that the virtual machine is not responding.
`paused`	This status indicates that the virtual machine process is running and the virtual machine is paused.
`powering_down`	This status indicates that the virtual machine process is running and it is about to stop running.
`powering_up`	This status indicates that the virtual machine process is running and the guest operating system is being loaded.
`reboot_in_progress`	This status indicates that the virtual machine process is running and the guest operating system is being rebooted.
`restoring_state`	This status indicates that the virtual machine process is about to run and the virtual machine is going to awake from hibernation.
`saving_state`	This status indicates that the virtual machine process is running and the virtual machine is being hibernated.
`suspended`	This status indicates that the virtual machine process is not running and a running state of the virtual machine was saved.
`unassigned`	This status is set when an invalid status is received.
`unknown`	This status indicates that the system failed to determine the status of the virtual machine.
`up`	This status indicates that the virtual machine process is running and the guest operating system is loaded.
`wait_for_launch`	This status indicates that the virtual machine process is about to run.

6.273.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.

6.273.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.

6.273.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.

6.273.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.

6.273.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.

6.273.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.

6.273.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.

6.273.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.

6.274. VmSummary struct

Table 6.359. Attributes summary

Name	Type	Summary
`active`	Integer
`migrating`	Integer
`total`	Integer

6.275. VmType enum

Type representing what the virtual machine is optimized for.

Table 6.360. Values summary

Name	Summary
`desktop`	The virtual machine is intended to be used as a desktop.
`server`	The virtual machine is intended to be used as a server.

6.275.1. desktop

The virtual machine is intended to be used as a desktop. Currently, its implication is that a sound device will be automatically added to the virtual machine.

6.275.2. server

The virtual machine is intended to be used as a server. Currently, its implication is that a sound device will not be automatically added to the virtual machine.

6.276. VnicPassThrough struct

Table 6.361. Attributes summary

Name	Type	Summary
`mode`	VnicPassThroughMode	Defines whether the vNIC will be implemented as a virtual device, or as a pass-through to a host device.

6.277. VnicPassThroughMode enum

The enum describes whether vNIC to be implemented as a pass-through device or a virtual one. Currently it supports only 2 option, but there is a plan to add more in the future.

Table 6.362. Values summary

Name	Summary
`disabled`	To be implemented as a virtual device
`enabled`	To be implemented as a pass-through device

6.278. VnicProfile struct

Table 6.363. Attributes summary

Name	Type	Summary
`comment`	String	Free text containing comments about this object.
`custom_properties`	CustomProperty[]
`description`	String	A human-readable description in plain text.
`id`	String	A unique identifier.
`name`	String	A human-readable name in plain text.
`pass_through`	VnicPassThrough
`port_mirroring`	Boolean

Table 6.364. Links summary

Name	Type	Summary
`network`	Network
`network_filter`	NetworkFilter	Network filter will enhance the admin ability to manage the network packets traffic from/to the participated VMs.
`permissions`	Permission[]
`qos`	Qos

6.279. VolumeGroup struct

Table 6.365. Attributes summary

Name	Type	Summary
`id`	String
`logical_units`	LogicalUnit[]
`name`	String

6.280. Watchdog struct

This type represents a watchdog configuration.

Table 6.366. Attributes summary

Name	Type	Summary
`action`	WatchdogAction	Watchdog action to be performed when watchdog is triggered.
`comment`	String	Free text containing comments about this object.
`description`	String	A human-readable description in plain text.
`id`	String	A unique identifier.
`model`	WatchdogModel	Model of watchdog device.
`name`	String	A human-readable name in plain text.

6.280.1. model

Model of watchdog device. Currently supported only I6300ESB.

Table 6.367. Links summary

Name	Type	Summary
`instance_type`	InstanceType	Optionally references to an instance type the device is used by.
`template`	Template	Optionally references to a template the device is used by.
`vm`	Vm	Don’t use this element, use `vms` instead.
`vms`	Vm[]	References to the virtual machines that are using this device.

6.280.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.

6.281. WatchdogAction enum

This type describes available watchdog actions.

Table 6.368. Values summary

Name	Summary
`dump`	Virtual machine process will get core dumped to the default path on the host.
`none`	No action will be performed when watchdog action is triggered.
`pause`	Virtual machine will be paused when watchdog action is triggered.
`poweroff`	Virtual machine will be powered off when watchdog action is triggered.
`reset`	Virtual machine will be rebooted when watchdog action is triggered.

6.281.1. none

No action will be performed when watchdog action is triggered. However log message will still be generated.

6.282. WatchdogModel enum

This type represents the watchdog model.

Table 6.369. Values summary

Name	Summary
`i6300esb`	Currently only model supported is model I6300ESB.

6.283. Weight struct

Table 6.370. Attributes summary

Name	Type	Summary
`comment`	String	Free text containing comments about this object.
`description`	String	A human-readable description in plain text.
`factor`	Integer
`id`	String	A unique identifier.
`name`	String	A human-readable name in plain text.

Table 6.371. Links summary

Name	Type	Summary
`scheduling_policy`	SchedulingPolicy
`scheduling_policy_unit`	SchedulingPolicyUnit