REST API - apply-task
  1. Operations
  2. esx
  3. settings
  4. clusters
  5. software
  6. ha internal

esx settings clusters software ha internal: apply-task

Applies the HA Component specified in the desired specification document to the hosts in the cluster.

Request:

HTTP request

POST https://{server}/api/esx/settings/clusters/{cluster}/software/ha-internal

?action=apply
&vmw-task=true

Path Parameters

Name Type Description
Required
cluster string Identifier of the cluster.

Response:

HTTP Status Code: 202

Response Body Structure:

"obj-103"

Headers:

None

Type:

Name Type Description
bold = required
- string The result of apply operation.

Errors:

HTTP Status Code Type Description
400 already_in_desired_state If the HA component is already at a desired spec.
500 error If there is an unknown internal error. The accompanying error message will give more details about the failure.
400 invalid_argument If the cluster is not valid.
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.