REST API - enable-task

esx settings hosts enablement software: enable-task

Enables the feature which manages 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

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

?vmw-task=true
{
    "skip_software_check"true
}

Path Parameters

Name Type Description
Required
host string Identifier of the host.

Body Parameters:

Name Type Description
bold = required
- enable_spec Optional. Enablement specification.
-.skip_software_check boolean Skip SOFTWARE check during feature enablement. 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

Errors:

HTTP Status Code Type Description
500 error If feature enablement failed for the given host. The value of the data field of vapi.std.errors.error will be a structure that contains all the fields defined in esx.settings.hosts.enablement.software.check_result.
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.