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

string
bios_uuid Optional

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


string
cluster Optional

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.


string
cluster_name Optional

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


string
datacenter Required

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.


string
datacenter_name Required

The name of the datacenter of the VCHA node.


string
ha_network Optional

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.


string
ha_network_name Optional

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


ha_network_type Optional

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


string
host Required

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.


string
host_name Required

The name of the host of the VCHA node.


string
management_network Required

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.


string
management_network_name Required

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


management_network_type Required

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


string
management_vcenter_name Required

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


string
management_vcenter_server_guid Optional

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.


storage Required

The storage information of the VCHA node.


string
vm_name Required

The virtual machine name of the VCHA node.

JSON Example

{
    "datacenter": "string",
    "datacenter_name": "string",
    "host": "string",
    "host_name": "string",
    "management_network": "string",
    "management_network_name": "string",
    "management_network_type": "enum",
    "management_vcenter_name": "string",
    "storage": {
        "datastore": "string",
        "datastore_name": "string"
    },
    "vm_name": "string"
}
Feedback

Was this page helpful?