REST API - placement

vcenter vcha: placement spec

The placement_spec structure contains information to describe the inventory placement of a single node of a VCHA cluster. This structure was added in vSphere API 6.7.1.

Representation:

JSON

{
    "ha_network_type" : "STANDARD_PORTGROUP",
    "folder" : "obj-103",
    "name" : "string",
    "host" : "obj-103",
    "management_network_type" : "STANDARD_PORTGROUP",
    "management_network" : "obj-103",
    "storage" : {
        "datastore" : "obj-103"
    },
    "resource_pool" : "obj-103",
    "ha_network" : "obj-103"
}

Attributes:

Name	Type	Description
Required
name	string	The name of the VCHA node to be used for the virtual machine name. This attribute was added in vSphere API 6.7.1.
folder	string	The identifier of the folder to deploy the VCHA node to. 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: `Folder:VCenter`. When operations return a value of this structure as a result, the field will be an identifier for the resource type: `Folder:VCenter`.
Optional
host	string	The identifier of the host to deploy the VCHA node to. This attribute was added in vSphere API 6.7.1. Optional. If unset, see vim.vm.RelocateSpec.host.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`.
resource_pool	string	The identifier of the resource pool to deploy the VCHA node to. This attribute was added in vSphere API 6.7.1. Optional. If unset, then the active node's resource pool will be used.When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: `ResourcePool:VCenter`. When operations return a value of this structure as a result, the field will be an identifier for the resource type: `ResourcePool:VCenter`.
ha_network_type	string	The type of the Network object used by the HA network. If the vcenter.vcha.placement_spec.ha_network field is set, then the vcenter.vcha.placement_spec.ha_network_type field must be set. If the vcenter.vcha.placement_spec.ha_network field is unset, then the vcenter.vcha.placement_spec.ha_network_type field is ignored. This attribute was added in vSphere API 6.7.1. Optional. If unset and the vcenter.vcha.placement_spec.ha_network field is unset, then the same network present on the Active node virtual machine is used to deploy the virtual machine with an assumption that the network is present on the destination. If unset and the vcenter.vcha.placement_spec.ha_network field is set, then an error is reported.
ha_network	string	The identifier of the Network object used for the HA network. If the vcenter.vcha.placement_spec.ha_network field is set, then the {#link #haNetworkType} field must be set. If the vcenter.vcha.placement_spec.ha_network field is unset, then the vcenter.vcha.placement_spec.ha_network_type field is ignored. This attribute was added in vSphere API 6.7.1. Optional. If unset and the vcenter.vcha.placement_spec.ha_network_type field is unset, then the same network present on the Active node virtual machine is used to deploy the virtual machine with an assumption that the network is present on the destination. . 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_type	string	The type of the Network object used by the Management network. If the vcenter.vcha.placement_spec.management_network field is set, then the {#link #managementNetworkType} field must be set. If the vcenter.vcha.placement_spec.management_network field is unset, then the vcenter.vcha.placement_spec.management_network_type field is ignored. This attribute was added in vSphere API 6.7.1. Optional. If unset and the vcenter.vcha.placement_spec.management_network field is unset, then the same network present on the Active node virtual machine is used to deploy the virtual machine with an assumption that the network is present on the destination. If unset and the vcenter.vcha.placement_spec.management_network field is set, then an error is reported.
management_network	string	The identifier of the Network object used for the Management network. If the vcenter.vcha.placement_spec.management_network field is set, then the vcenter.vcha.placement_spec.management_network_type field must be set. If the vcenter.vcha.placement_spec.management_network field is unset, then the vcenter.vcha.placement_spec.management_network_type field is ignored. This attribute was added in vSphere API 6.7.1. Optional. If unset and the vcenter.vcha.placement_spec.management_network_type field is unset, then the same network present on the Active node virtual machine is used to deploy the virtual machine with an assumption that the network is present on the destination. . 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`.
storage	disk_spec	The storage specification to deploy the VCHA node to. This attribute was added in vSphere API 6.7.1. Optional. If unset, see vim.vm.RelocateSpec.datastore.
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. Optional. This field needs to be set. If unset, then see vim.vm.RelocateSpec.datastore.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`.