Chapter 7. Types

7.1. AccessProtocol enum
リンクのコピー

Represents the access protocols supported by Gluster volumes. gluster and nfs are enabled by default.

Expand

Table 7.1. Values summary
Name	Summary
`cifs`	CIFS access protocol.
`gluster`	Gluster access protocol.
`nfs`	NFS access protocol.

7.2. Action struct
リンクのコピー

Expand

Table 7.2. Attributes summary
Name	Type	Summary
`allow_partial_import`	Boolean
`async`	Boolean
`attachment`	DiskAttachment
`authorized_key`	AuthorizedKey
`bricks`	GlusterBrick[]
`certificates`	Certificate[]
`check_connectivity`	Boolean
`clone`	Boolean
`clone_permissions`	Boolean
`cluster`	Cluster
`collapse_snapshots`	Boolean
`comment`	String	Free text containing comments about this object.
`connection`	StorageConnection
`connectivity_timeout`	Integer
`data_center`	DataCenter
`deploy_hosted_engine`	Boolean
`description`	String	A human-readable description in plain text.
`details`	GlusterVolumeProfileDetails
`directory`	String
`discard_snapshots`	Boolean
`discovered_targets`	IscsiDetails[]
`disk`	Disk
`disk_profile`	DiskProfile
`disks`	Disk[]
`exclusive`	Boolean
`fault`	Fault
`fence_type`	String
`filename`	String
`filter`	Boolean
`fix_layout`	Boolean
`force`	Boolean
`grace_period`	GracePeriod
`host`	Host
`id`	String	A unique identifier.
`image`	String
`image_transfer`	ImageTransfer
`import_as_template`	Boolean
`is_attached`	Boolean
`iscsi`	IscsiDetails
`iscsi_targets`	String[]
`job`	Job
`lease`	StorageDomainLease
`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
`permission`	Permission
`power_management`	PowerManagement
`proxy_ticket`	ProxyTicket
`quota`	Quota
`reason`	String
`reassign_bad_macs`	Boolean
`reboot`	Boolean
`registration_configuration`	RegistrationConfiguration
`remote_viewer_connection_file`	String
`removed_bonds`	HostNic[]
`removed_labels`	NetworkLabel[]
`removed_network_attachments`	NetworkAttachment[]
`resolution_type`	String
`restore_memory`	Boolean
`root_password`	String
`seal`	Boolean
`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
`vnic_profile_mappings`	VnicProfileMapping[]
`volatile`	Boolean

7.3. AffinityGroup struct
リンクのコピー

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

Expand

Table 7.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.
`hosts_rule`	AffinityRule	Specifies the affinity rule applied between virtual machines and hosts that are members of this 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.
`vms_rule`	AffinityRule	Specifies the affinity rule applied to virtual machines that are members of this affinity group.

7.3.1. enforcing
リンクのコピー

Specifies whether the affinity group uses hard or soft enforcement of the affinity applied to virtual machines that are members of that affinity group.

Warning

Please note that this attribute has been deprecated since version 4.1 of the engine, and will be removed in the future. Use the vms_rule attribute from now on.

7.3.2. positive
リンクのコピー

Specifies whether the affinity group applies positive affinity or negative affinity to virtual machines that are members of that affinity group.

Warning

Please note that this attribute has been deprecated since version 4.1 of the engine, and will be removed in the future. Use the vms_rule attribute from now on.

Expand

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

7.4. AffinityLabel struct
リンクのコピー

The affinity label can influence virtual machine scheduling. It is most frequently used to create a sub-cluster from the available hosts.

Expand

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

7.4.1. read_only
リンクのコピー

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

Expand

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

7.5. AffinityRule struct
リンクのコピー

Generic rule definition for affinity group. Each supported resource type (virtual machine, host) is controlled by a separate rule. This allows expressing of rules like: no affinity between defined virtual machines, but hard affinity between defined virtual machines and virtual hosts.

Expand

Table 7.7. Attributes summary
Name	Type	Summary
`enabled`	Boolean	Specifies whether the affinity group uses this rule or not.
`enforcing`	Boolean	Specifies whether the affinity group uses hard or soft enforcement of the affinity applied to the resources that are controlled by this rule.
`positive`	Boolean	Specifies whether the affinity group applies positive affinity or negative affinity to the resources that are controlled by this rule.

7.5.1. enabled
リンクのコピー

Specifies whether the affinity group uses this rule or not. This attribute is optional during creation and is considered to be true when it is not provided. In case this attribute is not provided to the update operation, it is considered to be true if AffinityGroup positive attribute is set as well. The backend enabled value will be preserved when both enabled and positive attributes are missing.

7.5.2. enforcing
リンクのコピー

Specifies whether the affinity group uses hard or soft enforcement of the affinity applied to the resources that are controlled by this rule. This argument is mandatory if the rule is enabled and is ignored when the rule is disabled.

7.5.3. positive
リンクのコピー

Specifies whether the affinity group applies positive affinity or negative affinity to the resources that are controlled by this rule. This argument is mandatory if the rule is enabled and is ignored when the rule is disabled.

7.6. Agent struct
リンクのコピー

Type representing a fence agent.

Expand

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

Expand

Table 7.9. Links summary
Name	Type	Summary
`host`	Host	Reference to the host service.

7.6.1. host
リンクのコピー

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

7.7. AgentConfiguration struct
リンクのコピー

Expand

Table 7.10. Attributes summary
Name	Type	Summary
`address`	String
`broker_type`	MessageBrokerType
`network_mappings`	String
`password`	String
`port`	Integer
`username`	String

7.8. Api struct
リンクのコピー

This type contains the information returned by the root service of the API.

To get that information send a request like this:

GET /ovirt-engine/api

The result will be like this:

<api>
  <link rel="hosts" href="/ovirt-engine/api/hosts"/>
  <link rel="vms" href="/ovirt-engine/api/vms"/>
  ...
  <product_info>
    <name>oVirt Engine</name>
    <vendor>ovirt.org</vendor>
    <version>
      <build>0</build>
      <full_version>4.1.0_master</full_version>
      <major>4</major>
      <minor>1</minor>
      <revision>0</revision>
    </version>
  </product_info>
  <special_objects>
    <link rel="templates/blank" href="..."/>
    <link rel="tags/root" href="..."/>
  </special_objects>
  <summary>
    <vms>
      <total>10</total>
      <active>3</active>
    </vms>
    <hosts>
      <total>2</total>
      <active>2</active>
    </hosts>
    <users>
      <total>8</total>
      <active>2</active>
    </users>
    <storage_domains>
      <total>2</total>
      <active>2</active>
    </storage_domains>
  </summary>
  <time>2016-12-12T12:22:25.866+01:00</time>
</api>

Expand

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

Expand

Table 7.12. Links summary
Name	Type	Summary
`authenticated_user`	User	Reference to the authenticated user.
`effective_user`	User	Reference to the effective user.

7.8.1. authenticated_user
リンクのコピー

Reference to the authenticated user.

The authenticated user is the user whose credentials were verified in order to accept the current request. In the current version of the system the authenticated user and the effective user are always the same. In the future, when support for user impersonation is introduced, they will be potentially different.

7.8.2. effective_user
リンクのコピー

Reference to the effective user.

The effective user is the user whose permissions apply during the current request. In the current version of the system the authenticated user and the effective user are always the same. In the future, when support for user impersonation is introduced, they will be potentially different.

7.9. ApiSummary struct
リンクのコピー

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

Expand

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

7.10. ApiSummaryItem struct
リンクのコピー

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

Expand

Table 7.14. Attributes summary
Name	Type	Summary
`active`	Integer	The total number of active objects.
`total`	Integer	The total number of objects.

7.11. Application struct
リンクのコピー

Represents an application installed on a virtual machine. Applications are reported by the guest agent, if you deploy one on the virtual machine operating system.

To get that information send a request like this:

GET /ovirt-engine/api/vms/123/applications/456

The result will be like this:

<application href="/ovirt-engine/api/vms/123/applications/456" id="456">
  <name>application-test-1.0.0-0.el7</name>
  <vm href="/ovirt-engine/api/vms/123" id="123"/>
</application>

Expand

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

Expand

Table 7.16. Links summary
Name	Type	Summary
`vm`	Vm	A reference to the virtual machine the application is installed on.

7.12. Architecture enum
リンクのコピー

Expand

Table 7.17. Values summary
Name	Summary
`ppc64`
`s390x`	IBM S390X CPU architecture.
`undefined`
`x86_64`

7.12.1. s390x
リンクのコピー

IBM S390X CPU architecture.

Needs to be specified for virtual machines and clusters running on the S390X architecture.

Note that S390 is often used in an ambiguous way to describe either the general machine architecture as such or its 31-bit variant. S390X is used specifically for the 64-bit architecture, which is in line with the other architectures, like X86_64 or PPC64.

7.13. AuthorizedKey struct
リンクのコピー

Expand

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

Expand

Table 7.19. Links summary
Name	Type	Summary
`user`	User

7.14. AutoNumaStatus enum
リンクのコピー

Expand

Table 7.20. Values summary
Name	Summary
`disable`
`enable`
`unknown`

7.15. Balance struct
リンクのコピー

Expand

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

Expand

Table 7.22. Links summary
Name	Type	Summary
`scheduling_policy`	SchedulingPolicy
`scheduling_policy_unit`	SchedulingPolicyUnit

7.16. Bios struct
リンクのコピー

Expand

Table 7.23. Attributes summary
Name	Type	Summary
`boot_menu`	BootMenu

7.17. BlockStatistic struct
リンクのコピー

Expand

Table 7.24. Attributes summary
Name	Type	Summary
`statistics`	Statistic[]

7.18. Bonding struct
リンクのコピー

Represents a network interfaces bond.

Expand

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

7.18.1. ad_partner_mac
リンクのコピー

The ad_partner_mac property of the partner bond in mode 4. Bond mode 4 is the 802.3ad standard, which is also called dynamic link aggregation. See Wikipedia and Presentation for more information. ad_partner_mac is the MAC address of the system (switch) at the other end of a bond. This parameter is read-only. Setting it will have no effect on the bond. It is retrieved from /sys/class/net/bondX/bonding/ad_partner_mac file on the system where the bond is located.

7.18.2. options
リンクのコピー

A list of option elements for a bonded interface. Each option contains property name and value attributes. Only required when adding bonded interfaces.

7.18.3. slaves
リンクのコピー

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

Expand

Table 7.26. Links summary
Name	Type	Summary
`active_slave`	HostNic	The `active_slave` property of the bond in modes that support it (active-backup, balance-alb and balance-tlb).

7.18.4. active_slave
リンクのコピー

The active_slave property of the bond in modes that support it (active-backup, balance-alb and balance-tlb). See Linux documentation for further details. This parameter is read-only. Setting it will have no effect on the bond. It is retrieved from /sys/class/net/bondX/bonding/active_slave file on the system where the bond is located.

For example:

GET /ovirt-engine/api/hosts/123/nics/321

Will respond:

<host_nic href="/ovirt-engine/api/hosts/123/nics/321" id="321">
  ...
  <bonding>
    <slaves>
      <host_nic href="/ovirt-engine/api/hosts/123/nics/456" id="456" />
      ...
    </slaves>
    <active_slave href="/ovirt-engine/api/hosts/123/nics/456" id="456" />
  </bonding>
  ...
</host_nic>

7.19. Bookmark struct
リンクのコピー

Represents a bookmark in the system.

Expand

Table 7.27. 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	The bookmark value, representing a search in the engine.

7.20. Boot struct
リンクのコピー

Configuration of the boot sequence of a virtual machine.

Expand

Table 7.28. Attributes summary
Name	Type	Summary
`devices`	BootDevice[]	Ordered list of boot devices.

7.20.1. devices
リンクのコピー

Ordered list of boot devices. The virtual machine will try to boot from the given boot devices, in the given order.

7.21. BootDevice enum
リンクのコピー

Represents the kinds of devices that a virtual machine can boot from.

Expand

Table 7.29. Values summary
Name	Summary
`cdrom`	Boot from CD-ROM.
`hd`	Boot from the hard drive.
`network`	Boot from the network, using PXE.

7.21.1. cdrom
リンクのコピー

Boot from CD-ROM. The CD-ROM can be chosen from the list of ISO files available in an ISO domain attached to the ata center that the virtual machine belongs to.

7.21.2. network
リンクのコピー

Boot from the network, using PXE. It is necessary to have PXE configured on the network that the virtual machine is connected to.

7.22. BootMenu struct
リンクのコピー

Represents boot menu configuration for virtual machines and templates.

Expand

Table 7.30. Attributes summary
Name	Type	Summary
`enabled`	Boolean	Whether the boot menu is enabled for this virtual machine (or template), or not.

7.23. BootProtocol enum
リンクのコピー

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

Expand

Table 7.31. Values summary
Name	Summary
`autoconf`	Stateless address auto-configuration.
`dhcp`	Dynamic host configuration protocol.
`none`	No address configuration.
`poly_dhcp_autoconf`	DHCP alongside Stateless address auto-configuration (SLAAC) The SLAAC mechanism is defined by RFC 4862.
`static`	Statically-defined address, mask and gateway.

7.23.1. autoconf
リンクのコピー

Stateless address auto-configuration.

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

Note

The value is valid for IPv6 addresses only.

7.23.2. dhcp
リンクのコピー

Dynamic host configuration protocol.

Please refer to this wikipedia article for more information.

7.23.3. poly_dhcp_autoconf
リンクのコピー

DHCP alongside Stateless address auto-configuration (SLAAC)

The SLAAC mechanism is defined by RFC 4862. Please refer to Stateless address auto-configuration and DHCP for more information.

Note

The value is valid for IPv6 addresses only.

7.24. BrickProfileDetail struct
リンクのコピー

Expand

Table 7.32. Attributes summary
Name	Type	Summary
`profile_details`	ProfileDetail[]

Expand

Table 7.33. Links summary
Name	Type	Summary
`brick`	GlusterBrick

7.25. Cdrom struct
リンクのコピー

Expand

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

Expand

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

7.25.1. vms
リンクのコピー

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

7.26. Certificate struct
リンクのコピー

Expand

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

7.27. CloudInit struct
リンクのコピー

Deprecated type to specify cloud-init configuration.

This type has been deprecated and replaced by alternative attributes inside the Initialization type. See the cloud_init attribute documentation for details.

Expand

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

7.28. Cluster struct
リンクのコピー

Type representation of a cluster.

A JSON representation of a cluster:

{
  "cluster" : [ {
    "ballooning_enabled" : "false",
    "cpu" : {
      "architecture" : "x86_64",
      "type" : "Intel SandyBridge Family"
    },
    "custom_scheduling_policy_properties" : {
      "property" : [ {
        "name" : "HighUtilization",
        "value" : "80"
      }, {
        "name" : "CpuOverCommitDurationMinutes",
        "value" : "2"
      } ]
    },
    "error_handling" : {
      "on_error" : "migrate"
    },
    "fencing_policy" : {
      "enabled" : "true",
      "skip_if_connectivity_broken" : {
        "enabled" : "false",
        "threshold" : "50"
      },
      "skip_if_gluster_bricks_up" : "false",
      "skip_if_gluster_quorum_not_met" : "false",
      "skip_if_sd_active" : {
        "enabled" : "false"
      }
    },
    "gluster_service" : "false",
    "firewall_type" : "iptables",
    "ha_reservation" : "false",
    "ksm" : {
      "enabled" : "true",
      "merge_across_nodes" : "true"
    },
    "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"
    }, {
      "href" : "/ovirt-engine/api/clusters/234/enabledfeatures",
      "rel" : "enabledfeatures"
    }, {
      "href" : "/ovirt-engine/api/clusters/234/externalnetworkproviders",
      "rel" : "externalnetworkproviders"
    } ]
  } ]
}

Expand

Table 7.38. 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	A custom fencing policy can be defined for a cluster.
`firewall_type`	FirewallType	The type of firewall to be used on hosts in this cluster.
`gluster_service`	Boolean
`gluster_tuned_profile`	String	The name of the https://fedorahosted.
`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[]	Set of random number generator (RNG) sources required from each host in the cluster.
`serial_number`	SerialNumber
`supported_versions`	Version[]
`switch_type`	SwitchType	The 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

7.28.1. custom_scheduling_policy_properties
リンクのコピー

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

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

PUT /ovirt-engine/api/clusters/123

With a request body:

<cluster>
  <custom_scheduling_policy_properties>
    <property>
      <name>HighUtilization</name>
      <value>70</value>
    </property>
  </custom_scheduling_policy_properties>
</cluster>

Update operations using the custom_scheduling_policy_properties attribute will not update the the properties of the scheduling policy specified by the scheduling_policy link, they will only be reflected on this specific cluster.

7.28.2. fencing_policy
リンクのコピー

A custom fencing policy can be defined for a cluster.

For example:

PUT /ovirt-engine/api/cluster/123

With request body like this:

<cluster>
  <fencing_policy>
    <enabled>true</enabled>
    <skip_if_sd_active>
      <enabled>false</enabled>
    </skip_if_sd_active>
    <skip_if_connectivity_broken>
      <enabled>false</enabled>
      <threshold>50</threshold>
    </skip_if_connectivity_broken>
  </fencing_policy>
</cluster>

7.28.3. firewall_type
リンクのコピー

The type of firewall to be used on hosts in this cluster.

Up to version 4.1, it was always iptables. Since version 4.2, you can choose between iptables and firewalld. For clusters with a compatibility version of 4.2 and higher, the default firewall type is firewalld.

7.28.4. gluster_tuned_profile
リンクのコピー

The name of the tuned profile to set on all the hosts in the cluster. This is not mandatory and relevant only for clusters with Gluster service.

7.28.5. required_rng_sources
リンクのコピー

Set of random number generator (RNG) sources required from each host in the cluster.

When read, it returns the implicit urandom (for cluster version 4.1 and higher) or random (for cluster version 4.0 and lower) plus additional selected RNG sources. When written, the implicit urandom and random RNG sources cannot be removed.

Important

Before version 4.1 of the engine, the set of required random number generators was completely controllable by the administrator; any source could be added or removed, including the random source. But starting with version 4.1, the urandom and random sources will always be part of the set, and can’t be removed.

Important

Engine version 4.1 introduces a new RNG source urandom that replaces random RNG source in clusters with compatibility version 4.1 or higher.

7.28.6. version
リンクのコピー

The compatibility version of the cluster.

All hosts in this cluster must support at least this compatibility version.

For example:

GET /ovirt-engine/api/clusters/123

Will respond with:

<cluster>
  ...
  <version>
    <major>4</major>
    <minor>0</minor>
  </version>
  ...
</cluster>

To update the compatibility version, use:

PUT /ovirt-engine/api/clusters/123

With a request body like this:

<cluster>
  <version>
    <major>4</major>
    <minor>1</minor>
  </version>
</cluster>

In order to update the cluster compatibility version, all hosts in the cluster must support the new compatibility version.

Expand

Table 7.39. Links summary
Name	Type	Summary
`affinity_groups`	AffinityGroup[]
`cpu_profiles`	CpuProfile[]
`data_center`	DataCenter
`enabled_features`	ClusterFeature[]	Custom features that are enabled for the cluster.
`external_network_providers`	ExternalProvider[]	A reference to the external network provider available in the cluster.
`gluster_hooks`	GlusterHook[]
`gluster_volumes`	GlusterVolume[]
`mac_pool`	MacPool	A reference to the MAC pool used by this cluster.
`management_network`	Network
`network_filters`	NetworkFilter[]
`networks`	Network[]
`permissions`	Permission[]
`scheduling_policy`	SchedulingPolicy	Reference to the default scheduling policy used by this cluster.

7.28.7. external_network_providers
リンクのコピー

A reference to the external network provider available in the cluster.

If the automatic deployment of the external network provider is supported, the networks of the referenced network provider are available on every host in the cluster. External network providers of a cluster can only be set during adding the cluster. This value may be overwritten for individual hosts during adding the host.

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

7.29. ClusterFeature struct
リンクのコピー

Type represents an additional feature that is available at a cluster level.

Expand

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

Expand

Table 7.41. Links summary
Name	Type	Summary
`cluster_level`	ClusterLevel	Reference to the cluster level.

7.30. ClusterLevel struct
リンクのコピー

Describes the capabilities supported by a specific cluster level.

Expand

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

Expand

Table 7.43. Links summary
Name	Type	Summary
`cluster_features`	ClusterFeature[]	The additional features supported by this cluster level.

7.31. Configuration struct
リンクのコピー

Expand

Table 7.44. Attributes summary
Name	Type	Summary
`data`	String	The document describing the virtual machine.
`type`	ConfigurationType

7.31.1. data
リンクのコピー

The document describing the virtual machine.

Example of the OVF document:

<?xml version='1.0' encoding='UTF-8'?>
<ovf:Envelope xmlns:ovf="http://schemas.dmtf.org/ovf/envelope/1/"
  xmlns:rasd="http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/CIM_ResourceAllocationSettingData"
  xmlns:vssd="http://schemas.dmtf.org/wbem/wscim/1/cim-schema/2/CIM_VirtualSystemSettingData"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  ovf:version="3.5.0.0">
  <References/>
  <Section xsi:type="ovf:NetworkSection_Type">
    <Info>List of networks</Info>
    <Network ovf:name="Network 1"/>
  </Section>
  <Section xsi:type="ovf:DiskSection_Type">
    <Info>List of Virtual Disks</Info>
  </Section>
  <Content ovf:id="out" xsi:type="ovf:VirtualSystem_Type">
    <CreationDate>2014/12/03 04:25:45</CreationDate>
    <ExportDate>2015/02/09 14:12:24</ExportDate>
    <DeleteProtected>false</DeleteProtected>
    <SsoMethod>guest_agent</SsoMethod>
    <IsSmartcardEnabled>false</IsSmartcardEnabled>
    <TimeZone>Etc/GMT</TimeZone>
    <default_boot_sequence>0</default_boot_sequence>
    <Generation>1</Generation>
    <VmType>1</VmType>
    <MinAllocatedMem>1024</MinAllocatedMem>
    <IsStateless>false</IsStateless>
    <IsRunAndPause>false</IsRunAndPause>
    <AutoStartup>false</AutoStartup>
    <Priority>1</Priority>
    <CreatedByUserId>fdfc627c-d875-11e0-90f0-83df133b58cc</CreatedByUserId>
    <IsBootMenuEnabled>false</IsBootMenuEnabled>
    <IsSpiceFileTransferEnabled>true</IsSpiceFileTransferEnabled>
    <IsSpiceCopyPasteEnabled>true</IsSpiceCopyPasteEnabled>
    <Name>VM_export</Name>
    <TemplateId>00000000-0000-0000-0000-000000000000</TemplateId>
    <TemplateName>Blank</TemplateName>
    <IsInitilized>false</IsInitilized>
    <Origin>3</Origin>
    <DefaultDisplayType>1</DefaultDisplayType>
    <TrustedService>false</TrustedService>
    <OriginalTemplateId>00000000-0000-0000-0000-000000000000</OriginalTemplateId>
    <OriginalTemplateName>Blank</OriginalTemplateName>
    <UseLatestVersion>false</UseLatestVersion>
    <Section ovf:id="70b4d9a7-4f73-4def-89ca-24fc5f60e01a"
      ovf:required="false"
      xsi:type="ovf:OperatingSystemSection_Type">
      <Info>Guest Operating System</Info>
      <Description>other</Description>
    </Section>
    <Section xsi:type="ovf:VirtualHardwareSection_Type">
      <Info>1 CPU, 1024 Memory</Info>
      <System>
        <vssd:VirtualSystemType>ENGINE 3.5.0.0</vssd:VirtualSystemType>
      </System>
      <Item>
        <rasd:Caption>1 virtual cpu</rasd:Caption>
        <rasd:Description>Number of virtual CPU</rasd:Description>
        <rasd:InstanceId>1</rasd:InstanceId>
        <rasd:ResourceType>3</rasd:ResourceType>
        <rasd:num_of_sockets>1</rasd:num_of_sockets>
        <rasd:cpu_per_socket>1</rasd:cpu_per_socket>
      </Item>
      <Item>
        <rasd:Caption>1024 MB of memory</rasd:Caption>
        <rasd:Description>Memory Size</rasd:Description>
        <rasd:InstanceId>2</rasd:InstanceId>
        <rasd:ResourceType>4</rasd:ResourceType>
        <rasd:AllocationUnits>MegaBytes</rasd:AllocationUnits>
        <rasd:VirtualQuantity>1024</rasd:VirtualQuantity>
      </Item>
      <Item>
        <rasd:Caption>USB Controller</rasd:Caption>
        <rasd:InstanceId>3</rasd:InstanceId>
        <rasd:ResourceType>23</rasd:ResourceType>
        <rasd:UsbPolicy>DISABLED</rasd:UsbPolicy>
      </Item>
    </Section>
  </Content>
</ovf:Envelope>

7.32. ConfigurationType enum
リンクのコピー

Configuration format types.

Expand

Table 7.45. Values summary
Name	Summary
`ova`	ConfigurationType of type standard OVF.
`ovf`	ConfigurationType of type oVirt-compatible OVF.

7.32.1. ova
リンクのコピー

ConfigurationType of type standard OVF.

The provided virtual machine configuration conforms with the Open Virtualization Format (OVF) standard. This value should be used for an OVF configuration that is extracted from an Open Virtual Appliance (OVA) that was generated by oVirt or by other vendors. See here for the OVF specification.

7.32.2. ovf
リンクのコピー

ConfigurationType of type oVirt-compatible OVF.

The provided virtual machine configuration conforms with the oVirt-compatible form of the Open Virtualization Format (OVF). Note that the oVirt-compatible form of the OVF may differ from the OVF standard that is used by other vendors. This value should be used for an OVF configuration that is taken from a storage domain.

7.33. Console struct
リンクのコピー

Representation for serial console device.

Expand

Table 7.46. Attributes summary
Name	Type	Summary
`enabled`	Boolean	Enable/disable the serial console device.

7.34. Core struct
リンクのコピー

Expand

Table 7.47. Attributes summary
Name	Type	Summary
`index`	Integer
`socket`	Integer

7.35. Cpu struct
リンクのコピー

Expand

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

7.36. CpuMode enum
リンクのコピー

Expand

Table 7.49. Values summary
Name	Summary
`custom`
`host_model`
`host_passthrough`

7.37. CpuProfile struct
リンクのコピー

Expand

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

Expand

Table 7.51. Links summary
Name	Type	Summary
`cluster`	Cluster
`permissions`	Permission[]
`qos`	Qos

7.38. CpuTopology struct
リンクのコピー

Expand

Table 7.52. Attributes summary
Name	Type	Summary
`cores`	Integer
`sockets`	Integer
`threads`	Integer

7.39. CpuTune struct
リンクのコピー

Expand

Table 7.53. Attributes summary
Name	Type	Summary
`vcpu_pins`	VcpuPin[]

7.40. CpuType struct
リンクのコピー

Describes a supported CPU type.

Expand

Table 7.54. 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`.

7.41. CreationStatus enum
リンクのコピー

Expand

Table 7.55. Values summary
Name	Summary
`complete`
`failed`
`in_progress`
`pending`

7.42. CustomProperty struct
リンクのコピー

Custom property representation.

Expand

Table 7.56. Attributes summary
Name	Type	Summary
`name`	String	Property name.
`regexp`	String	A regular expression defining the available values a custom property can get.
`value`	String	Property value.

7.43. DataCenter struct
リンクのコピー

Expand

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

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

Expand

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

7.44. DataCenterStatus enum
リンクのコピー

Expand

Table 7.59. Values summary
Name	Summary
`contend`
`maintenance`
`not_operational`
`problematic`
`uninitialized`
`up`

7.45. Device struct
リンクのコピー

A device wraps links to potential parents of a device.

Expand

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

Expand

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

7.45.1. vms
リンクのコピー

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

7.46. Disk struct
リンクのコピー

Represents a virtual disk device.

Expand

Table 7.62. 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.
`content_type`	DiskContentType	Indicates the actual content residing on the disk.
`description`	String	A human-readable description in plain text.
`format`	DiskFormat	The underlying storage format.
`id`	String	A unique identifier.
`image_id`	String
`initial_size`	Integer	The initial size of a sparse image disk created on block storage, in bytes.
`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 cause virtual machine to be paused or if disk errors should be propagated to the the guest operating system instead.
`provisioned_size`	Integer	The virtual size of the disk, in bytes.
`qcow_version`	QcowVersion	The underlying QCOW version of a QCOW volume.
`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
`total_size`	Integer	The total size of the disk including all of its snapshots, in bytes.
`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.

7.46.1. active
リンクのコピー

Indicates if the disk is visible to the virtual machine.

Important

When adding a disk attachment to a virtual machine, if the server accepts requests that do not contain this attribute the result is undefined. In some cases the disk will be automatically activated and in other cases it will not. To avoid issues it is strongly recommended to always include the this attribute with the desired value.

7.46.2. actual_size
リンクのコピー

The actual size of the disk, in bytes.

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

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

7.46.4. initial_size
リンクのコピー

The initial size of a sparse image disk created on block storage, in bytes.

The initial size is the number of bytes a sparse disk is initially allocated with when created on block storage. The initial size will be smaller than the provisioned size. If not specified the default initial size used by the system will be allocated.

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

7.46.6. provisioned_size
リンクのコピー

The virtual size of the disk, in bytes.

This attribute is mandatory when creating a new disk.

7.46.7. qcow_version
リンクのコピー

The underlying QCOW version of a QCOW volume. The QCOW version specifies to the qemu which qemu version the volume supports. This field can be updated using the update API and will be reported only for QCOW volumes. It is determined by the version of the storage domain that the disk is created on. Storage domains with a version lower than V4 support QCOW2 volumes. V4 storage domains also support QCOW2v3. For more information about features of the different QCOW versions, see here.

7.46.8. read_only
リンクのコピー

Indicates if the disk is in read-only mode.

Since version 4.0 this attribute is not shown in the API and was moved to DiskAttachment.

Since version 4.1.2 of Red Hat Virtualization Manager this attribute is deprecated, and it will be removed in the future. In order to attach a disk in read only mode use the read_only attribute of the DiskAttachment type. For example:

POST /ovirt-engine/api/vms/123/diskattachments

<disk_attachment>
  <read_only>true</read_only>
  ...
</disk_attachment>

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

7.46.10. total_size
リンクのコピー

The total size of the disk including all of its snapshots, in bytes.

The total size is the number of bytes actually used by the disk plus the size of its snapshots. It won’t be populated for direct LUN and Cinder disks. For disks without snapshots the total size is equal to the actual size.

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

Expand

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

7.46.12. statistics
リンクのコピー

Statistics exposed by the disk. For example:

<statistics>
  <statistic href="/ovirt-engine/api/disks/123/statistics/456" id="456">
    <name>data.current.read</name>
    <description>Read data rate</description>
    <kind>gauge</kind>
    <type>decimal</type>
    <unit>bytes_per_second</unit>
    <values>
      <value>
        <datum>1052</datum>
      </value>
    </values>
    <disk href="/ovirt-engine/api/disks/123" id="123"/>
  </statistic>
  ...
</statistics>

These statistics are not directly included when the disk is retrieved, only a link. To obtain the statistics follow the included link:

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

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

7.46.14. vms
リンクのコピー

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

7.47. DiskAttachment struct
リンクのコピー

Describes how a disk is attached to a virtual machine.

Expand

Table 7.64. Attributes summary
Name	Type	Summary
`active`	Boolean	Defines whether 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.
`pass_discard`	Boolean	Defines whether the virtual machine passes discard commands to the storage.
`read_only`	Boolean	Indicates whether the disk is connected to the virtual machine as read only.
`uses_scsi_reservation`	Boolean	Defines whether SCSI reservation is enabled for this disk.

7.47.1. active
リンクのコピー

Defines whether the disk is active in the virtual machine it’s attached to.

A disk attached to a virtual machine in an active status is connected to the virtual machine at run time and can be used.

7.47.2. logical_name
リンクのコピー

The logical name of the virtual machine’s disk, as seen from inside the virtual machine.

The logical name of a disk is reported only when the guest agent is installed and running inside the virtual machine.

For example, if the guest operating system is Linux and the disk is connected via a VirtIO interface, the logical name will be reported as /dev/vda:

<disk_attachment>
  ...
  <logical_name>/dev/vda</logical_name>
</disk_attachment>

If the guest operating system is Windows, the logical name will be reported as \\.\PHYSICALDRIVE0.

7.47.3. read_only
リンクのコピー

Indicates whether the disk is connected to the virtual machine as read only.

When adding a new disk attachment the default value is false.

<disk_attachment>
  ...
  <read_only>true</read_only>
</disk_attachment>

7.47.4. uses_scsi_reservation
リンクのコピー

Defines whether SCSI reservation is enabled for this disk.

Virtual machines with VIRTIO-SCSI passthrough enabled can set persistent SCSI reservations on disks. If they set persistent SCSI reservations, those virtual machines cannot be migrated to a different host because they would lose access to the disk, because SCSI reservations are specific to SCSI initiators, and therefore hosts. This scenario cannot be automatically detected. To avoid migrating these virtual machines, the user can set this attribute to true, to indicate the virtual machine is using SCSI reservations.

Expand

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

7.48. DiskContentType enum
リンクのコピー

The actual content residing on the disk.

Expand

Table 7.66. Values summary
Name	Summary
`data`	The disk contains data.
`iso`	The disk contains an ISO image to be used a CDROM device.
`memory_dump_volume`	The disk contains a memory dump from a live snapshot.
`memory_metadata_volume`	The disk contains memory metadata from a live snapshot.
`ovf_store`	The disk is an OVF store.

7.49. DiskFormat enum
リンクのコピー

The underlying storage format of disks.

Expand

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

7.50. DiskInterface enum
リンクのコピー

The underlying storage interface of disks communication with controller.

Expand

Table 7.68. Values summary
Name	Summary
`ide`	Legacy controller device.
`spapr_vscsi`	Para-virtualized device supported by the IBM pSeries family of machines, using the SCSI protocol.
`virtio`	Virtualization interface where just the guest’s device driver knows it is running in a virtual environment.
`virtio_scsi`	Para-virtualized SCSI controller device.

7.50.1. ide
リンクのコピー

Legacy controller device. Works with almost all guest operating systems, so it is good for compatibility. Performance is lower than with the other alternatives.

7.50.2. virtio
リンクのコピー

Virtualization interface where just the guest’s device driver knows it is running in a virtual environment. Enables guests to get high performance disk operations.

7.50.3. virtio_scsi
リンクのコピー

Para-virtualized SCSI controller device. Fast interface with the guest via direct physical storage device address, using the SCSI protocol.

7.51. DiskProfile struct
リンクのコピー

Expand

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

Expand

Table 7.70. Links summary
Name	Type	Summary
`permissions`	Permission[]
`qos`	Qos
`storage_domain`	StorageDomain

7.52. DiskSnapshot struct
リンクのコピー

Expand

Table 7.71. 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.
`content_type`	DiskContentType	Indicates the actual content residing on the disk.
`description`	String	A human-readable description in plain text.
`format`	DiskFormat	The underlying storage format.
`id`	String	A unique identifier.
`image_id`	String
`initial_size`	Integer	The initial size of a sparse image disk created on block storage, in bytes.
`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 cause virtual machine to be paused or if disk errors should be propagated to the the guest operating system instead.
`provisioned_size`	Integer	The virtual size of the disk, in bytes.
`qcow_version`	QcowVersion	The underlying QCOW version of a QCOW volume.
`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
`total_size`	Integer	The total size of the disk including all of its snapshots, in bytes.
`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.

7.52.1. active
リンクのコピー

Indicates if the disk is visible to the virtual machine.

Important

When adding a disk attachment to a virtual machine, if the server accepts requests that do not contain this attribute the result is undefined. In some cases the disk will be automatically activated and in other cases it will not. To avoid issues it is strongly recommended to always include the this attribute with the desired value.

7.52.2. actual_size
リンクのコピー

The actual size of the disk, in bytes.

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

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

7.52.4. initial_size
リンクのコピー

The initial size of a sparse image disk created on block storage, in bytes.

The initial size is the number of bytes a sparse disk is initially allocated with when created on block storage. The initial size will be smaller than the provisioned size. If not specified the default initial size used by the system will be allocated.

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

7.52.6. provisioned_size
リンクのコピー

The virtual size of the disk, in bytes.

This attribute is mandatory when creating a new disk.

7.52.7. qcow_version
リンクのコピー

The underlying QCOW version of a QCOW volume. The QCOW version specifies to the qemu which qemu version the volume supports. This field can be updated using the update API and will be reported only for QCOW volumes. It is determined by the version of the storage domain that the disk is created on. Storage domains with a version lower than V4 support QCOW2 volumes. V4 storage domains also support QCOW2v3. For more information about features of the different QCOW versions, see here.

7.52.8. read_only
リンクのコピー

Indicates if the disk is in read-only mode.

Since version 4.0 this attribute is not shown in the API and was moved to DiskAttachment.

Since version 4.1.2 of Red Hat Virtualization Manager this attribute is deprecated, and it will be removed in the future. In order to attach a disk in read only mode use the read_only attribute of the DiskAttachment type. For example:

POST /ovirt-engine/api/vms/123/diskattachments

<disk_attachment>
  <read_only>true</read_only>
  ...
</disk_attachment>

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

7.52.10. total_size
リンクのコピー

The total size of the disk including all of its snapshots, in bytes.

The total size is the number of bytes actually used by the disk plus the size of its snapshots. It won’t be populated for direct LUN and Cinder disks. For disks without snapshots the total size is equal to the actual size.

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

Expand

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

7.52.12. statistics
リンクのコピー

Statistics exposed by the disk. For example:

<statistics>
  <statistic href="/ovirt-engine/api/disks/123/statistics/456" id="456">
    <name>data.current.read</name>
    <description>Read data rate</description>
    <kind>gauge</kind>
    <type>decimal</type>
    <unit>bytes_per_second</unit>
    <values>
      <value>
        <datum>1052</datum>
      </value>
    </values>
    <disk href="/ovirt-engine/api/disks/123" id="123"/>
  </statistic>
  ...
</statistics>

These statistics are not directly included when the disk is retrieved, only a link. To obtain the statistics follow the included link:

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

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

7.52.14. vms
リンクのコピー

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

7.53. DiskStatus enum
リンクのコピー

Current status representation for disk.

Expand

Table 7.73. Values summary
Name	Summary
`illegal`	Disk cannot be accessed by the virtual machine, and the user needs to take action to resolve the issue.
`locked`	The disk is being used by the system, therefore it cannot be accessed by virtual machines at this point.
`ok`	The disk status is normal and can be accessed by the virtual machine.

7.53.1. locked
リンクのコピー

The disk is being used by the system, therefore it cannot be accessed by virtual machines at this point. This is usually a temporary status, until the disk is freed.

7.54. DiskStorageType enum
リンクのコピー

Expand

Table 7.74. Values summary
Name	Summary
`cinder`
`image`
`lun`

7.55. DiskType enum
リンクのコピー

Expand

Table 7.75. Values summary
Name	Summary
`data`
`system`

7.56. Display struct
リンクのコピー

Represents a graphic console configuration.

Expand

Table 7.76. Attributes summary
Name	Type	Summary
`address`	String	The IP address of the guest to connect the graphic console client to.
`allow_override`	Boolean	Indicates if to override the display address per host.
`certificate`	Certificate	The TLS certificate in case of a TLS connection.
`copy_paste_enabled`	Boolean	Indicates whether a user is able to copy and paste content from an external host into the graphic console.
`disconnect_action`	String	Returns the action that will take place when the graphic console is disconnected.
`file_transfer_enabled`	Boolean	Indicates if a user is able to drag and drop files from an external host into the graphic console.
`keyboard_layout`	String	The keyboard layout to use with this graphic console.
`monitors`	Integer	The number of monitors opened for this graphic console.
`port`	Integer	The port address on the guest to connect the graphic console client to.
`proxy`	String	The proxy IP which will be used by the graphic console client to connect to the guest.
`secure_port`	Integer	The secured port address on the guest, in case of using TLS, to connect the graphic console client to.
`single_qxl_pci`	Boolean	Indicates if to use one PCI slot for each monitor or to use a single PCI channel for all multiple monitors.
`smartcard_enabled`	Boolean	Indicates if to use smart card authentication.
`type`	DisplayType	The graphic console protocol type.

7.56.1. allow_override
リンクのコピー

Indicates if to override the display address per host. Relevant only for the Host.display attribute. If set, the graphical console address of a virtual machine will be overridden by the host specified display address. if not set, the graphical console address of a virtual machine will not be overridden.

7.56.2. certificate
リンクのコピー

The TLS certificate in case of a TLS connection. If TLS isn’t enabled then it won’t be reported.

7.56.3. copy_paste_enabled
リンクのコピー

Indicates whether a user is able to copy and paste content from an external host into the graphic console. This option is only available for the SPICE console type.

7.56.4. disconnect_action
リンクのコピー

Returns the action that will take place when the graphic console is disconnected. The options are:

none: No action is taken.
lock_screen: Locks the currently active user session.
logout: Logs out the currently active user session.
reboot: Initiates a graceful virtual machine reboot.
shutdown: Initiates a graceful virtual machine shutdown.

This option is only available for the SPICE console type.

7.56.5. file_transfer_enabled
リンクのコピー

Indicates if a user is able to drag and drop files from an external host into the graphic console. This option is only available for the SPICE console type.

7.56.6. keyboard_layout
リンクのコピー

The keyboard layout to use with this graphic console. This option is only available for the VNC console type. If no keyboard is enabled then it won’t be reported.

7.56.7. monitors
リンクのコピー

The number of monitors opened for this graphic console. This option is only available for the SPICE console type. Possible values are 1, 2 or 4.

7.56.8. proxy
リンクのコピー

The proxy IP which will be used by the graphic console client to connect to the guest. It is useful when the client is outside the guest’s network. This option is only available for the SPICE console type. This proxy can be set in global configuration, cluster level, virtual machine pool level or disabled per virtual machine. If the proxy is set in any of this mentioned places and not disabled for the virtual machine, it will be returned by this method. If the proxy is not set, nothing will be reported.

7.56.9. secure_port
リンクのコピー

The secured port address on the guest, in case of using TLS, to connect the graphic console client to. If TLS isn’t enabled then it won’t be reported.

7.56.10. single_qxl_pci
リンクのコピー

Indicates if to use one PCI slot for each monitor or to use a single PCI channel for all multiple monitors. This option is only available for the SPICE console type and only for connecting a guest Linux based OS.

7.56.11. smartcard_enabled
リンクのコピー

Indicates if to use smart card authentication. This option is only available for the SPICE console type.

7.57. DisplayType enum
リンクのコピー

Represents an enumeration of the protocol used to connect to the graphic console of the virtual machine.

Expand

Table 7.77. Values summary
Name	Summary
`spice`	Display of type SPICE.
`vnc`	Display of type VNC.

7.57.1. spice
リンクのコピー

Display of type SPICE. See https://www.spice-space.org for more details.

7.57.2. vnc
リンクのコピー

Display of type VNC. VNC stands for Virtual Network Computing, and it is a graphical desktop sharing system that uses RFB (Remote Frame Buffer) protocol to remotely control another machine.

7.58. Dns struct
リンクのコピー

Represents the DNS resolver configuration.

Expand

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

7.59. DnsResolverConfiguration struct
リンクのコピー

Represents the DNS resolver configuration.

Expand

Table 7.79. Attributes summary
Name	Type	Summary
`name_servers`	String[]	Array of addresses of name servers.

7.59.1. name_servers
リンクのコピー

Array of addresses of name servers. Either IPv4 or IPv6 addresses may be specified.

7.60. Domain struct
リンクのコピー

This type represents a directory service domain.

Expand

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

Expand

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

7.60.1. users
リンクのコピー

A reference to a list of all users in the directory service. This information is used to add new users to the Red Hat Virtualization environment.

7.61. EntityExternalStatus enum
リンクのコピー

Type representing an external entity status.

Expand

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

7.61.1. error
リンクのコピー

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

7.61.2. failure
リンクのコピー

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

7.62. EntityProfileDetail struct
リンクのコピー

Expand

Table 7.83. Attributes summary
Name	Type	Summary
`profile_details`	ProfileDetail[]

7.63. ErrorHandling struct
リンクのコピー

Expand

Table 7.84. Attributes summary
Name	Type	Summary
`on_error`	MigrateOnError

7.64. Event struct
リンクのコピー

Type representing an event.

Expand

Table 7.85. 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.
`index`	Integer	The numeric index of this event.
`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.

7.64.1. correlation_id
リンクのコピー

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

7.64.2. flood_rate
リンクのコピー

Defines the flood rate. This prevents flooding in case an event appeared more than once in the defined rate. Defaults is 30 seconds.

7.64.3. index
リンクのコピー

The numeric index of this event. The indexes of events are always increasing, so events with higher indexes are guaranteed to be older than events with lower indexes.

Important

In the current implementation of the engine, the id attribute has the same value as this index attribute. That is an implementation detail that the user of the API should not rely on. In the future the id attribute may be changed to an arbitrary string, containing non numeric characters and no implicit order. On the other hand this index attribute is guaranteed to stay as integer and ordered.

Expand

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

7.64.4. cluster
リンクのコピー

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

7.64.5. data_center
リンクのコピー

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

7.64.6. host
リンクのコピー

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

7.64.7. storage_domain
リンクのコピー

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

7.64.8. template
リンクのコピー

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

7.64.9. user
リンクのコピー

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

7.64.10. vm
リンクのコピー

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

7.65. ExternalComputeResource struct
リンクのコピー

Expand

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

Expand

Table 7.88. Links summary
Name	Type	Summary
`external_host_provider`	ExternalHostProvider

7.66. ExternalDiscoveredHost struct
リンクのコピー

Expand

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

Expand

Table 7.90. Links summary
Name	Type	Summary
`external_host_provider`	ExternalHostProvider

7.67. ExternalHost struct
リンクのコピー

Represents a host provisioned by a host provider (such as Foreman/Satellite).

See https://www.theforeman.org/ for more details on Foreman. See https://access.redhat.com/products/red-hat-satellite for more details on Red Hat Satellite.

Expand

Table 7.91. Attributes summary
Name	Type	Summary
`address`	String	The address of the host, either IP address of FQDN (Fully Qualified Domain Name).
`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.

Expand

Table 7.92. Links summary
Name	Type	Summary
`external_host_provider`	ExternalHostProvider	A reference to the external host provider that the host is managed by.

7.68. ExternalHostGroup struct
リンクのコピー

Expand

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

Expand

Table 7.94. Links summary
Name	Type	Summary
`external_host_provider`	ExternalHostProvider

7.69. ExternalHostProvider struct
リンクのコピー

Represents an external host provider, such as Foreman or Satellite.

See https://www.theforeman.org/ for more details on Foreman. See https://access.redhat.com/products/red-hat-satellite for more details on Red Hat Satellite.

Expand

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

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

Expand

Table 7.96. Links summary
Name	Type	Summary
`certificates`	Certificate[]	A reference to the certificates the engine supports for this provider.
`compute_resources`	ExternalComputeResource[]	A reference to the compute resource as represented in the host provider.
`discovered_hosts`	ExternalDiscoveredHost[]	A reference to the discovered hosts in the host provider.
`host_groups`	ExternalHostGroup[]	A reference to the host groups in the host provider.
`hosts`	Host[]	A reference to the hosts provisioned by the host provider.

7.69.2. compute_resources
リンクのコピー

A reference to the compute resource as represented in the host provider. Each host provider optionally has the engine defined as a compute resource, which allows to create virtual machines in the engine. This compute resource details are used in the Bare-Metal provisioning use-case, in order to deploy the hypervisor.

7.69.3. discovered_hosts
リンクのコピー

A reference to the discovered hosts in the host provider. Discovered hosts are hosts that were not provisioned yet.

7.69.4. host_groups
リンクのコピー

A reference to the host groups in the host provider. Host group contains different properties that the host provider applies on all hosts that are member of this group. Such as installed software, system definitions, passwords and more.

7.70. ExternalNetworkProviderConfiguration struct
リンクのコピー

Describes how an external network provider is provisioned on a host.

Expand

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

Expand

Table 7.98. Links summary
Name	Type	Summary
`external_network_provider`	ExternalProvider	Link to the external network provider.
`host`	Host	Link to the host.

7.71. ExternalProvider struct
リンクのコピー

Represents an external provider.

Expand

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

7.71.1. requires_authentication
リンクのコピー

Defines whether provider authentication is required or not.

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

7.72. ExternalStatus enum
リンクのコピー

Represents an external status. This status is currently used for hosts and storage domains, and allows an external system to update status of objects it is aware of.

Expand

Table 7.100. Values summary
Name	Summary
`error`	Error status.
`failure`	Failure status.
`info`	Info status.
`ok`	OK status.
`warning`	Warning status.

7.72.1. error
リンクのコピー

Error status. There is some kind of error in the relevant object.

7.72.2. failure
リンクのコピー

Failure status. The relevant object is failing.

7.72.3. info
リンクのコピー

Info status. The relevant object is in OK status, but there is an information available that might be relevant for the administrator.

7.72.4. ok
リンクのコピー

OK status. The relevant object is working well.

7.72.5. warning
リンクのコピー

Warning status. The relevant object is working well, but there is some warning that might be relevant for the administrator.

7.73. ExternalSystemType enum
リンクのコピー

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

Expand

Table 7.101. 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`.

7.74. ExternalVmImport struct
リンクのコピー

Describes the parameters for the virtual machine import operation from an external system.

Expand

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

7.74.1. url
リンクのコピー

The URL to be passed to the virt-v2v tool for conversion.

Example:

vpx://wmware_user@vcenter-host/DataCenter/Cluster/esxi-host?no_verify=1

More examples can be found at http://libguestfs.org/virt-v2v.1.html.

Expand

Table 7.103. Links summary
Name	Type	Summary
`cluster`	Cluster	Specifies the target cluster for the resulting virtual machine.
`cpu_profile`	CpuProfile	Optional.
`drivers_iso`	File	Optional.
`host`	Host	Optional.
`quota`	Quota	Optional.
`storage_domain`	StorageDomain	Specifies the target storage domain for converted disks.
`vm`	Vm	The virtual machine entity used to specify a name for the newly created virtual machine.

7.74.2. cpu_profile
リンクのコピー

Optional. Specifies the CPU profile of the resulting virtual machine.

7.74.3. drivers_iso
リンクのコピー

Optional. The name of the ISO containing drivers that can be used during the virt-v2v conversion process.

7.74.4. host
リンクのコピー

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

7.74.5. quota
リンクのコピー

Optional. Specifies the quota that will be applied to the resulting virtual machine.

7.74.6. vm
リンクのコピー

The virtual machine entity used to specify a name for the newly created virtual machine.

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

7.75. ExternalVmProviderType enum
リンクのコピー

Describes the type of external hypervisor system.

Expand

Table 7.104. Values summary
Name	Summary
`kvm`
`vmware`
`xen`

7.76. Fault struct
リンクのコピー

Expand

Table 7.105. Attributes summary
Name	Type	Summary
`detail`	String
`reason`	String

7.77. FenceType enum
リンクのコピー

Type representing the type of the fence operation.

Expand

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

7.78. FencingPolicy struct
リンクのコピー

Type representing a cluster fencing policy.

Expand

Table 7.107. 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_gluster_bricks_up`	Boolean	A flag indicating if fencing should be skipped if Gluster bricks are up and running in the host being fenced.
`skip_if_gluster_quorum_not_met`	Boolean	A flag indicating if fencing should be skipped if Gluster bricks are up and running and Gluster quorum will not be met without those bricks.
`skip_if_sd_active`	SkipIfSdActive	If enabled, we will skip fencing in case the host maintains its lease in the storage.

7.78.1. skip_if_connectivity_broken
リンクのコピー

If enabled, we will not fence a host in case more than a configurable percentage of hosts in the cluster lost connectivity as well. This comes to prevent fencing storm in cases where there is a global networking issue in the cluster.

7.78.2. skip_if_gluster_bricks_up
リンクのコピー

A flag indicating if fencing should be skipped if Gluster bricks are up and running in the host being fenced. This flag is optional, and the default value is false.

7.78.3. skip_if_gluster_quorum_not_met
リンクのコピー

A flag indicating if fencing should be skipped if Gluster bricks are up and running and Gluster quorum will not be met without those bricks. This flag is optional, and the default value is false.

7.78.4. skip_if_sd_active
リンクのコピー

If enabled, we will skip fencing in case the host maintains its lease in the storage. It means that if the host still has storage access then it won’t get fenced.

7.79. File struct
リンクのコピー

Expand

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

Expand

Table 7.109. Links summary
Name	Type	Summary
`storage_domain`	StorageDomain

7.80. Filter struct
リンクのコピー

Expand

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

Expand

Table 7.111. Links summary
Name	Type	Summary
`scheduling_policy_unit`	SchedulingPolicyUnit

7.81. FirewallType enum
リンクのコピー

Describes all firewall types supported by the system.

Expand

Table 7.112. Values summary
Name	Summary
`firewalld`	FirewallD firewall type.
`iptables`	IPTables firewall type.

7.81.1. firewalld
リンクのコピー

FirewallD firewall type.

When a cluster has the firewall type set to firewalld, the firewalls of all hosts in the cluster will be configured using firewalld. FirewallD replaced IPTables in version 4.2. It simplifies configuration using a command line program and dynamic configuration.

7.81.2. iptables
リンクのコピー

IPTables firewall type.

When a cluster has the firewall type set to iptables, the firewalls of all hosts in the cluster will be configured using iptables. iptables adds firewall rules to /etc/sysconfig/iptables using a special iptables syntax. For more information, see the iptables manual page.

iptables is deprecated in cluster version 4.2 and will be removed in cluster version 4.3.

7.82. Floppy struct
リンクのコピー

The underlying representation of a floppy file.

Expand

Table 7.113. 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	File object that represent the Floppy device’s content and its type.
`id`	String	A unique identifier.
`name`	String	A human-readable name in plain text.

Expand

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

7.82.1. vms
リンクのコピー

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

7.83. FopStatistic struct
リンクのコピー

Expand

Table 7.115. Attributes summary
Name	Type	Summary
`name`	String
`statistics`	Statistic[]

7.84. GlusterBrick struct
リンクのコピー

Expand

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

Expand

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

7.84.1. vms
リンクのコピー

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

7.85. GlusterBrickAdvancedDetails struct
リンクのコピー

Expand

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

Expand

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

7.85.1. vms
リンクのコピー

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

7.86. GlusterBrickMemoryInfo struct
リンクのコピー

Expand

Table 7.120. Attributes summary
Name	Type	Summary
`memory_pools`	GlusterMemoryPool[]

7.87. GlusterBrickStatus enum
リンクのコピー

Expand

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

7.88. GlusterClient struct
リンクのコピー

Expand

Table 7.122. Attributes summary
Name	Type	Summary
`bytes_read`	Integer
`bytes_written`	Integer
`client_port`	Integer
`host_name`	String

7.89. GlusterHook struct
リンクのコピー

Expand

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

Expand

Table 7.124. Links summary
Name	Type	Summary
`cluster`	Cluster
`server_hooks`	GlusterServerHook[]

7.90. GlusterHookStatus enum
リンクのコピー

Expand

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

7.91. GlusterMemoryPool struct
リンクのコピー

Expand

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

7.92. GlusterServerHook struct
リンクのコピー

Expand

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

Expand

Table 7.128. Links summary
Name	Type	Summary
`host`	Host

7.93. GlusterState enum
リンクのコピー

Expand

Table 7.129. Values summary
Name	Summary
`down`
`unknown`
`up`

7.94. GlusterVolume struct
リンクのコピー

Expand

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

Expand

Table 7.131. Links summary
Name	Type	Summary
`bricks`	GlusterBrick[]
`cluster`	Cluster
`statistics`	Statistic[]

7.95. GlusterVolumeProfileDetails struct
リンクのコピー

Expand

Table 7.132. 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[]

7.96. GlusterVolumeStatus enum
リンクのコピー

Expand

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

7.97. GlusterVolumeType enum
リンクのコピー

Type representing the type of Gluster Volume.

Expand

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

7.97.1. disperse
リンクのコピー

Dispersed volumes are based on erasure codes, providing space-efficient protection against disk or server failures.

Dispersed volumes an encoded fragment of the original file to each brick in a way that only a subset of the fragments is needed to recover the original file. The number of bricks that can be missing without losing access to data is configured by the administrator on volume creation time.

7.97.2. distribute
リンクのコピー

Distributed volumes distributes files throughout the bricks in the volume.

Distributed volumes can be used where the requirement is to scale storage and the redundancy is either not important or is provided by other hardware/software layers.

7.97.3. distributed_disperse
リンクのコピー

Distributed dispersed volumes distribute files across dispersed subvolumes.

This has the same advantages of distribute replicate volumes, but using disperse to store the data into the bricks.

7.97.4. distributed_replicate
リンクのコピー

Distributed replicated volumes distributes files across replicated bricks in the volume.

Distributed replicated volumes can be used in environments where the requirement is to scale storage and high-reliability is critical. Distributed replicated volumes also offer improved read performance in most environments.

7.97.5. distributed_stripe
リンクのコピー

Distributed striped volumes stripe data across two or more nodes in the cluster.

Distributed striped volumes should be used where the requirement is to scale storage and in high concurrency environments accessing very large files is critical.

Note: With the introduction of Sharding in Glusterfs 3.7 releases, striped volumes are not recommended and it will be removed in future release.

7.97.6. distributed_striped_replicate
リンクのコピー

Distributed striped replicated volumes distributes striped data across replicated bricks in the cluster.

For best results, distributed striped replicated volumes should be used in highly concurrent environments where parallel access of very large files and performance is critical.

Note: With the introduction of Sharding in Glusterfs 3.7 releases, striped volumes are not recommended and it will be removed in future release.

7.97.7. replicate
リンクのコピー

Replicated volumes replicates files across bricks in the volume.

Replicated volumes can be used in environments where high-availability and high-reliability are critical.

7.97.8. stripe
リンクのコピー

Striped volumes stripes data across bricks in the volume.

For best results, striped volumes should only in high concurrency environments accessing very large files.

Note: With the introduction of Sharding in Glusterfs 3.7 releases, striped volumes are not recommended and it will be removed in future release.

7.97.9. striped_replicate
リンクのコピー

Striped replicated volumes stripes data across replicated bricks in the cluster.

For best results, striped replicated volumes should be used in highly concurrent environments where there is parallel access of very large files and performance is critical.

Note: With the introduction of Sharding in Glusterfs 3.7 releases, striped volumes are not recommended and it will be removed in future release.

7.98. GracePeriod struct
リンクのコピー

Expand

Table 7.135. Attributes summary
Name	Type	Summary
`expiry`	Integer

7.99. GraphicsConsole struct
リンクのコピー

Expand

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

Expand

Table 7.137. Links summary
Name	Type	Summary
`instance_type`	InstanceType
`template`	Template
`vm`	Vm

7.100. GraphicsType enum
リンクのコピー

The graphics protocol used to connect to the graphic console.

Expand

Table 7.138. Values summary
Name	Summary
`spice`	Graphics protocol of type SPICE.
`vnc`	Graphics protocol of type VNC.

7.100.1. spice
リンクのコピー

Graphics protocol of type SPICE. See https://www.spice-space.org for more details.

7.100.2. vnc
リンクのコピー

Graphics protocol of type VNC. VNC stands for Virtual Network Computing, and it is a graphical desktop sharing system that uses RFB (Remote Frame Buffer) protocol to remotely control another machine.

7.101. Group struct
リンクのコピー

This type represents all groups in the directory service.

Expand

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

Expand

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

7.101.1. roles
リンクのコピー

A link to the roles sub-collection for roles attached to this group.

Used only to represent the initial role assignments for a new group; thereafter, modification of role assignments is only supported via the roles sub-collection.

7.102. GuestOperatingSystem struct
リンクのコピー

Represents an operating system installed on the virtual machine.

To get that information send a request like this:

GET /ovirt-engine/api/vms/123

The result will be like this:

<vm href="/ovirt-engine/api/vms/123" id="123">
...
  <guest_operating_system>
    <architecture>x86_64</architecture>
    <codename>Maipo</codename>
    <distribution>{enterprise-linux} Server</distribution>
    <family>Linux</family>
    <kernel>
      <version>
        <build>0</build>
        <full_version>3.10.0-514.10.2.el7.x86_64</full_version>
        <major>3</major>
        <minor>10</minor>
        <revision>514</revision>
      </version>
    </kernel>
    <version>
      <full_version>7.3</full_version>
      <major>7</major>
      <minor>3</minor>
    </version>
  </guest_operating_system>
</vm>

Expand

Table 7.141. Attributes summary
Name	Type	Summary
`architecture`	String	The architecture of the operating system, such as x86_64.
`codename`	String	Code name of the operating system, such as `Maipo`.
`distribution`	String	Full name of operating system distribution.
`family`	String	Family of operating system, such as `Linux`.
`kernel`	Kernel	Kernel version of the operating system.
`version`	Version	Version of the installed operating system.

7.103. HardwareInformation struct
リンクのコピー

Represents hardware information of host.

To get that information send a request like this:

GET /ovirt-engine/api/hosts/123

The result will be like this:

<host href="/ovirt-engine/api/hosts/123" id="123">
  ...
  <hardware_information>
    <family>{enterprise-linux}</family>
    <manufacturer>Red Hat</manufacturer>
    <product_name>RHEV Hypervisor</product_name>
    <serial_number>01234567-89AB-CDEF-0123-456789ABCDEF</serial_number>
    <supported_rng_sources>
      <supported_rng_source>random</supported_rng_source>
    </supported_rng_sources>
    <uuid>12345678-9ABC-DEF0-1234-56789ABCDEF0</uuid>
    <version>1.2-34.5.el7ev</version>
  </hardware_information>
  ...
</application>

Expand

Table 7.142. Attributes summary
Name	Type	Summary
`family`	String	Type of host’s CPU.
`manufacturer`	String	Manufacturer of the host’s machine and hardware vendor.
`product_name`	String	Host’s product name (for example `RHEV Hypervisor`).
`serial_number`	String	Unique ID for host’s chassis.
`supported_rng_sources`	RngSource[]	Supported sources of random number generator.
`uuid`	String	Unique ID for each host.
`version`	String	Unique name for each of the manufacturer.

7.104. HighAvailability struct
リンクのコピー

Type representing high availability of a virtual machine.

Expand

Table 7.143. Attributes summary
Name	Type	Summary
`enabled`	Boolean	Define if the virtual machine should be consider highly available.
`priority`	Integer	Indicates the priority of the virtual machine inside the run and migration queues.

7.104.1. priority
リンクのコピー

Indicates the priority of the virtual machine inside the run and migration queues.

Virtual machines with higher priorities will be started and migrated before virtual machines with lower priorities.

The value is an integer between 0 and 100. The higher the value, the higher the priority.

The graphical user interface (GUI) does not allow specifying all the possible values, instead it only allows you to select Low, Medium or High. When the value is set using the API, the GUI will set the label as follows:

Expand

API Value	GUI Label
0 - 25	Low
26 - 74	Medium
75 - 100	High

When the label is selected using the GUI, the value in the API will be set as follows:

Expand

GUI Label	API Value
Low	1
Medium	50
High	100

7.105. Hook struct
リンクのコピー

Represents a hook.

Expand

Table 7.144. 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	Name of the event to execute the hook on.
`id`	String	A unique identifier.
`md5`	String	Checksum of the hook.
`name`	String	A human-readable name in plain text.

Expand

Table 7.145. Links summary
Name	Type	Summary
`host`	Host	Reference to the host the hook belongs to.

7.106. HookContentType enum
リンクのコピー

Represents content type of hook script.

Expand

Table 7.146. Values summary
Name	Summary
`binary`	Binary content type of the hook.
`text`	Text content type of the hook.

7.107. HookStage enum
リンクのコピー

Type represents a stage of volume event at which hook executes.

Expand

Table 7.147. Values summary
Name	Summary
`post`	Stage after start of volume.
`pre`	Stage before start of volume.

7.108. HookStatus enum
リンクのコピー

Type represents the status of a hook.

Expand

Table 7.148. Values summary
Name	Summary
`disabled`	Hook is disabled.
`enabled`	Hook is enabled.
`missing`	Hook is missing.

7.109. Host struct
リンクのコピー

Type representing a host.

Expand

Table 7.149. 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 self-hosted engine status of 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.
`network_operation_in_progress`	Boolean	Specifies whether a network-related operation, such as 'setup networks' or 'sync networks', is currently being executed on this host.
`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.

7.109.1. external_status
リンクのコピー

The host external status. This can be used by third-party software to change the host external status in case of an issue. This has no effect on the host lifecycle, unless a third-party software checks for this status and acts accordingly.

7.109.2. hosted_engine
リンクのコピー

The self-hosted engine status of this host.

Important

When a host or collection of hosts is retrieved, this attribute is not included unless the all_content parameter of the operation is explicitly set to true. See the documentation of the operations that retrieve one or multiple hosts for details.

7.109.3. kdump_status
リンクのコピー

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

7.109.4. ksm
リンクのコピー

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

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

PUT /ovirt-engine/api/hosts/123

With a request body like this:

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

7.109.5. libvirt_version
リンクのコピー

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

7.109.6. override_iptables
リンクのコピー

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

7.109.7. protocol
リンクのコピー

The protocol that the engine uses to communicate with the host.

Warning

Since version 4.1 of the engine the protocol is always set to stomp since xml was removed.

7.109.8. se_linux
リンクのコピー

The host SElinux status. Security-Enhanced Linux (SELinux) is a component in the Linux kernel that provides a mechanism for supporting access control security policies.

7.109.9. spm
リンクのコピー

The host storage pool manager (SPM) status and definition. Use it to set the SPM priority of this host, and to see whether this is the current SPM or not.

7.109.10. status_detail
リンクのコピー

The host status details. Relevant for Gluster hosts.

7.109.11. transparent_huge_pages
リンクのコピー

Transparent huge page support expands the size of memory pages beyond the standard 4 KiB limit. This reduces memory consumption and increases host performance.

For example, to enable transparent huge page support for host 123, send a request like this:

PUT /ovirt-engine/api/hosts/123

With a request body like this:

<host>
  <transparent_hugepages>
    <enabled>true</enabled>
  </transparent_hugepages>
</host>

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

Expand

Table 7.150. Links summary
Name	Type	Summary
`affinity_labels`	AffinityLabel[]
`agents`	Agent[]
`cluster`	Cluster
`devices`	Device[]
`external_host_provider`	ExternalHostProvider
`external_network_provider_configurations`	ExternalNetworkProviderConfiguration[]	External network providers provisioned on the host.
`hooks`	Hook[]
`katello_errata`	KatelloErratum[]	Lists all the Katello errata assigned to the host.
`network_attachments`	NetworkAttachment[]
`nics`	HostNic[]
`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[]

7.109.13. external_network_provider_configurations
リンクのコピー

External network providers provisioned on the host.

External network providers on the host can be controlled when adding the host.

7.109.14. katello_errata
リンクのコピー

Lists all the Katello errata assigned to the host.

GET /ovirt-engine/api/hosts/123/katelloerrata

You will receive response in XML like this one:

<katello_errata>
  <katello_erratum href="/ovirt-engine/api/katelloerrata/456" id="456">
    <name>RHBA-2013:XYZ</name>
    <description>The description of the erratum</description>
    <title>some bug fix update</title>
    <type>bugfix</type>
    <issued>2013-11-20T02:00:00.000+02:00</issued>
    <solution>Few guidelines regarding the solution</solution>
    <summary>Updated packages that fix one bug are now available for XYZ</summary>
    <packages>
      <package>
        <name>libipa_hbac-1.9.2-82.11.el6_4.i686</name>
      </package>
      ...
    </packages>
  </katello_erratum>
  ...
</katello_errata>

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

Expand

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.

7.110. HostDevice struct
リンクのコピー

Expand

Table 7.151. 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.
`driver`	String	The name of the driver this device is bound to.
`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

7.110.1. driver
リンクのコピー

The name of the driver this device is bound to.

For example: pcieport or uhci_hcd.

Expand

Table 7.152. Links summary
Name	Type	Summary
`host`	Host
`parent_device`	HostDevice
`vm`	Vm

7.111. HostDevicePassthrough struct
リンクのコピー

Expand

Table 7.153. Attributes summary
Name	Type	Summary
`enabled`	Boolean

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

Expand

Table 7.154. 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	Describes the virtual functions configuration of a physical function NIC.
`vlan`	Vlan

7.112.1. ad_aggregator_id
リンクのコピー

The ad_aggregator_id property of a bond or bond slave, for bonds in mode 4. Bond mode 4 is the 802.3ad standard, also called dynamic link aggregation. (See Wikipedia and Presentation for more information). This is only valid for bonds in mode 4, or NICs which are part of a bond. It is not present for bonds in other modes, or NICs which are not part of a bond in mode 4. The ad_aggregator_id property indicates which of the bond slaves are active. The value of the ad_aggregator_id of an active slave is the same as the value of the ad_aggregator_id property of the bond. This parameter is read only. Setting it will have no effect on the bond/NIC. It is retrieved from the /sys/class/net/bondX/bonding/ad_aggregator file for a bond, and the /sys/class/net/ensX/bonding_slave/ad_aggregator_id file for a NIC.

7.112.2. bridged
リンクのコピー

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

7.112.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.current.rx.bps - The rate in bits per second of data received (since version 4.2).
data.current.tx.bps - The rate in bits per second of data transmitted (since version 4.2).
data.total.rx - Total received data.
data.total.tx - Total transmitted data.
errors.total.rx - Total errors from receiving data.
errors.total.tx - Total errors from transmitting data.

Expand

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

7.112.4. network
リンクのコピー

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

7.113. HostNicVirtualFunctionsConfiguration struct
リンクのコピー

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

Expand

Table 7.156. 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	The maximum number of virtual functions the NIC supports.
`number_of_virtual_functions`	Integer	The number of virtual functions currently defined.

7.113.1. max_number_of_virtual_functions
リンクのコピー

The maximum number of virtual functions the NIC supports. This property is read-only.

7.113.2. number_of_virtual_functions
リンクのコピー

The number of virtual functions currently defined. A user-defined value between 0 and max_number_of_virtual_functions.

7.114. HostProtocol enum
リンクのコピー

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

Warning

Since version 4.1 of the engine the protocol is always set to stomp since xml was removed.

Expand

Table 7.157. Values summary
Name	Summary
`stomp`	JSON-RPC protocol on top of STOMP.
`xml`	XML-RPC protocol.

7.115. HostStatus enum
リンクのコピー

Type representing a host status.

Expand

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

7.115.1. error
リンクのコピー

The host is in error status. This will happen if we will try to run a virtual machine several times and it will fail.

7.115.2. initializing
リンクのコピー

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

7.115.3. install_failed
リンクのコピー

The host installation failed. In such cases look at the event log to understand what failed the installation, and issue a re-install.

7.115.4. installing_os
リンクのコピー

The host operating system is now installing. This status is relevant when using a Satellite/Foreman provider, and issuing a bare-metal provisioning (discovered host provisioning).

7.115.5. maintenance
リンクのコピー

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

7.115.6. non_operational
リンクのコピー

The host is non operational. This can happen due to various reasons, such as not having a connection with the storage, not supporting a mandatory network, not supporting the cluster level, and more.

7.115.7. non_responsive
リンクのコピー

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

7.115.8. pending_approval
リンクのコピー

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

7.115.9. preparing_for_maintenance
リンクのコピー

The host is preparing for maintenance. During this time the engine makes sure to live migrate all the virtual machines from this host to other hosts. Once all migrations have been completed the host will move to 'maintenance' status.

7.116. HostStorage struct
リンクのコピー

Expand

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

7.116.1. nfs_retrans
リンクのコピー

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

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

Expand

Table 7.160. Links summary
Name	Type	Summary
`host`	Host

7.117. HostType enum
リンクのコピー

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

Expand

Table 7.161. Values summary
Name	Summary
`ovirt_node`	The host contains Red Hat Virtualization Host (RHVH): a new implementation of Red Hat Enterprise Virtualization Hypervisor (RHEV-H) which uses the same installer as Red Hat Enterprise Linux, CentOS, or Fedora.
`rhel`	The host contains a full Red Hat Enterprise Linux, CentOS, or Fedora installation.
`rhev_h`	The host contains Red Hat Enterprise Virtualization Hypervisor (RHEV-H), a small-scaled version of Red Hat Enterprise Linux, CentOS, or Fedora, used solely to host virtual machines.

7.117.1. ovirt_node
リンクのコピー

The host contains Red Hat Virtualization Host (RHVH): a new implementation of Red Hat Enterprise Virtualization Hypervisor (RHEV-H) which uses the same installer as Red Hat Enterprise Linux, CentOS, or Fedora. The main difference between RHVH and legacy RHEV-H is that RHVH has a writeable file system and will handle its own installation instead of having RPMs pushed to it by the Manager like in legacy RHEV-H.

7.118. HostedEngine struct
リンクのコピー

Expand

Table 7.162. Attributes summary
Name	Type	Summary
`active`	Boolean
`configured`	Boolean
`global_maintenance`	Boolean
`local_maintenance`	Boolean
`score`	Integer

7.119. Icon struct
リンクのコピー

Icon of virtual machine or template.

Expand

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

7.119.1. media_type
リンクのコピー

Format of icon file.

One of:

image/jpeg
image/png
image/gif

7.120. Identified struct
リンクのコピー

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

Expand

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

7.121. Image struct
リンクのコピー

Represents an image entity.

Expand

Table 7.165. 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.
`size`	Integer	The size of the image file.
`type`	ImageFileType	The type of the image file.

Expand

Table 7.166. Links summary
Name	Type	Summary
`storage_domain`	StorageDomain	The storage domain associated with this image.

7.122. ImageFileType enum
リンクのコピー

Represents the file type of an image.

Expand

Table 7.167. Values summary
Name	Summary
`disk`	The image is a disk format that can be used as a virtual machine’s disk.
`floppy`	The image is a floppy disk that can be attached to a virtual machine, for example to install the VirtIO drivers in Windows.
`iso`	The image is a `.

7.122.1. iso
リンクのコピー

The image is a .iso file that can be used as a CD-ROM to boot and install a virtual machine.

7.123. ImageTransfer struct
リンクのコピー

This type contains information regarding an image transfer being performed.

Expand

Table 7.168. Attributes summary
Name	Type	Summary
`active`	Boolean	Indicates whether there’s at least one active session for this transfer, i,e there’s at least one live transfer session between the client and the daemon.
`comment`	String	Free text containing comments about this object.
`description`	String	A human-readable description in plain text.
`direction`	ImageTransferDirection	The direction indicates whether the transfer is sending image data (`upload`) or receiving image data (`download`).
`id`	String	A unique identifier.
`inactivity_timeout`	Integer	The timeout in seconds of client inactivity, after which the transfer is aborted by the Red Hat Virtualization Manager.
`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).
`transfer_url`	String	The URL of the daemon server that the user can input or output to directly.
`transferred`	Integer	Indicates the amount of transferred bytes.

7.123.1. direction
リンクのコピー

The direction indicates whether the transfer is sending image data (upload) or receiving image data (download).

If a direction is not set during an addition of a new transfer, The default direction for the transfer will be upload.

7.123.2. inactivity_timeout
リンクのコピー

The timeout in seconds of client inactivity, after which the transfer is aborted by the Red Hat Virtualization Manager. To disable the inactivity timeout specify '0'. If not specified, the value is defaulted to the engine-config value: TransferImageClientInactivityTimeoutInSeconds.

7.123.3. phase
リンクのコピー

The current phase of the image transfer in progress. Each transfer needs a managed session, which must be opened for the user to input or output an image. Please refer to image transfer for further documentation.

7.123.4. proxy_url
リンクのコピー

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

7.123.5. transfer_url
リンクのコピー

The URL of the daemon server that the user can input or output to directly.

This is as an alternative to the proxy_url. I.e. if the client has access to the host machine, it could bypass the proxy and transfer directly to the host, potentially improving the throughput performance. This attribute is available only if the image transfer is in the transferring phase. See phase for details.

Expand

Table 7.169. Links summary
Name	Type	Summary
`disk`	Disk	The disk which is targeted for input or output.
`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 input or output.
`snapshot`	DiskSnapshot	The disk snapshot which is targeted for input or output.

7.123.6. host
リンクのコピー

The host which will be used to write to the image which is targeted for input or output. If not specified, an active host will be randomly selected from the data center.

7.123.7. image
リンクのコピー

The image which is targeted for input or output.

Important

This attribute is deprecated since version 4.2 of the engine. Use the disk or snapshot attributes instead.

7.124. ImageTransferDirection enum
リンクのコピー

The image transfer direction for a transfer.

When adding a new transfer, the user can choose whether the transfer will be to an image, choosing upload, or to transfer from an image- choosing download as an ImageTransferDirection.

Please refer to image transfer for further documentation.

Expand

Table 7.170. Values summary
Name	Summary
`download`	The user must choose `download` when he/she wants to stream data from an image.
`upload`	The user can choose `upload` when he/she wants to stream data to an image.

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

Expand

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

7.125.1. cancelled
リンクのコピー

This phase will be set as a result of the user cancelling the transfer. The cancellation can only be performed in the Administration Portal.

7.125.2. finalizing_success
リンクのコピー

This phase will be set when the user calls finalize. Calling finalize is essential to finish the transfer session, and finish using the targeted image. After finalizing, the phase will be changed to finished_success or finished_failure.

Refer to image transfer for more information.

7.125.3. finished_failure
リンクのコピー

Indicates that the targeted image failed the verification, and cannot be used. After reaching this phase, the image transfer entity will be deleted, and the targeted image will be set to illegal.

7.125.4. finished_success
リンクのコピー

Indicates that the transfer session was successfully closed, and the targeted image was verified and ready to be used. After reaching this phase, the image transfer entity will be deleted.

7.125.5. initializing
リンクのコピー

The initial phase of an image transfer. It is set while the transfer session is establishing. Once the session is established, the phase will be changed to transferring

7.125.6. paused_system
リンクのコピー

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

7.125.7. resuming
リンクのコピー

The phase where the transfer has been resumed by the client calling resume. Resuming starts a new session, and after calling it, the phase will be changed to transferring, or paused_system in case of a failure.

7.125.8. unknown
リンクのコピー

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

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

Expand

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

7.127. Initialization struct
リンクのコピー

Expand

Table 7.173. Attributes summary
Name	Type	Summary
`active_directory_ou`	String
`authorized_ssh_keys`	String
`cloud_init`	CloudInit	Deprecated attribute to specify cloud-init configuration.
`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

7.127.1. cloud_init
リンクのコピー

Deprecated attribute to specify cloud-init configuration.

This attribute, and the CloudInit type have been deprecated and will be removed in the future. To specify the cloud-init configuration, use the attributes inside the Initialization type. The mapping between the attributes of these two types are as follows:

Expand

CloudInit	Initialization
`authorized_keys`	`authorized_ssh_keys`
`dns.search_domains`	`dns_search`
`dns.servers`	`dns_servers`
`files`	`custom_script`
`host`	`host_name`
`network_configuration.nics`	`nic_configurations`
`regenerate_ssh_keys`	`regenerate_ssh_keys`
`timezone`	`timezone`
`users`	`user_name` & `root_password`

For more details on how to use cloud-init see the examples in Python, Ruby and Java.

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

Expand

Table 7.174. 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 the virtual machine’s initialization configuration.
`io`	Io	For performance tuning of IO threading.
`large_icon`	Icon	Virtual machine’s large icon.
`lease`	StorageDomainLease	Reference to the storage domain this virtual machine/template lease reside on.
`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.
`multi_queues_enabled`	Boolean	If `true`, each virtual interface will get the optimal number of queues, depending on the available virtual Cpus.
`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.
`placement_policy`	VmPlacementPolicy	The configuration of the virtual machine’s placement policy.
`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.
`storage_error_resume_behaviour`	VmStorageErrorResumeBehaviour	Determines how the virtual machine will be resumed after storage error.
`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.

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

7.128.2. custom_compatibility_version
リンクのコピー

Virtual machine custom compatibility version.

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

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

7.128.3. high_availability
リンクのコピー

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

7.128.4. initialization
リンクのコピー

Reference to the virtual machine’s initialization configuration.

Note

Since Red Hat Virtualization 4.1.8 this property can be cleared by sending an empty tag.

For example, to clear the initialization attribute send a request like this:

PUT /ovirt-engine/api/vms/123

With a request body like this:

<vm>
  <initialization/>
</vm>

The response to such a request, and requests with the header All-Content: true will still contain this attribute.

7.128.5. large_icon
リンクのコピー

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

7.128.6. lease
リンクのコピー

Reference to the storage domain this virtual machine/template lease reside on.

A virtual machine running with a lease requires checking while running that the lease is not taken by another host, preventing another instance of this virtual machine from running on another host. This provides protection against split-brain in highly available virtual machines. A template can also have a storage domain defined for a lease in order to have the virtual machines created from this template to be preconfigured with this storage domain as the location of the leases.

7.128.7. memory
リンクのコピー

The virtual machine’s memory, in bytes.

For example, to update a virtual machine to contain 1 Gibibyte (GiB) of memory, send the following request:

PUT /ovirt-engine/api/vms/123

With the following request body:

<vm>
  <memory>1073741824</memory>
</vm>

Memory hot plug is supported from Red Hat Virtualization 3.6 onwards. You can use the example above to increase memory while the virtual machine is in state up. The size increment must be dividable by the value of the HotPlugMemoryBlockSizeMb configuration value (256 MiB by default). If the memory size increment is not dividable by this value, the memory size change is only stored to next run configuration. Each successful memory hot plug operation creates one or two new memory devices.

Memory hot unplug is supported since Red Hat Virtualization 4.2 onwards. Memory hot unplug can only be performed when the virtual machine is in state up. Only previously hot plugged memory devices can be removed by the hot unplug operation. The requested memory decrement is rounded down to match sizes of a combination of previously hot plugged memory devices. The requested memory value is stored to next run configuration without rounding.

Note

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

Note

Red Hat Virtualization Manager internally rounds values down to whole MiBs (1MiB = 2²⁰ bytes)

7.128.8. migration_downtime
リンクのコピー

Maximum time the virtual machine can be non responsive during its live migration to another host in ms.

Set either explicitly for the virtual machine or by engine-config -s DefaultMaximumMigrationDowntime=[value]

7.128.9. origin
リンクのコピー

The origin of this virtual machine.

Possible values:

ovirt
rhev
vmware
xen
external
hosted_engine
managed_hosted_engine
kvm
physical_machine
hyperv

7.128.10. placement_policy
リンクのコピー

The configuration of the virtual machine’s placement policy.

This configuration can be updated to pin a virtual machine to one or more hosts.

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>

7.128.11. small_icon
リンクのコピー

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

7.128.12. sso
リンクのコピー

Reference to the Single Sign On configuration this virtual machine is configured for. The user can be automatically signed in the virtual machine’s operating system when console is opened.

Expand

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

7.129. Io struct
リンクのコピー

Expand

Table 7.176. Attributes summary
Name	Type	Summary
`threads`	Integer

7.130. Ip struct
リンクのコピー

Represents the IP configuration of a network interface.

Expand

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

7.130.1. address
リンクのコピー

The text representation of the IP address.

For example, an IPv4 address will be represented as follows:

<ip>
  <address>192.168.0.1</address>
  ...
</ip>

An IPv6 address will be represented as follows:

<ip>
  <address>2620:52:0:20f0:4216:7eff:feaa:1b50</address>
  ...
</ip>

7.130.2. netmask
リンクのコピー

The network mask.

For IPv6 addresses the value is an integer in the range of 0-128, which represents the subnet prefix.

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

7.131. IpAddressAssignment struct
リンクのコピー

Represents an IP address assignment for a network device.

For a static boot protocol assignment, subnet mask and IP address (and optinally default gateway) must be provided in the IP configuration.

Expand

Table 7.178. Attributes summary
Name	Type	Summary
`assignment_method`	BootProtocol	Sets the boot protocol used to assign the IP configuration for a network device.
`ip`	Ip	Sets the IP configuration for a network device.

7.132. IpVersion enum
リンクのコピー

Defines the values for the IP protocol version.

Expand

Table 7.179. Values summary
Name	Summary
`v4`	IPv4.
`v6`	IPv6.

7.133. IscsiBond struct
リンクのコピー

Expand

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

Expand

Table 7.181. Links summary
Name	Type	Summary
`data_center`	DataCenter
`networks`	Network[]
`storage_connections`	StorageConnection[]

7.134. IscsiDetails struct
リンクのコピー

Expand

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

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

Expand

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

7.135.1. external
リンクのコピー

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

Expand

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

7.136. JobStatus enum
リンクのコピー

Represents the status of the job.

Expand

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

7.136.1. aborted
リンクのコピー

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

7.136.2. finished
リンクのコピー

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

7.136.3. started
リンクのコピー

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

7.136.4. unknown
リンクのコピー

The unknown job status. This status represents jobs which their resolution is not known, i.e. jobs that were executed before the system was unexpectedly restarted.

7.137. KatelloErratum struct
リンクのコピー

Type representing a Katello erratum.

Expand

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

7.137.1. severity
リンクのコピー

The severity of the Katello erratum.

The supported severities are moderate, important or critical.

7.137.2. type
リンクのコピー

The type of the Katello erratum.

The supported types are bugfix, enhancement or security.

Expand

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

7.138. KdumpStatus enum
リンクのコピー

Expand

Table 7.188. Values summary
Name	Summary
`disabled`
`enabled`
`unknown`

7.139. Kernel struct
リンクのコピー

Expand

Table 7.189. Attributes summary
Name	Type	Summary
`version`	Version

7.140. Ksm struct
リンクのコピー

Expand

Table 7.190. Attributes summary
Name	Type	Summary
`enabled`	Boolean
`merge_across_nodes`	Boolean

7.141. LinkLayerDiscoveryProtocolElement struct
リンクのコピー

Represents an information element received by Link Layer Discovery Protocol (LLDP). IEEE 802.1AB defines type, length, value (TLV) as a "short, variable length encoding of an information element". This type represents such an information element.

The attribute name is a human-readable string used to describe what the value is about, and may not be unique. The name is redundant, because it could be created from type and the optional oui and subtype. The purpose of name is to simplify the reading of the information element. The name of a property is exactly the same string which is used in IEEE 802.1AB chapter 8.

Organizationally-specific information elements have the type of 127 and the attributes oui and subtype.

For example, the XML representation of an information element may look like this:

<link_layer_discovery_protocol_element>
  <name>Port VLAN Id</name>
  <oui>32962</oui>
  <properties>
    <property>
      <name>vlan id</name>
      <value>488</value>
    </property>
    <property>
      <name>vlan name</name>
      <value>v2-0488-03-0505</value>
    </property>
  </properties>
  <subtype>3</subtype>
  <type>127</type>
</link_layer_discovery_protocol_element>

Expand

Table 7.191. 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.
`oui`	Integer	The organizationally-unique identifier (OUI) encoded as an integer.
`properties`	Property[]	Represents structured data transported by the information element as a list of name/value pairs.
`subtype`	Integer	The organizationally-defined subtype encoded as an integer.
`type`	Integer	The type of the LinkLayerDiscoveryProtocolElement encoded as an integer.

7.141.1. oui
リンクのコピー

The organizationally-unique identifier (OUI) encoded as an integer. Only available if type is 127.

7.141.2. subtype
リンクのコピー

The organizationally-defined subtype encoded as an integer. Only available if type is 127.

7.142. LogSeverity enum
リンクのコピー

Enum representing a severity of an event.

Expand

Table 7.192. Values summary
Name	Summary
`alert`	Alert severity.
`error`	Error severity.
`normal`	Normal severity.
`warning`	Warning severity.

7.142.1. alert
リンクのコピー

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

7.142.2. error
リンクのコピー

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

7.142.3. normal
リンクのコピー

Normal severity. Used for information events.

7.142.4. warning
リンクのコピー

Warning severity. Used to warn something might be wrong.

7.143. LogicalUnit struct
リンクのコピー

Expand

Table 7.193. Attributes summary
Name	Type	Summary
`address`	String
`discard_max_size`	Integer	The maximum number of bytes that can be discarded by the logical unit’s underlying storage in a single operation.
`discard_zeroes_data`	Boolean	True, if previously discarded blocks in the logical unit’s underlying storage are read back as zeros.
`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

7.143.1. discard_max_size
リンクのコピー

The maximum number of bytes that can be discarded by the logical unit’s underlying storage in a single operation. A value of 0 means that the device does not support discard functionality.

Note

This is the software limit, and not the hardware limit, as noted in the documentation of queue-sysfs for discard_max_bytes.

7.143.2. discard_zeroes_data
リンクのコピー

True, if previously discarded blocks in the logical unit’s underlying storage are read back as zeros. For more information please see the documentation of queue-sysfs for discard_zeroes_data.

Important

Since version 4.2.1 of the system, the support for this attribute has been removed as the sysfs file, discard_zeroes_data, was deprecated in the kernel. It is preserved for backwards compatibility, but the value will always be false.

7.144. LunStatus enum
リンクのコピー

Expand

Table 7.194. Values summary
Name	Summary
`free`
`unusable`
`used`

7.145. Mac struct
リンクのコピー

Represents a MAC address of a virtual network interface.

Expand

Table 7.195. Attributes summary
Name	Type	Summary
`address`	String	MAC address.

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

Expand

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

7.146.1. allow_duplicates
リンクのコピー

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

7.146.2. default_pool
リンクのコピー

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

7.146.3. ranges
リンクのコピー

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

7.147. MemoryOverCommit struct
リンクのコピー

Expand

Table 7.197. Attributes summary
Name	Type	Summary
`percent`	Integer

7.148. MemoryPolicy struct
リンクのコピー

Logical grouping of memory-related properties of virtual machine-like entities.

Expand

Table 7.198. Attributes summary
Name	Type	Summary
`ballooning`	Boolean
`guaranteed`	Integer	The amount of memory, in bytes, that is guaranteed to not be drained by the balloon mechanism.
`max`	Integer	Maximum virtual machine memory, in bytes.
`over_commit`	MemoryOverCommit
`transparent_huge_pages`	TransparentHugePages

7.148.1. guaranteed
リンクのコピー

The amount of memory, in bytes, that is guaranteed to not be drained by the balloon mechanism.

The Red Hat Virtualization Manager internally rounds this value down to whole MiB (1MiB = 2²⁰ bytes).

Note

It can be updated while the virtual machine is running since Red Hat Virtualization 4.2 onwards, provided memory is updated in the same request as well, and the virtual machine is in state up.

7.148.2. max
リンクのコピー

Maximum virtual machine memory, in bytes.

The user provides the value in bytes, and the Red Hat Virtualization Manager rounds the value down to the nearest lower MiB value.

For example, if the user enters a value of 1073741825 (1 GiB + 1 byte), then the Red Hat Virtualization Manager will truncate that value to the nearest lower MiB boundary: in this case 1073741824 (1 GiB).

7.149. MessageBrokerType enum
リンクのコピー

Expand

Table 7.199. Values summary
Name	Summary
`qpid`
`rabbit_mq`

7.150. Method struct
リンクのコピー

Expand

Table 7.200. Attributes summary
Name	Type	Summary
`id`	SsoMethod

7.151. MigrateOnError enum
リンクのコピー

Expand

Table 7.201. Values summary
Name	Summary
`do_not_migrate`
`migrate`
`migrate_highly_available`

7.152. MigrationBandwidth struct
リンクのコピー

Defines the bandwidth used by migration.

Expand

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

7.152.1. custom_value
リンクのコピー

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

7.153. MigrationBandwidthAssignmentMethod enum
リンクのコピー

Defines how the migration bandwidth is assigned.

Expand

Table 7.203. Values summary
Name	Summary
`auto`	Takes the bandwidth from the Quality of Service if the Quality of Service is defined.
`custom`	Custom defined bandwidth in Mbit/s.
`hypervisor_default`	Takes the value as configured on the hypervisor.

7.153.1. auto
リンクのコピー

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

7.154. MigrationOptions struct
リンクのコピー

The type for migration options.

Expand

Table 7.204. Attributes summary
Name	Type	Summary
`auto_converge`	InheritableBoolean
`bandwidth`	MigrationBandwidth	The bandwidth that is allowed to be used by the migration.
`compressed`	InheritableBoolean

Expand

Table 7.205. Links summary
Name	Type	Summary
`policy`	MigrationPolicy	A reference to the migration policy, as defined using `engine-config`.

7.155. MigrationPolicy struct
リンクのコピー

A policy describing how the migration is treated, such as convergence or how many parallel migrations are allowed.

Expand

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

7.156. Network struct
リンクのコピー

The type for a logical network.

An example of the JSON representation of a logical network:

{
  "network" : [ {
    "data_center" : {
      "href" : "/ovirt-engine/api/datacenters/123",
      "id" : "123"
    },
    "stp" : "false",
    "mtu" : "0",
    "usages" : {
      "usage" : [ "vm" ]
    },
    "name" : "ovirtmgmt",
    "description" : "Management Network",
    "href" : "/ovirt-engine/api/networks/456",
    "id" : "456",
    "link" : [ {
      "href" : "/ovirt-engine/api/networks/456/permissions",
      "rel" : "permissions"
    }, {
      "href" : "/ovirt-engine/api/networks/456/vnicprofiles",
      "rel" : "vnicprofiles"
    }, {
      "href" : "/ovirt-engine/api/networks/456/labels",
      "rel" : "labels"
    } ]
  } ]
}

An example of the XML representation of the same logical network:

<network href="/ovirt-engine/api/networks/456" id="456">
  <name>ovirtmgmt</name>
  <description>Management Network</description>
  <link href="/ovirt-engine/api/networks/456/permissions" rel="permissions"/>
  <link href="/ovirt-engine/api/networks/456/vnicprofiles" rel="vnicprofiles"/>
  <link href="/ovirt-engine/api/networks/456/labels" rel="labels"/>
  <data_center href="/ovirt-engine/api/datacenters/123" id="123"/>
  <stp>false</stp>
  <mtu>0</mtu>
  <usages>
    <usage>vm</usage>
  </usages>
</network>

Expand

Table 7.207. 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	Deprecated, 'usages' should be used to define network as a display network.
`dns_resolver_configuration`	DnsResolverConfiguration
`id`	String	A unique identifier.
`ip`	Ip	Deprecated, not in use.
`mtu`	Integer	Specifies the maximum transmission unit for the network.
`name`	String	A human-readable name in plain text.
`profile_required`	Boolean	Specifies whether upon creation of the network a virtual network interface profile should automatically be created.
`required`	Boolean	Defines whether the network is mandatory for all the hosts in the cluster.
`status`	NetworkStatus	The status of the network.
`stp`	Boolean	Specifies whether the spanning tree protocol is enabled for the network.
`usages`	NetworkUsage[]	Defines a set of usage elements for the network.
`vlan`	Vlan	A VLAN tag.

7.156.1. required
リンクのコピー

Defines whether the network is mandatory for all the hosts in the cluster. In case a 'required' operational network is omitted from a host, the host will be marked as non_operational,

7.156.2. status
リンクのコピー

The status of the network. non_operational if the network defined as 'required' and omitted from any active cluster host. operational otherwise.

7.156.3. usages
リンクのコピー

Defines a set of usage elements for the network.

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

Expand

Table 7.208. Links summary
Name	Type	Summary
`cluster`	Cluster	A reference to the cluster this network is attached to.
`data_center`	DataCenter	A reference to the data center that the network is a member of.
`external_provider`	OpenStackNetworkProvider	An optional reference to the OpenStack network provider on which the network is created.
`external_provider_physical_network`	Network	An optional reference to a network that should be used for physical network access.
`network_labels`	NetworkLabel[]	A reference to the labels assigned to the network.
`permissions`	Permission[]	A reference to the permissions of the network.
`qos`	Qos	Reference to quality of service.
`vnic_profiles`	VnicProfile[]	A reference to the profiles of the network.

7.156.4. cluster
リンクのコピー

A reference to the cluster this network is attached to. Will be filled only if the network is accessed from the cluster level.

7.156.5. external_provider
リンクのコピー

An optional reference to the OpenStack network provider on which the network is created.

If it is specified when a network is created, a matching OpenStack network will be also created.

7.156.6. external_provider_physical_network
リンクのコピー

An optional reference to a network that should be used for physical network access. Valid only if external_provider is specified.

7.157. NetworkAttachment struct
リンクのコピー

Describes how a host connects to a network.

An XML representation of a network attachment on a host:

<network_attachment href="/ovirt-engine/api/hosts/123/nics/456/networkattachments/789" id="789">
  <network href="/ovirt-engine/api/networks/234" id="234"/>
  <host_nic href="/ovirt-engine/api/hosts/123/nics/123" id="123"/>
  <in_sync>true</in_sync>
  <ip_address_assignments>
    <ip_address_assignment>
      <assignment_method>static</assignment_method>
      <ip>
        <address>192.168.122.39</address>
        <gateway>192.168.122.1</gateway>
        <netmask>255.255.255.0</netmask>
        <version>v4</version>
      </ip>
    </ip_address_assignment>
  </ip_address_assignments>
  <reported_configurations>
    <reported_configuration>
      <name>mtu</name>
      <expected_value>1500</expected_value>
      <actual_value>1500</actual_value>
      <in_sync>true</in_sync>
    </reported_configuration>
    <reported_configuration>
      <name>bridged</name>
      <expected_value>true</expected_value>
      <actual_value>true</actual_value>
      <in_sync>true</in_sync>
    </reported_configuration>
    ...
  </reported_configurations>
</network_attachment>

The network element, with either a name or an id, is required in order to attach a network to a network interface card (NIC).

For example, to attach a network to a host network interface card, send a request like this:

POST /ovirt-engine/api/hosts/123/nics/456/networkattachments

With a request body like this:

<networkattachment>
  <network id="234"/>
</networkattachment>

To attach a network to a host, send a request like this:

POST /ovirt-engine/api/hosts/123/networkattachments

With a request body like this:

<network_attachment>
  <network id="234"/>
  <host_nic id="456"/>
</network_attachment>

The ip_address_assignments and properties elements are updatable post-creation.

For example, to update a network attachment, send a request like this:

PUT /ovirt-engine/api/hosts/123/nics/456/networkattachments/789

With a request body like this:

<network_attachment>
  <ip_address_assignments>
    <ip_address_assignment>
      <assignment_method>static</assignment_method>
      <ip>
        <address>7.1.1.1</address>
        <gateway>7.1.1.2</gateway>
        <netmask>255.255.255.0</netmask>
        <version>v4</version>
      </ip>
    </ip_address_assignment>
  </ip_address_assignments>
</network_attachment>

To detach a network from the network interface card send a request like this:

DELETE /ovirt-engine/api/hosts/123/nics/456/networkattachments/789

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>

Expand

Table 7.209. Attributes summary
Name	Type	Summary
`comment`	String	Free text containing comments about this object.
`description`	String	A human-readable description in plain text.
`dns_resolver_configuration`	DnsResolverConfiguration	DNS resolver configuration will be reported when retrieving the network attachment using GET.
`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.

7.157.1. dns_resolver_configuration
リンクのコピー

DNS resolver configuration will be reported when retrieving the network attachment using GET. It is optional when creating a new network attachment or updating an existing one.

7.157.2. properties
リンクのコピー

Defines custom properties for the network configuration.

Bridge options have the set name of bridge_opts. Separate multiple entries with a whitespace character. The following keys are valid for bridge_opts:

Expand

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`

Expand

Table 7.210. Links summary
Name	Type	Summary
`host`	Host
`host_nic`	HostNic	A reference to the host network interface.
`network`	Network	A reference to the network that the interface is attached to.
`qos`	Qos

7.158. NetworkConfiguration struct
リンクのコピー

Expand

Table 7.211. Attributes summary
Name	Type	Summary
`dns`	Dns
`nics`	Nic[]

7.159. NetworkFilter struct
リンクのコピー

Network filters filter packets sent to and from the virtual machine’s NIC according to defined rules.

There are several types of network filters supported based on libvirt. For more details about the different network filters see here.

In addition to libvirt’s network filters, there are two additional network filters: The first is called vdsm-no-mac-spoofing and is composed of no-mac-spoofing and no-arp-mac-spoofing. The second is called ovirt-no-filter and is used when no network filter is to be defined for the virtual machine’s NIC. The ovirt-no-filter network filter is only used for internal implementation, and does not exist on the NICs.

This is a example of the XML representation:

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

Expand

Table 7.212. 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	The minimum supported version of a specific NetworkFilter.

7.159.1. version
リンクのコピー

The minimum supported version of a specific NetworkFilter. This is the version that the NetworkFilter was first introduced in.

7.160. NetworkFilterParameter struct
リンクのコピー

Parameter for the network filter.

See Libvirt-Filters for further details. This is a example of the XML representation:

<network_filter_parameter id="123">
  <name>IP</name>
  <value>10.0.1.2</value>
</network_filter_parameter>

Expand

Table 7.213. 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	Represents the value of the parameter.

Expand

Table 7.214. Links summary
Name	Type	Summary
`nic`	Nic	The virtual machine NIC the parameter is assiciated to.

7.161. NetworkLabel struct
リンクのコピー

Represents a label which can be added to a host network interface and to a network. The label binds the network to the host network interface by the label id.

Expand

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

Expand

Table 7.216. Links summary
Name	Type	Summary
`host_nic`	HostNic	A reference to the host network interface which contains this label.
`network`	Network	A reference to the network which contains this label.

7.162. NetworkPluginType enum
リンクのコピー

Network plug-in type.

Specifies the provider driver implementation on the host.

Since version 4.2 of the Red Hat Virtualization Manager, this type has been deprecated in favour of the external_plugin_type attribute of the OpenStackNetworkProvider type.

Expand

Table 7.217. Values summary
Name	Summary
`open_vswitch`	Open vSwitch.

7.162.1. open_vswitch
リンクのコピー

Open vSwitch.

Specifies that Open vSwitch based driver implementation should be used for this provider.

Since version 4.2 of the Red Hat Virtualization Manager, this value has been deprecated. Use the string open_vswitch in the OpenStackNetworkProvider.external_plugin_type attribute instead.

7.163. NetworkStatus enum
リンクのコピー

Expand

Table 7.218. Values summary
Name	Summary
`non_operational`
`operational`

7.164. NetworkUsage enum
リンクのコピー

This type indicates the purpose that the network is used for in the cluster.

Expand

Table 7.219. Values summary
Name	Summary
`default_route`	The default gateway and the DNS resolver configuration of the host will be taken from this network.
`display`	The network will be used for SPICE and VNC traffic.
`gluster`	The network will be used for Gluster (bricks) data traffic.
`management`	The network will be used for communication between the Red Hat Virtualization Manager and the nodes.
`migration`	The network will be used for virtual machine migration.
`vm`

7.164.1. default_route
リンクのコピー

The default gateway and the DNS resolver configuration of the host will be taken from this network.

If this network is attached to the host, then the DNS resolver configuration will be taken from the dns_resolver_configuration attribute of the network attachment. If there is no dns_resolver_configuration attribute in this network attachment, then they will be taken from the dns_resolver_configuration of the network itself. If dns_resolver_configuration attribute isn’t present even there, DNS resolver configuration won’t be set.

If you set this flag on a network, then the the default gateway for the host will be taken from the gateway attribute of the ip_address_assignment of the network attachment.

7.164.2. management
リンクのコピー

The network will be used for communication between the Red Hat Virtualization Manager and the nodes. This is the network where the ovirtmgmt bridge will be created.

7.165. NfsProfileDetail struct
リンクのコピー

Expand

Table 7.220. Attributes summary
Name	Type	Summary
`nfs_server_ip`	String
`profile_details`	ProfileDetail[]

7.166. NfsVersion enum
リンクのコピー

Expand

Table 7.221. Values summary
Name	Summary
`auto`
`v3`
`v4`
`v4_1`
`v4_2`	NFS 4.

7.166.1. v4_2
リンクのコピー

NFS 4.2.

7.167. Nic struct
リンクのコピー

Represents a virtual machine NIC.

For example, the XML representation of a NIC will look like this:

<nic href="/ovirt-engine/api/vms/123/nics/456" id="456">
  <name>nic1</name>
  <vm href="/ovirt-engine/api/vms/123" id="123"/>
  <interface>virtio</interface>
  <linked>true</linked>
  <mac>
    <address>02:00:00:00:00:00</address>
  </mac>
  <plugged>true</plugged>
  <vnic_profile href="/ovirt-engine/api/vnicprofiles/789" id="789"/>
</nic>

Expand

Table 7.222. Attributes summary
Name	Type	Summary
`boot_protocol`	BootProtocol	Defines how an IP address is assigned to the NIC.
`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	Defines if the network interface should be activated upon operation system startup.
`plugged`	Boolean	Defines if the NIC is plugged in to the virtual machine.

Expand

Table 7.223. 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 that the interface should be connected to.
`network_attachments`	NetworkAttachment[]	A link to a collection of network attachments that are associated with the host NIC.
`network_filter_parameters`	NetworkFilterParameter[]	A link to the network filter parameters.
`network_labels`	NetworkLabel[]	A link to a collection of network labels that are associated with the host NIC.
`reported_devices`	ReportedDevice[]	A link to a collection of reported devices that are associated with the virtual network interface.
`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[]	A link to a collection of network labels that are allowed to be attached to the virtual functions of an SR-IOV NIC.
`virtual_function_allowed_networks`	Network[]	A link to a collection of networks that are allowed to be attached to the virtual functions of an SR-IOV NIC.
`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	A link to an associated virtual network interface profile.

7.167.1. network
リンクのコピー

A reference to the network that the interface should be connected to. A blank network ID is allowed.

Usage of this element for creating or updating a NIC is deprecated; use vnic_profile instead. It is preserved because it is still in use by the initialization element, as a holder for IP addresses and other network details.

7.167.2. vms
リンクのコピー

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

7.168. NicConfiguration struct
リンクのコピー

The type describes the configuration of a virtual network interface.

Expand

Table 7.224. Attributes summary
Name	Type	Summary
`boot_protocol`	BootProtocol	IPv4 boot protocol.
`ip`	Ip	IPv4 address details.
`ipv6`	Ip	IPv6 address details.
`ipv6_boot_protocol`	BootProtocol	IPv6 boot protocol.
`name`	String	Network interface name.
`on_boot`	Boolean	Specifies whether the network interface should be activated on the virtual machine guest operating system boot.

7.169. NicInterface enum
リンクのコピー

Defines the options for an emulated virtual network interface device model.

Expand

Table 7.225. Values summary
Name	Summary
`e1000`	e1000.
`pci_passthrough`	PCI Passthrough.
`rtl8139`	rtl8139.
`rtl8139_virtio`	Dual mode rtl8139, VirtIO.
`spapr_vlan`	sPAPR VLAN.
`virtio`	VirtIO.

7.170. NicStatus enum
リンクのコピー

Network interface card status.

Expand

Table 7.226. Values summary
Name	Summary
`down`	The NIC is down and cannot be accessed.
`up`	The NIC is up and can be accessed.

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

Expand

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

Expand

Table 7.228. Links summary
Name	Type	Summary
`host`	Host
`statistics`	Statistic[]	Each host NUMA node resource exposes a statistics sub-collection for host NUMA node specific statistics.

7.171.1. statistics
リンクのコピー

Each host NUMA node resource exposes a statistics sub-collection for host NUMA node specific statistics.

An example of an XML representation:

<statistics>
  <statistic href="/ovirt-engine/api/hosts/123/numanodes/456/statistics/789" id="789">
    <name>memory.total</name>
    <description>Total memory</description>
    <kind>gauge</kind>
    <type>integer</type>
    <unit>bytes</unit>
    <values>
      <value>
        <datum>25165824000</datum>
      </value>
    </values>
    <host_numa_node href="/ovirt-engine/api/hosts/123/numanodes/456" id="456" />
  </statistic>
    ...
</statistics>

Note

This statistics sub-collection is read-only.

The following list shows the statistic types for a host NUMA node:

Expand

Name	Description
`memory.total`	Total memory in bytes on the NUMA node.
`memory.used`	Memory in bytes used on the NUMA node.
`memory.free`	Memory in bytes free on the NUMA node.
`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.

7.172. NumaNodePin struct
リンクのコピー

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

Expand

Table 7.229. Attributes summary
Name	Type	Summary
`host_numa_node`	NumaNode	Deprecated.
`index`	Integer	The index of a physical NUMA node to which the virtual NUMA node is pinned.
`pinned`	Boolean	Deprecated.

7.172.1. host_numa_node
リンクのコピー

Deprecated. Has no function.

7.172.2. pinned
リンクのコピー

Deprecated. Should always be true.

7.173. NumaTuneMode enum
リンクのコピー

Expand

Table 7.230. Values summary
Name	Summary
`interleave`
`preferred`
`strict`

7.174. OpenStackImage struct
リンクのコピー

Expand

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

Expand

Table 7.232. Links summary
Name	Type	Summary
`openstack_image_provider`	OpenStackImageProvider

7.175. OpenStackImageProvider struct
リンクのコピー

Expand

Table 7.233. 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	Defines the tenant name for OpenStack Identity API v2.
`url`	String	Defines URL address of the external provider.
`username`	String	Defines user name to be used during authentication process.

7.175.1. requires_authentication
リンクのコピー

Defines whether provider authentication is required or not.

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

7.175.2. tenant_name
リンクのコピー

Defines the tenant name for OpenStack Identity API v2.0.

Expand

Table 7.234. Links summary
Name	Type	Summary
`certificates`	Certificate[]
`images`	OpenStackImage[]

7.176. OpenStackNetwork struct
リンクのコピー

Expand

Table 7.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.
`name`	String	A human-readable name in plain text.

Expand

Table 7.236. Links summary
Name	Type	Summary
`openstack_network_provider`	OpenStackNetworkProvider

7.177. OpenStackNetworkProvider struct
リンクのコピー

Expand

Table 7.237. Attributes summary
Name	Type	Summary
`agent_configuration`	AgentConfiguration	Agent configuration settings.
`authentication_url`	String	Defines the external provider authentication URL address.
`auto_sync`	Boolean	Indicates if the networks of this provider are automatically synchronized.
`comment`	String	Free text containing comments about this object.
`description`	String	A human-readable description in plain text.
`external_plugin_type`	String	Network plug-in type.
`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 plug-in type.
`project_domain_name`	String	Defines the project’s domain name for OpenStack Identity API v3.
`project_name`	String	Defines the project name for OpenStack Identity API v3.
`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	Defines the tenant name for OpenStack Identity API v2.
`type`	OpenStackNetworkProviderType	The type of provider.
`unmanaged`	Boolean	Indicates whether the provider is unmanaged by Red Hat Virtualization.
`url`	String	Defines URL address of the external provider.
`user_domain_name`	String	Defines the domain name of the `username` in ExternalProvider for OpenStack Identity API v3.
`username`	String	Defines user name to be used during authentication process.

7.177.1. auto_sync
リンクのコピー

Indicates if the networks of this provider are automatically synchronized.

If true, the networks of this provider are automatically and cyclically synchronized to Red Hat Virtualization in the background. This means that all new networks of this provider are imported, and all discarded networks are removed from all clusters that have this external provider as the default provider. If the name of a network is changed on the provider, the change is synchronized to the network entity in Red Hat Virtualization. Furthermore, if a new cluster that has the provider as the default provider is added, already imported networks are attached to this new cluster during synchronization.

The automatically initiated import triggers the following steps:

The networks of the external provider will be imported to every data center in the data centers of the clusters that have that external provider as the default provider.
A vNIC profile will be created for each involved data center and network.
The networks will be assigned to each cluster that has that external provider as the default provider.

All users are allowed to use the new vNIC Profile.

The default is false for backwards compatibility.

7.177.2. external_plugin_type
リンクのコピー

Network plug-in type.

This attribute allows you to choose the correct provider driver on the host when an external NIC is added or modified. If automated installation of the driver is supported (only available for some predefined implementations, for example ovirt-provider-ovn), this attribute will also allow the system to decide which driver implementation to install on newly added hosts.

7.177.3. plugin_type
リンクのコピー

Network plug-in type.

Since version 4.2 of the Red Hat Virtualization Manager, this attribute has been deprecated in favour of external_plugin_type. This attribute is only valid for providers of type open_vswitch, and will only be returned when the value of the external_plugin_type attribute value is equal to open_vswitch.

If both plugin_type and external_plugin_type are specified during an update, the value of plugin_type will be ignored.

For external providers this value will not be shown and will be ignored during update requests.

7.177.4. read_only
リンクのコピー

Indicates whether the provider is read-only.

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

7.177.5. requires_authentication
リンクのコピー

Defines whether provider authentication is required or not.

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

7.177.6. tenant_name
リンクのコピー

Defines the tenant name for OpenStack Identity API v2.0.

7.177.7. unmanaged
リンクのコピー

Indicates whether the provider is unmanaged by Red Hat Virtualization.

If true, authentication and subnet control are entirely left to the external provider and are unmanaged by Red Hat Virtualization.

The default is false for backwards compatibility.

Expand

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

7.178. OpenStackNetworkProviderType enum
リンクのコピー

The OpenStack network provider can either be implemented by OpenStack Neutron, in which case the Neutron agent is automatically installed on the hosts, or it can be an external provider implementing the OpenStack API, in which case the virtual interface driver is a custom solution installed manually.

Expand

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

7.178.1. external
リンクのコピー

Indicates that the provider is an external one, implementing the OpenStack Neutron API. The virtual interface driver in this case is implemented by the external provider.

7.178.2. neutron
リンクのコピー

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

7.179. OpenStackProvider struct
リンクのコピー

Expand

Table 7.240. 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	Defines the tenant name for OpenStack Identity API v2.
`url`	String	Defines URL address of the external provider.
`username`	String	Defines user name to be used during authentication process.

7.179.1. requires_authentication
リンクのコピー

Defines whether provider authentication is required or not.

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

7.179.2. tenant_name
リンクのコピー

Defines the tenant name for OpenStack Identity API v2.0.

7.180. OpenStackSubnet struct
リンクのコピー

Expand

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

7.180.1. ip_version
リンクのコピー

Defines IP version.

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

Expand

Table 7.242. Links summary
Name	Type	Summary
`openstack_network`	OpenStackNetwork	Reference to the service managing the OpenStack network.

7.181. OpenStackVolumeProvider struct
リンクのコピー

Expand

Table 7.243. 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	Defines the tenant name for OpenStack Identity API v2.
`url`	String	Defines URL address of the external provider.
`username`	String	Defines user name to be used during authentication process.

7.181.1. requires_authentication
リンクのコピー

Defines whether provider authentication is required or not.

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

7.181.2. tenant_name
リンクのコピー

Defines the tenant name for OpenStack Identity API v2.0.

Expand

Table 7.244. Links summary
Name	Type	Summary
`authentication_keys`	OpenstackVolumeAuthenticationKey[]
`certificates`	Certificate[]
`data_center`	DataCenter
`volume_types`	OpenStackVolumeType[]

7.182. OpenStackVolumeType struct
リンクのコピー

Expand

Table 7.245. 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[]

Expand

Table 7.246. Links summary
Name	Type	Summary
`openstack_volume_provider`	OpenStackVolumeProvider

7.183. OpenstackVolumeAuthenticationKey struct
リンクのコピー

Expand

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

Expand

Table 7.248. Links summary
Name	Type	Summary
`openstack_volume_provider`	OpenStackVolumeProvider

7.184. OpenstackVolumeAuthenticationKeyUsageType enum
リンクのコピー

Expand

Table 7.249. Values summary
Name	Summary
`ceph`

7.185. OperatingSystem struct
リンクのコピー

Information describing the operating system. This is used for both virtual machines and hosts.

Expand

Table 7.250. Attributes summary
Name	Type	Summary
`boot`	Boot	Configuration of the boot sequence.
`cmdline`	String	Custom kernel parameters for start the virtual machine with if Linux operating system is used.
`custom_kernel_cmdline`	String	A custom part of the host kernel command line.
`initrd`	String	Path to custom initial ramdisk on ISO storage domain if Linux operating system is used.
`kernel`	String	Path to custom kernel on ISO storage domain if Linux operating system is used.
`reported_kernel_cmdline`	String	The host kernel command line as reported by a running host.
`type`	String	Operating system name in human readable form.
`version`	Version

7.185.1. boot
リンクのコピー

Configuration of the boot sequence.

Note

Not used for hosts.

7.185.2. cmdline
リンクのコピー

Custom kernel parameters for start the virtual machine with if Linux operating system is used.

Note

Not used for hosts.

7.185.3. custom_kernel_cmdline
リンクのコピー

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

You must reinstall and then reboot the host to apply the changes implemented by this attribute.

During each host deploy procedure, kernel parameters that were added in the previous host deploy procedure are removed using grubby --update-kernel DEFAULT --remove-args <previous_custom_params>, and the current kernel command line customization is applied using grubby --update-kernel DEFAULT --args <custom_params>. The Manager internally keeps track of the last-applied kernel parameters customization.

Note

This attribute is currently only used for hosts.

7.185.4. initrd
リンクのコピー

Path to custom initial ramdisk on ISO storage domain if Linux operating system is used.

For example iso://initramfs-3.10.0-514.6.1.el7.x86_64.img.

Note

Not used for hosts.

7.185.5. kernel
リンクのコピー

Path to custom kernel on ISO storage domain if Linux operating system is used.

For example iso://vmlinuz-3.10.0-514.6.1.el7.x86_64.

Note

Not used for hosts.

7.185.6. reported_kernel_cmdline
リンクのコピー

The host kernel command line as reported by a running host.

This is a read-only attribute. Attempts to change this attribute are silently ignored.

Note

This attribute is currently only used for hosts.

7.185.7. type
リンクのコピー

Operating system name in human readable form.

For example Fedora or RHEL. In general one of the names returned by the operating system service.

Note

Read only for hosts.

7.186. OperatingSystemInfo struct
リンクのコピー

Represents a guest operating system.

Expand

Table 7.251. Attributes summary
Name	Type	Summary
`architecture`	Architecture	Operating system architecture.
`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	Large icon of the guest operating system.
`name`	String	A human-readable name in plain text.
`small_icon`	Icon	Small icon of the guest operating system.

7.186.1. large_icon
リンクのコピー

Large icon of the guest operating system. Maximum dimensions: width 150px, height 120px.

7.186.2. small_icon
リンクのコピー

Small icon of the guest operating system. Maximum dimensions: width 43px, height 43px.

7.187. Option struct
リンクのコピー

Expand

Table 7.252. Attributes summary
Name	Type	Summary
`name`	String
`type`	String
`value`	String

7.188. OsType enum
リンクのコピー

Type representing kind of operating system.

Warning

This type has been deprecated with the introduction of the OperatingSystemInfo type. Operating systems are available as a top-level collection in the API: operating_systems

The end-user declares the type of the operating system installed in the virtual machine (guest operating system) by selecting one of these values. This declaration enables the system to tune the virtual machine configuration for better user experience. For example, the system chooses devices that are most suitable for the operating system. Note that the system rely on user’s selection and does not verify it by inspecting the actual guest operating system installed.

Expand

Table 7.253. Values summary
Name	Summary
`other`	Other type of operating system, not specified by the other values.
`other_linux`	Distribution of Linux other than those specified by the other values.
`rhel_3`	Red Hat Enterprise Linux 3 32-bit.
`rhel_3x64`	Red Hat Enterprise Linux 3 64-bit.
`rhel_4`	Red Hat Enterprise Linux 4 32-bit.
`rhel_4x64`	Red Hat Enterprise Linux 4 64-bit.
`rhel_5`	Red Hat Enterprise Linux 5 32-bit.
`rhel_5x64`	Red Hat Enterprise Linux 5 64-bit.
`rhel_6`	Red Hat Enterprise Linux 6 32-bit.
`rhel_6x64`	Red Hat Enterprise Linux 6 64-bit.
`unassigned`	This value is mapped to `other`.
`windows_2003`	Windows 2003 32-bit.
`windows_2003x64`	Windows 2003 64-bit.
`windows_2008`	Windows 2008 32-bit.
`windows_2008r2x64`	Windows 2008 R2 64-bit.
`windows_2008x64`	Windows 2008 64-bit.
`windows_2012x64`	Windows 2012 64-bit.
`windows_7`	Windows 7 32-bit.
`windows_7x64`	Windows 7 64-bit.
`windows_8`	Windows 8 32-bit.
`windows_8x64`	Windows 8 64-bit.
`windows_xp`	Windows XP.

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

Expand

Table 7.254. Attributes summary
Name	Type	Summary
`name`	String	The name of the package.

7.190. Payload struct
リンクのコピー

Expand

Table 7.255. Attributes summary
Name	Type	Summary
`files`	File[]
`type`	VmDeviceType
`volume_id`	String

7.191. PayloadEncoding enum
リンクのコピー

Expand

Table 7.256. Values summary
Name	Summary
`base64`
`plaintext`

7.192. Permission struct
リンクのコピー

Type represents a permission.

Expand

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

Expand

Table 7.258. Links summary
Name	Type	Summary
`cluster`	Cluster	Reference to cluster.
`data_center`	DataCenter	Reference to data center.
`disk`	Disk	Reference to disk.
`group`	Group	Reference to group.
`host`	Host	Reference to host.
`role`	Role	Reference to role.
`storage_domain`	StorageDomain	Reference to storage domain.
`template`	Template	Reference to template.
`user`	User	Reference to user.
`vm`	Vm	Reference to virtual machine.
`vm_pool`	VmPool	Reference to virtual machines pool.

7.193. Permit struct
リンクのコピー

Type represents a permit.

Expand

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

Expand

Table 7.260. Links summary
Name	Type	Summary
`role`	Role	Reference to the role the permit belongs to.

7.194. PmProxy struct
リンクのコピー

Expand

Table 7.261. Attributes summary
Name	Type	Summary
`type`	PmProxyType

7.195. PmProxyType enum
リンクのコピー

Expand

Table 7.262. Values summary
Name	Summary
`cluster`	The fence proxy is selected from the same cluster as the fenced host.
`dc`	The fence proxy is selected from the same data center as the fenced host.
`other_dc`	The fence proxy is selected from a different data center than the fenced host.

7.196. PolicyUnitType enum
リンクのコピー

Holds the types of all internal policy unit types.

Expand

Table 7.263. Values summary
Name	Summary
`filter`
`load_balancing`
`weight`

7.197. PortMirroring struct
リンクのコピー

7.198. PowerManagement struct
リンクのコピー

Expand

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

7.198.1. agents
リンクのコピー

Specifies fence agent options when multiple fences are used.

Use the order sub-element to prioritize the fence agents. Agents are run sequentially according to their order until the fence action succeeds. When two or more fence agents have the same order, they are run concurrently. Other sub-elements include type, ip, user, password, and options.

7.198.2. automatic_pm_enabled
リンクのコピー

Toggles the automated power control of the host in order to save energy. When set to true, the host will be automatically powered down if the cluster’s load is low, and powered on again when required. This is set to true when a host is created, unless disabled by the user.

7.198.3. kdump_detection
リンクのコピー

Toggles whether to determine if kdump is running on the host before it is shut down. When set to true, the host will not shut down during a kdump process. This is set to true when a host has power management enabled, unless disabled by the user.

7.198.4. type
リンクのコピー

Fencing device code.

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

7.199. PowerManagementStatus enum
リンクのコピー

Expand

Table 7.265. Values summary
Name	Summary
`off`	Host is OFF.
`on`	Host is ON.
`unknown`	Unknown status.

7.200. Product struct
リンクのコピー

Expand

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

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

Expand

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

7.201.1. vendor
リンクのコピー

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

7.202. ProfileDetail struct
リンクのコピー

Expand

Table 7.268. Attributes summary
Name	Type	Summary
`block_statistics`	BlockStatistic[]
`duration`	Integer
`fop_statistics`	FopStatistic[]
`profile_type`	String
`statistics`	Statistic[]

7.203. Property struct
リンクのコピー

Expand

Table 7.269. Attributes summary
Name	Type	Summary
`name`	String
`value`	String

7.204. ProxyTicket struct
リンクのコピー

Expand

Table 7.270. Attributes summary
Name	Type	Summary
`value`	String

7.205. QcowVersion enum
リンクのコピー

The QCOW version specifies to the qemu which qemu version the volume supports.

This field can be updated using the update API and will be reported only for QCOW volumes, it is determined by the storage domain’s version which the disk is created on. Storage domains with version lower than V4 support QCOW2 version 2 volumes, while V4 storage domains also support QCOW2 version 3. For more information about features of the different QCOW versions, see here.

Expand

Table 7.271. Values summary
Name	Summary
`qcow2_v2`	The Copy On Write default compatibility version It means that every QEMU can use it.
`qcow2_v3`	The Copy On Write compatibility version which was introduced in QEMU 1.

7.205.1. qcow2_v3
リンクのコピー

The Copy On Write compatibility version which was introduced in QEMU 1.1 It means that the new format is in use.

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

Expand

Table 7.272. 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 (Megabits per sec).
`inbound_burst`	Integer	The amount of data that can be delivered in a single burst, in MB.
`inbound_peak`	Integer	The maximum inbound rate in Mbps (Megabits per sec).
`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 (Megabits per sec).
`outbound_average_linkshare`	Integer	Weighted share.
`outbound_average_realtime`	Integer	The committed rate in Mbps (Megabits per sec).
`outbound_average_upperlimit`	Integer	The maximum bandwidth to be used by a network in Mbps (Megabits per sec).
`outbound_burst`	Integer	The amount of data that can be sent in a single burst, in MB.
`outbound_peak`	Integer	The maximum outbound rate in Mbps (Megabits per sec).
`type`	QosType	The kind of resources this entry can be assigned.

7.206.1. cpu_limit
リンクのコピー

The maximum processing capability in %.

Used to configure computing resources.

7.206.2. inbound_average
リンクのコピー

The desired average inbound bit rate in Mbps (Megabits per sec).

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

See Libvirt-QOS for further details.

7.206.3. inbound_burst
リンクのコピー

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

Used to configure virtual machine networks. If defined, inbound_average and inbound_peak must also be set.

See Libvirt-QOS for further details.

7.206.4. inbound_peak
リンクのコピー

The maximum inbound rate in Mbps (Megabits per sec).

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

See Libvirt-QOS for further details.

7.206.5. max_iops
リンクのコピー

Maximum permitted number of input and output operations per second.

Used to configure storage. Must not be set if max_read_iops or max_write_iops is set.

7.206.6. max_read_iops
リンクのコピー

Maximum permitted number of input operations per second.

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

7.206.7. max_read_throughput
リンクのコピー

Maximum permitted throughput for read operations.

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

7.206.8. max_throughput
リンクのコピー

Maximum permitted total throughput.

Used to configure storage. Must not be set if max_read_throughput or max_write_throughput is set.

7.206.9. max_write_iops
リンクのコピー

Maximum permitted number of output operations per second.

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

7.206.10. max_write_throughput
リンクのコピー

Maximum permitted throughput for write operations.

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

7.206.11. outbound_average
リンクのコピー

The desired average outbound bit rate in Mbps (Megabits per sec).

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

See Libvirt-QOS for further details.

7.206.12. outbound_average_linkshare
リンクのコピー

Weighted share.

Used to configure host networks. Signifies how much of the logical link’s capacity a specific network should be allocated, relative to the other networks attached to the same logical link. The exact share depends on the sum of shares of all networks on that link. By default this is a number in the range 1-100.

7.206.13. outbound_average_realtime
リンクのコピー

The committed rate in Mbps (Megabits per sec).

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

7.206.14. outbound_average_upperlimit
リンクのコピー

The maximum bandwidth to be used by a network in Mbps (Megabits per sec).

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

See Libvirt-QOS for further details.

7.206.15. outbound_burst
リンクのコピー

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

Used to configure virtual machine networks. If defined, outbound_average and outbound_peak must also be set.

See Libvirt-QOS for further details.

7.206.16. outbound_peak
リンクのコピー

The maximum outbound rate in Mbps (Megabits per sec).

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

See Libvirt-QOS for further details.

Expand

Table 7.273. Links summary
Name	Type	Summary
`data_center`	DataCenter	The data center the QoS is assiciated to.

7.207. QosType enum
リンクのコピー

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

Expand

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

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

Expand

Table 7.275. 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[]

Expand

Table 7.276. Links summary
Name	Type	Summary
`permissions`	Permission[]
`quota_cluster_limits`	QuotaClusterLimit[]
`quota_storage_limits`	QuotaStorageLimit[]

7.209. QuotaClusterLimit struct
リンクのコピー

Expand

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

Expand

Table 7.278. Links summary
Name	Type	Summary
`cluster`	Cluster
`quota`	Quota

7.210. QuotaModeType enum
リンクのコピー

Expand

Table 7.279. Values summary
Name	Summary
`audit`
`disabled`
`enabled`

7.211. QuotaStorageLimit struct
リンクのコピー

Expand

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

Expand

Table 7.281. Links summary
Name	Type	Summary
`quota`	Quota
`storage_domain`	StorageDomain

7.212. Range struct
リンクのコピー

Expand

Table 7.282. Attributes summary
Name	Type	Summary
`from`	String
`to`	String

7.213. Rate struct
リンクのコピー

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

Expand

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

7.214. RegistrationAffinityGroupMapping struct
リンクのコピー

This type describes how to map affinity groups as part of the object registration. An object can be a virtual machine, template, etc.

An example of an XML representation using this mapping:

<action>
  <registration_configuration>
    <affinity_group_mappings>
     <registration_affinity_group_mapping>
       <from>
         <name>affinity</name>
       </from>
       <to>
         <name>affinity2</name>
       </to>
     </registration_affinity_group_mapping>
    </affinity_group_mappings>
  </registration_configuration>
</action>

Expand

Table 7.284. Links summary
Name	Type	Summary
`from`	AffinityGroup	Reference to the original affinity group.
`to`	AffinityGroup	Reference to the destination affinity group.

7.214.1. from
リンクのコピー

Reference to the original affinity group. It can be specified using name.

7.215. RegistrationAffinityLabelMapping struct
リンクのコピー

This type describes how to map affinity labels as part of the object registration. An object can be a virtual machine, template, etc.

An example of an XML representation using mapping:

<action>
  <registration_configuration>
    <affinity_label_mappings>
     <registration_affinity_label_mapping>
       <from>
         <name>affinity_label</name>
       </from>
       <to>
         <name>affinity_label2</name>
       </to>
     </registration_affinity_label_mapping>
    </affinity_label_mappings>
  </registration_configuration>
</action>

Expand

Table 7.285. Links summary
Name	Type	Summary
`from`	AffinityLabel	Reference to the original affinity label.
`to`	AffinityLabel	Reference to the destination affinity label.

7.215.1. from
リンクのコピー

Reference to the original affinity label. It can be specified using name.

7.216. RegistrationClusterMapping struct
リンクのコピー

This type describes how to map clusters as part of the object registration. An object can be a virtual machine, template, etc.

An example of an XML representation using this mapping:

<action>
  <registration_configuration>
    <cluster_mappings>
      <registration_cluster_mapping>
        <from>
          <name>myoriginalcluster</name>
        </from>
        <to>
          <name>mynewcluster</name>
        </to>
      </registration_cluster_mapping>
    </cluster_mappings>
  </registration_configuration>
</action>

Expand

Table 7.286. Links summary
Name	Type	Summary
`from`	Cluster	Reference to the original cluster.
`to`	Cluster	Reference to the destination cluster.

7.216.1. from
リンクのコピー

Reference to the original cluster. It can be specified using the id or the name.

7.216.2. to
リンクのコピー

Reference to the destination cluster. It can be specified using the id or the name.

7.217. RegistrationConfiguration struct
リンクのコピー

This type describes how an object (virtual machine, template, etc) is registered, and is used for the implementation of disaster recovery solutions.

Each mapping contained in this type can be used to map objects in the original system to corresponding objects in the system where the virtual machine or template is being registered. For example, there could be a primary setup with a virtual machine configured on cluster A, and an active secondary setup with cluster B. Cluster B is compatible with that virtual machine, and in case of a disaster recovery scenario the storage domain can be imported to the secondary setup, and the user can register the virtual machine to cluster B.

In that case, we can automate the recovery process by defining a cluster mapping. After the entity is registered, its OVF will indicate it belongs to cluster A, but the mapping will indicate that cluster A will be replaced with cluster B. Red Hat Virtualization Manager should do the switch and register the virtual machine to cluster B in the secondary site.

Cluster mapping is just one example, there are different types of mappings:

Cluster mapping.
LUN mapping.
Role mapping.
Domain mapping.
Permissions mapping.
Affinity Group mapping.
Affinity Label mapping.
Virtual NIC profile mapping.

Each mapping will be used for its specific OVF’s data once the register operation takes place in the Red Hat Virtualization Manager.

An example of an XML representation using the mapping:

<action>
  <registration_configuration>
    <cluster_mappings>
      <registration_cluster_mapping>
        <from>
          <name>myoriginalcluster</name>
        </from>
        <to>
          <name>mynewcluster</name>
        </to>
      </registration_cluster_mapping>
    </cluster_mappings>
    <role_mappings>
      <registration_role_mapping>
        <from>
          <name>SuperUser</name>
        </from>
        <to>
          <name>UserVmRunTimeManager</name>
        </to>
      </registration_role_mapping>
    </role_mappings>
    <domain_mappings>
      <registration_domain_mapping>
        <from>
          <name>redhat</name>
        </from>
        <to>
          <name>internal</name>
        </to>
      </registration_domain_mapping>
    </domain_mappings>
    <lun_mappings>
     <registration_lun_mapping>
       <from id="111">
       </from>
       <to id="222">
         <alias>weTestLun</alias>
         <lun_storage>
           <type>iscsi</type>
           <logical_units>
              <logical_unit id="36001405fb1ddb4b91e44078f1fffcfef">
                 <address>44.33.11.22</address>
                 <port>3260</port>
                 <portal>1</portal>
                 <target>iqn.2017-11.com.name.redhat:444</target>
              </logical_unit>
           </logical_units>
         </lun_storage>
       </to>
     </registration_lun_mapping>
    </lun_mappings>
    <affinity_group_mappings>
     <registration_affinity_group_mapping>
       <from>
         <name>affinity</name>
       </from>
       <to>
         <name>affinity2</name>
       </to>
     </registration_affinity_group_mapping>
    </affinity_group_mappings>
    <affinity_label_mappings>
     <registration_affinity_label_mapping>
       <from>
         <name>affinity_label</name>
       </from>
       <to>
         <name>affinity_label2</name>
       </to>
     </registration_affinity_label_mapping>
    </affinity_label_mappings>
    <vnic_profile_mappings>
      <registration_vnic_profile_mapping>
        <from>
          <name>gold</name>
          <network>
            <name>red</name>
          </network>
        </from>
        <to id="738dd914-8ec8-4a8b-8628-34672a5d449b"/>
      </registration_vnic_profile_mapping>
      <registration_vnic_profile_mapping>
        <from>
          <name>silver</name>
          <network>
            <name>blue</name>
          </network>
        </from>
        <to>
          <name>copper</name>
          <network>
            <name>orange</name>
          </network>
        </to>
      </registration_vnic_profile_mapping>
    </vnic_profile_mappings>
  </registration_configuration>
</action>

Expand

Table 7.287. Attributes summary
Name	Type	Summary
`affinity_group_mappings`	RegistrationAffinityGroupMapping[]	Describes how the affinity groups are mapped.
`affinity_label_mappings`	RegistrationAffinityLabelMapping[]	Describes how the affinity labels are mapped.
`cluster_mappings`	RegistrationClusterMapping[]	Describes how the clusters that the object references are mapped.
`domain_mappings`	RegistrationDomainMapping[]	Describes how the users' domains are mapped.
`lun_mappings`	RegistrationLunMapping[]	Describes how the LUNs are mapped.
`role_mappings`	RegistrationRoleMapping[]	Describes how the roles are mapped.
`vnic_profile_mappings`	RegistrationVnicProfileMapping[]	Mapping rules for virtual NIC profiles that will be applied during the register process.

7.218. RegistrationDomainMapping struct
リンクのコピー

This type describes how to map the users' domain as part of the object registration. An object can be a virtual machine, template, etc. NOTE: This is based on the assumption that user names will be the same, and that only the domain name will be changed.

An example of an XML representation using this mapping:

<action>
  <registration_configuration>
    <domain_mappings>
      <registration_domain_mapping>
        <from>
          <name>redhat</name>
        </from>
        <to>
          <name>internal</name>
        </to>
      </registration_domain_mapping>
    </domain_mappings>
  </registration_configuration>
</action>

Expand

Table 7.288. Links summary
Name	Type	Summary
`from`	Domain	Reference to the original domain.
`to`	Domain	Reference to the destination domain.

7.218.1. from
リンクのコピー

Reference to the original domain. It can be specified using name.

7.219. RegistrationLunMapping struct
リンクのコピー

This type describes how to map LUNs as part of the object registration. An object can be a virtual machine, template, etc.

An external LUN disk is an entity which does not reside on a storage domain. It must be specified because it doesn’t need to exist in the environment where the object is registered. An example of an XML representation using this mapping:

<action>
  <registration_configuration>
    <lun_mappings>
      <registration_lun_mapping>
    <lun_mappings>
     <registration_lun_mapping>
       <from id="111">
       </from>
       <to id="222">
         <alias>weTestLun</alias>
         <lun_storage>
           <type>iscsi</type>
           <logical_units>
              <logical_unit id="36001405fb1ddb4b91e44078f1fffcfef">
                 <address>44.33.11.22</address>
                 <port>3260</port>
                 <portal>1</portal>
                 <target>iqn.2017-11.com.name.redhat:444</target>
              </logical_unit>
           </logical_units>
         </lun_storage>
       </to>
     </registration_lun_mapping>
    </lun_mappings>
  </registration_configuration>
</action>

Expand

Table 7.289. Links summary
Name	Type	Summary
`from`	Disk	Reference to the original LUN.
`to`	Disk	Reference to the LUN which is to be added to the virtual machine.

7.219.1. from
リンクのコピー

Reference to the original LUN. This must be specified using the id attribute.

7.220. RegistrationRoleMapping struct
リンクのコピー

This type describes how to map roles as part of the object registration. An object can be a virtual machine, template, etc.

A role mapping is intended to map correlating roles between the primary site and the secondary site. For example, there may be permissions with role UserVmRunTimeManager for the virtual machine that is being registered. Therefore we can send a mapping that will register the virtual machine in the secondary setup using the SuperUser role instead of UserVmRunTimeManager An example of an XML representation using this mapping:

<action>
  <registration_configuration>
    <role_mappings>
      <registration_eole_mapping>
        <from>
          <name>SuperUser</name>
        </from>
        <to>
          <name>UserVmRunTimeManager</name>
        </to>
      </registration_role_mapping>
    </role_mappings>
  </registration_configuration>
</action>

Expand

Table 7.290. Links summary
Name	Type	Summary
`from`	Role	Reference to the original role.
`to`	Role	Reference to the destination role.

7.220.1. from
リンクのコピー

Reference to the original role. It can be specified using name.

7.221. RegistrationVnicProfileMapping struct
リンクのコピー

Maps an external virtual NIC profile to one that exists in the Red Hat Virtualization Manager. The target may be specified as a profile ID or a pair of profile name and network name.

If, for example, the desired virtual NIC profile mapping includes the following lines:

Expand

Source network name	Source network profile name	Target virtual NIC profile ID\names
`red`	`gold`	`738dd914-8ec8-4a8b-8628-34672a5d449b`
`<empty>` (no network name)	`<empty>` (no network profile name)	`892a12ec-2028-4451-80aa-ff3bf55d6bac`
`blue`	`silver`	`orange\copper`
`yellow`	`platinum`	`<empty>` (no profile)
`green`	`bronze`

Then the following snippet should be added to RegistrationConfiguration

<vnic_profile_mappings>
  <registration_vnic_profile_mapping>
    <from>
      <name>gold</name>
      <network>
        <name>red</name>
      </network>
    </from>
    <to id="738dd914-8ec8-4a8b-8628-34672a5d449b"/>
  </registration_vnic_profile_mapping>
  <registration_vnic_profile_mapping>
    <from>
      <name></name>
      <network>
        <name></name>
      </network>
    </from>
    <to id="892a12ec-2028-4451-80aa-ff3bf55d6bac"/>
  </registration_vnic_profile_mapping>
  <registration_vnic_profile_mapping>
    <from>
      <name>silver</name>
      <network>
        <name>blue</name>
      </network>
    </from>
    <to>
      <name>copper</name>
      <network>
        <name>orange</name>
      </network>
    </to>
  </registration_vnic_profile_mapping>
  <registration_vnic_profile_mapping>
    <from>
      <name>platinum</name>
      <network>
        <name>yellow</name>
      </network>
    </from>
    <to>
      <name></name>
      <network>
        <name></name>
      </network>
    </to>
  </registration_vnic_profile_mapping>
  <registration_vnic_profile_mapping>
    <from>
      <name>bronze</name>
      <network>
        <name>green</name>
      </network>
    </from>
  </registration_vnic_profile_mapping>
</vnic_profile_mappings>

Expand

Table 7.291. Links summary
Name	Type	Summary
`from`	VnicProfile	References to the external network and the external network profile.
`to`	VnicProfile	Reference to to an existing virtual NIC profile.

7.221.1. from
リンクのコピー

References to the external network and the external network profile. Both should be specified using their name.

7.221.2. to
リンクのコピー

Reference to to an existing virtual NIC profile. It should be specified using its name or id. Either name or id should be specified but not both.

7.222. ReportedConfiguration struct
リンクのコピー

Expand

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

7.223. ReportedDevice struct
リンクのコピー

Expand

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

Expand

Table 7.294. Links summary
Name	Type	Summary
`vm`	Vm

7.224. ReportedDeviceType enum
リンクのコピー

Expand

Table 7.295. Values summary
Name	Summary
`network`

7.225. ResolutionType enum
リンクのコピー

Expand

Table 7.296. Values summary
Name	Summary
`add`
`copy`

7.226. RngDevice struct
リンクのコピー

Random number generator (RNG) device model.

Expand

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

7.227. RngSource enum
リンクのコピー

Representing the random generator backend types.

Expand

Table 7.298. 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.
`urandom`	Obtains random data from the `/dev/urandom` device.

7.227.1. urandom
リンクのコピー

Obtains random data from the /dev/urandom device.

This RNG source is meant to replace random RNG source for non-cluster-aware entities (i.e. Blank template and instance types) and entities associated with clusters with compatibility version 4.1 or higher.

7.228. Role struct
リンクのコピー

Represents a system role.

Expand

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

7.228.1. mutable
リンクのコピー

Defines the ability to update or delete the role.

Roles with mutable set to false are predefined roles.

Expand

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

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

Expand

Table 7.301. Values summary
Name	Summary
`admin`	Administrative role.
`user`	User role.

7.230. SchedulingPolicy struct
リンクのコピー

Expand

Table 7.302. 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[]

Expand

Table 7.303. Links summary
Name	Type	Summary
`balances`	Balance[]
`filters`	Filter[]
`weight`	Weight[]

7.231. SchedulingPolicyUnit struct
リンクのコピー

Expand

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

7.232. ScsiGenericIO enum
リンクのコピー

Expand

Table 7.305. Values summary
Name	Summary
`filtered`
`unfiltered`

7.233. SeLinux struct
リンクのコピー

Represents SELinux in the system.

Expand

Table 7.306. Attributes summary
Name	Type	Summary
`mode`	SeLinuxMode	SELinux current mode.

7.234. SeLinuxMode enum
リンクのコピー

Represents an SELinux enforcement mode.

Expand

Table 7.307. Values summary
Name	Summary
`disabled`	SELinux is disabled in the kernel.
`enforcing`	SELinux is running and enforcing permissions.
`permissive`	SELinux is running and logging but not enforcing permissions.

7.235. SerialNumber struct
リンクのコピー

Expand

Table 7.308. Attributes summary
Name	Type	Summary
`policy`	SerialNumberPolicy
`value`	String

7.236. SerialNumberPolicy enum
リンクのコピー

Expand

Table 7.309. Values summary
Name	Summary
`custom`
`host`
`vm`

7.237. Session struct
リンクのコピー

Describes a user session to a virtual machine.

Expand

Table 7.310. 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	The IP address the user is connected from.
`name`	String	A human-readable name in plain text.
`protocol`	String	The protocol used by the session.

7.237.1. console_user
リンクのコピー

Indicates if this is a console session.

The value will be true for console users (SPICE or VNC), and false for others (such as RDP or SSH).

7.237.2. ip
リンクのコピー

The IP address the user is connected from.

Currently only available for console users.

7.237.3. protocol
リンクのコピー

The protocol used by the session.

Currently not used. Intended for info about how the user is connected: through SPICE, VNC, SSH, or RDP.

Expand

Table 7.311. Links summary
Name	Type	Summary
`user`	User	The user related to this session.
`vm`	Vm	A link to the virtual machine related to this session.

7.237.4. user
リンクのコピー

The user related to this session.

If the user is a console user, this is a link to the real Red Hat Virtualization user. Otherwise, only the user name is provided.

7.238. SkipIfConnectivityBroken struct
リンクのコピー

Expand

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

7.238.1. enabled
リンクのコピー

If enabled, we will not fence a host in case more than a configurable percentage of hosts in the cluster lost connectivity as well. This comes to prevent fencing storm in cases where there is a global networking issue in the cluster.

7.238.2. threshold
リンクのコピー

Threshold for connectivity testing. If at least the threshold percentage of hosts in the cluster lost connectivity then fencing will not take place.

7.239. SkipIfSdActive struct
リンクのコピー

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

Expand

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

7.239.1. enabled
リンクのコピー

If enabled, we will skip fencing in case the host maintains its lease in the storage. It means that if the host still has storage access then it won’t get fenced.

7.240. Snapshot struct
リンクのコピー

Represents a snapshot object.

Example XML representation:

<snapshot id="456" href="/ovirt-engine/api/vms/123/snapshots/456">
  <actions>
    <link rel="restore" href="/ovirt-engine/api/vms/123/snapshots/456/restore"/>
  </actions>
  <vm id="123" href="/ovirt-engine/api/vms/123"/>
  <description>Virtual Machine 1 - Snapshot A</description>
  <type>active</type>
  <date>2010-08-16T14:24:29</date>
  <persist_memorystate>false</persist_memorystate>
</snapshot>

Expand

Table 7.314. 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	The date when this snapshot has been created.
`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).
`has_illegal_images`	Boolean	Indicates whether the virtual machine has snapshots with disks in `ILLEGAL` state.
`high_availability`	HighAvailability	The virtual machine high availability configuration.
`id`	String	A unique identifier.
`initialization`	Initialization	Reference to the virtual machine’s initialization configuration.
`io`	Io	For performance tuning of IO threading.
`large_icon`	Icon	Virtual machine’s large icon.
`lease`	StorageDomainLease	Reference to the storage domain this virtual machine/template lease reside on.
`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.
`multi_queues_enabled`	Boolean	If `true`, each virtual interface will get the optimal number of queues, depending on the available virtual Cpus.
`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	Indicates if the content of the memory of the virtual machine is included in the snapshot.
`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	Status of the snapshot.
`snapshot_type`	SnapshotType	Type of the snapshot.
`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.
`storage_error_resume_behaviour`	VmStorageErrorResumeBehaviour	Determines how the virtual machine will be resumed after storage error.
`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.

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

7.240.2. custom_compatibility_version
リンクのコピー

Virtual machine custom compatibility version.

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

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

7.240.3. high_availability
リンクのコピー

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

7.240.4. initialization
リンクのコピー

Reference to the virtual machine’s initialization configuration.

Note

Since Red Hat Virtualization 4.1.8 this property can be cleared by sending an empty tag.

For example, to clear the initialization attribute send a request like this:

PUT /ovirt-engine/api/vms/123

With a request body like this:

<vm>
  <initialization/>
</vm>

The response to such a request, and requests with the header All-Content: true will still contain this attribute.

7.240.5. large_icon
リンクのコピー

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

7.240.6. lease
リンクのコピー

Reference to the storage domain this virtual machine/template lease reside on.

A virtual machine running with a lease requires checking while running that the lease is not taken by another host, preventing another instance of this virtual machine from running on another host. This provides protection against split-brain in highly available virtual machines. A template can also have a storage domain defined for a lease in order to have the virtual machines created from this template to be preconfigured with this storage domain as the location of the leases.

7.240.7. memory
リンクのコピー

The virtual machine’s memory, in bytes.

For example, to update a virtual machine to contain 1 Gibibyte (GiB) of memory, send the following request:

PUT /ovirt-engine/api/vms/123

With the following request body:

<vm>
  <memory>1073741824</memory>
</vm>

Memory hot plug is supported from Red Hat Virtualization 3.6 onwards. You can use the example above to increase memory while the virtual machine is in state up. The size increment must be dividable by the value of the HotPlugMemoryBlockSizeMb configuration value (256 MiB by default). If the memory size increment is not dividable by this value, the memory size change is only stored to next run configuration. Each successful memory hot plug operation creates one or two new memory devices.

Memory hot unplug is supported since Red Hat Virtualization 4.2 onwards. Memory hot unplug can only be performed when the virtual machine is in state up. Only previously hot plugged memory devices can be removed by the hot unplug operation. The requested memory decrement is rounded down to match sizes of a combination of previously hot plugged memory devices. The requested memory value is stored to next run configuration without rounding.

Note

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

Note

Red Hat Virtualization Manager internally rounds values down to whole MiBs (1MiB = 2²⁰ bytes)

7.240.8. migration_downtime
リンクのコピー

Maximum time the virtual machine can be non responsive during its live migration to another host in ms.

Set either explicitly for the virtual machine or by engine-config -s DefaultMaximumMigrationDowntime=[value]

7.240.9. next_run_configuration_exists
リンクのコピー

Virtual machine configuration has been changed and requires restart of the virtual machine. Changed configuration is applied at processing the virtual machine’s shut down.

7.240.10. origin
リンクのコピー

The origin of this virtual machine.

Possible values:

ovirt
rhev
vmware
xen
external
hosted_engine
managed_hosted_engine
kvm
physical_machine
hyperv

7.240.11. persist_memorystate
リンクのコピー

Indicates if the content of the memory of the virtual machine is included in the snapshot.

When a snapshot is created the default value is true.

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

7.240.13. small_icon
リンクのコピー

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

7.240.14. sso
リンクのコピー

Reference to the Single Sign On configuration this virtual machine is configured for. The user can be automatically signed in the virtual machine’s operating system when console is opened.

7.240.15. stop_reason
リンクのコピー

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

Expand

Table 7.315. 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.
`original_template`	Template	References the original template used to create the 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	The virtual machine this snapshot has been taken for.
`vm_pool`	VmPool	Reference to the pool the virtual machine is optionally member of.
`watchdogs`	Watchdog[]	Refers to the Watchdog configuration.

7.240.16. affinity_labels
リンクのコピー

Optional. Used for labeling of sub-clusters.

7.240.17. katello_errata
リンクのコピー

Lists all the Katello errata assigned to the virtual machine.

GET /ovirt-engine/api/vms/123/katelloerrata

You will receive response in XML like this one:

<katello_errata>
  <katello_erratum href="/ovirt-engine/api/katelloerrata/456" id="456">
    <name>RHBA-2013:XYZ</name>
    <description>The description of the erratum</description>
    <title>some bug fix update</title>
    <type>bugfix</type>
    <issued>2013-11-20T02:00:00.000+02:00</issued>
    <solution>Few guidelines regarding the solution</solution>
    <summary>Updated packages that fix one bug are now available for XYZ</summary>
    <packages>
      <package>
        <name>libipa_hbac-1.9.2-82.11.el6_4.i686</name>
      </package>
      ...
    </packages>
  </katello_erratum>
  ...
</katello_errata>

7.240.18. original_template
リンクのコピー

References the original template used to create the virtual machine.

If the virtual machine is cloned from a template or another virtual machine, the template links to the Blank template, and the original_template is used to track history.

Otherwise the template and original_template are the same.

7.240.19. statistics
リンクのコピー

Statistics data collected from this virtual machine.

Note that some statistics, notably memory.buffered and memory.cached are available only when oVirt guest agent is installed in the virtual machine.

7.241. SnapshotStatus enum
リンクのコピー

Represents the current status of the snapshot.

Expand

Table 7.316. Values summary
Name	Summary
`in_preview`	The snapshot is being previewed.
`locked`	The snapshot is locked.
`ok`	The snapshot is OK.

7.241.1. locked
リンクのコピー

The snapshot is locked.

The snapshot is locked when it is in process of being created, deleted, restored or previewed.

7.242. SnapshotType enum
リンクのコピー

Represents the type of the snapshot.

Expand

Table 7.317. Values summary
Name	Summary
`active`	Reference to the current configuration of the virtual machines.
`preview`	The `active` snapshot will become `preview` if some snapshot is being previewed.
`regular`	Snapshot created by user.
`stateless`	Snapshot created internally for stateless virtual machines.

7.242.1. preview
リンクのコピー

The active snapshot will become preview if some snapshot is being previewed.

In other words, this is the active snapshot before preview.

7.242.2. stateless
リンクのコピー

Snapshot created internally for stateless virtual machines.

This snapshot is created when the virtual machine is started and it is restored when the virtual machine is shut down.

7.243. SpecialObjects struct
リンクのコピー

This type contains references to special objects, such as blank templates and the root of a hierarchy of tags.

Expand

Table 7.318. Links summary
Name	Type	Summary
`blank_template`	Template	A reference to a blank template.
`root_tag`	Tag	A reference to the root of a hierarchy of tags.

7.244. Spm struct
リンクのコピー

Expand

Table 7.319. Attributes summary
Name	Type	Summary
`priority`	Integer
`status`	SpmStatus

7.245. SpmStatus enum
リンクのコピー

Expand

Table 7.320. Values summary
Name	Summary
`contending`
`none`
`spm`

7.246. Ssh struct
リンクのコピー

Expand

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

7.247. SshAuthenticationMethod enum
リンクのコピー

Expand

Table 7.322. Values summary
Name	Summary
`password`
`publickey`

7.248. SshPublicKey struct
リンクのコピー

Expand

Table 7.323. Attributes summary
Name	Type	Summary
`comment`	String	Free text containing comments about this object.
`content`	String	Contains a saved SSH key.
`description`	String	A human-readable description in plain text.
`id`	String	A unique identifier.
`name`	String	A human-readable name in plain text.

Expand

Table 7.324. Links summary
Name	Type	Summary
`user`	User

7.249. Sso struct
リンクのコピー

Expand

Table 7.325. Attributes summary
Name	Type	Summary
`methods`	Method[]

7.250. SsoMethod enum
リンクのコピー

Expand

Table 7.326. Values summary
Name	Summary
`guest_agent`

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

Expand

Table 7.327. 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`.

Expand

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

7.252. StatisticKind enum
リンクのコピー

Expand

Table 7.329. Values summary
Name	Summary
`counter`
`gauge`

7.253. StatisticUnit enum
リンクのコピー

Expand

Table 7.330. Values summary
Name	Summary
`bits_per_second`
`bytes`
`bytes_per_second`
`count_per_second`
`none`
`percent`
`seconds`

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

Expand

Table 7.331. 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.
`progress`	Integer	The step progress (if reported) in percentages.
`start_time`	Date	The start time of the step.
`status`	StepStatus	The status of the step.
`type`	StepEnum	The type of the step.

7.254.1. external
リンクのコピー

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

Expand

Table 7.332. Links summary
Name	Type	Summary
`execution_host`	Host	The host used for the step execution (optional).
`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[]

7.255. StepEnum enum
リンクのコピー

Type representing a step type.

Expand

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

7.255.1. executing
リンクのコピー

The executing step type. Used to track the main execution block of the job. Usually it will be a parent step of several sub-steps which describe portions of the execution step.

7.255.2. finalizing
リンクのコピー

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

7.255.3. rebalancing_volume
リンクのコピー

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

7.255.4. removing_bricks
リンクのコピー

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

7.255.5. unknown
リンクのコピー

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

7.255.6. validating
リンクのコピー

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

7.256. StepStatus enum
リンクのコピー

Represents the status of the step.

Expand

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

7.256.1. aborted
リンクのコピー

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

7.256.2. finished
リンクのコピー

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

7.256.3. started
リンクのコピー

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

7.256.4. unknown
リンクのコピー

The unknown step status. This status represents steps which their resolution is not known, i.e. steps that were executed before the system was unexpectedly restarted.

7.257. StorageConnection struct
リンクのコピー

Represents a storage server connection.

Example XML representation:

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

Expand

Table 7.335. Attributes summary
Name	Type	Summary
`address`	String	A storage server connection’s address.
`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	The mount options of an NFS storage server connection.
`name`	String	A human-readable name in plain text.
`nfs_retrans`	Integer	The NFS retrans value of an NFS storage server connection.
`nfs_timeo`	Integer	The NFS timeo value of an NFS storage server connection.
`nfs_version`	NfsVersion	The NFS version of an NFS storage server connection.
`password`	String	The password of an iSCSI storage server connection.
`path`	String	The path of an NFS storage server connection.
`port`	Integer	The port of an iSCSI storage server connection.
`portal`	String	The portal of an iSCSI storage server connection.
`target`	String	The target of an iSCSI storage server connection.
`type`	StorageType	A storage server connection’s type.
`username`	String	The user name of an iSCSI storage server connection.
`vfs_type`	String	The VFS type of an NFS storage server connection.

Expand

Table 7.336. Links summary
Name	Type	Summary
`gluster_volume`	GlusterVolume	Link to the gluster volume, used by that storage domain.
`host`	Host

7.258. StorageConnectionExtension struct
リンクのコピー

Expand

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

Expand

Table 7.338. Links summary
Name	Type	Summary
`host`	Host

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

Expand

Table 7.339. Attributes summary
Name	Type	Summary
`available`	Integer
`backup`	Boolean	This attribute indicates whether a data storage domain is used as backup domain or not.
`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.
`discard_after_delete`	Boolean	Indicates whether disks' blocks on block storage domains will be discarded right before they are deleted.
`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
`supports_discard`	Boolean	Indicates whether a block storage domain supports discard operations.
`supports_discard_zeroes_data`	Boolean	Indicates whether a block storage domain supports the property that discard zeroes the data.
`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.

7.259.1. backup
リンクのコピー

This attribute indicates whether a data storage domain is used as backup domain or not. If the domain is set to backup then it will be used to store virtual machines and templates for disaster recovery purposes in the same way we use export storage domain. This attribute is only available with data storage domain and not with ISO domain or export storage domain. User can use this functionality while creating a data storage domain or importing a data storage domain.

7.259.2. discard_after_delete
リンクのコピー

Indicates whether disks' blocks on block storage domains will be discarded right before they are deleted.

If true, and a disk on this storage domain has its wipe_after_delete value enabled, then when the disk is deleted:

It is first wiped.
Then its blocks are discarded.
Finally it is deleted.

Note that:

Discard after delete will always be false for non block storage types.
Discard after delete can be set to true only if the storage domain supports discard.

7.259.3. supports_discard
リンクのコピー

Indicates whether a block storage domain supports discard operations. A storage domain only supports discard if all of the logical units that it is built from support discard; that is, if each logical unit’s discard_max_size value is greater than 0. This is one of the conditions necessary for a virtual disk in this storage domain to have its pass_discard attribute enabled.

7.259.4. supports_discard_zeroes_data
リンクのコピー

Indicates whether a block storage domain supports the property that discard zeroes the data. A storage domain only supports the property that discard zeroes the data if all of the logical units that it is built from support it; that is, if each logical unit’s discard_zeroes_data value is true.

Important

Since version 4.2.1 of the system, the support for this attribute has been removed as the sysfs file, discard_zeroes_data, was deprecated in the kernel. It is preserved for backwards compatibility, but the value will always be false.

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

Expand

Table 7.340. Links summary
Name	Type	Summary
`data_center`	DataCenter	A link to the data center that the storage domain is attached to.
`data_centers`	DataCenter[]	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[]

7.259.6. data_center
リンクのコピー

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

7.260. StorageDomainLease struct
リンクのコピー

Represents a lease residing on a storage domain.

A lease is a Sanlock resource residing on a special volume on the storage domain, this Sanlock resource is used to provide storage base locking.

Expand

Table 7.341. Links summary
Name	Type	Summary
`storage_domain`	StorageDomain	Reference to the storage domain on which the lock resides on.

7.261. StorageDomainStatus enum
リンクのコピー

Expand

Table 7.342. Values summary
Name	Summary
`activating`
`active`
`detaching`
`inactive`
`locked`
`maintenance`
`mixed`
`preparing_for_maintenance`
`unattached`
`unknown`

7.262. StorageDomainType enum
リンクのコピー

Indicates the kind of data managed by a storage domain.

Expand

Table 7.343. Values summary
Name	Summary
`data`	Data domains are used to store the disks and snapshots of the virtual machines and templates in the system.
`export`	Export domains are temporary storage repositories used to copy and move virtual machines and templates between data centers and Red Hat Virtualization environments.
`image`	Image domain store images that can be imported into from an external system.
`iso`	ISO domains store ISO files (or logical CDs) used to install and boot operating systems and applications for the virtual machines.
`volume`	Volume domains store logical volumes that can be used as disks for virtual machines.

7.262.1. data
リンクのコピー

Data domains are used to store the disks and snapshots of the virtual machines and templates in the system. In addition, snapshots of the disks are also stored in data domains. Data domains cannot be shared across data centers.

7.262.2. export
リンクのコピー

Export domains are temporary storage repositories used to copy and move virtual machines and templates between data centers and Red Hat Virtualization environments. Export domains can also be used to backup virtual machines. An export domain can be moved between data centers but it can only be active in one data center at a time.

7.262.3. image
リンクのコピー

Image domain store images that can be imported into from an external system. For example, images from an OpenStack Glance image repository.

7.262.4. iso
リンクのコピー

ISO domains store ISO files (or logical CDs) used to install and boot operating systems and applications for the virtual machines. ISO domains remove the data center’s need for physical media. An ISO domain can be shared across different data centers.

7.262.5. volume
リンクのコピー

Volume domains store logical volumes that can be used as disks for virtual machines. For example, volumes from an OpenStack Cincer block storage service.

7.263. StorageFormat enum
リンクのコピー

Type which represents a format of storage domain.

Expand

Table 7.344. Values summary
Name	Summary
`v1`	Version 1 of the storage domain format is applicable to NFS, iSCSI and FC storage domains.
`v2`	Version 2 of the storage domain format is applicable to iSCSI and FC storage domains.
`v3`	Version 3 of the storage domain format is applicable to NFS, POSIX, iSCSI and FC storage domains.
`v4`	Version 4 of the storage domain format.

7.263.1. v1
リンクのコピー

Version 1 of the storage domain format is applicable to NFS, iSCSI and FC storage domains.

Each storage domain contains metadata describing its own structure, and all of the names of physical volumes that are used to back virtual machine disk images. Master domains additionally contain metadata for all the domains and physical volume names in the storage pool. The total size of this metadata is limited to 2 KiB, limiting the number of storage domains that can be in a pool. Template and virtual machine base images are read only.

7.263.2. v2
リンクのコピー

Version 2 of the storage domain format is applicable to iSCSI and FC storage domains.

All storage domain and pool metadata is stored as logical volume tags rather than written to a logical volume. Metadata about virtual machine disk volumes is still stored in a logical volume on the domains. Physical volume names are no longer included in the metadata. Template and virtual machine base images are read only.

7.263.3. v3
リンクのコピー

Version 3 of the storage domain format is applicable to NFS, POSIX, iSCSI and FC storage domains.

All storage domain and pool metadata is stored as logical volume tags rather than written to a logical volume. Metadata about virtual machine disk volumes is still stored in a logical volume on the domains. Virtual machine and template base images are no longer read only. This change enables live snapshots, live storage migration, and clone from snapshot. Support for Unicode metadata is added, for non-English volume names.

7.264. StorageType enum
リンクのコピー

Type representing a storage domain type.

Expand

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

7.264.1. cinder
リンクのコピー

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

7.264.2. glance
リンクのコピー

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

7.264.3. glusterfs
リンクのコピー

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

7.265. SwitchType enum
リンクのコピー

Describes all switch types supported by the Manager.

Expand

Table 7.346. Values summary
Name	Summary
`legacy`	The native switch type.
`ovs`	The Open vSwitch type.

7.266. SystemOption struct
リンクのコピー

Type representing a configuration option of the system.

Expand

Table 7.347. 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.
`values`	SystemOptionValue[]	Values of the option for various system versions.

7.267. SystemOptionValue struct
リンクのコピー

Type representing a pair of value and version of a configuration option.

Expand

Table 7.348. Attributes summary
Name	Type	Summary
`value`	String	Configuration option’s value for specific version.
`version`	String	Configuration option’s version.

7.268. Tag struct
リンクのコピー

Represents a tag in the system.

Expand

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

Expand

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

7.269. Template struct
リンクのコピー

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

Expand

Table 7.351. 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 the virtual machine’s initialization configuration.
`io`	Io	For performance tuning of IO threading.
`large_icon`	Icon	Virtual machine’s large icon.
`lease`	StorageDomainLease	Reference to the storage domain this virtual machine/template lease reside on.
`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.
`multi_queues_enabled`	Boolean	If `true`, each virtual interface will get the optimal number of queues, depending on the available virtual Cpus.
`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.
`placement_policy`	VmPlacementPolicy	The configuration of the virtual machine’s placement policy.
`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.
`storage_error_resume_behaviour`	VmStorageErrorResumeBehaviour	Determines how the virtual machine will be resumed after storage error.
`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.

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

7.269.2. custom_compatibility_version
リンクのコピー

Virtual machine custom compatibility version.

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

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

7.269.3. high_availability
リンクのコピー

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

7.269.4. initialization
リンクのコピー

Reference to the virtual machine’s initialization configuration.

Note

Since Red Hat Virtualization 4.1.8 this property can be cleared by sending an empty tag.

For example, to clear the initialization attribute send a request like this:

PUT /ovirt-engine/api/vms/123

With a request body like this:

<vm>
  <initialization/>
</vm>

The response to such a request, and requests with the header All-Content: true will still contain this attribute.

7.269.5. large_icon
リンクのコピー

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

7.269.6. lease
リンクのコピー

Reference to the storage domain this virtual machine/template lease reside on.

A virtual machine running with a lease requires checking while running that the lease is not taken by another host, preventing another instance of this virtual machine from running on another host. This provides protection against split-brain in highly available virtual machines. A template can also have a storage domain defined for a lease in order to have the virtual machines created from this template to be preconfigured with this storage domain as the location of the leases.

7.269.7. memory
リンクのコピー

The virtual machine’s memory, in bytes.

For example, to update a virtual machine to contain 1 Gibibyte (GiB) of memory, send the following request:

PUT /ovirt-engine/api/vms/123

With the following request body:

<vm>
  <memory>1073741824</memory>
</vm>

Memory hot plug is supported from Red Hat Virtualization 3.6 onwards. You can use the example above to increase memory while the virtual machine is in state up. The size increment must be dividable by the value of the HotPlugMemoryBlockSizeMb configuration value (256 MiB by default). If the memory size increment is not dividable by this value, the memory size change is only stored to next run configuration. Each successful memory hot plug operation creates one or two new memory devices.

Memory hot unplug is supported since Red Hat Virtualization 4.2 onwards. Memory hot unplug can only be performed when the virtual machine is in state up. Only previously hot plugged memory devices can be removed by the hot unplug operation. The requested memory decrement is rounded down to match sizes of a combination of previously hot plugged memory devices. The requested memory value is stored to next run configuration without rounding.

Note

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

Note

Red Hat Virtualization Manager internally rounds values down to whole MiBs (1MiB = 2²⁰ bytes)

7.269.8. migration_downtime
リンクのコピー

Maximum time the virtual machine can be non responsive during its live migration to another host in ms.

Set either explicitly for the virtual machine or by engine-config -s DefaultMaximumMigrationDowntime=[value]

7.269.9. origin
リンクのコピー

The origin of this virtual machine.

Possible values:

ovirt
rhev
vmware
xen
external
hosted_engine
managed_hosted_engine
kvm
physical_machine
hyperv

7.269.10. placement_policy
リンクのコピー

The configuration of the virtual machine’s placement policy.

This configuration can be updated to pin a virtual machine to one or more hosts.

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>

7.269.11. small_icon
リンクのコピー

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

7.269.12. sso
リンクのコピー

Reference to the Single Sign On configuration this virtual machine is configured for. The user can be automatically signed in the virtual machine’s operating system when console is opened.

Expand

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

7.270. TemplateStatus enum
リンクのコピー

Type representing a status of a virtual machine template.

Expand

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

7.271. TemplateVersion struct
リンクのコピー

Type representing a version of a virtual machine template.

Expand

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

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

Expand

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

7.272. Ticket struct
リンクのコピー

Type representing a ticket that allows virtual machine access.

Expand

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

7.273. TimeZone struct
リンクのコピー

Time zone representation.

Expand

Table 7.357. Attributes summary
Name	Type	Summary
`name`	String	Name of the time zone.
`utc_offset`	String	Offset from UTC.

7.273.1. utc_offset
リンクのコピー

Offset from UTC.

7.274. TransparentHugePages struct
リンクのコピー

Type representing a transparent huge pages (THP) support.

Expand

Table 7.358. Attributes summary
Name	Type	Summary
`enabled`	Boolean	Enable THP support.

7.275. TransportType enum
リンクのコピー

Protocol used to access a Gluster volume.

Expand

Table 7.359. Values summary
Name	Summary
`rdma`	Remote direct memory access.
`tcp`	TCP.

7.276. UnmanagedNetwork struct
リンクのコピー

Expand

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

Expand

Table 7.361. Links summary
Name	Type	Summary
`host`	Host
`host_nic`	HostNic

7.277. Usb struct
リンクのコピー

Configuration of the USB device of a virtual machine.

Expand

Table 7.362. Attributes summary
Name	Type	Summary
`enabled`	Boolean	Determines whether the USB device should be included or not.
`type`	UsbType	USB type, currently only `native` is supported.

7.278. UsbType enum
リンクのコピー

Type of USB device redirection.

Expand

Table 7.363. Values summary
Name	Summary
`legacy`	Legacy USB redirection.
`native`	Native USB redirection.

7.278.1. legacy
リンクのコピー

Legacy USB redirection.

This USB type has been deprecated since version 3.6 of the engine, and has been completely removed in version 4.1. It is preserved only to avoid syntax errors in existing scripts. If it is used it will be automatically replaced by native.

7.278.2. native
リンクのコピー

Native USB redirection.

Native USB redirection allows KVM/SPICE USB redirection for Linux and Windows virtual machines. Virtual (guest) machines require no guest-installed agents or drivers for native USB. On Linux clients, all packages required for USB redirection are provided by the virt-viewer package. On Windows clients, you must also install the usbdk package.

7.279. User struct
リンクのコピー

Represents a user in the system.

Expand

Table 7.364. 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 the user resides.
`password`	String
`principal`	String	Similar to `user_name`.
`user_name`	String	The user’s username.

7.279.1. namespace
リンクのコピー

Namespace where the user resides. When using the authorization provider that stores users in the LDAP server, this attribute equals the naming context of the LDAP server. See https://github.com/oVirt/ovirt-engine-extension-aaa-ldap for more information. When using the built-in authorization provider that stores users in the database this attribute is ignored. See https://github.com/oVirt/ovirt-engine-extension-aaa-jdbc for more information.

7.279.2. principal
リンクのコピー

Similar to user_name. The format depends on the LDAP provider. With most LDAP providers it is the value of the uid LDAP attribute. In the case of Active Directory it is the User Principal Name (UPN).

7.279.3. user_name
リンクのコピー

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

Expand

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

7.280. Value struct
リンクのコピー

Expand

Table 7.366. Attributes summary
Name	Type	Summary
`datum`	Decimal
`detail`	String

7.281. ValueType enum
リンクのコピー

Expand

Table 7.367. Values summary
Name	Summary
`decimal`
`integer`
`string`

7.282. VcpuPin struct
リンクのコピー

Expand

Table 7.368. Attributes summary
Name	Type	Summary
`cpu_set`	String
`vcpu`	Integer

7.283. Vendor struct
リンクのコピー

Expand

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

7.284. Version struct
リンクのコピー

Expand

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

7.285. VirtioScsi struct
リンクのコピー

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

Expand

Table 7.371. Attributes summary
Name	Type	Summary
`enabled`	Boolean	Enable Virtio SCSI support.

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

Expand

Table 7.372. 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[]

Expand

Table 7.373. Links summary
Name	Type	Summary
`host`	Host
`statistics`	Statistic[]	Each host NUMA node resource exposes a statistics sub-collection for host NUMA node specific statistics.
`vm`	Vm

7.286.1. statistics
リンクのコピー

Each host NUMA node resource exposes a statistics sub-collection for host NUMA node specific statistics.

An example of an XML representation:

<statistics>
  <statistic href="/ovirt-engine/api/hosts/123/numanodes/456/statistics/789" id="789">
    <name>memory.total</name>
    <description>Total memory</description>
    <kind>gauge</kind>
    <type>integer</type>
    <unit>bytes</unit>
    <values>
      <value>
        <datum>25165824000</datum>
      </value>
    </values>
    <host_numa_node href="/ovirt-engine/api/hosts/123/numanodes/456" id="456" />
  </statistic>
    ...
</statistics>

Note

This statistics sub-collection is read-only.

The following list shows the statistic types for a host NUMA node:

Expand

Name	Description
`memory.total`	Total memory in bytes on the NUMA node.
`memory.used`	Memory in bytes used on the NUMA node.
`memory.free`	Memory in bytes free on the NUMA node.
`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.

7.287. Vlan struct
リンクのコピー

Type representing a Virtual LAN (VLAN) type.

Expand

Table 7.374. Attributes summary
Name	Type	Summary
`id`	Integer	Virtual LAN ID.

7.288. Vm struct
リンクのコピー

Represents a virtual machine.

Expand

Table 7.375. 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).
`has_illegal_images`	Boolean	Indicates whether the virtual machine has snapshots with disks in `ILLEGAL` state.
`high_availability`	HighAvailability	The virtual machine high availability configuration.
`id`	String	A unique identifier.
`initialization`	Initialization	Reference to the virtual machine’s initialization configuration.
`io`	Io	For performance tuning of IO threading.
`large_icon`	Icon	Virtual machine’s large icon.
`lease`	StorageDomainLease	Reference to the storage domain this virtual machine/template lease reside on.
`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.
`multi_queues_enabled`	Boolean	If `true`, each virtual interface will get the optimal number of queues, depending on the available virtual Cpus.
`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.
`storage_error_resume_behaviour`	VmStorageErrorResumeBehaviour	Determines how the virtual machine will be resumed after storage error.
`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.

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

7.288.2. custom_compatibility_version
リンクのコピー

Virtual machine custom compatibility version.

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

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

7.288.3. high_availability
リンクのコピー

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

7.288.4. initialization
リンクのコピー

Reference to the virtual machine’s initialization configuration.

Note

Since Red Hat Virtualization 4.1.8 this property can be cleared by sending an empty tag.

For example, to clear the initialization attribute send a request like this:

PUT /ovirt-engine/api/vms/123

With a request body like this:

<vm>
  <initialization/>
</vm>

The response to such a request, and requests with the header All-Content: true will still contain this attribute.

7.288.5. large_icon
リンクのコピー

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

7.288.6. lease
リンクのコピー

Reference to the storage domain this virtual machine/template lease reside on.

A virtual machine running with a lease requires checking while running that the lease is not taken by another host, preventing another instance of this virtual machine from running on another host. This provides protection against split-brain in highly available virtual machines. A template can also have a storage domain defined for a lease in order to have the virtual machines created from this template to be preconfigured with this storage domain as the location of the leases.

7.288.7. memory
リンクのコピー

The virtual machine’s memory, in bytes.

For example, to update a virtual machine to contain 1 Gibibyte (GiB) of memory, send the following request:

PUT /ovirt-engine/api/vms/123

With the following request body:

<vm>
  <memory>1073741824</memory>
</vm>

Memory hot plug is supported from Red Hat Virtualization 3.6 onwards. You can use the example above to increase memory while the virtual machine is in state up. The size increment must be dividable by the value of the HotPlugMemoryBlockSizeMb configuration value (256 MiB by default). If the memory size increment is not dividable by this value, the memory size change is only stored to next run configuration. Each successful memory hot plug operation creates one or two new memory devices.

Memory hot unplug is supported since Red Hat Virtualization 4.2 onwards. Memory hot unplug can only be performed when the virtual machine is in state up. Only previously hot plugged memory devices can be removed by the hot unplug operation. The requested memory decrement is rounded down to match sizes of a combination of previously hot plugged memory devices. The requested memory value is stored to next run configuration without rounding.

Note

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

Note

Red Hat Virtualization Manager internally rounds values down to whole MiBs (1MiB = 2²⁰ bytes)

7.288.8. migration_downtime
リンクのコピー

Maximum time the virtual machine can be non responsive during its live migration to another host in ms.

Set either explicitly for the virtual machine or by engine-config -s DefaultMaximumMigrationDowntime=[value]

7.288.9. next_run_configuration_exists
リンクのコピー

Virtual machine configuration has been changed and requires restart of the virtual machine. Changed configuration is applied at processing the virtual machine’s shut down.

7.288.10. origin
リンクのコピー

The origin of this virtual machine.

Possible values:

ovirt
rhev
vmware
xen
external
hosted_engine
managed_hosted_engine
kvm
physical_machine
hyperv

7.288.11. placement_policy
リンクのコピー

The configuration of the virtual machine’s placement policy.

This configuration can be updated to pin a virtual machine to one or more hosts.

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>

7.288.12. small_icon
リンクのコピー

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

7.288.13. sso
リンクのコピー

Reference to the Single Sign On configuration this virtual machine is configured for. The user can be automatically signed in the virtual machine’s operating system when console is opened.

7.288.14. stop_reason
リンクのコピー

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

Expand

Table 7.376. 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.
`original_template`	Template	References the original template used to create the 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.

7.288.15. affinity_labels
リンクのコピー

Optional. Used for labeling of sub-clusters.

7.288.16. katello_errata
リンクのコピー

Lists all the Katello errata assigned to the virtual machine.

GET /ovirt-engine/api/vms/123/katelloerrata

You will receive response in XML like this one:

<katello_errata>
  <katello_erratum href="/ovirt-engine/api/katelloerrata/456" id="456">
    <name>RHBA-2013:XYZ</name>
    <description>The description of the erratum</description>
    <title>some bug fix update</title>
    <type>bugfix</type>
    <issued>2013-11-20T02:00:00.000+02:00</issued>
    <solution>Few guidelines regarding the solution</solution>
    <summary>Updated packages that fix one bug are now available for XYZ</summary>
    <packages>
      <package>
        <name>libipa_hbac-1.9.2-82.11.el6_4.i686</name>
      </package>
      ...
    </packages>
  </katello_erratum>
  ...
</katello_errata>

7.288.17. original_template
リンクのコピー

References the original template used to create the virtual machine.

If the virtual machine is cloned from a template or another virtual machine, the template links to the Blank template, and the original_template is used to track history.

Otherwise the template and original_template are the same.

7.288.18. statistics
リンクのコピー

Statistics data collected from this virtual machine.

Note that some statistics, notably memory.buffered and memory.cached are available only when oVirt guest agent is installed in the virtual machine.

7.289. VmAffinity enum
リンクのコピー

Expand

Table 7.377. Values summary
Name	Summary
`migratable`
`pinned`
`user_migratable`

7.290. VmBase struct
リンクのコピー

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

Expand

Table 7.378. 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 the virtual machine’s initialization configuration.
`io`	Io	For performance tuning of IO threading.
`large_icon`	Icon	Virtual machine’s large icon.
`lease`	StorageDomainLease	Reference to the storage domain this virtual machine/template lease reside on.
`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.
`multi_queues_enabled`	Boolean	If `true`, each virtual interface will get the optimal number of queues, depending on the available virtual Cpus.
`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.
`placement_policy`	VmPlacementPolicy	The configuration of the virtual machine’s placement policy.
`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.
`storage_error_resume_behaviour`	VmStorageErrorResumeBehaviour	Determines how the virtual machine will be resumed after storage error.
`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.

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

7.290.2. custom_compatibility_version
リンクのコピー

Virtual machine custom compatibility version.

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

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

7.290.3. high_availability
リンクのコピー

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

7.290.4. initialization
リンクのコピー

Reference to the virtual machine’s initialization configuration.

Note

Since Red Hat Virtualization 4.1.8 this property can be cleared by sending an empty tag.

For example, to clear the initialization attribute send a request like this:

PUT /ovirt-engine/api/vms/123

With a request body like this:

<vm>
  <initialization/>
</vm>

The response to such a request, and requests with the header All-Content: true will still contain this attribute.

7.290.5. large_icon
リンクのコピー

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

7.290.6. lease
リンクのコピー

Reference to the storage domain this virtual machine/template lease reside on.

A virtual machine running with a lease requires checking while running that the lease is not taken by another host, preventing another instance of this virtual machine from running on another host. This provides protection against split-brain in highly available virtual machines. A template can also have a storage domain defined for a lease in order to have the virtual machines created from this template to be preconfigured with this storage domain as the location of the leases.

7.290.7. memory
リンクのコピー

The virtual machine’s memory, in bytes.

For example, to update a virtual machine to contain 1 Gibibyte (GiB) of memory, send the following request:

PUT /ovirt-engine/api/vms/123

With the following request body:

<vm>
  <memory>1073741824</memory>
</vm>

Memory hot plug is supported from Red Hat Virtualization 3.6 onwards. You can use the example above to increase memory while the virtual machine is in state up. The size increment must be dividable by the value of the HotPlugMemoryBlockSizeMb configuration value (256 MiB by default). If the memory size increment is not dividable by this value, the memory size change is only stored to next run configuration. Each successful memory hot plug operation creates one or two new memory devices.

Memory hot unplug is supported since Red Hat Virtualization 4.2 onwards. Memory hot unplug can only be performed when the virtual machine is in state up. Only previously hot plugged memory devices can be removed by the hot unplug operation. The requested memory decrement is rounded down to match sizes of a combination of previously hot plugged memory devices. The requested memory value is stored to next run configuration without rounding.

Note

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

Note

Red Hat Virtualization Manager internally rounds values down to whole MiBs (1MiB = 2²⁰ bytes)

7.290.8. migration_downtime
リンクのコピー

Maximum time the virtual machine can be non responsive during its live migration to another host in ms.

Set either explicitly for the virtual machine or by engine-config -s DefaultMaximumMigrationDowntime=[value]

7.290.9. origin
リンクのコピー

The origin of this virtual machine.

Possible values:

ovirt
rhev
vmware
xen
external
hosted_engine
managed_hosted_engine
kvm
physical_machine
hyperv

7.290.10. placement_policy
リンクのコピー

The configuration of the virtual machine’s placement policy.

This configuration can be updated to pin a virtual machine to one or more hosts.

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>

7.290.11. small_icon
リンクのコピー

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

7.290.12. sso
リンクのコピー

Reference to the Single Sign On configuration this virtual machine is configured for. The user can be automatically signed in the virtual machine’s operating system when console is opened.

Expand

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

7.291. VmDeviceType enum
リンクのコピー

Expand

Table 7.380. Values summary
Name	Summary
`cdrom`
`floppy`

7.292. VmPlacementPolicy struct
リンクのコピー

Expand

Table 7.381. Attributes summary
Name	Type	Summary
`affinity`	VmAffinity

Expand

Table 7.382. Links summary
Name	Type	Summary
`hosts`	Host[]

7.293. VmPool struct
リンクのコピー

Type represeting a virtual machines pool.

Expand

Table 7.383. Attributes summary
Name	Type	Summary
`auto_storage_select`	Boolean	Indicates if the pool should automatically distribute the disks of the virtual machines across the multiple storage domains where the template is copied.
`comment`	String	Free text containing comments about this object.
`description`	String	A human-readable description in plain text.
`display`	Display	The display settings configured for virtual machines in the pool.
`id`	String	A unique identifier.
`max_user_vms`	Integer	The maximum number of virtual machines in the pool that could be assigned to a particular user.
`name`	String	A human-readable name in plain text.
`prestarted_vms`	Integer	The system attempts to prestart the specified number of virtual machines from the pool.
`rng_device`	RngDevice	The random number generator device configured for virtual machines in the pool.
`size`	Integer	The number of virtual machines in the pool.
`soundcard_enabled`	Boolean	Indicates if sound card should be configured for virtual machines in the pool.
`stateful`	Boolean	Virtual machine pool’s stateful flag.
`type`	VmPoolType	The deallocation policy of virtual machines in the pool.
`use_latest_template_version`	Boolean	Indicates if virtual machines in the pool are updated to newer versions of the template the pool is based on.

7.293.1. auto_storage_select
リンクのコピー

Indicates if the pool should automatically distribute the disks of the virtual machines across the multiple storage domains where the template is copied.

When the template used by the pool is present in multiple storage domains, the disks of the virtual machines of the pool will be created in one of those storage domains. By default, or when the value of this attribute is false, that storage domain is selected when the pool is created, and all virtual machines will use the same. If this attribute is true, then, when a virtual machine is added to the pool, the storage domain that has more free space is selected.

7.293.2. prestarted_vms
リンクのコピー

The system attempts to prestart the specified number of virtual machines from the pool.

These virtual machines are started without being attached to any user. That way, users can acquire virtual machines from the pool faster.

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

Expand

Table 7.384. Links summary
Name	Type	Summary
`cluster`	Cluster	Reference to the cluster the pool resides in.
`instance_type`	InstanceType	Reference to the instance type on which this pool is based.
`permissions`	Permission[]	Permissions set for this virtual machine pool.
`template`	Template	Reference to the template the pool is based on.
`vm`	Vm	Reference to an arbitrary virtual machine that is part of the pool.

7.293.4. instance_type
リンクのコピー

Reference to the instance type on which this pool is based. It can be set only on pool creation and cannot be edited.

7.293.5. vm
リンクのコピー

Reference to an arbitrary virtual machine that is part of the pool.

Note that this virtual machine may not be based to the latest version of the pool’s template.

7.294. VmPoolType enum
リンクのコピー

Type represeting the deallocation policy of virtual machines in a virtual machines pool.

Expand

Table 7.385. Values summary
Name	Summary
`automatic`	This policy indicates that virtual machines in the pool are automcatically deallocated by the system.
`manual`	This policy indicates that virtual machines in the pool are deallocated manually by the administrator.

7.294.1. automatic
リンクのコピー

This policy indicates that virtual machines in the pool are automcatically deallocated by the system.

With this policy, when a virtual machine that is part of the pool and is assigned to a user is shut-down, it is detached from the user, its state is restored to the pool’s default state, and the virtual machine returns to pool (i.e., the virtual machine can then be assigned to another user).

7.294.2. manual
リンクのコピー

This policy indicates that virtual machines in the pool are deallocated manually by the administrator.

With this policy, a virtual machine that is part of the pool remains assigned to its user and preserves its state on shut-down. In order to return the virtual machine back to the pool, the administrator needs to deallocate it explicitly by removing the user’s permissions on that virtual machine.

7.295. VmStatus enum
リンクのコピー

Type represeting a status of a virtual machine.

Expand

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

7.295.1. paused
リンクのコピー

This status indicates that the virtual machine process is running and the virtual machine is paused. This may happen in two cases: when running a virtual machine is paused mode and when the virtual machine is being automatically paused due to an error.

7.295.2. powering_up
リンクのコピー

This status indicates that the virtual machine process is running and the guest operating system is being loaded. Note that if no guest-agent is installed, this status is set for a predefined period of time, that is by default 60 seconds, when running a virtual machine.

7.295.3. restoring_state
リンクのコピー

This status indicates that the virtual machine process is about to run and the virtual machine is going to awake from hibernation. In this status, the running state of the virtual machine is being restored.

7.295.4. saving_state
リンクのコピー

This status indicates that the virtual machine process is running and the virtual machine is being hibernated. In this status, the running state of the virtual machine is being saved. Note that this status does not mean that the guest operating system is being hibernated.

7.295.5. suspended
リンクのコピー

This status indicates that the virtual machine process is not running and a running state of the virtual machine was saved. This status is similar to Down, but when the VM is started in this status its saved running state is restored instead of being booted using the normal procedue.

7.295.6. unknown
リンクのコピー

This status indicates that the system failed to determine the status of the virtual machine. The virtual machine process may be running or not running in this status. For instance, when host becomes non-responsive the virtual machines that ran on it are set with this status.

7.295.7. up
リンクのコピー

This status indicates that the virtual machine process is running and the guest operating system is loaded. Note that if no guest-agent is installed, this status is set after a predefined period of time, that is by default 60 seconds, when running a virtual machine.

7.295.8. wait_for_launch
リンクのコピー

This status indicates that the virtual machine process is about to run. This status is set when a request to run a virtual machine arrives to the host. It is possible that the virtual machine process will fail to run.

7.296. VmStorageErrorResumeBehaviour enum
リンクのコピー

If the storage, on which this virtual machine has some disks gets unresponsive, the virtual machine gets paused.

This are the possible options, what should happen with the virtual machine in the moment the storage gets available again.

Expand

Table 7.387. Values summary
Name	Summary
`auto_resume`	The virtual machine gets resumed automatically in the moment the storage is available again.
`kill`	The virtual machine will be killed after a timeout (configurable on the hypervisor).
`leave_paused`	Do nothing with the virtual machine.

7.296.1. auto_resume
リンクのコピー

The virtual machine gets resumed automatically in the moment the storage is available again.

This is the only behavior available before 4.2.

7.296.2. kill
リンクのコピー

The virtual machine will be killed after a timeout (configurable on the hypervisor).

This is the only option supported for highly available virtual machines with leases. The reason is that the highly available virtual machine is restarted using the infrastructure and any kind of resume risks split brains.

7.296.3. leave_paused
リンクのコピー

Do nothing with the virtual machine.

Useful if there is a custom failover implemented and the user does not want the virtual machine to get resumed.

7.297. VmSummary struct
リンクのコピー

Type containing information related to virtual machines on a particular host.

Expand

Table 7.388. Attributes summary
Name	Type	Summary
`active`	Integer	The number of virtual machines active on the host.
`migrating`	Integer	The number of virtual machines migrating to or from the host.
`total`	Integer	The number of virtual machines present on the host.

7.298. VmType enum
リンクのコピー

Type representing what the virtual machine is optimized for.

Expand

Table 7.389. Values summary
Name	Summary
`desktop`	The virtual machine is intended to be used as a desktop.
`high_performance`	The virtual machine is intended to be used as a high performance virtual machine.
`server`	The virtual machine is intended to be used as a server.

7.298.1. desktop
リンクのコピー

The virtual machine is intended to be used as a desktop.

Currently, its implication is that a sound device will automatically be added to the virtual machine.

7.298.2. high_performance
リンクのコピー

The virtual machine is intended to be used as a high performance virtual machine.

Currently, its implication is that the virtual machine configuration will automatically be set for running with the highest possible performance, and with performance metrics as close to bare metal as possible.

Some of the recommended configuration settings for the highest possible performance cannot be set automatically; manually setting them before running the virtual machine is recommended.

The following configuration changes are set automatically:

Enable headless mode.
Enable serial console.
Enable passthrough host CPU.
Enable I/O threads.
Enable I/O threads pinning and set the pinning topology.
Enable the paravirtualized random number generator PCI (virtio-rng) device.
Disable all USB devices.
Disable the soundcard device.
Disable the smartcard device.
Disable the memory balloon device.
Disable the watchdog device.
Disable migration.
Disable high availability.

The following recommended configuration changes have to be set manually by the user:

Enable CPU pinning topology.
Enable non-uniform memory access (NUMA) pinning topology.
Enable and set huge pages configuration.
Disable kernel same-page merging (KSM).

7.298.3. server
リンクのコピー

The virtual machine is intended to be used as a server.

Currently, its implication is that a sound device will not automatically be added to the virtual machine.

7.299. VnicPassThrough struct
リンクのコピー

Expand

Table 7.390. Attributes summary
Name	Type	Summary
`mode`	VnicPassThroughMode	Defines whether the vNIC will be implemented as a virtual device, or as a passthrough to a host device.

7.300. VnicPassThroughMode enum
リンクのコピー

Describes whether the vNIC is to be implemented as a passthrough device or a virtual one.

Expand

Table 7.391. Values summary
Name	Summary
`disabled`	To be implemented as a virtual device.
`enabled`	To be implemented as a passthrough device.

7.301. VnicProfile struct
リンクのコピー

A vNIC profile is a collection of settings that can be applied to individual NIC.

Expand

Table 7.392. Attributes summary
Name	Type	Summary
`comment`	String	Free text containing comments about this object.
`custom_properties`	CustomProperty[]	Custom properties applied to the vNIC profile.
`description`	String	A human-readable description in plain text.
`id`	String	A unique identifier.
`migratable`	Boolean	Marks whether `pass_through` NIC is migratable or not.
`name`	String	A human-readable name in plain text.
`pass_through`	VnicPassThrough	Enables passthrough to an SR-IOV-enabled host NIC.
`port_mirroring`	Boolean	Enables port mirroring.

7.301.1. migratable
リンクのコピー

Marks whether pass_through NIC is migratable or not.

If pass_through.mode is set to disabled this option has no meaning, and it will be considered to be true. If you omit this option from a request, by default, this will be set to true.

When migrating a virtual machine, this virtual machine will be migrated only if all pass_through NICs are flagged as migratable.

7.301.2. pass_through
リンクのコピー

Enables passthrough to an SR-IOV-enabled host NIC.

A vNIC profile enables a NIC to be directly connected to a virtual function (VF) of an SR-IOV-enabled host NIC, if passthrough is enabled. The NIC will then bypass the software network virtualization and connect directly to the VF for direct device assignment.

Passthrough cannot be enabled if the vNIC profile is already attached to a NIC. If a vNIC profile has passthrough enabled, qos and port_mirroring are disabled for the vNIC profile.

7.301.3. port_mirroring
リンクのコピー

Enables port mirroring.

Port mirroring copies layer 3 network traffic on a given logical network and host to a NIC on a virtual machine. This virtual machine can be used for network debugging and tuning, intrusion detection, and monitoring the behavior of other virtual machines on the same host and logical network. The only traffic copied is internal to one logical network on one host. There is no increase in traffic on the network external to the host; however a virtual machine with port mirroring enabled uses more host CPU and RAM than other virtual machines.

Port mirroring has the following limitations:

Hot plugging a NIC with a vNIC profile that has port mirroring enabled is not supported.
Port mirroring cannot be altered when the vNIC profile is attached to a virtual machine.

Given the above limitations, it is recommended that you enable port mirroring on an additional, dedicated vNIC profile.

Important

Enabling port mirroring reduces the privacy of other network users.

Expand

Table 7.393. Links summary
Name	Type	Summary
`network`	Network	Reference to the network that the vNIC profile is applied to.
`network_filter`	NetworkFilter	Reference to the top-level network filter that applies to the NICs that use this profile.
`permissions`	Permission[]	Permissions to allow usage of the vNIC profile.
`qos`	Qos	Reference to the quality of service attributes to apply to the vNIC profile.

7.301.4. network_filter
リンクのコピー

Reference to the top-level network filter that applies to the NICs that use this profile.

Network filters enhance the ability to manage the network packets traffic to and from virtual machines. The network filter may either contain a reference to other filters, rules for traffic filtering, or a combination of both.

7.301.5. qos
リンクのコピー

Reference to the quality of service attributes to apply to the vNIC profile.

Quality of Service attributes regulate inbound and outbound network traffic of the NIC.

7.302. VnicProfileMapping struct
リンクのコピー

Deprecated type that maps an external virtual NIC profile to one that exists in the Red Hat Virtualization Manager.

If, for example, the desired virtual NIC profile’s mapping includes the following two lines:

Expand

Source network name	Source network profile name	Target virtual NIC profile ID
`red`	`gold`	`738dd914-8ec8-4a8b-8628-34672a5d449b`
`blue`	`silver`	`892a12ec-2028-4451-80aa-ff3bf55d6bac`

The following form is deprecated since 4.2.1 and will be removed in the future:

<vnic_profile_mappings>
  <vnic_profile_mapping>
    <source_network_name>red</source_network_name>
    <source_network_profile_name>gold</source_network_profile_name>
    <target_vnic_profile id="738dd914-8ec8-4a8b-8628-34672a5d449b"/>
  </vnic_profile_mapping>
  <vnic_profile_mapping>
    <source_network_name>blue</source_network_name>
    <source_network_profile_name>silver</source_network_profile_name>
    <target_vnic_profile id="892a12ec-2028-4451-80aa-ff3bf55d6bac"/>
  </vnic_profile_mapping>
</vnic_profile_mappings>

Expand

Table 7.394. Attributes summary
Name	Type	Summary
`source_network_name`	String	Deprecated attribute describing the name of the external network.
`source_network_profile_name`	String	Deprecated attribute describing the name of the external network profile.

7.302.1. source_network_name
リンクのコピー

Deprecated attribute describing the name of the external network.

Warning

Please note that this attribute has been deprecated since version 4.2.1 of the engine, and preserved only for backward compatibility. It will be removed in the future.

7.302.2. source_network_profile_name
リンクのコピー

Deprecated attribute describing the name of the external network profile.

Warning

Please note that this attribute has been deprecated since version 4.2.1 of the engine, and preserved only for backward compatibility. It will be removed in the future.

Expand

Table 7.395. Links summary
Name	Type	Summary
`target_vnic_profile`	VnicProfile	Deprecated attribute describing an existing virtual NIC profile.

7.302.3. target_vnic_profile
リンクのコピー

Deprecated attribute describing an existing virtual NIC profile.

Warning

Please note that this attribute has been deprecated since version 4.2.1 of the engine, and preserved only for backward compatibility. It will be removed in the future.

7.303. VolumeGroup struct
リンクのコピー

Expand

Table 7.396. Attributes summary
Name	Type	Summary
`id`	String
`logical_units`	LogicalUnit[]
`name`	String

7.304. Watchdog struct
リンクのコピー

This type represents a watchdog configuration.

Expand

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

7.304.1. model
リンクのコピー

Model of watchdog device. Currently supported only I6300ESB.

Expand

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

7.304.2. vms
リンクのコピー

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

7.305. WatchdogAction enum
リンクのコピー

This type describes available watchdog actions.

Expand

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

7.305.1. none
リンクのコピー

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

7.306. WatchdogModel enum
リンクのコピー

This type represents the watchdog model.

Expand

Table 7.400. Values summary
Name	Summary
`diag288`	The watchdog model for S390X machines.
`i6300esb`	PCI based watchdog model.

7.306.1. diag288
リンクのコピー

The watchdog model for S390X machines.

S390X has an integrated watchdog facility that is controlled via the DIAG288 instruction. Use this model for S390X virtual machines.

7.306.2. i6300esb
リンクのコピー

PCI based watchdog model.

Use the I6300ESB watchdog for x86_64 and PPC64 virtual machines.

7.307. Weight struct
リンクのコピー

Expand

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

Expand

Table 7.402. Links summary
Name	Type	Summary
`scheduling_policy`	SchedulingPolicy
`scheduling_policy_unit`	SchedulingPolicyUnit

このコンテンツは選択した言語では利用できません。

7.1. AccessProtocol enumリンクのコピーリンクがクリップボードにコピーされました!

7.2. Action structリンクのコピーリンクがクリップボードにコピーされました!

7.3. AffinityGroup structリンクのコピーリンクがクリップボードにコピーされました!

7.3.1. enforcingリンクのコピーリンクがクリップボードにコピーされました!

7.3.2. positiveリンクのコピーリンクがクリップボードにコピーされました!

7.4. AffinityLabel structリンクのコピーリンクがクリップボードにコピーされました!

7.4.1. read_onlyリンクのコピーリンクがクリップボードにコピーされました!

7.5. AffinityRule structリンクのコピーリンクがクリップボードにコピーされました!

7.5.1. enabledリンクのコピーリンクがクリップボードにコピーされました!

7.5.2. enforcingリンクのコピーリンクがクリップボードにコピーされました!

7.5.3. positiveリンクのコピーリンクがクリップボードにコピーされました!

7.6. Agent structリンクのコピーリンクがクリップボードにコピーされました!

7.6.1. hostリンクのコピーリンクがクリップボードにコピーされました!

7.7. AgentConfiguration structリンクのコピーリンクがクリップボードにコピーされました!

7.8. Api structリンクのコピーリンクがクリップボードにコピーされました!

7.8.1. authenticated_userリンクのコピーリンクがクリップボードにコピーされました!

7.8.2. effective_userリンクのコピーリンクがクリップボードにコピーされました!

7.9. ApiSummary structリンクのコピーリンクがクリップボードにコピーされました!

7.10. ApiSummaryItem structリンクのコピーリンクがクリップボードにコピーされました!

7.11. Application structリンクのコピーリンクがクリップボードにコピーされました!

7.12. Architecture enumリンクのコピーリンクがクリップボードにコピーされました!

7.12.1. s390xリンクのコピーリンクがクリップボードにコピーされました!

7.13. AuthorizedKey structリンクのコピーリンクがクリップボードにコピーされました!

7.14. AutoNumaStatus enumリンクのコピーリンクがクリップボードにコピーされました!

7.15. Balance structリンクのコピーリンクがクリップボードにコピーされました!

7.16. Bios structリンクのコピーリンクがクリップボードにコピーされました!

7.17. BlockStatistic structリンクのコピーリンクがクリップボードにコピーされました!

7.18. Bonding structリンクのコピーリンクがクリップボードにコピーされました!

7.18.1. ad_partner_macリンクのコピーリンクがクリップボードにコピーされました!

7.18.2. optionsリンクのコピーリンクがクリップボードにコピーされました!

7.18.3. slavesリンクのコピーリンクがクリップボードにコピーされました!

7.18.4. active_slaveリンクのコピーリンクがクリップボードにコピーされました!

7.19. Bookmark structリンクのコピーリンクがクリップボードにコピーされました!

7.20. Boot structリンクのコピーリンクがクリップボードにコピーされました!

7.20.1. devicesリンクのコピーリンクがクリップボードにコピーされました!

7.21. BootDevice enumリンクのコピーリンクがクリップボードにコピーされました!

7.21.1. cdromリンクのコピーリンクがクリップボードにコピーされました!

7.21.2. networkリンクのコピーリンクがクリップボードにコピーされました!

7.22. BootMenu structリンクのコピーリンクがクリップボードにコピーされました!

7.23. BootProtocol enumリンクのコピーリンクがクリップボードにコピーされました!

7.23.1. autoconfリンクのコピーリンクがクリップボードにコピーされました!

7.23.2. dhcpリンクのコピーリンクがクリップボードにコピーされました!

7.23.3. poly_dhcp_autoconfリンクのコピーリンクがクリップボードにコピーされました!

7.24. BrickProfileDetail structリンクのコピーリンクがクリップボードにコピーされました!

7.25. Cdrom structリンクのコピーリンクがクリップボードにコピーされました!

7.25.1. vmsリンクのコピーリンクがクリップボードにコピーされました!

7.26. Certificate structリンクのコピーリンクがクリップボードにコピーされました!

7.27. CloudInit structリンクのコピーリンクがクリップボードにコピーされました!

7.28. Cluster structリンクのコピーリンクがクリップボードにコピーされました!

7.28.1. custom_scheduling_policy_propertiesリンクのコピーリンクがクリップボードにコピーされました!

7.28.2. fencing_policyリンクのコピーリンクがクリップボードにコピーされました!

7.28.3. firewall_typeリンクのコピーリンクがクリップボードにコピーされました!

7.28.4. gluster_tuned_profileリンクのコピーリンクがクリップボードにコピーされました!

7.28.5. required_rng_sourcesリンクのコピーリンクがクリップボードにコピーされました!

7.28.6. versionリンクのコピーリンクがクリップボードにコピーされました!

7.28.7. external_network_providersリンクのコピーリンクがクリップボードにコピーされました!

7.28.8. scheduling_policyリンクのコピーリンクがクリップボードにコピーされました!

7.29. ClusterFeature structリンクのコピーリンクがクリップボードにコピーされました!

7.30. ClusterLevel structリンクのコピーリンクがクリップボードにコピーされました!

7.31. Configuration structリンクのコピーリンクがクリップボードにコピーされました!

7.31.1. dataリンクのコピーリンクがクリップボードにコピーされました!

7.32. ConfigurationType enumリンクのコピーリンクがクリップボードにコピーされました!

7.32.1. ovaリンクのコピーリンクがクリップボードにコピーされました!

7.32.2. ovfリンクのコピーリンクがクリップボードにコピーされました!

7.33. Console structリンクのコピーリンクがクリップボードにコピーされました!

7.34. Core structリンクのコピーリンクがクリップボードにコピーされました!

7.35. Cpu structリンクのコピーリンクがクリップボードにコピーされました!

7.36. CpuMode enumリンクのコピーリンクがクリップボードにコピーされました!

7.37. CpuProfile structリンクのコピーリンクがクリップボードにコピーされました!

7.38. CpuTopology structリンクのコピーリンクがクリップボードにコピーされました!

7.39. CpuTune structリンクのコピーリンクがクリップボードにコピーされました!

7.40. CpuType structリンクのコピーリンクがクリップボードにコピーされました!

7.41. CreationStatus enumリンクのコピーリンクがクリップボードにコピーされました!

7.42. CustomProperty structリンクのコピーリンクがクリップボードにコピーされました!

7.43. DataCenter structリンクのコピーリンクがクリップボードにコピーされました!

7.43.1. versionリンクのコピーリンクがクリップボードにコピーされました!

7.44. DataCenterStatus enumリンクのコピーリンクがクリップボードにコピーされました!

7.45. Device structリンクのコピーリンクがクリップボードにコピーされました!

7.1. AccessProtocol enum
リンクのコピー

7.2. Action struct
リンクのコピー

7.3. AffinityGroup struct
リンクのコピー

7.3.1. enforcing
リンクのコピー

7.3.2. positive
リンクのコピー

7.4. AffinityLabel struct
リンクのコピー

7.4.1. read_only
リンクのコピー

7.5. AffinityRule struct
リンクのコピー

7.5.1. enabled
リンクのコピー

7.5.2. enforcing
リンクのコピー

7.5.3. positive
リンクのコピー

7.6. Agent struct
リンクのコピー

7.6.1. host
リンクのコピー

7.7. AgentConfiguration struct
リンクのコピー

7.8. Api struct
リンクのコピー

7.8.1. authenticated_user
リンクのコピー

7.8.2. effective_user
リンクのコピー

7.9. ApiSummary struct
リンクのコピー

7.10. ApiSummaryItem struct
リンクのコピー

7.11. Application struct
リンクのコピー

7.12. Architecture enum
リンクのコピー

7.12.1. s390x
リンクのコピー

7.13. AuthorizedKey struct
リンクのコピー

7.14. AutoNumaStatus enum
リンクのコピー

7.15. Balance struct
リンクのコピー

7.16. Bios struct
リンクのコピー

7.17. BlockStatistic struct
リンクのコピー

7.18. Bonding struct
リンクのコピー

7.18.1. ad_partner_mac
リンクのコピー

7.18.2. options
リンクのコピー

7.18.3. slaves
リンクのコピー

7.18.4. active_slave
リンクのコピー

7.19. Bookmark struct
リンクのコピー

7.20. Boot struct
リンクのコピー

7.20.1. devices
リンクのコピー

7.21. BootDevice enum
リンクのコピー

7.21.1. cdrom
リンクのコピー

7.21.2. network
リンクのコピー

7.22. BootMenu struct
リンクのコピー

7.23. BootProtocol enum
リンクのコピー

7.23.1. autoconf
リンクのコピー

7.23.2. dhcp
リンクのコピー

7.23.3. poly_dhcp_autoconf
リンクのコピー

7.24. BrickProfileDetail struct
リンクのコピー

7.25. Cdrom struct
リンクのコピー

7.25.1. vms
リンクのコピー

7.26. Certificate struct
リンクのコピー

7.27. CloudInit struct
リンクのコピー

7.28. Cluster struct
リンクのコピー

7.28.1. custom_scheduling_policy_properties
リンクのコピー

7.28.2. fencing_policy
リンクのコピー

7.28.3. firewall_type
リンクのコピー

7.28.4. gluster_tuned_profile
リンクのコピー

7.28.5. required_rng_sources
リンクのコピー

7.28.6. version
リンクのコピー

7.28.7. external_network_providers
リンクのコピー

7.28.8. scheduling_policy
リンクのコピー

7.29. ClusterFeature struct
リンクのコピー

7.30. ClusterLevel struct
リンクのコピー

7.31. Configuration struct
リンクのコピー

7.31.1. data
リンクのコピー

7.32. ConfigurationType enum
リンクのコピー

7.32.1. ova
リンクのコピー

7.32.2. ovf
リンクのコピー

7.33. Console struct
リンクのコピー

7.34. Core struct
リンクのコピー

7.35. Cpu struct
リンクのコピー

7.36. CpuMode enum
リンクのコピー

7.37. CpuProfile struct
リンクのコピー

7.38. CpuTopology struct
リンクのコピー

7.39. CpuTune struct
リンクのコピー

7.40. CpuType struct
リンクのコピー

7.41. CreationStatus enum
リンクのコピー

7.42. CustomProperty struct
リンクのコピー

7.43. DataCenter struct
リンクのコピー

7.43.1. version
リンクのコピー

7.44. DataCenterStatus enum
リンクのコピー

7.45. Device struct
リンクのコピー

7.45.1. vms
リンクのコピー

7.46. Disk struct
リンクのコピー