Developer Documentation

VchaPlacementInfo

The PlacementInfo structure contains information to describe the inventory placement of a single node of a VCHA cluster. The active node’s management vCenter server credentials are required to populate all fields except biosUuid.


Properties

Required Property Name Type Description
optional bios_uuid string

BIOS UUID for the node. If unset, the information is currently unavailable.

optional cluster string

The identifier of the cluster of which PlacementInfo.host is member. If unset, PlacementInfo.host is a standalone host. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: ClusterComputeResource:VCenter. When operations return a value of this structure as a result, the field will be an identifier for the resource type: ClusterComputeResource:VCenter.

optional cluster_name string

The name of the cluster of which PlacementInfo.host is member. If unset, PlacementInfo.host is a standalone host.

required datacenter string

The identifier of the datacenter of the VCHA node. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: Datacenter:VCenter. When operations return a value of this structure as a result, the field will be an identifier for the resource type: Datacenter:VCenter.

required datacenter_name string

The name of the datacenter of the VCHA node.

optional ha_network string

The identifier of the Network object used for the HA network. If unset, the information is currently unavailable or the haNetwork is not configured. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: Network:VCenter. When operations return a value of this structure as a result, the field will be an identifier for the resource type: Network:VCenter.

optional ha_network_name string

The name of the Network object used for the HA network. If unset, the information is currently unavailable or the haNetwork is not configured.

optional ha_network_type VchaNetworkType Enum

The type of the Network object used for the HA network. If unset, the information is currently unavailable or the haNetwork is not configured.

required host string

The identifier of the host of the VCHA node. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: HostSystem:VCenter. When operations return a value of this structure as a result, the field will be an identifier for the resource type: HostSystem:VCenter.

required host_name string

The name of the host of the VCHA node.

required management_network string

The identifier of the Network object used for the Management network. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: Network:VCenter. When operations return a value of this structure as a result, the field will be an identifier for the resource type: Network:VCenter.

required management_network_name string

The name of the Network object used for the Management network.

required management_network_type VchaNetworkType Enum

The type of the Network object used for the Management network.

required management_vcenter_name string

The hostname of the vCenter server that is managing the VCHA node.

optional management_vcenter_server_guid string

The unique identifier of the vCenter server that is managing the VCHA node. This field is optional because it was added in a newer version than its parent node.

required storage VchaDiskInfo

The storage information of the VCHA node.

required vm_name string

The virtual machine name of the VCHA node.

Feedback

Was this page helpful?