REST API - scan-task

esx settings hosts software: scan-task

Scans the host against the host'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/hosts/{host}/software

?action=scan
&vmw-task=true

Path Parameters

Name Type Description
Required
host string Identifier of the host.

Response:

HTTP Status Code: 202

Response Body Structure:

"obj-103"

Headers:

None

Type:

Name Type Description
bold = required
- string Compliance result of the host.

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 host associated with host 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.
400 unsupported If the host is not a standlone host, but instead part of a cluster.