Check Cluster Passive
If vSphere APIs begin with /rest, maps are consumed and emitted as lists of objects containing a key:value pair.
Validates the specified passive node’s placement configuration.
Request
URLURL
https://{api_host}/rest/vcenter/vcha/cluster/passive?action=check
Header Parameters
Header Parameters
| Required | Parameter Name | Type | Description |
|---|---|---|---|
| required |
|
string | Required session ID, obtained by first calling Create Session API |
Request Body
Request Body
Contains VchaClusterPassiveCheckRequestBody
of type application/json
(required)
{
"spec": {
"placement": {
"folder": "string",
"name": "string"
}
}
}| Required | Property Name | Type | Description |
|---|---|---|---|
| required | spec | VchaClusterPassiveCheckSpec |
Contains the passive node’s placement specification. |
Response
Response
Response BodyResponse Body
200 OK returns
VchaClusterPassiveCheckResponseBody
of type application/json
CheckResult structure containing errors and warnings.
{
"value": {}
}| Property Name | Type | Description |
|---|---|---|
| value | VchaClusterPassiveCheckResult |
CheckResult structure containing errors and warnings. |
cURL Command
curl -X POST -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"spec":{"placement":{"folder":"string","ha_network":"string","ha_network_type":"enum","host":"string","management_network":"string","management_network_type":"enum","name":"string","resource_pool":"string","storage":{"datastore":"string"}},"vc_spec":{"active_location":{"hostname":"string","password":"string","port":0,"ssl_thumbprint":"string","username":"string"}}}}' https://{api_host}/rest/vcenter/vcha/cluster/passive?action=check
Errors
| Code | Returns | Description |
|---|---|---|
| 403 | ErrorRest | 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. |
| 404 | ErrorRest | com.vmware.vapi.std.errors.not_found : If the active virtual machine is not managed by the specified vCenter server for the active node. | com.vmware.vapi.std.errors.error : If any other error occurs. |
| 409 | ErrorRest | com.vmware.vapi.std.errors.not_allowed_in_current_state : If the clone operation is not allowed in the current state of the system. |
| default | ErrorRest | Not available |
| 400 | ErrorRest | com.vmware.vapi.std.errors.invalid_argument : If the credentials provided for authentincating with the active node's management vCenter server are invalid. If the specified resource spec is deemed invalid for the clone operation. | com.vmware.vapi.std.errors.invalid_element_configuration : If the active node is on more than one datastore. |
| 401 | ErrorRest | com.vmware.vapi.std.errors.unauthorized : If the user has insufficient privilege to perform the operation. Operation execution requires the Global.VCServer privilege. |
