Deploy Cluster Task Deprecated
Prepares, clones, and configures a VCHA cluster.
Request
URLURL
https://{api_host}/rest/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
VchaClusterDeployTaskRequestBody of mimetype application/json
Required
This is a request body class for an operation.
(The request body parameter is missing description)
{
"spec": {
"active": {
"ha_ip": {
"ip_family": "IPV4"
}
},
"deployment": "AUTO",
"passive": {
"ha_ip": {
"ip_family": "IPV4"
}
},
"witness": {
"ha_ip": {
"ip_family": "IPV4"
}
}
}
}
spec
Required
Contains the deploy specification for all three nodes of a VCHA cluster.
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK returns
VchaClusterDeployTaskResponseBody 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.
{
"value": "string"
}
string
value
Optional
Identifier for the task created by this API invocation.
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
cURL Command
curl -X POST -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"spec":{"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}/rest/vcenter/vcha/cluster?action=deploy&vmw-task=true
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-new-method: post
x-vmw-doc-new-path: /api/vcenter/vcha/cluster?action=deploy&vmw-task=true
x-vmw-doc-operation: deploy_task
Availability
Added in 6.7.1
