REST API - scan-task
  1. Operations
  2. esx
  3. settings
  4. clusters
  5. software

esx settings clusters software: scan-task

Scans all the hosts in the cluster against the cluster's desired state. The result of this operation can be queried by calling the cis/tasks/{task-id} where the task-id is the response of this operation.

Request:

HTTP request

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

?action=scan
&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 Compliance result for the cluster.

Errors:

HTTP Status Code Type Description
500 error If there is unknown internal error. The accompanying error message will give more details about the failure.
404 not_found If there is no cluster associated with cluster in the system or if desired software document is not found.
503 service_unavailable If the service is not available.
401 unauthenticated If the caller is not authenticated.