Vcha_PlacementSpec

Vcha_PlacementSpec
Vcha_PlacementSpec

The PlacementSpec structure contains information to describe the inventory placement of a single node of a VCHA cluster.

JSON Example
{
    "name": "string",
    "folder": "string",
    "host": "string",
    "resource_pool": "string",
    "ha_network_type": "string",
    "ha_network": "string",
    "management_network_type": "string",
    "management_network": "string",
    "storage": {
        "datastore": "string"
    }
}
string
name
Required

The name of the VCHA node to be used for the virtual machine name.

string
folder
Required

The identifier of the folder to deploy the VCHA node to. 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.

string
host
Optional

The identifier of the host to deploy the VCHA node to. 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.

string
resource_pool
Optional

The identifier of the resource pool to deploy the VCHA node to. 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
Optional

The NetworkType enumerated type defines the type of a vCenter Server network.
STANDARD_PORTGROUP : vSphere standard portgroup network.
DISTRIBUTED_PORTGROUP : Distributed virtual switch.

string
ha_network
Optional

The identifier of the Network object used for the HA network. If the PlacementSpec.ha-network field is set, then the {#link #haNetworkType} field must be set. If the PlacementSpec.ha-network field is unset, then the PlacementSpec.ha-network-type field is ignored. If unset and the PlacementSpec.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
Optional

The NetworkType enumerated type defines the type of a vCenter Server network.
STANDARD_PORTGROUP : vSphere standard portgroup network.
DISTRIBUTED_PORTGROUP : Distributed virtual switch.

string
management_network
Optional

The identifier of the Network object used for the Management network. If the PlacementSpec.management-network field is set, then the PlacementSpec.management-network-type field must be set. If the PlacementSpec.management-network field is unset, then the PlacementSpec.management-network-type field is ignored. If unset and the PlacementSpec.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
Optional

The DiskSpec structure contains information to describe the storage configuration of a vCenter virtual machine.