Esx Settings Hosts Software apply$Task

Esx Settings Hosts Software apply$Task

Applies the desired software document associated with the given host.

If commit property is set, it implies the minimum commit that the POST /esx/settings/hosts/{host}/software?action=apply operation should use, however if subsequent commits have been made to the desired state document the apply operation will use the most recent desired state document. 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.

This operation was added in vSphere API 8.0.0.1.

Returns an authorization error if you do not have all of the privileges described as follows:

  • Operation execution requires VcIntegrity.lifecycleSoftwareRemediation.Write and VcIntegrity.lifecycleHealth.Read.
  • The resource HostSystem referenced by the parameter host requires VcIntegrity.lifecycleSoftwareRemediation.Write and VcIntegrity.lifecycleHealth.Read.
Request
URI
POST
https://{api_host}/api/esx/settings/hosts/{host}/software?action=apply&vmw-task=true
COPY
Path Parameters
string
host
Required

Identifier of the host.

The parameter must be an identifier for the resource type: HostSystem.


Request Body

Apply specification.

Esx Settings Hosts Software ApplySpec of type(s) application/json
Required
{
    "commit": "string",
    "accept_eula": false
}
string
commit
Optional

The minimum commit identifier of the desired software document to be used during the POST /esx/settings/hosts/{host}/software?action=apply operation.

This property was added in vSphere API 8.0.0.1.

if missing or null or empty the apply operation will use the latest commit to fetch the desired state document.

When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: com.vmware.esx.settings.commit. When operations return a value of this schema as a response, the property will be an identifier for the resource type: com.vmware.esx.settings.commit.

boolean
accept_eula
Optional

Accept the VMware End User License Agreement (EULA) before starting the POST /esx/settings/hosts/{host}/software?action=apply operation.

The VMware EULA is available for download at, https://www.vmware.com/download/eula.html

This property was added in vSphere API 8.0.0.1.

if missing or null the POST /esx/settings/hosts/{host}/software?action=apply operation could fail due to the EULA not being accepted.

Authentication
This operation uses the following authentication methods.
Responses
202

The result of the POST /esx/settings/hosts/{host}/software?action=apply operation.

Returns string of type(s) application/json
Operation doesn't return any data structure

400

Vapi Std Errors AlreadyInDesiredState If the host is already at specified commit as described in the apply specification.

Vapi Std Errors InvalidArgument If the commit property of spec specifies an invalid commit.

Vapi Std Errors NotAllowedInCurrentState If there is another operation in progress.

Vapi Std Errors Unsupported If the host is not a vLCM managed standlone host.

Returns Vapi Std Errors Error of type(s) application/json
"Vapi Std Errors Error Object"
array of object
messages
Required

Stack of one or more localizable messages for human error consumers.

The message at the top of the stack (first in the list) describes the error from the perspective of the operation the client invoked.

Each subsequent message in the stack describes the "cause" of the prior message.

object
data
Optional

Data to facilitate clients responding to the operation reporting a standard error to indicating that it was unable to complete successfully.

Operations may provide data that clients can use when responding to errors. Since the data that clients need may be specific to the context of the operation reporting the error, different operations that report the same error may provide different data in the error. The documentation for each each operation will describe what, if any, data it provides for each error it reports.

The Vapi Std Errors ArgumentLocations, Vapi Std Errors FileLocations, and Vapi Std Errors TransientIndication schemas are intended as possible values for this property. Vapi Std DynamicID may also be useful as a value for this property (although that is not its primary purpose). Some resources may provide their own specific schemas for use as the value of this property when reporting errors from their operations.

Some operations will not set this property when reporting errors.

string
error_type
Required

Discriminator field to help API consumers identify the structure type.

For more information see: Vapi Std Errors Error Type.

This property was added in vSphere API 6.7.2.

Can be missing or null for compatibility with preceding implementations.


401

If the caller is not authenticated.

Returns Vapi Std Errors Unauthenticated of type(s) application/json
This response body class contains all of the following: InlineVapi Std Errors Unauthenticated0
"Vapi Std Errors Unauthenticated Object"
string
challenge
Optional

Indicates the authentication challenges applicable to the target API provider. It can be used by a client to discover the correct authentication scheme to use. The exact syntax of the value is defined by the specific provider, the protocol and authentication schemes used.

For example, a provider using REST may adhere to the WWW-Authenticate HTTP header specification, RFC7235, section 4.1. In this case an example challenge value may be: SIGN realm="27da1358-2ba4-11e9-b210-d663bd873d93",sts="http://vcenter/sso?vsphere.local", Basic realm="vCenter"

This property was added in vSphere API 7.0.0.0.

This property is optional because it was added in a newer version than its parent node.


404

If there is no host associated with host in the system or if desired software document is not found.

Returns Vapi Std Errors NotFound of type(s) application/json
This response body class contains all of the following: InlineVapi Std Errors NotFound0
"Vapi Std Errors NotFound Object"

500

Vapi Std Errors Error If there is an unknown internal error or if the EULA has not been accepted. The accompanying error message will give more details about the failure.

Vapi Std Errors TimedOut If the operation times out.

Returns Vapi Std Errors Error of type(s) application/json
"Vapi Std Errors Error Object"
array of object
messages
Required

Stack of one or more localizable messages for human error consumers.

The message at the top of the stack (first in the list) describes the error from the perspective of the operation the client invoked.

Each subsequent message in the stack describes the "cause" of the prior message.

object
data
Optional

Data to facilitate clients responding to the operation reporting a standard error to indicating that it was unable to complete successfully.

Operations may provide data that clients can use when responding to errors. Since the data that clients need may be specific to the context of the operation reporting the error, different operations that report the same error may provide different data in the error. The documentation for each each operation will describe what, if any, data it provides for each error it reports.

The Vapi Std Errors ArgumentLocations, Vapi Std Errors FileLocations, and Vapi Std Errors TransientIndication schemas are intended as possible values for this property. Vapi Std DynamicID may also be useful as a value for this property (although that is not its primary purpose). Some resources may provide their own specific schemas for use as the value of this property when reporting errors from their operations.

Some operations will not set this property when reporting errors.

string
error_type
Required

Discriminator field to help API consumers identify the structure type.

For more information see: Vapi Std Errors Error Type.

This property was added in vSphere API 6.7.2.

Can be missing or null for compatibility with preceding implementations.


503

If the service is not available.

Returns Vapi Std Errors ServiceUnavailable of type(s) application/json
This response body class contains all of the following: InlineVapi Std Errors ServiceUnavailable0
"Vapi Std Errors ServiceUnavailable Object"

Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{}' https://{api_host}/api/esx/settings/hosts/{host}/software?action=apply&vmw-task=true