com.vmware.vcenter.crypto_manager.hosts.kms

Interface Providers

All Superinterfaces:

ProvidersTypes, Service

All Known Implementing Classes:

ProvidersStub

public interface Providers
extends Service, ProvidersTypes

The Providers interface provides methods to retrieve providers on a host. This interface was added in vSphere API 7.0.2.0.

Nested Class Summary

Nested classes/interfaces inherited from interface com.vmware.vcenter.crypto_manager.hosts.kms.ProvidersTypes

ProvidersTypes.FilterSpec, ProvidersTypes.Health, ProvidersTypes.Info, ProvidersTypes.NativeProviderInfo, ProvidersTypes.Summary, ProvidersTypes.Type

Field Summary

Fields inherited from interface com.vmware.vcenter.crypto_manager.hosts.kms.ProvidersTypes

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method and Description
ProvidersTypes.Info	get(java.lang.String host, java.lang.String provider) Get a provider on a host.
void	get(java.lang.String host, java.lang.String provider, AsyncCallback<ProvidersTypes.Info> asyncCallback) Get a provider on a host.
void	get(java.lang.String host, java.lang.String provider, AsyncCallback<ProvidersTypes.Info> asyncCallback, InvocationConfig invocationConfig) Get a provider on a host.
ProvidersTypes.Info	get(java.lang.String host, java.lang.String provider, InvocationConfig invocationConfig) Get a provider on a host.
java.util.List<ProvidersTypes.Summary>	list(java.lang.String host, ProvidersTypes.FilterSpec filterSpec) List the available providers on a host.
void	list(java.lang.String host, ProvidersTypes.FilterSpec filterSpec, AsyncCallback<java.util.List<ProvidersTypes.Summary>> asyncCallback) List the available providers on a host.
void	list(java.lang.String host, ProvidersTypes.FilterSpec filterSpec, AsyncCallback<java.util.List<ProvidersTypes.Summary>> asyncCallback, InvocationConfig invocationConfig) List the available providers on a host.
java.util.List<ProvidersTypes.Summary>	list(java.lang.String host, ProvidersTypes.FilterSpec filterSpec, InvocationConfig invocationConfig) List the available providers on a host.

Method Detail

list

java.util.List<ProvidersTypes.Summary> list(java.lang.String host,
                                            ProvidersTypes.FilterSpec filterSpec)

List the available providers on a host. This method was added in vSphere API 7.0.2.0.

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

Parameters:

host - Host identifier. The parameter must be an identifier for the resource type: HostSystem.

filterSpec - Filter spec. If null, the behavior is equivalent to a ProvidersTypes.FilterSpec with all properties null.

Returns:

Summary of providers.

Throws:

Error - if there is a generic error.

InvalidArgument - if the host identifier is empty or the FilterSpec is invalid.

NotFound - if the host is not found.

Unauthenticated - if the caller is not authenticated.

Unauthorized - if the caller is not authorized.

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

• The resource HostSystem referenced by the parameter host requires Cryptographer.ReadKeyServersInfo.

list

java.util.List<ProvidersTypes.Summary> list(java.lang.String host,
                                            ProvidersTypes.FilterSpec filterSpec,
                                            InvocationConfig invocationConfig)

List the available providers on a host. This method was added in vSphere API 7.0.2.0.

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:

host - Host identifier. The parameter must be an identifier for the resource type: HostSystem.

filterSpec - Filter spec. If null, the behavior is equivalent to a ProvidersTypes.FilterSpec with all properties null.

invocationConfig - Configuration for the method invocation.

Returns:

Summary of providers.

Throws:

Error - if there is a generic error.

InvalidArgument - if the host identifier is empty or the FilterSpec is invalid.

NotFound - if the host is not found.

Unauthenticated - if the caller is not authenticated.

Unauthorized - if the caller is not authorized.

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

• The resource HostSystem referenced by the parameter host requires Cryptographer.ReadKeyServersInfo.

list

void list(java.lang.String host,
          ProvidersTypes.FilterSpec filterSpec,
          AsyncCallback<java.util.List<ProvidersTypes.Summary>> asyncCallback)

List the available providers on a host. This method was added in vSphere API 7.0.2.0.

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

Invocation Result:
Summary of providers.

Operation Errors:
Error - if there is a generic error.
InvalidArgument - if the host identifier is empty or the FilterSpec is invalid.
NotFound - if the host is not found.
Unauthenticated - if the caller is not authenticated.
Unauthorized - if the caller is not authorized.
Unauthorized - if you do not have all of the privileges described as follows:

• The resource HostSystem referenced by the parameter host requires Cryptographer.ReadKeyServersInfo.

Parameters:

host - Host identifier. The parameter must be an identifier for the resource type: HostSystem.

filterSpec - Filter spec. If null, the behavior is equivalent to a ProvidersTypes.FilterSpec with all properties null.

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

list

void list(java.lang.String host,
          ProvidersTypes.FilterSpec filterSpec,
          AsyncCallback<java.util.List<ProvidersTypes.Summary>> asyncCallback,
          InvocationConfig invocationConfig)

List the available providers on a host. This method was added in vSphere API 7.0.2.0.

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:
Summary of providers.

Operation Errors:
Error - if there is a generic error.
InvalidArgument - if the host identifier is empty or the FilterSpec is invalid.
NotFound - if the host is not found.
Unauthenticated - if the caller is not authenticated.
Unauthorized - if the caller is not authorized.
Unauthorized - if you do not have all of the privileges described as follows:

• The resource HostSystem referenced by the parameter host requires Cryptographer.ReadKeyServersInfo.

Parameters:

host - Host identifier. The parameter must be an identifier for the resource type: HostSystem.

filterSpec - Filter spec. If null, the behavior is equivalent to a ProvidersTypes.FilterSpec with all properties null.

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

invocationConfig - Configuration for the method invocation.

get

ProvidersTypes.Info get(java.lang.String host,
                        java.lang.String provider)

Get a provider on a host. This method was added in vSphere API 7.0.2.0.

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

Parameters:

host - Host identifier. The parameter must be an identifier for the resource type: HostSystem.

provider - Provider identifier. The parameter must be an identifier for the resource type: com.vmware.vcenter.crypto_manager.kms.provider.

Returns:

Information of the provider.

Throws:

Error - if there is a generic error.

InvalidArgument - if the host identifier is empty or the provider identifier is empty.

NotFound - if the provider or the host is not found.

Unauthenticated - if the caller is not authenticated.

Unauthorized - if the caller is not authorized.

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

• The resource HostSystem referenced by the parameter host requires Cryptographer.ReadKeyServersInfo.

get

ProvidersTypes.Info get(java.lang.String host,
                        java.lang.String provider,
                        InvocationConfig invocationConfig)

Get a provider on a host. This method was added in vSphere API 7.0.2.0.

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:

host - Host identifier. The parameter must be an identifier for the resource type: HostSystem.

provider - Provider identifier. The parameter must be an identifier for the resource type: com.vmware.vcenter.crypto_manager.kms.provider.

invocationConfig - Configuration for the method invocation.

Returns:

Information of the provider.

Throws:

Error - if there is a generic error.

InvalidArgument - if the host identifier is empty or the provider identifier is empty.

NotFound - if the provider or the host is not found.

Unauthenticated - if the caller is not authenticated.

Unauthorized - if the caller is not authorized.

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

• The resource HostSystem referenced by the parameter host requires Cryptographer.ReadKeyServersInfo.

get

void get(java.lang.String host,
         java.lang.String provider,
         AsyncCallback<ProvidersTypes.Info> asyncCallback)

Get a provider on a host. This method was added in vSphere API 7.0.2.0.

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

Invocation Result:
Information of the provider.

Operation Errors:
Error - if there is a generic error.
InvalidArgument - if the host identifier is empty or the provider identifier is empty.
NotFound - if the provider or the host is not found.
Unauthenticated - if the caller is not authenticated.
Unauthorized - if the caller is not authorized.
Unauthorized - if you do not have all of the privileges described as follows:

• The resource HostSystem referenced by the parameter host requires Cryptographer.ReadKeyServersInfo.

Parameters:

host - Host identifier. The parameter must be an identifier for the resource type: HostSystem.

provider - Provider identifier. The parameter must be an identifier for the resource type: com.vmware.vcenter.crypto_manager.kms.provider.

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

get

void get(java.lang.String host,
         java.lang.String provider,
         AsyncCallback<ProvidersTypes.Info> asyncCallback,
         InvocationConfig invocationConfig)

Get a provider on a host. This method was added in vSphere API 7.0.2.0.

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:
Information of the provider.

Operation Errors:
Error - if there is a generic error.
InvalidArgument - if the host identifier is empty or the provider identifier is empty.
NotFound - if the provider or the host is not found.
Unauthenticated - if the caller is not authenticated.
Unauthorized - if the caller is not authorized.
Unauthorized - if you do not have all of the privileges described as follows:

• The resource HostSystem referenced by the parameter host requires Cryptographer.ReadKeyServersInfo.

Parameters:

host - Host identifier. The parameter must be an identifier for the resource type: HostSystem.

provider - Provider identifier. The parameter must be an identifier for the resource type: com.vmware.vcenter.crypto_manager.kms.provider.

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

invocationConfig - Configuration for the method invocation.