Esx. Settings. Clusters. Policies. Apply. Effective Get

Esx. Settings. Clusters. Policies. Apply. Effective Get

Returns the effective apply policy based on system defaults and what has been configured for the cluster.

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.Read.
  • The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSettings.Read.
Request
URI
GET
https://{api_host}/esx/settings/clusters/{cluster}/policies/apply/effective
COPY
Path Parameters
string
cluster
Required

The cluster identifier.

The parameter must be an identifier for the resource type: ClusterComputeResource.

Authentication
This operation uses the following authentication methods.
Responses
200

The effective policies that impact the apply operation on this cluster.

Returns Esx.Settings.Clusters.Policies.Apply.Effective.EffectivePolicySpec of type(s) application/json 
"Esx.Settings.Clusters.Policies.Apply.Effective.EffectivePolicySpec 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 cluster associated with cluster 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/clusters/{cluster}/policies/apply/effective
On This Page
Esx.settings.clusters.policies.apply.effective Operations
GET
Esx. Settings. Clusters. Policies. Apply. Effective Get