This API has a deprecated equivalent from v7.0U1.
Deploy Cluster Task
Prepares, clones, and configures a VCHA cluster.
Request
URLURL
https://{api_host}/api/vcenter/vcha/cluster?action=deploy&vmw-task=true
Header Parameters
Header Parameters
string
vmware-api-session-id
Required
Required session ID, acquired from Create Session API under CIS product
vmware-api-session-id example
"b00db39f948d13ea1e59b4d6fce56389"
Request Body
Request Body
VchaClusterDeploySpec of mimetype application/json
Required
Contains the deploy specification for all three nodes of a VCHA cluster.
{
"active": {
"ha_ip": {
"ip_family": "IPV4"
}
},
"deployment": "AUTO",
"passive": {
"ha_ip": {
"ip_family": "IPV4"
}
},
"witness": {
"ha_ip": {
"ip_family": "IPV4"
}
}
}
deployment
Required
The Cluster.Type enumerated type defines the possible deployment types for a VCHA Cluster.
AUTO : Passive and witness nodes are cloned automatically.
MANUAL : Passive and witness nodes are not cloned automatically. After deployment, the customer should clone the passive and witness virtual machines.
Possible values are: AUTO , MANUAL
vc_spec
Optional
Contains the active node’s management vCenter server credentials. 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.
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
202 Accepted returns
string
of type application/json
An identifier for the task created by this API invocation will be returned. If the non-async version of the operation returns a value, this id can be used with the CIS Get Task operation to fetch that value. The normal description of this operation’s return value will follow if one exists.
Errors
400
com.vmware.vapi.std.errors.invalid_argument : If the credentials provided for authenticating with the active node’s management vCenter server are invalid. | com.vmware.vapi.std.errors.unverified_peer : If the SSL certificate of the management vCenter server cannot be validated. The value of the data field of Error will be a structure that contains all the fields defined in CertificateInfo.
403
com.vmware.vapi.std.errors.unauthorized : If the user has insufficient privilege to perform the operation. Operation execution requires the Global.VCServer privilege.
default
‘Default’ means this response is used for all HTTP codes that are not covered individually for this operation.
Code Samples
PowerCLI Client SDK Example
$VchaIpSpec = Initialize-VchaIpSpec -IpFamily "IPV4"
$VchaClusterActiveSpec = Initialize-VchaClusterActiveSpec -HaIp $VchaIpSpec
$VchaClusterPassiveSpec = Initialize-VchaClusterPassiveSpec -HaIp $VchaIpSpec
$VchaClusterWitnessSpec = Initialize-VchaClusterWitnessSpec -HaIp $VchaIpSpec
$VchaClusterDeploySpec = Initialize-VchaClusterDeploySpec -Deployment "AUTO" -Active $VchaClusterActiveSpec -Passive $VchaClusterPassiveSpec -Witness $VchaClusterWitnessSpec
Invoke-DeployVchaClusterAsync -VchaClusterDeploySpec $VchaClusterDeploySpec
PowerCLI Client SDK All Parameters Example
$VchaConnectionSpec = Initialize-VchaConnectionSpec -Hostname "MyHostname" -Port 0 -SslThumbprint "MySslThumbprint" -Username "MyUsername" -Password "MyPassword"
$VchaCredentialsSpec = Initialize-VchaCredentialsSpec -ActiveLocation $VchaConnectionSpec
$VchaIpv4Spec = Initialize-VchaIpv4Spec -Address "MyAddress" -SubnetMask "MySubnetMask" -Prefix 0
$VchaIpv6Spec = Initialize-VchaIpv6Spec -Address "MyAddress" -Prefix 0
$VchaIpSpec = Initialize-VchaIpSpec -IpFamily "IPV4" -Ipv4 $VchaIpv4Spec -Ipv6 $VchaIpv6Spec -DefaultGateway "MyDefaultGateway" -DnsServers "MyDnsServers"
$VchaClusterActiveSpec = Initialize-VchaClusterActiveSpec -HaNetworkType "STANDARD_PORTGROUP" -HaNetwork "MyHaNetwork" -HaIp $VchaIpSpec
$VchaDiskSpec = Initialize-VchaDiskSpec -Datastore "MyDatastore"
$VchaPlacementSpec = Initialize-VchaPlacementSpec -Name "MyName" -Folder "MyFolder" -VarHost "MyVarHost" -ResourcePool "MyResourcePool" -HaNetworkType "STANDARD_PORTGROUP" -HaNetwork "MyHaNetwork" -ManagementNetworkType "STANDARD_PORTGROUP" -ManagementNetwork "MyManagementNetwork" -Storage $VchaDiskSpec
$VchaClusterPassiveSpec = Initialize-VchaClusterPassiveSpec -Placement $VchaPlacementSpec -HaIp $VchaIpSpec -FailoverIp $VchaIpSpec
$VchaClusterWitnessSpec = Initialize-VchaClusterWitnessSpec -Placement $VchaPlacementSpec -HaIp $VchaIpSpec
$VchaClusterDeploySpec = Initialize-VchaClusterDeploySpec -VcSpec $VchaCredentialsSpec -Deployment "AUTO" -Active $VchaClusterActiveSpec -Passive $VchaClusterPassiveSpec -Witness $VchaClusterWitnessSpec
Invoke-DeployVchaClusterAsync -VchaClusterDeploySpec $VchaClusterDeploySpec
cURL Command
curl -X POST -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"active":{"ha_ip":{"default_gateway":"string","dns_servers":["string"],"ip_family":"IPV4","ipv4":{"address":"string","prefix":0,"subnet_mask":"string"},"ipv6":{"address":"string","prefix":0}},"ha_network":"string","ha_network_type":"STANDARD_PORTGROUP"},"deployment":"AUTO","passive":{"failover_ip":{"default_gateway":"string","dns_servers":["string"],"ip_family":"IPV4","ipv4":{"address":"string","prefix":0,"subnet_mask":"string"},"ipv6":{"address":"string","prefix":0}},"ha_ip":{"default_gateway":"string","dns_servers":["string"],"ip_family":"IPV4","ipv4":{"address":"string","prefix":0,"subnet_mask":"string"},"ipv6":{"address":"string","prefix":0}},"placement":{"folder":"string","ha_network":"string","ha_network_type":"STANDARD_PORTGROUP","host":"string","management_network":"string","management_network_type":"STANDARD_PORTGROUP","name":"string","resource_pool":"string","storage":{"datastore":"string"}}},"vc_spec":{"active_location":{"hostname":"string","password":"string","port":0,"ssl_thumbprint":"string","username":"string"}},"witness":{"ha_ip":{"default_gateway":"string","dns_servers":["string"],"ip_family":"IPV4","ipv4":{"address":"string","prefix":0,"subnet_mask":"string"},"ipv6":{"address":"string","prefix":0}},"placement":{"folder":"string","ha_network":"string","ha_network_type":"STANDARD_PORTGROUP","host":"string","management_network":"string","management_network_type":"STANDARD_PORTGROUP","name":"string","resource_pool":"string","storage":{"datastore":"string"}}}}' https://{api_host}/api/vcenter/vcha/cluster?action=deploy&vmw-task=true
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-deprecated-method: post
x-vmw-doc-deprecated-path: /rest/vcenter/vcha/cluster?action=deploy&vmw-task=true
x-vmw-doc-operation: deploy_task
Availability
Added in 7.0U2
