Precheck Clusters Configuration Task
This API will perform precheck of the desired cluster configuration on each of the hosts in the cluster. The API will check against the desired image schema whether the desired configuration has added any requirements for the host to be put in maintenance mode or to be rebooted. The API will also invoke plugins provided by the configuration owner to detect if the host needs to be put in maintenance mode or to be rebooted. If any host needs to be put in maintenance mode or rebooted, prechecks will be performed at the cluster and host level. The result will specify the validation errors if the desired configuration is not valid on the host. If valid, the result will specify host impact of the desired configuration, and list the configurations that will change on applying the desired configuration. If host impact is maintenance mode or reboot, precheck results will also be specified in the result.
Request
URLURL
https://{api_host}/api/esx/settings/clusters/{cluster}/configuration?action=precheck&vmw-task=true
Path Parameters
Path Parameters
string
cluster
Required
The cluster on which to perform precheck. The parameter must be an identifier for the resource type: ClusterComputeResource.
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"
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. This output structure of type com.vmware.esx.settings.clusters.Configuration#ClusterPrecheckResult represents results of the impact analysis and precheck executed on each of the hosts for the desired configuration. If the precheck could not be performed on a host, the com.vmware.esx.settings.clusters.Configuration.ClusterPrecheckResult#hostStatus map will contain the reason.
Errors
400
com.vmware.vapi.std.errors.invalid_argument : If API is called on a cluster that is not managed by desired configuration management platform.
500
com.vmware.vapi.std.errors.error : The server encountered an unexpected condition which prevented it from fulfilling the request. | com.vmware.vapi.std.errors.timed_out : If the API timed out before completion.
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
Invoke-PrecheckClusterConfigurationAsync -Cluster "MyCluster"
cURL Command
curl -X POST -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/esx/settings/clusters/{cluster}/configuration?action=precheck&vmw-task=true
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: precheck_task
Availability
Added in 8.0.1.0
