Esx.Settings.Inventory.CheckSpec

Esx.Settings.Inventory.CheckSpec
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.

Possible values:

  • GENERAL_UPGRADE_READINESS: Represents the initial readiness evaluation phase. This perspective checks whether the entity meets the required health criteria and passes all relevant eligibility checks to begin the upgrade process.
  • UPGRADE_PLANNING: Represents the planning phase. This perspective determines upgrade feasibility of the entity to a designated software release. Ensures that entity meets the required health criteria and passes all relevant eligibility checks to upgrade to the specific release.

For more information see: Esx.Settings.Inventory.CheckSpec.Perspective.

Warning: this property is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

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.