Esx Settings Hosts Software check$Task
Runs checks on the host before applying the desired software document.
Checks if host is in a good state to be updated with the desired software document. If commit property is set it implies the minimum commit that the check operation should use, however if subsequent commits have been made to the desired state document the check 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.ReadandVcIntegrity.lifecycleHealth.Read. - The resource
HostSystemreferenced by the parameter host requiresVcIntegrity.lifecycleSoftwareRemediation.ReadandVcIntegrity.lifecycleHealth.Read.
Identifier of the host.
The parameter must be an identifier for the resource type: HostSystem.
Check specification.
{
"commit": "string"
}The minimum commit identifier of the desired software document to be used during the check operation.
This property was added in vSphere API 8.0.0.1.
if missing or null or empty the check opertion 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.
The results of all checks performed.
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 or if the commit property of spec specifies a commit that has already been applied.
Vapi Std Errors Unsupported If the host is not a vLCM managed standlone host.
"Vapi Std Errors Error Object"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.
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.
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.
If the caller is not authenticated.
"Vapi Std Errors Unauthenticated Object"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.
If there is no host associated with host in the system.
"Vapi Std Errors NotFound Object"Vapi Std Errors Error If there is unknown internal error. The accompanying error message will give more details about the failure.
Vapi Std Errors TimedOut If the operation times out.
"Vapi Std Errors Error Object"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.
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.
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.
If the service is not available.
"Vapi Std Errors ServiceUnavailable Object" curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{}' https://{api_host}/api/esx/settings/hosts/{host}/software?action=check&vmw-task=true