com.vmware.vcenter.trusted_infrastructure.trusted_clusters.kms

Interface ServicesAppliedConfig

All Superinterfaces:

Service, ServicesAppliedConfigTypes

All Known Implementing Classes:

ServicesAppliedConfigStub

public interface ServicesAppliedConfig
extends Service, ServicesAppliedConfigTypes

The ServicesAppliedConfig interface provides information about the aggregate health of the applied Key Provider Service configuration on the Trusted Clusters. The desired state of the Key Provider Service is stored within vCenter, while the applied configuration is stored on the hosts in the cluster. The ServicesAppliedConfig interface is available for all clusters, not only Trusted Clusters. In such cases empty desired state is assumed, e.g. when an applied Key Provider Service configuration is found outside of a Trusted Cluster it is considered an ServicesAppliedConfigTypes.Health.ERROR. The ServicesAppliedConfig interface is able to put the applied Key Provider Service configuration into a consistent state when individual host configurations have diverged from the desired state. This interface was added in vSphere API 7.0.1.0.

Nested Class Summary

Nested classes/interfaces inherited from interface com.vmware.vcenter.trusted_infrastructure.trusted_clusters.kms.ServicesAppliedConfigTypes

ServicesAppliedConfigTypes._VAPI_OPERATIONS, ServicesAppliedConfigTypes.FilterSpec, ServicesAppliedConfigTypes.Health, ServicesAppliedConfigTypes.Info, ServicesAppliedConfigTypes.Summary

Field Summary

Fields inherited from interface com.vmware.vcenter.trusted_infrastructure.trusted_clusters.kms.ServicesAppliedConfigTypes

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method and Description
java.lang.String	delete_Task(java.lang.String cluster) Delete the Key Provider Service configuration that has been applied to the given cluster.
void	delete_Task(java.lang.String cluster, AsyncCallback<java.lang.String> asyncCallback) Delete the Key Provider Service configuration that has been applied to the given cluster.
void	delete_Task(java.lang.String cluster, AsyncCallback<java.lang.String> asyncCallback, InvocationConfig invocationConfig) Delete the Key Provider Service configuration that has been applied to the given cluster.
java.lang.String	delete_Task(java.lang.String cluster, InvocationConfig invocationConfig) Delete the Key Provider Service configuration that has been applied to the given cluster.
java.lang.String	get_Task(java.lang.String cluster, NetworkAddress address) Returns detailed information about the health of the specified Key Provider Service configuration applied to the cluster with respect to the desired state.
void	get_Task(java.lang.String cluster, NetworkAddress address, AsyncCallback<java.lang.String> asyncCallback) Returns detailed information about the health of the specified Key Provider Service configuration applied to the cluster with respect to the desired state.
void	get_Task(java.lang.String cluster, NetworkAddress address, AsyncCallback<java.lang.String> asyncCallback, InvocationConfig invocationConfig) Returns detailed information about the health of the specified Key Provider Service configuration applied to the cluster with respect to the desired state.
java.lang.String	get_Task(java.lang.String cluster, NetworkAddress address, InvocationConfig invocationConfig) Returns detailed information about the health of the specified Key Provider Service configuration applied to the cluster with respect to the desired state.
java.lang.String	list_Task(java.lang.String cluster, ServicesAppliedConfigTypes.FilterSpec spec) Returns basic information about the health of all Key Provider Service configurations applied to the cluster with respect to the desired state.
void	list_Task(java.lang.String cluster, ServicesAppliedConfigTypes.FilterSpec spec, AsyncCallback<java.lang.String> asyncCallback) Returns basic information about the health of all Key Provider Service configurations applied to the cluster with respect to the desired state.
void	list_Task(java.lang.String cluster, ServicesAppliedConfigTypes.FilterSpec spec, AsyncCallback<java.lang.String> asyncCallback, InvocationConfig invocationConfig) Returns basic information about the health of all Key Provider Service configurations applied to the cluster with respect to the desired state.
java.lang.String	list_Task(java.lang.String cluster, ServicesAppliedConfigTypes.FilterSpec spec, InvocationConfig invocationConfig) Returns basic information about the health of all Key Provider Service configurations applied to the cluster with respect to the desired state.
java.lang.String	update_Task(java.lang.String cluster) Update the applied Key Provider Service configuration on the given Trusted Cluster to be consistent with the desired state.
void	update_Task(java.lang.String cluster, AsyncCallback<java.lang.String> asyncCallback) Update the applied Key Provider Service configuration on the given Trusted Cluster to be consistent with the desired state.
void	update_Task(java.lang.String cluster, AsyncCallback<java.lang.String> asyncCallback, InvocationConfig invocationConfig) Update the applied Key Provider Service configuration on the given Trusted Cluster to be consistent with the desired state.
java.lang.String	update_Task(java.lang.String cluster, InvocationConfig invocationConfig) Update the applied Key Provider Service configuration on the given Trusted Cluster to be consistent with the desired state.

Method Detail

list_Task

java.lang.String list_Task(java.lang.String cluster,
                           ServicesAppliedConfigTypes.FilterSpec spec)

Returns basic information about the health of all Key Provider Service configurations applied to the cluster with respect to the desired state. This method was added in vSphere API 7.0.1.0.

Synchronous method overload. Result of the invocation is a task identifier which will be returned by this method.

Parameters:

cluster - The ID of the cluster against which the operation will be executed. The parameter must be an identifier for the resource type: ClusterComputeResource.

spec - The specification for the subset of results desired to be returned. If all results are returned.

Returns:

identifier for the task created by this API invocation

Throws:

Error - if there is a generic error.

InvalidArgument - if the cluster ID is empty.

NotFound - if no cluster corresponding to the given ID is found within this vCenter.

ResourceBusy - if there are ongoing mutating operations.

Unauthenticated - if the caller is not authenticated.

list_Task

java.lang.String list_Task(java.lang.String cluster,
                           ServicesAppliedConfigTypes.FilterSpec spec,
                           InvocationConfig invocationConfig)

Returns basic information about the health of all Key Provider Service configurations applied to the cluster with respect to the desired state. This method was added in vSphere API 7.0.1.0.

Synchronous method overload. Result of the invocation is a task identifier which will be returned by this method. Use invocationConfig to specify configuration for this particular invocation.

Parameters:

cluster - The ID of the cluster against which the operation will be executed. The parameter must be an identifier for the resource type: ClusterComputeResource.

spec - The specification for the subset of results desired to be returned. If all results are returned.

invocationConfig - Configuration for the method invocation.

Returns:

identifier for the task created by this API invocation

Throws:

Error - if there is a generic error.

InvalidArgument - if the cluster ID is empty.

NotFound - if no cluster corresponding to the given ID is found within this vCenter.

ResourceBusy - if there are ongoing mutating operations.

Unauthenticated - if the caller is not authenticated.

list_Task

void list_Task(java.lang.String cluster,
               ServicesAppliedConfigTypes.FilterSpec spec,
               AsyncCallback<java.lang.String> asyncCallback)

Returns basic information about the health of all Key Provider Service configurations applied to the cluster with respect to the desired state. This method was added in vSphere API 7.0.1.0.

Asynchronous method overload. Result of the invocation which is a task identifier will be reported via the specified asyncCallback.

Invocation Result:
identifier for the task created by this API invocation

Operation Errors:
Error - if there is a generic error.
InvalidArgument - if the cluster ID is empty.
NotFound - if no cluster corresponding to the given ID is found within this vCenter.
ResourceBusy - if there are ongoing mutating operations.
Unauthenticated - if the caller is not authenticated.

Parameters:

cluster - The ID of the cluster against which the operation will be executed. The parameter must be an identifier for the resource type: ClusterComputeResource.

spec - The specification for the subset of results desired to be returned. If all results are returned.

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

list_Task

void list_Task(java.lang.String cluster,
               ServicesAppliedConfigTypes.FilterSpec spec,
               AsyncCallback<java.lang.String> asyncCallback,
               InvocationConfig invocationConfig)

Returns basic information about the health of all Key Provider Service configurations applied to the cluster with respect to the desired state. This method was added in vSphere API 7.0.1.0.

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

Invocation Result:
identifier for the task created by this API invocation

Operation Errors:
Error - if there is a generic error.
InvalidArgument - if the cluster ID is empty.
NotFound - if no cluster corresponding to the given ID is found within this vCenter.
ResourceBusy - if there are ongoing mutating operations.
Unauthenticated - if the caller is not authenticated.

Parameters:

cluster - The ID of the cluster against which the operation will be executed. The parameter must be an identifier for the resource type: ClusterComputeResource.

spec - The specification for the subset of results desired to be returned. If all results are returned.

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

invocationConfig - Configuration for the method invocation.

get_Task

java.lang.String get_Task(java.lang.String cluster,
                          NetworkAddress address)

Returns detailed information about the health of the specified Key Provider Service configuration applied to the cluster with respect to the desired state. This method was added in vSphere API 7.0.1.0.

Synchronous method overload. Result of the invocation is a task identifier which will be returned by this method.

Parameters:

cluster - The ID of the cluster against which the operation will be executed. The parameter must be an identifier for the resource type: ClusterComputeResource.

address - The network address of the Key Provider service instance.

Returns:

identifier for the task created by this API invocation

Throws:

Error - if there is a generic error.

InvalidArgument - if the cluster ID is empty.

NotFound - if no cluster corresponding to the given ID is found within this vCenter or if no service corresponding to the given address is found.

ResourceBusy - if there are ongoing mutating operations.

Unauthenticated - if the caller is not authenticated.

get_Task

java.lang.String get_Task(java.lang.String cluster,
                          NetworkAddress address,
                          InvocationConfig invocationConfig)

Returns detailed information about the health of the specified Key Provider Service configuration applied to the cluster with respect to the desired state. This method was added in vSphere API 7.0.1.0.

Synchronous method overload. Result of the invocation is a task identifier which will be returned by this method. Use invocationConfig to specify configuration for this particular invocation.

Parameters:

cluster - The ID of the cluster against which the operation will be executed. The parameter must be an identifier for the resource type: ClusterComputeResource.

address - The network address of the Key Provider service instance.

invocationConfig - Configuration for the method invocation.

Returns:

identifier for the task created by this API invocation

Throws:

Error - if there is a generic error.

InvalidArgument - if the cluster ID is empty.

NotFound - if no cluster corresponding to the given ID is found within this vCenter or if no service corresponding to the given address is found.

ResourceBusy - if there are ongoing mutating operations.

Unauthenticated - if the caller is not authenticated.

get_Task

void get_Task(java.lang.String cluster,
              NetworkAddress address,
              AsyncCallback<java.lang.String> asyncCallback)

Returns detailed information about the health of the specified Key Provider Service configuration applied to the cluster with respect to the desired state. This method was added in vSphere API 7.0.1.0.

Asynchronous method overload. Result of the invocation which is a task identifier will be reported via the specified asyncCallback.

Invocation Result:
identifier for the task created by this API invocation

Operation Errors:
Error - if there is a generic error.
InvalidArgument - if the cluster ID is empty.
NotFound - if no cluster corresponding to the given ID is found within this vCenter or if no service corresponding to the given address is found.
ResourceBusy - if there are ongoing mutating operations.
Unauthenticated - if the caller is not authenticated.

Parameters:

cluster - The ID of the cluster against which the operation will be executed. The parameter must be an identifier for the resource type: ClusterComputeResource.

address - The network address of the Key Provider service instance.

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

get_Task

void get_Task(java.lang.String cluster,
              NetworkAddress address,
              AsyncCallback<java.lang.String> asyncCallback,
              InvocationConfig invocationConfig)

Returns detailed information about the health of the specified Key Provider Service configuration applied to the cluster with respect to the desired state. This method was added in vSphere API 7.0.1.0.

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

Invocation Result:
identifier for the task created by this API invocation

Operation Errors:
Error - if there is a generic error.
InvalidArgument - if the cluster ID is empty.
NotFound - if no cluster corresponding to the given ID is found within this vCenter or if no service corresponding to the given address is found.
ResourceBusy - if there are ongoing mutating operations.
Unauthenticated - if the caller is not authenticated.

Parameters:

cluster - The ID of the cluster against which the operation will be executed. The parameter must be an identifier for the resource type: ClusterComputeResource.

address - The network address of the Key Provider service instance.

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

invocationConfig - Configuration for the method invocation.

update_Task

java.lang.String update_Task(java.lang.String cluster)

Update the applied Key Provider Service configuration on the given Trusted Cluster to be consistent with the desired state. This method has no affect on the desired state, apart from it being used as a reference point for the remediation. This method was added in vSphere API 7.0.1.0.

Synchronous method overload. Result of the invocation is a task identifier which will be returned by this method.

Parameters:

cluster - The ID of the Trusted Cluster against which the operation will be executed. The parameter must be an identifier for the resource type: ClusterComputeResource.

Returns:

identifier for the task created by this API invocation

Throws:

Error - if there is a generic error.

InvalidArgument - if the cluster ID is empty

NotFound - if no cluster corresponding to the given ID is found within this vCenter.

ResourceBusy - if there are ongoing mutating operations.

Unauthenticated - if the caller is not authenticated.

update_Task

java.lang.String update_Task(java.lang.String cluster,
                             InvocationConfig invocationConfig)

Update the applied Key Provider Service configuration on the given Trusted Cluster to be consistent with the desired state. This method has no affect on the desired state, apart from it being used as a reference point for the remediation. This method was added in vSphere API 7.0.1.0.

Synchronous method overload. Result of the invocation is a task identifier which will be returned by this method. Use invocationConfig to specify configuration for this particular invocation.

Parameters:

cluster - The ID of the Trusted Cluster against which the operation will be executed. The parameter must be an identifier for the resource type: ClusterComputeResource.

invocationConfig - Configuration for the method invocation.

Returns:

identifier for the task created by this API invocation

Throws:

Error - if there is a generic error.

InvalidArgument - if the cluster ID is empty

NotFound - if no cluster corresponding to the given ID is found within this vCenter.

ResourceBusy - if there are ongoing mutating operations.

Unauthenticated - if the caller is not authenticated.

update_Task

void update_Task(java.lang.String cluster,
                 AsyncCallback<java.lang.String> asyncCallback)

Update the applied Key Provider Service configuration on the given Trusted Cluster to be consistent with the desired state. This method has no affect on the desired state, apart from it being used as a reference point for the remediation. This method was added in vSphere API 7.0.1.0.

Asynchronous method overload. Result of the invocation which is a task identifier will be reported via the specified asyncCallback.

Invocation Result:
identifier for the task created by this API invocation

Operation Errors:
Error - if there is a generic error.
InvalidArgument - if the cluster ID is empty
NotFound - if no cluster corresponding to the given ID is found within this vCenter.
ResourceBusy - if there are ongoing mutating operations.
Unauthenticated - if the caller is not authenticated.

Parameters:

cluster - The ID of the Trusted Cluster against which the operation will be executed. The parameter must be an identifier for the resource type: ClusterComputeResource.

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

update_Task

void update_Task(java.lang.String cluster,
                 AsyncCallback<java.lang.String> asyncCallback,
                 InvocationConfig invocationConfig)

Update the applied Key Provider Service configuration on the given Trusted Cluster to be consistent with the desired state. This method has no affect on the desired state, apart from it being used as a reference point for the remediation. This method was added in vSphere API 7.0.1.0.

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

Invocation Result:
identifier for the task created by this API invocation

Operation Errors:
Error - if there is a generic error.
InvalidArgument - if the cluster ID is empty
NotFound - if no cluster corresponding to the given ID is found within this vCenter.
ResourceBusy - if there are ongoing mutating operations.
Unauthenticated - if the caller is not authenticated.

Parameters:

cluster - The ID of the Trusted Cluster against which the operation will be executed. 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.

delete_Task

java.lang.String delete_Task(java.lang.String cluster)

Delete the Key Provider Service configuration that has been applied to the given cluster. This method has no affect on the desired state, it only removes applied Key Provider Service configuration from any Trusted Hosts within the given cluster. This method was added in vSphere API 7.0.1.0.

Synchronous method overload. Result of the invocation is a task identifier which will be returned by this method.

Parameters:

cluster - The ID of the cluster against which the operation will be executed. The parameter must be an identifier for the resource type: ClusterComputeResource.

Returns:

identifier for the task created by this API invocation

Throws:

Error - if there is a generic error.

InvalidArgument - if the cluster ID is empty.

NotFound - if no cluster corresponding to the given ID is found within this vCenter.

ResourceBusy - if there are ongoing mutating operations.

Unauthenticated - if the caller is not authenticated.

delete_Task

java.lang.String delete_Task(java.lang.String cluster,
                             InvocationConfig invocationConfig)

Delete the Key Provider Service configuration that has been applied to the given cluster. This method has no affect on the desired state, it only removes applied Key Provider Service configuration from any Trusted Hosts within the given cluster. This method was added in vSphere API 7.0.1.0.

Synchronous method overload. Result of the invocation is a task identifier which will be returned by this method. Use invocationConfig to specify configuration for this particular invocation.

Parameters:

cluster - The ID of the cluster against which the operation will be executed. The parameter must be an identifier for the resource type: ClusterComputeResource.

invocationConfig - Configuration for the method invocation.

Returns:

identifier for the task created by this API invocation

Throws:

Error - if there is a generic error.

InvalidArgument - if the cluster ID is empty.

NotFound - if no cluster corresponding to the given ID is found within this vCenter.

ResourceBusy - if there are ongoing mutating operations.

Unauthenticated - if the caller is not authenticated.

delete_Task

void delete_Task(java.lang.String cluster,
                 AsyncCallback<java.lang.String> asyncCallback)

Delete the Key Provider Service configuration that has been applied to the given cluster. This method has no affect on the desired state, it only removes applied Key Provider Service configuration from any Trusted Hosts within the given cluster. This method was added in vSphere API 7.0.1.0.

Asynchronous method overload. Result of the invocation which is a task identifier will be reported via the specified asyncCallback.

Invocation Result:
identifier for the task created by this API invocation

Operation Errors:
Error - if there is a generic error.
InvalidArgument - if the cluster ID is empty.
NotFound - if no cluster corresponding to the given ID is found within this vCenter.
ResourceBusy - if there are ongoing mutating operations.
Unauthenticated - if the caller is not authenticated.

Parameters:

cluster - The ID of the cluster against which the operation will be executed. The parameter must be an identifier for the resource type: ClusterComputeResource.

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

delete_Task

void delete_Task(java.lang.String cluster,
                 AsyncCallback<java.lang.String> asyncCallback,
                 InvocationConfig invocationConfig)

Delete the Key Provider Service configuration that has been applied to the given cluster. This method has no affect on the desired state, it only removes applied Key Provider Service configuration from any Trusted Hosts within the given cluster. This method was added in vSphere API 7.0.1.0.

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

Invocation Result:
identifier for the task created by this API invocation

Operation Errors:
Error - if there is a generic error.
InvalidArgument - if the cluster ID is empty.
NotFound - if no cluster corresponding to the given ID is found within this vCenter.
ResourceBusy - if there are ongoing mutating operations.
Unauthenticated - if the caller is not authenticated.

Parameters:

cluster - The ID of the cluster against which the operation will be executed. 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.