Esx Settings Defaults Clusters Policies Apply set
This API will set the configured policy specification.
This operation was added in vSphere API 7.0.0.0.
Returns an authorization error if you do not have all of the privileges described as follows:
- Operation execution requires
VcIntegrity.lifecycleSettings.Write.
The policy that needs to be configured.
{
"failure_action": {
"action": "string",
"retry_delay": 0,
"retry_count": 0
},
"pre_remediation_power_action": "string",
"enable_quick_boot": false,
"disable_dpm": false,
"disable_hac": false,
"evacuate_offline_vms": false,
"enforce_hcl_validation": false,
"parallel_remediation_action": {
"enabled": false,
"max_hosts": 0
},
"enforce_quick_patch": false,
"config_manager_policy_spec": {
"serial_remediation": false
}
}What action is to be taken if entering maintenance mode fails on a given host of the cluster.
This property was added in vSphere API 7.0.0.0.
If missing or null, configured value would be unset.
Specifies what should be done to the power state of the VM before entering maintenance mode.
For more information see: Esx Settings Defaults Clusters Policies Apply ConfiguredPolicySpec PreRemediationPowerAction.
This property was added in vSphere API 7.0.0.0.
If missing or null, configured value would be unset.
Enable Quick Boot during remediation in the cluster.
This property was added in vSphere API 7.0.0.0.
If missing or null, configured value would be unset.
Disable DPM on the cluster.
This property was added in vSphere API 7.0.0.0.
If missing or null, configured value would be unset.
Disable HA Admission control on the cluster.
This property was added in vSphere API 7.0.0.0.
If missing or null, configured value would be unset.
Evacuate powered off/suspended VMs when attempting maintenance mode.
This property was added in vSphere API 7.0.0.0.
If missing or null, configured value would be unset.
Enforce Hcl validation, when applicable, to prevent remediation if hardware compatibility issues are found.
This property was added in vSphere API 7.0.1.0.
If missing or null, hardware compatibility issues will not prevent remediation.
Enable parallel remediation of hosts in maintenance mode. Set max hosts when applicable.
This property was added in vSphere API 8.0.0.1.
If missing or null, parallel remediation will not happen.
Enforce quick patch on the cluster for images that support it.
This property was added in vSphere API 8.0.3.0.
If missing or null, configured value would be unset.
Configure settings applicable to the com.vmware.esx.settings.clusters.Configuration.apply API.
This property was added in vSphere API 8.0.3.0.
If missing or null, configured values will be unset.
Success!
If invalid value is provided.
"Vapi Std Errors InvalidArgument Object"If the caller is not authenticated.
"Vapi Std Errors Unauthenticated Object"Indicates the authentication challenges applicable to the target API provider. It can be used by a client to discover the correct authentication scheme to use. The exact syntax of the value is defined by the specific provider, the protocol and authentication schemes used.
For example, a provider using REST may adhere to the WWW-Authenticate HTTP header specification, RFC7235, section 4.1. In this case an example challenge value may be: SIGN realm="27da1358-2ba4-11e9-b210-d663bd873d93",sts="http://vcenter/sso?vsphere.local", Basic realm="vCenter"
This property was added in vSphere API 7.0.0.0.
This property is optional because it was added in a newer version than its parent node.
If there is an unknown internal error. The accompanying error message will give more details about the failure.
"Vapi Std Errors Error Object"Stack of one or more localizable messages for human error consumers.
The message at the top of the stack (first in the list) describes the error from the perspective of the operation the client invoked.
Each subsequent message in the stack describes the "cause" of the prior message.
Data to facilitate clients responding to the operation reporting a standard error to indicating that it was unable to complete successfully.
Operations may provide data that clients can use when responding to errors. Since the data that clients need may be specific to the context of the operation reporting the error, different operations that report the same error may provide different data in the error. The documentation for each each operation will describe what, if any, data it provides for each error it reports.
The Vapi Std Errors ArgumentLocations, Vapi Std Errors FileLocations, and Vapi Std Errors TransientIndication schemas are intended as possible values for this property. Vapi Std DynamicID may also be useful as a value for this property (although that is not its primary purpose). Some resources may provide their own specific schemas for use as the value of this property when reporting errors from their operations.
Some operations will not set this property when reporting errors.
Discriminator field to help API consumers identify the structure type.
For more information see: Vapi Std Errors Error Type.
This property was added in vSphere API 6.7.2.
Can be missing or null for compatibility with preceding implementations.
If the service is not available.
"Vapi Std Errors ServiceUnavailable Object" curl -X PUT -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{}' https://{api_host}/api/esx/settings/defaults/clusters/policies/apply