vcenter vcha cluster: deploy-task
Prepares, clones, and configures a VCHA cluster. This operation was added in vSphere API 6.7.1.
Request:
HTTP request
POST https://{server}/rest/vcenter/vcha/cluster?vmw-task=true&action=deploy
Request Body Structure:
{
"spec" : {
"witness" : {
"ha_ip" : {
"ip_family" : "IPV4",
"default_gateway" : "string",
"ipv4" : {
"address" : "string",
"prefix" : 1,
"subnet_mask" : "string"
},
"ipv6" : {
"address" : "string",
"prefix" : 1
},
"dns_servers" : [
"string",
"string"
]
},
"placement" : {
"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"
}
},
"vc_spec" : {
"active_location" : {
"hostname" : "string",
"password" : "secret string",
"port" : 1,
"ssl_thumbprint" : "string",
"username" : "string"
}
},
"active" : {
"ha_network_type" : "STANDARD_PORTGROUP",
"ha_ip" : {
"ip_family" : "IPV4",
"default_gateway" : "string",
"ipv4" : {
"address" : "string",
"prefix" : 1,
"subnet_mask" : "string"
},
"ipv6" : {
"address" : "string",
"prefix" : 1
},
"dns_servers" : [
"string",
"string"
]
},
"ha_network" : "obj-103"
},
"passive" : {
"failover_ip" : {
"ip_family" : "IPV4",
"default_gateway" : "string",
"ipv4" : {
"address" : "string",
"prefix" : 1,
"subnet_mask" : "string"
},
"ipv6" : {
"address" : "string",
"prefix" : 1
},
"dns_servers" : [
"string",
"string"
]
},
"ha_ip" : {
"ip_family" : "IPV4",
"default_gateway" : "string",
"ipv4" : {
"address" : "string",
"prefix" : 1,
"subnet_mask" : "string"
},
"ipv6" : {
"address" : "string",
"prefix" : 1
},
"dns_servers" : [
"string",
"string"
]
},
"placement" : {
"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"
}
},
"deployment" : "AUTO"
}
}
"spec" : {
"witness" : {
"ha_ip" : {
"ip_family" : "IPV4",
"default_gateway" : "string",
"ipv4" : {
"address" : "string",
"prefix" : 1,
"subnet_mask" : "string"
},
"ipv6" : {
"address" : "string",
"prefix" : 1
},
"dns_servers" : [
"string",
"string"
]
},
"placement" : {
"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"
}
},
"vc_spec" : {
"active_location" : {
"hostname" : "string",
"password" : "secret string",
"port" : 1,
"ssl_thumbprint" : "string",
"username" : "string"
}
},
"active" : {
"ha_network_type" : "STANDARD_PORTGROUP",
"ha_ip" : {
"ip_family" : "IPV4",
"default_gateway" : "string",
"ipv4" : {
"address" : "string",
"prefix" : 1,
"subnet_mask" : "string"
},
"ipv6" : {
"address" : "string",
"prefix" : 1
},
"dns_servers" : [
"string",
"string"
]
},
"ha_network" : "obj-103"
},
"passive" : {
"failover_ip" : {
"ip_family" : "IPV4",
"default_gateway" : "string",
"ipv4" : {
"address" : "string",
"prefix" : 1,
"subnet_mask" : "string"
},
"ipv6" : {
"address" : "string",
"prefix" : 1
},
"dns_servers" : [
"string",
"string"
]
},
"ha_ip" : {
"ip_family" : "IPV4",
"default_gateway" : "string",
"ipv4" : {
"address" : "string",
"prefix" : 1,
"subnet_mask" : "string"
},
"ipv6" : {
"address" : "string",
"prefix" : 1
},
"dns_servers" : [
"string",
"string"
]
},
"placement" : {
"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"
}
},
"deployment" : "AUTO"
}
}
Request Body Parameters:
| Name | Type | Description |
|---|---|---|
| bold = required | ||
| spec | deploy_spec | Contains the deploy specification for all three nodes of a VCHA cluster. |
| spec.vc_spec | credentials_spec | Contains the active node's management vCenter server credentials. This attribute was added in vSphere API 6.7.1. Optional. If unset, then the active vCenter Server instance is assumed to be either self-managed or else in enhanced linked mode and managed by a linked vCenter Server instance. |
| spec.vc_spec.active_location | connection_spec | Connection information for the management vCenter Server of the Active Node in a VCHA Cluster. This attribute was added in vSphere API 6.7.1. |
| spec.vc_spec.active_location.hostname | string | IP Address or DNS of the vCenter. This attribute was added in vSphere API 6.7.1. |
| spec.vc_spec.active_location.port | long | Port number. This attribute was added in vSphere API 6.7.1. Optional. If unset, port 443 will be used. |
| spec.vc_spec.active_location.ssl_thumbprint | string | SHA1 hash of the server SSL certificate. This attribute was added in vSphere API 6.7.1. Optional. If unset, empty ssl thumbprint is assumed. |
| spec.vc_spec.active_location.username | string | Username to access the server. This attribute was added in vSphere API 6.7.1. Optional. This field is currently required. If unset, an error is returned. In the future, if this field is unset, the system will attempt to identify the user. If a user cannot be identified, then the requested operation will fail. |
| spec.vc_spec.active_location.password | secret | Password for the specified user. This attribute was added in vSphere API 6.7.1. Optional. This field is currently required. If unset, an empty password is assumed. In the future, if this field is unset, the system will attempt to authenticate the user. If a user cannot be identified, then the requested operation will fail. |
| spec.deployment | string | Contains the deployment type. This attribute was added in vSphere API 6.7.1. Defines the possible deployment types for a VCHA Cluster. This enumeration was added in vSphere API 6.7.1. Value is one of: AUTO: Passive and witness nodes are cloned automatically. This constant was added in vSphere API 6.7.1. MANUAL: Passive and witness nodes are not cloned automatically. After deployment, the customer should clone the passive and witness virtual machines. This constant was added in vSphere API 6.7.1. |
| spec.active | active_spec | Contains the active node's network configuration. This attribute was added in vSphere API 6.7.1. |
| spec.active.ha_network_type | string | The type of the Network object used by the HA network. If the vcenter.vcha.cluster.active_spec.ha_network field is set, then the vcenter.vcha.cluster.active_spec.ha_network_type field must be set. If the vcenter.vcha.cluster.active_spec.ha_network field is unset, then the vcenter.vcha.cluster.active_spec.ha_network_type field is ignored. This attribute was added in vSphere API 6.7.1. Optional. If unset and the vcenter.vcha.cluster.active_spec.ha_network field is unset, then the second NIC is assumed to be already configured. If unset and the vcenter.vcha.cluster.active_spec.ha_network field is set, then an error is reported. |
| spec.active.ha_network | string | The identifier of the Network object used for the HA network. If the vcenter.vcha.cluster.active_spec.ha_network field is set, then the vcenter.vcha.cluster.active_spec.ha_network_type field must be set. If the vcenter.vcha.cluster.active_spec.ha_network field is unset, then the vcenter.vcha.cluster.active_spec.ha_network_type field is ignored. This attribute was added in vSphere API 6.7.1. Optional. If unset and the vcenter.vcha.cluster.active_spec.ha_network_type field is unset, then the second NIC is assumed to be already configured. If unset and the vcenter.vcha.cluster.active_spec.ha_network field is set, then an error is reported.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. |
| spec.active.ha_ip | ip_spec | IP specification for the HA network. This attribute was added in vSphere API 6.7.1. |
| spec.active.ha_ip.ip_family | string | Family of the IP address to configure the interface. This attribute was added in vSphere API 6.7.1. Defines the Ip address family. This enumeration was added in vSphere API 6.7.1. Value is one of: IPV4: IPV4 address family. This constant was added in vSphere API 6.7.1. IPV6: IPv6 address family. This constant was added in vSphere API 6.7.1. |
| spec.active.ha_ip.ipv4 | ipv4_spec | If the family of the ip is IPV4, then this will point to IPv4 address specification. This attribute was added in vSphere API 6.7.1. Optional. It is only relevant when ip_family has value IPV4. This field is optional and it is only relevant when the value of ip_family is IP_v4. |
| spec.active.ha_ip.ipv4.address | string | IPV4 address to be used to configure the interface. This attribute was added in vSphere API 6.7.1. |
| spec.active.ha_ip.ipv4.subnet_mask | string | The subnet mask for the interface. This attribute was added in vSphere API 6.7.1. Optional. If unset and the prefix field is unset, then an error will be reported.If unset and the prefix field is set, then the prefix field will be used to create a subnet mask whose first prefix bits are 1 and the remaining bits 0.If both the subnet_mask field and the prefix field are set and they do not represent the same value, then an error will be reported. |
| spec.active.ha_ip.ipv4.prefix | long | The CIDR prefix for the interface. This attribute was added in vSphere API 6.7.1. Optional. If unset and the subnet_mask field is unset, this an error will be reported.If unset and the subnet_mask field is set, then the subnet_mask field will be used.If both the subnet_mask field and the prefix field are set and they do not represent the same value, then an error will be reported. |
| spec.active.ha_ip.ipv6 | ipv6_spec | If the family of the ip is IPV6, then this will point to IPv6 address specification. This attribute was added in vSphere API 6.7.1. Optional. It is only relevant when ip_family has value IPV6. This field is optional and it is only relevant when the value of ip_family is IP_v6. |
| spec.active.ha_ip.ipv6.address | string | IPv6 address to be used to configure the interface. This attribute was added in vSphere API 6.7.1. |
| spec.active.ha_ip.ipv6.prefix | long | The CIDR prefix for the interface. This attribute was added in vSphere API 6.7.1. |
| spec.active.ha_ip.default_gateway | string | The IP address of the Gateway for this interface. This attribute was added in vSphere API 6.7.1. Optional. If unset, gateway will not be used for the network interface. |
| spec.active.ha_ip.dns_servers | string[] | The list of IP addresses of the DNS servers for this interface. This list is a comma separated list. This attribute was added in vSphere API 6.7.1. Optional. If unset, DNS servers will not be used for the network interface. |
| spec.passive | passive_spec | Contains the passive node's placement configuration. This attribute was added in vSphere API 6.7.1. |
| spec.passive.placement | placement_spec | Contains the placement configuration of the node. This attribute was added in vSphere API 6.7.1. Optional. If unset, then the it is assumed that the clone will be done manually by the customer. In this case, the placement configuration for the witness node should also be omitted. Only the network configuration will be setup. Once the passive and witness nodes are cloned from the active node, the VCHA high availability is turned on. |
| spec.passive.placement.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. |
| spec.passive.placement.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. |
| spec.passive.placement.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. |
| spec.passive.placement.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. |
| spec.passive.placement.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. |
| spec.passive.placement.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. |
| spec.passive.placement.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. |
| spec.passive.placement.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. |
| spec.passive.placement.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. |
| spec.passive.placement.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. |
| spec.passive.ha_ip | ip_spec | IP specification for the HA network. This attribute was added in vSphere API 6.7.1. |
| spec.passive.ha_ip.ip_family | string | Family of the IP address to configure the interface. This attribute was added in vSphere API 6.7.1. Defines the Ip address family. This enumeration was added in vSphere API 6.7.1. Value is one of: IPV4: IPV4 address family. This constant was added in vSphere API 6.7.1. IPV6: IPv6 address family. This constant was added in vSphere API 6.7.1. |
| spec.passive.ha_ip.ipv4 | ipv4_spec | If the family of the ip is IPV4, then this will point to IPv4 address specification. This attribute was added in vSphere API 6.7.1. Optional. It is only relevant when ip_family has value IPV4. This field is optional and it is only relevant when the value of ip_family is IP_v4. |
| spec.passive.ha_ip.ipv4.address | string | IPV4 address to be used to configure the interface. This attribute was added in vSphere API 6.7.1. |
| spec.passive.ha_ip.ipv4.subnet_mask | string | The subnet mask for the interface. This attribute was added in vSphere API 6.7.1. Optional. If unset and the prefix field is unset, then an error will be reported.If unset and the prefix field is set, then the prefix field will be used to create a subnet mask whose first prefix bits are 1 and the remaining bits 0.If both the subnet_mask field and the prefix field are set and they do not represent the same value, then an error will be reported. |
| spec.passive.ha_ip.ipv4.prefix | long | The CIDR prefix for the interface. This attribute was added in vSphere API 6.7.1. Optional. If unset and the subnet_mask field is unset, this an error will be reported.If unset and the subnet_mask field is set, then the subnet_mask field will be used.If both the subnet_mask field and the prefix field are set and they do not represent the same value, then an error will be reported. |
| spec.passive.ha_ip.ipv6 | ipv6_spec | If the family of the ip is IPV6, then this will point to IPv6 address specification. This attribute was added in vSphere API 6.7.1. Optional. It is only relevant when ip_family has value IPV6. This field is optional and it is only relevant when the value of ip_family is IP_v6. |
| spec.passive.ha_ip.ipv6.address | string | IPv6 address to be used to configure the interface. This attribute was added in vSphere API 6.7.1. |
| spec.passive.ha_ip.ipv6.prefix | long | The CIDR prefix for the interface. This attribute was added in vSphere API 6.7.1. |
| spec.passive.ha_ip.default_gateway | string | The IP address of the Gateway for this interface. This attribute was added in vSphere API 6.7.1. Optional. If unset, gateway will not be used for the network interface. |
| spec.passive.ha_ip.dns_servers | string[] | The list of IP addresses of the DNS servers for this interface. This list is a comma separated list. This attribute was added in vSphere API 6.7.1. Optional. If unset, DNS servers will not be used for the network interface. |
| spec.passive.failover_ip | ip_spec | IP specification for the management network. This attribute was added in vSphere API 6.7.1. Optional. If unset, then it will assume the public IP address of the Active vCenter Server. |
| spec.passive.failover_ip.ip_family | string | Family of the IP address to configure the interface. This attribute was added in vSphere API 6.7.1. Defines the Ip address family. This enumeration was added in vSphere API 6.7.1. Value is one of: IPV4: IPV4 address family. This constant was added in vSphere API 6.7.1. IPV6: IPv6 address family. This constant was added in vSphere API 6.7.1. |
| spec.passive.failover_ip.ipv4 | ipv4_spec | If the family of the ip is IPV4, then this will point to IPv4 address specification. This attribute was added in vSphere API 6.7.1. Optional. It is only relevant when ip_family has value IPV4. This field is optional and it is only relevant when the value of ip_family is IP_v4. |
| spec.passive.failover_ip.ipv4.address | string | IPV4 address to be used to configure the interface. This attribute was added in vSphere API 6.7.1. |
| spec.passive.failover_ip.ipv4.subnet_mask | string | The subnet mask for the interface. This attribute was added in vSphere API 6.7.1. Optional. If unset and the prefix field is unset, then an error will be reported.If unset and the prefix field is set, then the prefix field will be used to create a subnet mask whose first prefix bits are 1 and the remaining bits 0.If both the subnet_mask field and the prefix field are set and they do not represent the same value, then an error will be reported. |
| spec.passive.failover_ip.ipv4.prefix | long | The CIDR prefix for the interface. This attribute was added in vSphere API 6.7.1. Optional. If unset and the subnet_mask field is unset, this an error will be reported.If unset and the subnet_mask field is set, then the subnet_mask field will be used.If both the subnet_mask field and the prefix field are set and they do not represent the same value, then an error will be reported. |
| spec.passive.failover_ip.ipv6 | ipv6_spec | If the family of the ip is IPV6, then this will point to IPv6 address specification. This attribute was added in vSphere API 6.7.1. Optional. It is only relevant when ip_family has value IPV6. This field is optional and it is only relevant when the value of ip_family is IP_v6. |
| spec.passive.failover_ip.ipv6.address | string | IPv6 address to be used to configure the interface. This attribute was added in vSphere API 6.7.1. |
| spec.passive.failover_ip.ipv6.prefix | long | The CIDR prefix for the interface. This attribute was added in vSphere API 6.7.1. |
| spec.passive.failover_ip.default_gateway | string | The IP address of the Gateway for this interface. This attribute was added in vSphere API 6.7.1. Optional. If unset, gateway will not be used for the network interface. |
| spec.passive.failover_ip.dns_servers | string[] | The list of IP addresses of the DNS servers for this interface. This list is a comma separated list. This attribute was added in vSphere API 6.7.1. Optional. If unset, DNS servers will not be used for the network interface. |
| spec.witness | witness_spec | Contains the witness node's placement configuration. This attribute was added in vSphere API 6.7.1. |
| spec.witness.placement | placement_spec | Contains the placement configuration of the node. This attribute was added in vSphere API 6.7.1. Optional. If unset, then it is assumed that the clone will be done manually by the customer. In this case, the placement configuration for the witness node should also be omitted. Only the network configuration will be setup. Once the passive and witness nodes are cloned from the active node, the VCHA high availability is turned on. |
| spec.witness.placement.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. |
| spec.witness.placement.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. |
| spec.witness.placement.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. |
| spec.witness.placement.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. |
| spec.witness.placement.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. |
| spec.witness.placement.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. |
| spec.witness.placement.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. |
| spec.witness.placement.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. |
| spec.witness.placement.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. |
| spec.witness.placement.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. |
| spec.witness.ha_ip | ip_spec | IP specification for the HA network. This attribute was added in vSphere API 6.7.1. |
| spec.witness.ha_ip.ip_family | string | Family of the IP address to configure the interface. This attribute was added in vSphere API 6.7.1. Defines the Ip address family. This enumeration was added in vSphere API 6.7.1. Value is one of: IPV4: IPV4 address family. This constant was added in vSphere API 6.7.1. IPV6: IPv6 address family. This constant was added in vSphere API 6.7.1. |
| spec.witness.ha_ip.ipv4 | ipv4_spec | If the family of the ip is IPV4, then this will point to IPv4 address specification. This attribute was added in vSphere API 6.7.1. Optional. It is only relevant when ip_family has value IPV4. This field is optional and it is only relevant when the value of ip_family is IP_v4. |
| spec.witness.ha_ip.ipv4.address | string | IPV4 address to be used to configure the interface. This attribute was added in vSphere API 6.7.1. |
| spec.witness.ha_ip.ipv4.subnet_mask | string | The subnet mask for the interface. This attribute was added in vSphere API 6.7.1. Optional. If unset and the prefix field is unset, then an error will be reported.If unset and the prefix field is set, then the prefix field will be used to create a subnet mask whose first prefix bits are 1 and the remaining bits 0.If both the subnet_mask field and the prefix field are set and they do not represent the same value, then an error will be reported. |
| spec.witness.ha_ip.ipv4.prefix | long | The CIDR prefix for the interface. This attribute was added in vSphere API 6.7.1. Optional. If unset and the subnet_mask field is unset, this an error will be reported.If unset and the subnet_mask field is set, then the subnet_mask field will be used.If both the subnet_mask field and the prefix field are set and they do not represent the same value, then an error will be reported. |
| spec.witness.ha_ip.ipv6 | ipv6_spec | If the family of the ip is IPV6, then this will point to IPv6 address specification. This attribute was added in vSphere API 6.7.1. Optional. It is only relevant when ip_family has value IPV6. This field is optional and it is only relevant when the value of ip_family is IP_v6. |
| spec.witness.ha_ip.ipv6.address | string | IPv6 address to be used to configure the interface. This attribute was added in vSphere API 6.7.1. |
| spec.witness.ha_ip.ipv6.prefix | long | The CIDR prefix for the interface. This attribute was added in vSphere API 6.7.1. |
| spec.witness.ha_ip.default_gateway | string | The IP address of the Gateway for this interface. This attribute was added in vSphere API 6.7.1. Optional. If unset, gateway will not be used for the network interface. |
| spec.witness.ha_ip.dns_servers | string[] | The list of IP addresses of the DNS servers for this interface. This list is a comma separated list. This attribute was added in vSphere API 6.7.1. Optional. If unset, DNS servers will not be used for the network interface. |
Response:
HTTP Status Code: 200
Representation:
{
"value" : "obj-103"
}
"value" : "obj-103"
}
Response Type:
| Name | Type | Description |
|---|---|---|
| bold = required | ||
| value | string | |
Errors:
| HTTP Status Code | Type | Description |
|---|---|---|
| 400 | invalid_argument | If the credentials provided for authenticating with the active node's management vCenter server are invalid. |
| 403 | unauthorized | If the user has insufficient privilege to perform the operation. Operation execution requires the Global.VCServer privilege. |
| 400 | unverified_peer | If the SSL certificate of the management vCenter server cannot be validated. The value of the data field of vapi.std.errors.error will be a structure that contains all the fields defined in vcenter.vcha.certificate_info. |
| 500 | error | If any other error occurs. |