REST API - enable-task
  1. Operations
  2. esx
  3. settings
  4. clusters
  5. enablement
  6. software

esx settings clusters enablement software: enable-task

Enables the feature which manages the cluster with a single software specification.

Request:

HTTP request

PUT https://{server}/api/esx/settings/clusters/{cluster}/enablement/software

?vmw-task=true
{
    "skip_software_check" : true
}

Path Parameters

Name Type Description
Required
cluster string Identifier of the cluster.

Body Parameters:

Name Type Description
bold = required
- enable_spec Optional. Enablement specification.
-.skip_software_check boolean Skip SOFTWARE check during feature enablement.

Response:

HTTP Status Code: 202

Response Body Structure:

"obj-103"

Headers:

None

Type:

Name Type Description
bold = required
- string

Errors:

HTTP Status Code Type Description
500 error If feature enablement failed for the given cluster. The value of the data field of vapi.std.errors.error will be a structure that contains all the fields defined in esx.settings.clusters.enablement.software.check_result.
400 not_allowed_in_current_state If the feature is already enabled for the given cluster.
404 not_found If there is no cluster associated with cluster in the system
503 service_unavailable If the service is not available.
401 unauthenticated If the caller is not authenticated.