com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms

Interface Providers

All Superinterfaces:

ProvidersTypes, Service

All Known Implementing Classes:

ProvidersStub

public interface Providers
extends Service, ProvidersTypes

The Providers interface provides methods to create, update and delete Key Providers that handoff to key servers. This interface was added in vSphere API 7.0.0.

Nested Class Summary

Nested classes/interfaces inherited from interface com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms.ProvidersTypes

ProvidersTypes._VAPI_OPERATIONS, ProvidersTypes.CreateSpec, ProvidersTypes.Health, ProvidersTypes.Info, ProvidersTypes.KeyServerCreateSpec, ProvidersTypes.KeyServerInfo, ProvidersTypes.KeyServerUpdateSpec, ProvidersTypes.KmipServerCreateSpec, ProvidersTypes.KmipServerInfo, ProvidersTypes.KmipServerUpdateSpec, ProvidersTypes.Server, ProvidersTypes.ServerInfo, ProvidersTypes.Status, ProvidersTypes.Summary, ProvidersTypes.UpdateSpec

Field Summary

Fields inherited from interface com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms.ProvidersTypes

_VAPI_SERVICE_ID, RESOURCE_TYPE

Method Summary

Modifier and Type	Method and Description
java.lang.String	create_Task(java.lang.String cluster, ProvidersTypes.CreateSpec spec) Add a new Key Provider.
void	create_Task(java.lang.String cluster, ProvidersTypes.CreateSpec spec, AsyncCallback<java.lang.String> asyncCallback) Add a new Key Provider.
void	create_Task(java.lang.String cluster, ProvidersTypes.CreateSpec spec, AsyncCallback<java.lang.String> asyncCallback, InvocationConfig invocationConfig) Add a new Key Provider.
java.lang.String	create_Task(java.lang.String cluster, ProvidersTypes.CreateSpec spec, InvocationConfig invocationConfig) Add a new Key Provider.
java.lang.String	delete_Task(java.lang.String cluster, java.lang.String provider) Remove a Key Provider.
void	delete_Task(java.lang.String cluster, java.lang.String provider, AsyncCallback<java.lang.String> asyncCallback) Remove a Key Provider.
void	delete_Task(java.lang.String cluster, java.lang.String provider, AsyncCallback<java.lang.String> asyncCallback, InvocationConfig invocationConfig) Remove a Key Provider.
java.lang.String	delete_Task(java.lang.String cluster, java.lang.String provider, InvocationConfig invocationConfig) Remove a Key Provider.
java.lang.String	get_Task(java.lang.String cluster, java.lang.String provider) Return information about a Key Provider.
void	get_Task(java.lang.String cluster, java.lang.String provider, AsyncCallback<java.lang.String> asyncCallback) Return information about a Key Provider.
void	get_Task(java.lang.String cluster, java.lang.String provider, AsyncCallback<java.lang.String> asyncCallback, InvocationConfig invocationConfig) Return information about a Key Provider.
java.lang.String	get_Task(java.lang.String cluster, java.lang.String provider, InvocationConfig invocationConfig) Return information about a Key Provider.
java.lang.String	list_Task(java.lang.String cluster) Return a list of summary of Key Providers.
void	list_Task(java.lang.String cluster, AsyncCallback<java.lang.String> asyncCallback) Return a list of summary of Key Providers.
void	list_Task(java.lang.String cluster, AsyncCallback<java.lang.String> asyncCallback, InvocationConfig invocationConfig) Return a list of summary of Key Providers.
java.lang.String	list_Task(java.lang.String cluster, InvocationConfig invocationConfig) Return a list of summary of Key Providers.
java.lang.String	update_Task(java.lang.String cluster, java.lang.String provider, ProvidersTypes.UpdateSpec spec) Update an existing Key Provider.
void	update_Task(java.lang.String cluster, java.lang.String provider, ProvidersTypes.UpdateSpec spec, AsyncCallback<java.lang.String> asyncCallback) Update an existing Key Provider.
void	update_Task(java.lang.String cluster, java.lang.String provider, ProvidersTypes.UpdateSpec spec, AsyncCallback<java.lang.String> asyncCallback, InvocationConfig invocationConfig) Update an existing Key Provider.
java.lang.String	update_Task(java.lang.String cluster, java.lang.String provider, ProvidersTypes.UpdateSpec spec, InvocationConfig invocationConfig) Update an existing Key Provider.

Method Detail

list_Task

java.lang.String list_Task(java.lang.String cluster)

Return a list of summary of Key Providers. This method was added in vSphere API 7.0.0.

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

Parameters:

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

Returns:

identifier for the task created by this API invocation

Throws:

InvalidArgument - If the cluster id is empty.

NotFound - If the cluster is not found.

Unauthenticated - If the caller is not authenticated.

Error - For any other error.

list_Task

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

Return a list of summary of Key Providers. This method was added in vSphere API 7.0.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 - Identifier of the cluster. 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:

InvalidArgument - If the cluster id is empty.

NotFound - If the cluster is not found.

Unauthenticated - If the caller is not authenticated.

Error - For any other error.

list_Task

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

Return a list of summary of Key Providers. This method was added in vSphere API 7.0.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:
InvalidArgument - If the cluster id is empty.
NotFound - If the cluster is not found.
Unauthenticated - If the caller is not authenticated.
Error - For any other error.

Parameters:

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

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

list_Task

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

Return a list of summary of Key Providers. This method was added in vSphere API 7.0.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:
InvalidArgument - If the cluster id is empty.
NotFound - If the cluster is not found.
Unauthenticated - If the caller is not authenticated.
Error - For any other error.

Parameters:

cluster - Identifier of the cluster. 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.

create_Task

java.lang.String create_Task(java.lang.String cluster,
                             ProvidersTypes.CreateSpec spec)

Add a new Key Provider. This method was added in vSphere API 7.0.0.

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

Parameters:

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

spec - Provider information.

Returns:

identifier for the task created by this API invocation

Throws:

AlreadyExists - If the provider already exists.

InvalidArgument - If the spec is invalid or cluster id is empty.

NotFound - If the cluster is not found.

Unauthenticated - If the caller is not authenticated.

Error - For any other error.

create_Task

java.lang.String create_Task(java.lang.String cluster,
                             ProvidersTypes.CreateSpec spec,
                             InvocationConfig invocationConfig)

Add a new Key Provider. This method was added in vSphere API 7.0.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 - Identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.

spec - Provider information.

invocationConfig - Configuration for the method invocation.

Returns:

identifier for the task created by this API invocation

Throws:

AlreadyExists - If the provider already exists.

InvalidArgument - If the spec is invalid or cluster id is empty.

NotFound - If the cluster is not found.

Unauthenticated - If the caller is not authenticated.

Error - For any other error.

create_Task

void create_Task(java.lang.String cluster,
                 ProvidersTypes.CreateSpec spec,
                 AsyncCallback<java.lang.String> asyncCallback)

Add a new Key Provider. This method was added in vSphere API 7.0.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:
AlreadyExists - If the provider already exists.
InvalidArgument - If the spec is invalid or cluster id is empty.
NotFound - If the cluster is not found.
Unauthenticated - If the caller is not authenticated.
Error - For any other error.

Parameters:

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

spec - Provider information.

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

create_Task

void create_Task(java.lang.String cluster,
                 ProvidersTypes.CreateSpec spec,
                 AsyncCallback<java.lang.String> asyncCallback,
                 InvocationConfig invocationConfig)

Add a new Key Provider. This method was added in vSphere API 7.0.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:
AlreadyExists - If the provider already exists.
InvalidArgument - If the spec is invalid or cluster id is empty.
NotFound - If the cluster is not found.
Unauthenticated - If the caller is not authenticated.
Error - For any other error.

Parameters:

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

spec - Provider information.

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,
                             java.lang.String provider,
                             ProvidersTypes.UpdateSpec spec)

Update an existing Key Provider. This method was added in vSphere API 7.0.0.

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

Parameters:

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

provider - Identifier of the provider. The parameter must be an identifier for the resource type: com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms.Provider.

spec - Provider information.

Returns:

identifier for the task created by this API invocation

Throws:

InvalidArgument - If the cluster or provider id is empty, or the spec is invalid.

NotFound - If the cluster or provider is not found.

Unauthenticated - If the caller is not authenticated.

Error - For any other error.

update_Task

java.lang.String update_Task(java.lang.String cluster,
                             java.lang.String provider,
                             ProvidersTypes.UpdateSpec spec,
                             InvocationConfig invocationConfig)

Update an existing Key Provider. This method was added in vSphere API 7.0.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 - Identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.

provider - Identifier of the provider. The parameter must be an identifier for the resource type: com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms.Provider.

spec - Provider information.

invocationConfig - Configuration for the method invocation.

Returns:

identifier for the task created by this API invocation

Throws:

InvalidArgument - If the cluster or provider id is empty, or the spec is invalid.

NotFound - If the cluster or provider is not found.

Unauthenticated - If the caller is not authenticated.

Error - For any other error.

update_Task

void update_Task(java.lang.String cluster,
                 java.lang.String provider,
                 ProvidersTypes.UpdateSpec spec,
                 AsyncCallback<java.lang.String> asyncCallback)

Update an existing Key Provider. This method was added in vSphere API 7.0.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:
InvalidArgument - If the cluster or provider id is empty, or the spec is invalid.
NotFound - If the cluster or provider is not found.
Unauthenticated - If the caller is not authenticated.
Error - For any other error.

Parameters:

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

provider - Identifier of the provider. The parameter must be an identifier for the resource type: com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms.Provider.

spec - Provider information.

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

update_Task

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

Update an existing Key Provider. This method was added in vSphere API 7.0.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:
InvalidArgument - If the cluster or provider id is empty, or the spec is invalid.
NotFound - If the cluster or provider is not found.
Unauthenticated - If the caller is not authenticated.
Error - For any other error.

Parameters:

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

provider - Identifier of the provider. The parameter must be an identifier for the resource type: com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms.Provider.

spec - Provider information.

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,
                             java.lang.String provider)

Remove a Key Provider. This method was added in vSphere API 7.0.0.

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

Parameters:

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

provider - Identifier of the provider. The parameter must be an identifier for the resource type: com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms.Provider.

Returns:

identifier for the task created by this API invocation

Throws:

InvalidArgument - If the cluster or provider id is empty.

NotFound - If the cluster or provider is not found.

Unauthenticated - If the caller is not authenticated.

Error - For any other error.

delete_Task

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

Remove a Key Provider. This method was added in vSphere API 7.0.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 - Identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.

provider - Identifier of the provider. The parameter must be an identifier for the resource type: com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms.Provider.

invocationConfig - Configuration for the method invocation.

Returns:

identifier for the task created by this API invocation

Throws:

InvalidArgument - If the cluster or provider id is empty.

NotFound - If the cluster or provider is not found.

Unauthenticated - If the caller is not authenticated.

Error - For any other error.

delete_Task

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

Remove a Key Provider. This method was added in vSphere API 7.0.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:
InvalidArgument - If the cluster or provider id is empty.
NotFound - If the cluster or provider is not found.
Unauthenticated - If the caller is not authenticated.
Error - For any other error.

Parameters:

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

provider - Identifier of the provider. The parameter must be an identifier for the resource type: com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms.Provider.

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

delete_Task

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

Remove a Key Provider. This method was added in vSphere API 7.0.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:
InvalidArgument - If the cluster or provider id is empty.
NotFound - If the cluster or provider is not found.
Unauthenticated - If the caller is not authenticated.
Error - For any other error.

Parameters:

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

provider - Identifier of the provider. The parameter must be an identifier for the resource type: com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms.Provider.

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,
                          java.lang.String provider)

Return information about a Key Provider. This method was added in vSphere API 7.0.0.

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

Parameters:

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

provider - Identifier of the provider. The parameter must be an identifier for the resource type: com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms.Provider.

Returns:

identifier for the task created by this API invocation

Throws:

InvalidArgument - If the cluster or provider id is empty.

NotFound - If the cluster or provider is not found.

Unauthenticated - If the caller is not authenticated.

Error - For any other error.

get_Task

java.lang.String get_Task(java.lang.String cluster,
                          java.lang.String provider,
                          InvocationConfig invocationConfig)

Return information about a Key Provider. This method was added in vSphere API 7.0.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 - Identifier of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.

provider - Identifier of the provider. The parameter must be an identifier for the resource type: com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms.Provider.

invocationConfig - Configuration for the method invocation.

Returns:

identifier for the task created by this API invocation

Throws:

InvalidArgument - If the cluster or provider id is empty.

NotFound - If the cluster or provider is not found.

Unauthenticated - If the caller is not authenticated.

Error - For any other error.

get_Task

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

Return information about a Key Provider. This method was added in vSphere API 7.0.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:
InvalidArgument - If the cluster or provider id is empty.
NotFound - If the cluster or provider is not found.
Unauthenticated - If the caller is not authenticated.
Error - For any other error.

Parameters:

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

provider - Identifier of the provider. The parameter must be an identifier for the resource type: com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms.Provider.

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

get_Task

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

Return information about a Key Provider. This method was added in vSphere API 7.0.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:
InvalidArgument - If the cluster or provider id is empty.
NotFound - If the cluster or provider is not found.
Unauthenticated - If the caller is not authenticated.
Error - For any other error.

Parameters:

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

provider - Identifier of the provider. The parameter must be an identifier for the resource type: com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.kms.Provider.

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

invocationConfig - Configuration for the method invocation.