REST API - check-task
  1. Operations
  2. esx
  3. settings
  4. hosts
  5. enablement
  6. software

esx settings hosts enablement software: check-task

Checks the possibility to manage the host with a single software specification. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Request:

HTTP request

POST https://{server}/api/esx/settings/hosts/{host}/enablement/software

?action=check
&vmw-task=true
{
    "checks_to_skip" : [
        "SOFTWARE",
        "SOFTWARE"
    ]
}

Path Parameters

Name Type Description
Required
host string Identifier of the host.

Body Parameters:

Name Type Description
bold = required
- check_spec Optional. Check specification.
-.checks_to_skip string[] Specifies the checks that should be skipped. If the set is empty, all checks will be performed. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Response:

HTTP Status Code: 202

Response Body Structure:

"obj-103"

Headers:

None

Type:

Name Type Description
bold = required
- string Result of the check.

Errors:

HTTP Status Code Type Description
500 error If there is some unknown error. The accompanying error message will give more details about the failure.
400 not_allowed_in_current_state If the feature is already enabled for the given host.
404 not_found If there is no host associated with host in the system.
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.