REST API - scan-task

esx settings internal summary: scan-task

Scans all the clusters to get their compliance information against its respective desired state.

Request:

HTTP request

POST https://{server}/api/esx/settings/internal/summary

?folder={obj-103}
&datacenter={obj-103}
&action=scan
&vmw-task=true

Query Parameters:

Name Type Description
bold = required
folder string Identifier of the folder entity. Exactly one of folder or datacenter must be specified.

Optional. either folder or datacenter are unset, the default root entity will be vcenter.When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: Folder. When operations return a value of this structure as a result, the field will be an identifier for the resource type: Folder.

datacenter string Identifier of the datacenter entity Exactly one of folder or datacenter must be specified.

Optional. either folder or datacenter are unset, the default root entity will be vcenter.When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: Datacenter. When operations return a value of this structure as a result, the field will be an identifier for the resource type: Datacenter.

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 there is unknown internal error. The accompanying error message will give more details about the failure.
404 not_found If there is no entity found in the system.
503 service_unavailable If the service is not available.
401 unauthenticated If the caller is not authenticated.