Check Clusters Enablement Software Task
Checks the possibility to manage the cluster with a single software specification.
Request
URLURL
https://{api_host}/api/esx/settings/clusters/{cluster}/enablement/software?action=check&vmw-task=true
Path Parameters
Path Parameters
string
cluster
Required
Identifier of the cluster. 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"
Request Body
Request Body
SettingsClustersEnablementSoftwareCheckSpec of mimetype application/json
Optional
Check specification. If unset, all checks are performed.
{
"checks_to_skip": "SOFTWARE"
}
checks_to_skip
Required
The Software.CheckType enumerated type contains various checks to identify the possibility to enable the feature that manages the cluster with a single software specification.
SOFTWARE : Perform host software check. This check is to report standalone VIBs (VIBs which are not part of any component) and the features on the given cluster that cannot coexist with the feature which manages the cluster with a single software specification.
VERSION : Perform host version check. This feature does not support hosts with version less than XYZ.
STATELESSNESS : Perform host statelessness check. This feature does not support stateless hosts.
VUM_REMEDIATION : Perform VUM active remediation check.
SOFTWARE_SPECIFICATION_EXISTENCE : Perform cluster’s software specification existence check.
VSAN_WITNESS_ELIGIBILITY : Checks to verify if the cluster software specification can be used to manage any vSAN witness hosts in the cluster.
Possible values are: SOFTWARE , VERSION , STATELESSNESS , VUM_REMEDIATION , SOFTWARE_SPECIFICATION_EXISTENCE
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. The result of the check operation
Errors
400
com.vmware.vapi.std.errors.not_allowed_in_current_state : If the feature is already enabled for the given cluster.
404
com.vmware.vapi.std.errors.not_found : If there is no cluster associated with cluster in the system.
500
com.vmware.vapi.std.errors.error : If there is some unknown error. The accompanying error message will give more details about the failure.
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
$SettingsClustersEnablementSoftwareCheckSpec = Initialize-SettingsClustersEnablementSoftwareCheckSpec -ChecksToSkip "SOFTWARE"
Invoke-CheckClusterEnablementSoftwareAsync -Cluster "MyCluster" -SettingsClustersEnablementSoftwareCheckSpec $SettingsClustersEnablementSoftwareCheckSpec
cURL Command
curl -X POST -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"checks_to_skip":"SOFTWARE"}' https://{api_host}/api/esx/settings/clusters/{cluster}/enablement/software?action=check&vmw-task=true
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: check_task
Availability
Added in 7.0.0.0
