Apply Clusters Configuration Task
This description has no documentation
Request
Request
URLURL
https://{api_host}/api/esx/settings/clusters/{cluster}/configuration?action=apply&vmw-task=true
Path Parameters
Path Parameters
string
cluster
Required
The parameter must be an identifier for the resource type: ClusterComputeResource.
Header Parameters
Header Parameters
string
vmware-api-session-id
Required
Required session ID, acquired from Create Session API under CIS product
vmware-api-session-id example
"b00db39f948d13ea1e59b4d6fce56389"
Request Body
Request Body
SettingsClustersConfigurationApplySpec of mimetype application/json
Required
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.
(The request body parameter is missing description)
{
"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"
]
}
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.
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
202 Accepted returns
string
of type application/json
An identifier for the task created by this API invocation will be returned. If the non-async version of the operation returns a value, this id can be used with the CIS Get Task operation to fetch that value. The normal description of this operation’s return value will follow if one exists.
Errors
400
com.vmware.vapi.std.errors.already_in_desired_state : The request cannot be fulfilled due to bad syntax. | com.vmware.vapi.std.errors.invalid_argument : The request cannot be fulfilled due to bad syntax.
404
com.vmware.vapi.std.errors.not_found : The requested resource could not be found but may be available again in the future.
500
com.vmware.vapi.std.errors.error : The server encountered an unexpected condition which prevented it from fulfilling the request. | com.vmware.vapi.std.errors.timed_out : The server encountered an unexpected condition which prevented it from fulfilling the request.
503
com.vmware.vapi.std.errors.service_unavailable : The server is currently unavailable (because it is overloaded or down for maintenance).
default
‘Default’ means this response is used for all HTTP codes that are not covered individually for this operation.
Code Samples
PowerCLI Client SDK Example
$SettingsClustersPoliciesApplyEffectiveFailureAction = Initialize-SettingsClustersPoliciesApplyEffectiveFailureAction -Action "FAIL" -RetryDelay 0 -RetryCount 0
$SettingsClustersPoliciesApplyEffectiveParallelRemediationAction = Initialize-SettingsClustersPoliciesApplyEffectiveParallelRemediationAction -Enabled $false -MaxHosts 0
$SettingsClustersPoliciesApplyEffectiveEffectivePolicySpec = Initialize-SettingsClustersPoliciesApplyEffectiveEffectivePolicySpec -FailureAction $SettingsClustersPoliciesApplyEffectiveFailureAction -PreRemediationPowerAction "POWER_OFF_VMS" -EnableQuickBoot $false -DisableDpm $false -DisableHac $false -EvacuateOfflineVms $false -EnforceHclValidation $false -ParallelRemediationAction $SettingsClustersPoliciesApplyEffectiveParallelRemediationAction
$SettingsClustersConfigurationApplySpec = Initialize-SettingsClustersConfigurationApplySpec -Commit "MyCommit" -Hosts "MyHosts" -ApplyPolicySpec $SettingsClustersPoliciesApplyEffectiveEffectivePolicySpec
Invoke-ApplyClusterConfigurationAsync -Cluster "MyCluster" -SettingsClustersConfigurationApplySpec $SettingsClustersConfigurationApplySpec
cURL Command
curl -X POST -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"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"]}' https://{api_host}/api/esx/settings/clusters/{cluster}/configuration?action=apply&vmw-task=true
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: apply_task
