Vcenter Vcha Cluster Passive check
Validates the specified passive node's placement configuration.
This operation was added in vSphere API 6.7.1.
Contains the passive node's placement specification.
Show optional properties
{
"placement": {}
}{
"vc_spec": {
"active_location": {
"hostname": "string",
"port": 0,
"ssl_thumbprint": "string",
"ssl_certificate": "string",
"username": "string",
"password": "string"
}
},
"placement": {
"name": "string",
"folder": "string",
"host": "string",
"resource_pool": "string",
"ha_network_type": "string",
"ha_network": "string",
"management_network_type": "string",
"management_network": "string",
"storage": {
"datastore": "string"
}
}
}Contains the active node's management vCenter server credentials.
This property was added in vSphere API 6.7.1.
If missing or null, 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.
Contains the node's placement information for validation.
This property was added in vSphere API 6.7.1.
CheckResult structure containing errors and warnings.
"Vcenter Vcha Cluster Passive CheckResult Object"A list of problems which may require attention, but which are not fatal.
This property was added in vSphere API 6.7.1.
A list of problems which are fatal to the operation and the operation will fail.
This property was added in vSphere API 6.7.1.
Vapi Std Errors InvalidArgument:
- 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.
Vapi Std Errors UnverifiedPeer If the SSL certificate of the management vCenter server cannot be validated.
The value of the data property of Vapi Std Errors Error will be a schema that contains all the properties defined in Vcenter Vcha CertificateInfo.
Vapi Std Errors InvalidElementConfiguration If the active node is on more than one datastore.
Vapi Std Errors NotAllowedInCurrentState If the clone operation is not allowed in the current state of the system.
"Vapi Std Errors Error Object"Stack of one or more localizable messages for human error consumers.
The message at the top of the stack (first in the list) describes the error from the perspective of the operation the client invoked.
Each subsequent message in the stack describes the "cause" of the prior message.
Data to facilitate clients responding to the operation reporting a standard error to indicating that it was unable to complete successfully.
Operations may provide data that clients can use when responding to errors. Since the data that clients need may be specific to the context of the operation reporting the error, different operations that report the same error may provide different data in the error. The documentation for each each operation will describe what, if any, data it provides for each error it reports.
The Vapi Std Errors ArgumentLocations, Vapi Std Errors FileLocations, and Vapi Std Errors TransientIndication schemas are intended as possible values for this property. Vapi Std DynamicID may also be useful as a value for this property (although that is not its primary purpose). Some resources may provide their own specific schemas for use as the value of this property when reporting errors from their operations.
Some operations will not set this property when reporting errors.
Discriminator field to help API consumers identify the structure type.
For more information see: Vapi Std Errors Error Type.
This property was added in vSphere API 6.7.2.
Can be missing or null for compatibility with preceding implementations.
If the user has insufficient privilege to perform the operation. Operation execution requires the Global.VCServer privilege.
"Vapi Std Errors Unauthorized Object"If the active virtual machine is not managed by the specified vCenter server for the active node.
"Vapi Std Errors NotFound Object"If any other error occurs.
"Vapi Std Errors Error Object"Stack of one or more localizable messages for human error consumers.
The message at the top of the stack (first in the list) describes the error from the perspective of the operation the client invoked.
Each subsequent message in the stack describes the "cause" of the prior message.
Data to facilitate clients responding to the operation reporting a standard error to indicating that it was unable to complete successfully.
Operations may provide data that clients can use when responding to errors. Since the data that clients need may be specific to the context of the operation reporting the error, different operations that report the same error may provide different data in the error. The documentation for each each operation will describe what, if any, data it provides for each error it reports.
The Vapi Std Errors ArgumentLocations, Vapi Std Errors FileLocations, and Vapi Std Errors TransientIndication schemas are intended as possible values for this property. Vapi Std DynamicID may also be useful as a value for this property (although that is not its primary purpose). Some resources may provide their own specific schemas for use as the value of this property when reporting errors from their operations.
Some operations will not set this property when reporting errors.
Discriminator field to help API consumers identify the structure type.
For more information see: Vapi Std Errors Error Type.
This property was added in vSphere API 6.7.2.
Can be missing or null for compatibility with preceding implementations.
curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"placement":"{}"}' https://{api_host}/api/vcenter/vcha/cluster/passive?action=check