Esx. Settings. Hosts. Policies. Apply. Effective Get
Returns the effective policy based on system defaults and what has been configured for the ESXi host.
This operation was added in vSphere API 8.0.0.1.
Returns an authorization error 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
URI
GET
https://{api_host}/esx/settings/hosts/{host}/policies/apply/effective
COPY
Path Parameters
string
host
Required
The host identifier.
The parameter must be an identifier for the resource type: HostSystem.
Responses
200
The effective policies that impact the apply operation
Returns
Esx.Settings.Hosts.Policies.Apply.Effective.EffectivePolicySpec
of type(s)
application/json
"Esx.Settings.Hosts.Policies.Apply.Effective.EffectivePolicySpec Object"
400
If the host is not a vLCM managed standalone host.
Returns
Vapi.Std.Errors.Unsupported
of type(s)
application/json
"Vapi.Std.Errors.Unsupported Object"
401
if the caller is not authenticated.
Returns
Vapi.Std.Errors.Unauthenticated
of type(s)
application/json
"Vapi.Std.Errors.Unauthenticated Object"
404
If there is no host associated with host in the system.
Returns
Vapi.Std.Errors.NotFound
of type(s)
application/json
"Vapi.Std.Errors.NotFound Object"
500
If there is an unknown internal error. The accompanying error message will give more details about the failure.
Returns
Vapi.Std.Errors.Error
of type(s)
application/json
"Vapi.Std.Errors.Error Object"
503
If the service is not available.
Returns
Vapi.Std.Errors.ServiceUnavailable
of type(s)
application/json
"Vapi.Std.Errors.ServiceUnavailable Object"Code Samples
COPY
curl -H 'Authorization: <value>' https://{api_host}/esx/settings/hosts/{host}/policies/apply/effective
Esx.settings.hosts.policies.apply.effective Operations
GET
Esx. Settings. Hosts. Policies. Apply. Effective Get