This API has a deprecated equivalent from v7.0U1.
Check Cluster Witness
Validates the specified witness node’s placement configuration.
Request
URLURL
https://{api_host}/api/vcenter/vcha/cluster/witness?action=check
Header Parameters
Header Parameters
string
vmware-api-session-id
Required
Required session ID, obtained by first calling Create Session API
vmware-api-session-id example
b00db39f948d13ea1e59b4d6fce56389
Request Body
Request Body
VchaClusterWitnessCheckSpec of mimetype application/json
Required
Contains the witness node's placement specification.
{
"placement": {
"folder": "string",
"name": "string"
}
}
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.
Response
Response
Response BodyResponse Body
200 OK returns
VchaClusterWitnessCheckResult of type application/json
CheckResult structure containing errors and warnings.
{
"errors": [
{
"args": [
"string"
],
"default_message": "string",
"id": "string",
"localized": "string",
"params": {
"key": {
"d": 0,
"dt": "string",
"format": "enum",
"i": 0,
"l": {
"id": "string",
"params": "StdLocalizationParam Object"
},
"precision": 0,
"s": "string"
}
}
}
],
"warnings": [
{
"args": [
"string"
],
"default_message": "string",
"id": "string",
"localized": "string",
"params": {
"key": {
"d": 0,
"dt": "string",
"format": "enum",
"i": 0,
"l": {
"id": "string",
"params": "StdLocalizationParam Object"
},
"precision": 0,
"s": "string"
}
}
}
]
}
array of
StdLocalizableMessage
errors
Required
A list of problems which are fatal to the operation and the operation will fail.
array of
StdLocalizableMessage
warnings
Required
A list of problems which may require attention, but which are not fatal.
cURL Command
curl -X POST -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"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}/api/vcenter/vcha/cluster/witness?action=check
Errors
400
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.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. | com.vmware.vapi.std.errors.invalid_element_configuration : If the active node is on more than one datastore. | com.vmware.vapi.std.errors.not_allowed_in_current_state : If the clone operation is not allowed in the current state of the system.
403
com.vmware.vapi.std.errors.unauthorized : If the user has insufficient privilege to perform the operation. Operation execution requires the Global.VCServer privilege.
404
com.vmware.vapi.std.errors.not_found : If the active virtual machine is not managed by the specified vCenter server for the active node.
Availability
Added in 7.0U2
