REST API - placement

vcenter vcha: placement info

The placement_info 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. This structure was added in vSphere API 6.7.1.

Representation:

JSON

{
    "cluster" : "obj-103",
    "cluster_name" : "string",
    "management_network_type" : "STANDARD_PORTGROUP",
    "datacenter" : "obj-103",
    "management_network" : "obj-103",
    "storage" : {
        "datastore" : "obj-103",
        "datastore_name" : "string"
    },
    "management_vcenter_server_guid" : "string",
    "ha_network_type" : "STANDARD_PORTGROUP",
    "management_network_name" : "string",
    "host" : "obj-103",
    "management_vcenter_name" : "string",
    "ha_network" : "obj-103",
    "ha_network_name" : "string",
    "vm_name" : "string",
    "host_name" : "string",
    "datacenter_name" : "string",
    "bios_uuid" : "string"
}

Attributes:

Name	Type	Description
Required
management_vcenter_name	string	The hostname of the vCenter server that is managing the VCHA node. This attribute was added in vSphere API 6.7.1.
vm_name	string	The virtual machine name of the VCHA node. This attribute was added in vSphere API 6.7.1.
datacenter	string	The identifier of the datacenter of the VCHA node. This attribute was added in vSphere API 6.7.1. 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`.
datacenter_name	string	The name of the datacenter of the VCHA node. This attribute was added in vSphere API 6.7.1.
host	string	The identifier of the host of the VCHA node. This attribute was added in vSphere API 6.7.1. 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`.
host_name	string	The name of the host of the VCHA node. This attribute was added in vSphere API 6.7.1.
management_network	string	The identifier of the Network object used for the Management network. This attribute was added in vSphere API 6.7.1. 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`.
management_network_name	string	The name of the Network object used for the Management network. This attribute was added in vSphere API 6.7.1.
management_network_type	string	The type of the Network object used for the Management network. This attribute was added in vSphere API 6.7.1. Defines the type of a vCenter Server network. This enumeration was added in vSphere API 6.7.1. Value is one of: STANDARD_PORTGROUP: vSphere standard portgroup network. This constant was added in vSphere API 6.7.1. DISTRIBUTED_PORTGROUP: Distributed virtual switch. This constant was added in vSphere API 6.7.1.
storage	disk_info	The storage information of the VCHA node. This attribute was added in vSphere API 6.7.1.
storage.datastore	string	The identifier of the datastore to put all the virtual disks on. This attribute was added in vSphere API 6.7.1. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: `Datastore:VCenter`. When operations return a value of this structure as a result, the field will be an identifier for the resource type: `Datastore:VCenter`.
storage.datastore_name	string	The name of the datastore. This attribute was added in vSphere API 6.7.1.
Optional
management_vcenter_server_guid	string	The unique identifier of the vCenter server that is managing the VCHA node. This attribute was added in vSphere API 7.0.0.1. Optional. This field is optional because it was added in a newer version than its parent node.
cluster	string	The identifier of the cluster of which `host` is member. This attribute was added in vSphere API 6.7.1. Optional. If unset, `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`.
cluster_name	string	The name of the cluster of which `host` is member. This attribute was added in vSphere API 6.7.1. Optional. If unset, `host` is a standalone host.
ha_network	string	The identifier of the Network object used for the HA network. This attribute was added in vSphere API 6.7.1. Optional. 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`.
ha_network_name	string	The name of the Network object used for the HA network. This attribute was added in vSphere API 6.7.1. Optional. If unset, the information is currently unavailable or the haNetwork is not configured.
ha_network_type	string	The type of the Network object used for the HA network. This attribute was added in vSphere API 6.7.1. Optional. If unset, the information is currently unavailable or the haNetwork is not configured.
bios_uuid	string	BIOS UUID for the node. This attribute was added in vSphere API 6.7.1. Optional. If unset, the information is currently unavailable.