Developer Documentation
Scan Task Clusters Software Drafts
Released in v7.0.0Scans all the hosts in the cluster against the software draft. 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
URLURL
https://{api_host}/api/esx/settings/clusters/{cluster}/software/drafts/{draft}?action=scan&vmw-task=true
Path Parameters
Path Parameters
| Required | Parameter Name | Type | Description |
|---|---|---|---|
| required |
|
string | Identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource. |
| required |
|
string | Identifier of the working copy of the document. The parameter must be an identifier for the resource type: com.vmware.esx.settings.draft. |
Query Parameters
Query Parameters
| Required | Parameter Name | Type | Description |
|---|---|---|---|
| required |
|
string | vmw-task=true is set in order to call this as an async API. The return value then becomes the Task ID instead that is used to query the result from the Task API. |
Response
Response
Response BodyResponse Body
202 Accepted returns
string
of type application/json
Result of scan operation.
Errors
| Code | Returns | Description |
|---|---|---|
| 401 | Error | com.vmware.vapi.std.errors.unauthenticated : If the caller is not authenticated. |
| 404 | Error | com.vmware.vapi.std.errors.error : If there is unknown internal error. The accompanying error message will give more details about the failure. | com.vmware.vapi.std.errors.not_found : If there is no cluster associated with cluster or no draft associated with draft in the system. |
| 503 | Error | com.vmware.vapi.std.errors.service_unavailable : If the service is not available. |
| default | Error | Not available |
