Enable Clusters Enablement Software Task
Enables the feature which manages the cluster with a single software specification.
Request
URLURL
https://{api_host}/api/esx/settings/clusters/{cluster}/enablement/software?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
SettingsClustersEnablementSoftwareEnableSpec of mimetype application/json
Optional
Enablement specification. If unset, all checks are performed.
{
"skip_software_check": false
}
boolean
skip_software_check
Required
Skip SOFTWARE check during feature enablement.
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.
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 feature enablement failed for the given cluster. The value of the data field of Error will be a structure that contains all the fields defined in Software.CheckResult.
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
$SettingsClustersEnablementSoftwareEnableSpec = Initialize-SettingsClustersEnablementSoftwareEnableSpec -SkipSoftwareCheck $false
Invoke-SetClusterEnablementSoftwareAsync -Cluster "MyCluster" -SettingsClustersEnablementSoftwareEnableSpec $SettingsClustersEnablementSoftwareEnableSpec
cURL Command
curl -X PUT -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"skip_software_check":false}' https://{api_host}/api/esx/settings/clusters/{cluster}/enablement/software?vmw-task=true
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: enable_task
Availability
Added in 7.0.0.0
