Esx.Settings.Clusters.Software.Solutions.Nsx.NsxInternal.ApplySpec

The Esx.Settings.Clusters.Software.Solutions.Nsx.NsxInternal.ApplySpec schema contains properties that describe the specification to be used for applying the desired NSX software component to a cluster.

This schema was added in vSphere API 7.0.1.0.

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

JSON Example

{
    "hosts": [
        "string"
    ],
    "deployment_mode": "string",
    "parallel_host_remediation": false
}

array of string

hosts

Optional

The hosts within the cluster to be considered during the #apply operation.

This property was added in vSphere API 7.0.1.0.

if missing or null or empty the #apply operation will remediate all hosts within 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.

string

deployment_mode

Optional

Deployment mode policy for NSX components. It maps to maintenance-mode policies.

Possible values:

EVACUATE_POWERED_ON_VMS: Maps to maintenance-mode policy where powered-on VMs are evacuated.
EVACUATE_ALL_VMS: Maps to maintenance-mode policy where all VMs are evacuated.
LIVE_UPDATE: Maps to maintenance-mode policy where powered-on VMs remain powered-on but VMs motion to or from the host undergoing remediation is blocked.

For more information see: Esx.Settings.Clusters.Software.Solutions.Nsx.NsxInternal.ApplySpec.DeploymentMode.

This property was added in vSphere API 7.0.1.0.

if missing or null the #apply operation DeploymentMode will be EVACUATE_POWERED_ON_VMS.

boolean

parallel_host_remediation

Optional

Specifies whether the operation should be carried out serially or in parallel across all the hosts. This field will only exist if the deployment mode selected is live-update.

This property was added in vSphere API 7.0.1.0.

if missing or null, empty, or False the #apply operation will remediate all hosts serially. Otherwise, the #apply operation will remediate hosts in parallel.