Esx Settings Inventory CheckSpec

The Esx Settings Inventory CheckSpec schema contains properties that describe the specification to be used for checking the desired software specification to a group of inventories.

This schema was added in vSphere API 9.0.0.0.

JSON Example

{
    "software_spec": "string",
    "entities": {
        "type": "string",
        "hosts": [
            "string"
        ],
        "clusters": [
            "string"
        ],
        "folders": [
            "string"
        ],
        "datacenters": [
            "string"
        ]
    },
    "perspective": "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.

string

perspective

Optional

Specifies the upgrade perspective to be used for performing checks. This field is mainly intended for VMware Cloud Foundation (VCF) environment. For VMware vSphere Foundation (VVF) environment, configuring this field is not required.

For more information see: Esx Settings Inventory CheckSpec Perspective.

This property was added in vSphere API 9.1.0.0.

Only set if specific VCF upgrade workflow perspective to be used to perform checks. If missing or null all the checks would be performed on entities.

Parameter To

Esx Settings Inventory check$Task