Esx.Settings.Hosts.Policies.Apply.Effective.EffectivePolicySpec

The Esx.Settings.Hosts.Policies.Apply.Effective.EffectivePolicySpec schema contains properties that describe the effective policies to be used when the software and configuration specification documents are applied to ESXi hosts.

This schema was added in vSphere API 8.0.0.1.

JSON Example

{
    "failure_action": {
        "action": "string",
        "retry_delay": 0,
        "retry_count": 0
    },
    "pre_remediation_power_action": "string",
    "enable_quick_boot": false,
    "software_policy_spec": {
        "skip_reserved_vibs_caching": false
    }
}

failure_action

Required

What action is to be taken if entering maintenance mode fails on an ESXi host.

This property was added in vSphere API 8.0.0.1.

string

pre_remediation_power_action

Required

Specifies what should be done to the power state of the VM before entering maintenance mode.

Possible values:

POWER_OFF_VMS: Power off VMs before entering maintenance mode.
SUSPEND_VMS: Suspend VMs before entering maintenance mode
DO_NOT_CHANGE_VMS_POWER_STATE: Do not change the VM power state
SUSPEND_VMS_TO_MEMORY: Suspend VMs to Memory before entering maintenance mode

For more information see: Esx.Settings.Hosts.Policies.Apply.Effective.EffectivePolicySpec.PreRemediationPowerAction.

This property was added in vSphere API 8.0.0.1.

boolean

enable_quick_boot

Required

Enable Quick Boot during remediation of an ESXi host.

This property was added in vSphere API 8.0.0.1.

software_policy_spec

Optional

Software-specific policy settings applicable to the POST /esx/settings/hosts/{host}/software?action=apply API.

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.

This property is optional because it was added in a newer version than its parent node.