Esx Settings Clusters Configuration apply$Task
Applies the cluster configuration associated with the cluster on the hosts associated with the cluster.
This operation was added in vSphere API 8.0.1.0.
Returns an authorization error if you do not have all of the privileges described as follows:
- Operation execution requires
VcIntegrity.ClusterConfiguration.Remediate. - The resource
ClusterComputeResourcereferenced by the parameter cluster requiresVcIntegrity.ClusterConfiguration.Remediate.
Identifier of the cluster
The parameter must be an identifier for the resource type: ClusterComputeResource.
The Apply specification.
{
"commit": "string",
"hosts": [
"string"
],
"apply_policy_spec": {
"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
}
}
}The minimum commit identifier of the desired configuration to be used during the POST /esx/settings/clusters/{cluster}/configuration?action=apply operation.
This property was added in vSphere API 8.0.1.0.
if missing or null or empty the apply operation will use the latest commit to fetch the desired configuration.
When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: com.vmware.esx.settings.commit. When operations return a value of this schema as a response, the property will be an identifier for the resource type: com.vmware.esx.settings.commit.
The specific hosts within the cluster to be considered during the POST /esx/settings/clusters/{cluster}/configuration?action=apply operation.
This property was added in vSphere API 8.0.1.0.
if missing or null or empty the POST /esx/settings/clusters/{cluster}/configuration?action=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.
The parameter can be used to override the default remediation policies for the task.
This property was added in vSphere API 8.0.1.0.
if missing or null the default cluster remediation policies are used.
The output structure of type Esx Settings Clusters Configuration ApplyResult containing the result of this operation.
Vapi Std Errors AlreadyInDesiredState If the cluster is already at the specified commit as described in the apply specification.
Vapi Std Errors InvalidArgument If the Esx Settings Clusters Configuration ApplySpec.commit property of spec specifies an invalid commit, or the Esx Settings Clusters Configuration ApplySpec.hosts property of spec specifies an invalid host or a host that is not part of the cluster, or the cluster is not managed with a configuration specification. Also thrown if the specified cluster is empty.
"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 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 no cluster found in the inventory or no Esx Settings Clusters Configuration ApplySpec.commit associated with cluster.
"Vapi Std Errors NotFound Object"Vapi Std Errors Error If there is an unknown internal error. The accompanying error message will give more details about the failure.
Vapi Std Errors TimedOut If the API timed out before completion.
"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 POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{}' https://{api_host}/api/esx/settings/clusters/{cluster}/configuration?action=apply&vmw-task=true