Get Hosts Policies Apply
Returns the configured policy that has been set for the ESXi host. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.lifecycleSettings.Read. - The resource HostSystem referenced by the parameter host requires VcIntegrity.lifecycleSettings.Read.
Request
URLURL
https://{api_host}/api/esx/settings/hosts/{host}/policies/apply
Path Parameters
Path Parameters
string
host
Required
The host identifier. The parameter must be an identifier for the resource type: HostSystem.
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"
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK returns
SettingsHostsPoliciesApplyConfiguredPolicySpec
of type application/json
The configured policies that impact the apply operation
{
"enable_quick_boot": false,
"failure_action": {
"action": "FAIL",
"retry_count": 0,
"retry_delay": 0
},
"pre_remediation_power_action": "POWER_OFF_VMS"
}
boolean
enable_quick_boot
Optional
Enable Quick Boot during remediation of the host. If unset, configured value would be unset.
failure_action
Optional
What action is to be taken if entering maintenance mode fails on an ESXi host. If unset, configured value would be unset.
pre_remediation_power_action
Optional
The Apply.ConfiguredPolicySpec.PreRemediationPowerAction enumerated type defines the possible actions to take, before entering maintenance mode.
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
Possible values are: POWER_OFF_VMS , SUSPEND_VMS , DO_NOT_CHANGE_VMS_POWER_STATE , SUSPEND_VMS_TO_MEMORY
Errors
400
com.vmware.vapi.std.errors.unsupported : If the host is not a vLCM managed standlone host.
404
com.vmware.vapi.std.errors.not_found : If there is no host associated with host in the system.
500
com.vmware.vapi.std.errors.error : If there is an unknown internal error. The accompanying error message will give more details about the failure.
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
Invoke-GetHostPoliciesApply -Host "MyHost"
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/esx/settings/hosts/{host}/policies/apply
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: get
Availability
Added in 8.0.0.1
