Esx Settings ClusterSoftwarePolicySpec

This Esx Settings ClusterSoftwarePolicySpec schema contains properties that define the settings to manage the behaviour of the POST /esx/settings/clusters/{cluster}/software?action=apply API.

This schema was added in vSphere API 9.1.0.0.

JSON Example

{
    "enforce_hcl_validation": false,
    "parallel_remediation_action": {
        "enabled": false,
        "max_hosts": 0
    },
    "live_patch_action": {
        "live_patch_mode": "string"
    },
    "skip_reserved_vibs_caching": false
}

boolean

enforce_hcl_validation

Optional

Enforce HCL validation, when applicable, to prevent remediation if hardware compatibility issues are found.

This property was added in vSphere API 9.1.0.0.

If missing or null, hardware compatibility issues will not prevent remediation.

parallel_remediation_action

Optional

Enable parallel remediation of hosts in maintenance mode. Set max hosts when applicable.

This property was added in vSphere API 9.1.0.0.

If missing or null, parallel remediation will not happen.

live_patch_action

Optional

Live Patch action of the cluster.

This property was added in vSphere API 9.1.0.0.

If missing or null, configured value would be unset. This field should not be set together with Esx Settings Clusters Policies Apply ConfiguredPolicySpec.enforce_quick_patch. When com.vmware.esx.settings.clusters.policies.Apply.ConfiguredPolicySpec.softwarePolicySpec.livePatchAction#livePatchMode is set to com.vmware.esx.settings.ClusterLivePatchAction.livePatchMode#ENFORCE_LIVE_PATCH, Esx Settings Clusters Policies Apply ConfiguredPolicySpec.enforce_quick_patch will be set to true automatically. For other values, Esx Settings Clusters Policies Apply ConfiguredPolicySpec.enforce_quick_patch will be set to false.

boolean

skip_reserved_vibs_caching

Optional

Skip caching of reserved VIBs on the host. During effective VIB computation, a VIB at a lower version can get replaced by the same VIB at a higher version coming from another release unit. vLCM caches the lower version VIB in ESX-OSData partition to support extraction of currently running image from the hosts. Setting this option means (a) remediation will not cache reserved VIBs, (b) extracting the currently running image from such hosts will not include the reserved VIBs. Hence, the image will not be complete and that might lead to remediation failures.

NOTE: Use this option with caution.

This property was added in vSphere API 9.1.0.0.

If missing or null, reserved VIBs will be cached.