com.vmware.esx.settings.clusters.policies

Interface Apply

All Superinterfaces:

ApplyTypes, Service

All Known Implementing Classes:

ApplyStub

public interface Apply
extends Service, ApplyTypes

The Apply interface provides methods to configure the policies that will impact how the software and configuration specification documents are applied to an ESXi cluster.

Nested Class Summary

Nested classes/interfaces inherited from interface com.vmware.esx.settings.clusters.policies.ApplyTypes

ApplyTypes.ConfiguredPolicySpec, ApplyTypes.FailureAction

Field Summary

Fields inherited from interface com.vmware.esx.settings.clusters.policies.ApplyTypes

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method and Description
ApplyTypes.ConfiguredPolicySpec	get(java.lang.String cluster) Returns the configured policy that has been set for the cluster.
void	get(java.lang.String cluster, AsyncCallback<ApplyTypes.ConfiguredPolicySpec> asyncCallback) Returns the configured policy that has been set for the cluster.
void	get(java.lang.String cluster, AsyncCallback<ApplyTypes.ConfiguredPolicySpec> asyncCallback, InvocationConfig invocationConfig) Returns the configured policy that has been set for the cluster.
ApplyTypes.ConfiguredPolicySpec	get(java.lang.String cluster, InvocationConfig invocationConfig) Returns the configured policy that has been set for the cluster.
void	set(java.lang.String cluster, ApplyTypes.ConfiguredPolicySpec spec) This API will set the configured policy specification for the cluster.
void	set(java.lang.String cluster, ApplyTypes.ConfiguredPolicySpec spec, AsyncCallback<java.lang.Void> asyncCallback) This API will set the configured policy specification for the cluster.
void	set(java.lang.String cluster, ApplyTypes.ConfiguredPolicySpec spec, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) This API will set the configured policy specification for the cluster.
void	set(java.lang.String cluster, ApplyTypes.ConfiguredPolicySpec spec, InvocationConfig invocationConfig) This API will set the configured policy specification for the cluster.

Method Detail

get

ApplyTypes.ConfiguredPolicySpec get(java.lang.String cluster)

Returns the configured policy that has been set for the cluster.

Synchronous method overload. Result of the invocation will be reported as a method return value.

Parameters:

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

Returns:

The configured policies that impact the apply method

Throws:

Error - If there is an unknown internal error. The accompanying error message will give more details about the failure.

NotFound - If there is no cluster associated with cluster in the system.

ServiceUnavailable - If the service is not available.

Unauthenticated - if the caller is not authenticated.

Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires VcIntegrity.lifecycleSettings.Read.
• The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSettings.Read.

get

ApplyTypes.ConfiguredPolicySpec get(java.lang.String cluster,
                                    InvocationConfig invocationConfig)

Returns the configured policy that has been set for the cluster.

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Parameters:

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

invocationConfig - Configuration for the method invocation.

Returns:

The configured policies that impact the apply method

Throws:

Error - If there is an unknown internal error. The accompanying error message will give more details about the failure.

NotFound - If there is no cluster associated with cluster in the system.

ServiceUnavailable - If the service is not available.

Unauthenticated - if the caller is not authenticated.

Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires VcIntegrity.lifecycleSettings.Read.
• The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSettings.Read.

get

void get(java.lang.String cluster,
         AsyncCallback<ApplyTypes.ConfiguredPolicySpec> asyncCallback)

Returns the configured policy that has been set for the cluster.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback.

Invocation Result:
The configured policies that impact the apply method

Operation Errors:
Error - If there is an unknown internal error. The accompanying error message will give more details about the failure.
NotFound - If there is no cluster associated with cluster in the system.
ServiceUnavailable - If the service is not available.
Unauthenticated - if the caller is not authenticated.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires VcIntegrity.lifecycleSettings.Read.
• The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSettings.Read.

Parameters:

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

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

get

void get(java.lang.String cluster,
         AsyncCallback<ApplyTypes.ConfiguredPolicySpec> asyncCallback,
         InvocationConfig invocationConfig)

Returns the configured policy that has been set for the cluster.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback. Use invocationConfig to specify configuration for this particular invocation.

Invocation Result:
The configured policies that impact the apply method

Operation Errors:
Error - If there is an unknown internal error. The accompanying error message will give more details about the failure.
NotFound - If there is no cluster associated with cluster in the system.
ServiceUnavailable - If the service is not available.
Unauthenticated - if the caller is not authenticated.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires VcIntegrity.lifecycleSettings.Read.
• The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSettings.Read.

Parameters:

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

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

invocationConfig - Configuration for the method invocation.

set

void set(java.lang.String cluster,
         ApplyTypes.ConfiguredPolicySpec spec)

This API will set the configured policy specification for the cluster.

Synchronous method overload. Result of the invocation will be reported as a method return value.

Parameters:

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

spec - The policy that needs to be configured.

Throws:

Error - If there is an unknown internal error. The accompanying error message will give more details about the failure.

NotFound - If there is no cluster associated with cluster in the system.

InvalidArgument - If invalid value is provided.

ServiceUnavailable - If the service is not available.

Unauthenticated - If the caller is not authenticated.

Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires VcIntegrity.lifecycleSettings.Write.
• The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSettings.Write.

set

void set(java.lang.String cluster,
         ApplyTypes.ConfiguredPolicySpec spec,
         InvocationConfig invocationConfig)

This API will set the configured policy specification for the cluster.

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Parameters:

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

spec - The policy that needs to be configured.

invocationConfig - Configuration for the method invocation.

Throws:

Error - If there is an unknown internal error. The accompanying error message will give more details about the failure.

NotFound - If there is no cluster associated with cluster in the system.

InvalidArgument - If invalid value is provided.

ServiceUnavailable - If the service is not available.

Unauthenticated - If the caller is not authenticated.

Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires VcIntegrity.lifecycleSettings.Write.
• The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSettings.Write.

set

void set(java.lang.String cluster,
         ApplyTypes.ConfiguredPolicySpec spec,
         AsyncCallback<java.lang.Void> asyncCallback)

This API will set the configured policy specification for the cluster.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback.

Operation Errors:
Error - If there is an unknown internal error. The accompanying error message will give more details about the failure.
NotFound - If there is no cluster associated with cluster in the system.
InvalidArgument - If invalid value is provided.
ServiceUnavailable - If the service is not available.
Unauthenticated - If the caller is not authenticated.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires VcIntegrity.lifecycleSettings.Write.
• The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSettings.Write.

Parameters:

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

spec - The policy that needs to be configured.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

set

void set(java.lang.String cluster,
         ApplyTypes.ConfiguredPolicySpec spec,
         AsyncCallback<java.lang.Void> asyncCallback,
         InvocationConfig invocationConfig)

This API will set the configured policy specification for the cluster.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback. Use invocationConfig to specify configuration for this particular invocation.

Operation Errors:
Error - If there is an unknown internal error. The accompanying error message will give more details about the failure.
NotFound - If there is no cluster associated with cluster in the system.
InvalidArgument - If invalid value is provided.
ServiceUnavailable - If the service is not available.
Unauthenticated - If the caller is not authenticated.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires VcIntegrity.lifecycleSettings.Write.
• The resource ClusterComputeResource referenced by the parameter cluster requires VcIntegrity.lifecycleSettings.Write.

Parameters:

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

spec - The policy that needs to be configured.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

invocationConfig - Configuration for the method invocation.