Esx.Settings.Clusters.Software.HaInternal.ApplySpec

Esx.Settings.Clusters.Software.HaInternal.ApplySpec
Esx.Settings.Clusters.Software.HaInternal.ApplySpec

The Esx.Settings.Clusters.Software.HaInternal.ApplySpec schema contains properties that describe the specification to apply the HA solution to a cluster.

This schema was added in vSphere API 7.0.2.1.

Note: this schema is restricted for VMware internal use only.

JSON Example
{
    "host": "string",
    "hosts": [
        "string"
    ],
    "solution": {
        "id": "string",
        "version": "string",
        "components": [
            {
                "component": "string"
            }
        ]
    }
}
string
host
Optional

This property is deprecated as of vSphere API 9.0.0.0.

Host for which the HA components need to be applied. It supports add-host HA-Apply workflow and will change the API scope to host if the host is in maintenance mode.

This property was added in vSphere API 7.0.2.1.

if missing or null or empty, solution is applied to all the hosts in the cluster.

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

array of string
hosts
Optional

Set of hosts for which the HA components need to be applied. It supports add-host HA-Apply workflow and will change the API scope to all the hosts if the hosts are in maintenance mode.

This property was added in vSphere API 9.0.0.0.

if missing or null or empty, solution is applied to all the hosts with version less than 9.0 present in the cluster.

When clients pass a value of this schema as a parameter, the property must contain identifiers for the resource type: HostSystem. When operations return a value of this schema as a response, the property will contain identifiers for the resource type: HostSystem.

solution
Optional

Describe the solution identifier, the solution version and the specification detailing components registered by the solution. 1. If the base image in desired spec is greater than or equal to 9.0 and the cluster has hosts with ESXi version less than 9.0, then this field is expected to be provided by the user. 2. For cases where the base image is less than 9.0 in the cluster's desired spec then this filed is expected to be empty. The solution spec is retrieved from the desired spec. 3. If the base image in desired spec is greater than or equal to 9.0 and the cluster has hosts with ESXi version greater than or equal to 9.0, expectation is that this api will not be invoked.

This property was added in vSphere API 9.0.0.0.

Can be unset depending on the above mentioned cases.