Esx Settings Inventory check$Task

Runs checks on the inventories against the provided software specification or the assigned software specification before applying the desired software specification across all hosts in the inventories.

Checks if all hosts in the inventories are in a good state to be updated with the provided software specification by identifier or the assigned desired software specifications.

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 9.0.0.0.

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

Operation execution requires VcIntegrity.lifecycleSettings.Read.
The resource HostSystem referenced by the property Esx Settings Inventory EntitySpec.hosts requires VcIntegrity.lifecycleSettings.Read.
The resource ClusterComputeResource referenced by the property Esx Settings Inventory EntitySpec.clusters requires VcIntegrity.lifecycleSettings.Read.
The resource Datacenter referenced by the property Esx Settings Inventory EntitySpec.datacenters requires VcIntegrity.lifecycleSettings.Read.
The resource Folder referenced by the property Esx Settings Inventory EntitySpec.folders requires VcIntegrity.lifecycleSettings.Read.

Request

URI

POST

https://{api_host}/api/esx/settings/inventory?action=check&vmw-task=true

COPY

Request Body

The specification for check operation.

Esx Settings Inventory CheckSpec of type(s) application/json

Required

Show optional properties

{
    "entities": {}
}

{
    "software_spec": "string",
    "entities": {
        "type": "string",
        "hosts": [
            "string"
        ],
        "clusters": [
            "string"
        ],
        "folders": [
            "string"
        ],
        "datacenters": [
            "string"
        ]
    }
}

string

software_spec

Optional

The optional software specification identifier.

This property was added in vSphere API 9.0.0.0.

if missing or null the assigned software specifications will be checked against.

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.repository.software_spec. 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.repository.software_spec.

entities

Required

The entities containing the hosts to be checked.

This property was added in vSphere API 9.0.0.0.

Authentication

This operation uses the following authentication methods.

api_key_auth

Responses

202

The result summaries of the com.vmware.esx.settings.repository.Inventory#check operation for the inventories.

Returns string of type(s) application/json

Operation doesn't return any data structure

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.

403

If the caller does not have the necessary privileges.

Returns Vapi Std Errors Unauthorized of type(s) application/json

This response body class contains all of the following: InlineVapi Std Errors Unauthorized0

"Vapi Std Errors Unauthorized Object"

404

If some of the provided inventories doesn't exist.

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 unknown internal error. 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 '{"entities":"{}"}' https://{api_host}/api/esx/settings/inventory?action=check&vmw-task=true

On This Page

Description

Request

Request Body

Authentication

Response

202 Response Body

Errors

Esx Settings Operations

POST

Esx Settings Inventory apply$Task

POST