SettingsClustersConfigurationApplySpec

The Configuration.ApplySpec structure contains fields that describe the specification to be used for applying the desired configuration to a cluster. Warning: This structure is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.


Properties

apply_policy_spec Optional

The parameter can be used to override the default remediation policies for the task. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments. if unset the default cluster remediation policies are used.


string
commit Optional

The minimum commit identifier of the desired configuration to be used during the Configuration.apply operation. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments. if unset or empty the apply operation will use the latest commit to fetch the desired configuration. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: com.vmware.esx.settings.commit. When operations return a value of this structure as a result, the field will be an identifier for the resource type: com.vmware.esx.settings.commit.


array of string
hosts Optional

The specific hosts within the cluster to be considered during the Configuration.apply operation. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments. if unset or empty the Configuration.apply operation will remediate all hosts within the cluster. When clients pass a value of this structure as a parameter, the field must contain identifiers for the resource type: HostSystem. When operations return a value of this structure as a result, the field will contain identifiers for the resource type: HostSystem.

JSON Example

{
	"apply_policy_spec": {
		"disable_dpm": false,
		"disable_hac": false,
		"enable_quick_boot": false,
		"enforce_hcl_validation": false,
		"evacuate_offline_vms": false,
		"failure_action": {
			"action": "FAIL",
			"retry_count": 0,
			"retry_delay": 0
		},
		"parallel_remediation_action": {
			"enabled": false,
			"max_hosts": 0
		},
		"pre_remediation_power_action": "POWER_OFF_VMS"
	},
	"commit": "string",
	"hosts": [
		"string"
	]
}

Feedback

Was this page helpful?