com.vmware.vcenter.trusted_infrastructure.trust_authority_hosts

Interface Kms

All Superinterfaces:

KmsTypes, Service

All Known Implementing Classes:

KmsStub

public interface Kms
extends Service, KmsTypes

The Kms interface contains information necessary to connect to the hosts running Key Provider Service. This interface was added in vSphere API 7.0.0.0.

Nested Class Summary

Nested classes/interfaces inherited from interface com.vmware.vcenter.trusted_infrastructure.trust_authority_hosts.KmsTypes

KmsTypes.FilterSpec, KmsTypes.Info, KmsTypes.Summary, KmsTypes.SummaryType

Field Summary

Fields inherited from interface com.vmware.vcenter.trusted_infrastructure.trust_authority_hosts.KmsTypes

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method and Description
KmsTypes.Info	get(java.lang.String host) Returns the connection info about the Key Provider Service running on the specified host.
void	get(java.lang.String host, AsyncCallback<KmsTypes.Info> asyncCallback) Returns the connection info about the Key Provider Service running on the specified host.
void	get(java.lang.String host, AsyncCallback<KmsTypes.Info> asyncCallback, InvocationConfig invocationConfig) Returns the connection info about the Key Provider Service running on the specified host.
KmsTypes.Info	get(java.lang.String host, InvocationConfig invocationConfig) Returns the connection info about the Key Provider Service running on the specified host.
java.util.List<KmsTypes.Summary>	list(KmsTypes.FilterSpec spec, KmsTypes.SummaryType projection) Returns a list of the hosts running a Key Provider Service matching the specified KmsTypes.FilterSpec.
void	list(KmsTypes.FilterSpec spec, KmsTypes.SummaryType projection, AsyncCallback<java.util.List<KmsTypes.Summary>> asyncCallback) Returns a list of the hosts running a Key Provider Service matching the specified KmsTypes.FilterSpec.
void	list(KmsTypes.FilterSpec spec, KmsTypes.SummaryType projection, AsyncCallback<java.util.List<KmsTypes.Summary>> asyncCallback, InvocationConfig invocationConfig) Returns a list of the hosts running a Key Provider Service matching the specified KmsTypes.FilterSpec.
java.util.List<KmsTypes.Summary>	list(KmsTypes.FilterSpec spec, KmsTypes.SummaryType projection, InvocationConfig invocationConfig) Returns a list of the hosts running a Key Provider Service matching the specified KmsTypes.FilterSpec.

Method Detail

get

KmsTypes.Info get(java.lang.String host)

Returns the connection info about the Key Provider Service running on the specified host. This method was added in vSphere API 7.0.0.0.

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

Parameters:

host - @{link com.vmware.vcenter.Host} id. The parameter must be an identifier for the resource type: HostSystem.

Returns:

The KmsTypes.Info instance which contains the information necessary to connect to the Key Provider Service.

Throws:

Error - if service's TLS certificate chain is not valid.

NotFound - if host doesn't match to any Host.

Unauthenticated - if the user can not be authenticated.

ResourceInaccessible - if connection to host failed.

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

• Method execution requires TrustedAdmin.ReadTrustedHosts.
• The resource HostSystem referenced by the parameter host requires System.View.

get

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

Returns the connection info about the Key Provider Service running on the specified host. This method was added in vSphere API 7.0.0.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 - @{link com.vmware.vcenter.Host} id. The parameter must be an identifier for the resource type: HostSystem.

invocationConfig - Configuration for the method invocation.

Returns:

The KmsTypes.Info instance which contains the information necessary to connect to the Key Provider Service.

Throws:

Error - if service's TLS certificate chain is not valid.

NotFound - if host doesn't match to any Host.

Unauthenticated - if the user can not be authenticated.

ResourceInaccessible - if connection to host failed.

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

• Method execution requires TrustedAdmin.ReadTrustedHosts.
• The resource HostSystem referenced by the parameter host requires System.View.

get

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

Returns the connection info about the Key Provider Service running on the specified host. This method was added in vSphere API 7.0.0.0.

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

Invocation Result:
The KmsTypes.Info instance which contains the information necessary to connect to the Key Provider Service.

Operation Errors:
Error - if service's TLS certificate chain is not valid.
NotFound - if host doesn't match to any Host.
Unauthenticated - if the user can not be authenticated.
ResourceInaccessible - if connection to host failed.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires TrustedAdmin.ReadTrustedHosts.
• The resource HostSystem referenced by the parameter host requires System.View.

Parameters:

host - @{link com.vmware.vcenter.Host} id. The parameter must be an identifier for the resource type: HostSystem.

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

get

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

Returns the connection info about the Key Provider Service running on the specified host. This method was added in vSphere API 7.0.0.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:
The KmsTypes.Info instance which contains the information necessary to connect to the Key Provider Service.

Operation Errors:
Error - if service's TLS certificate chain is not valid.
NotFound - if host doesn't match to any Host.
Unauthenticated - if the user can not be authenticated.
ResourceInaccessible - if connection to host failed.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires TrustedAdmin.ReadTrustedHosts.
• The resource HostSystem referenced by the parameter host requires System.View.

Parameters:

host - @{link com.vmware.vcenter.Host} id. The parameter must be an identifier for the resource type: HostSystem.

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

invocationConfig - Configuration for the method invocation.

list

java.util.List<KmsTypes.Summary> list(KmsTypes.FilterSpec spec,
                                      KmsTypes.SummaryType projection)

Returns a list of the hosts running a Key Provider Service matching the specified KmsTypes.FilterSpec. This method was added in vSphere API 7.0.0.0.

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

Parameters:

spec - Return details about Key Provider Services matching the filter. If return all registered Key Provider Services.

projection - The type of the returned summary - brief, normal, or full. If a normal projection will be used.

Returns:

List of KmsTypes.Summary of Key Provider Services.

Throws:

Error - if there is a generic error.

InvalidArgument - if the response data will exceed the message limit.

Unauthenticated - if the user can not be authenticated.

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

• Method execution requires TrustedAdmin.ReadTrustedHosts.
• The resource HostSystem referenced by the property KmsTypes.FilterSpec.getHosts() requires System.View.
• The resource ClusterComputeResource referenced by the property KmsTypes.FilterSpec.getClusters() requires System.View.

list

java.util.List<KmsTypes.Summary> list(KmsTypes.FilterSpec spec,
                                      KmsTypes.SummaryType projection,
                                      InvocationConfig invocationConfig)

Returns a list of the hosts running a Key Provider Service matching the specified KmsTypes.FilterSpec. This method was added in vSphere API 7.0.0.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:

spec - Return details about Key Provider Services matching the filter. If return all registered Key Provider Services.

projection - The type of the returned summary - brief, normal, or full. If a normal projection will be used.

invocationConfig - Configuration for the method invocation.

Returns:

List of KmsTypes.Summary of Key Provider Services.

Throws:

Error - if there is a generic error.

InvalidArgument - if the response data will exceed the message limit.

Unauthenticated - if the user can not be authenticated.

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

• Method execution requires TrustedAdmin.ReadTrustedHosts.
• The resource HostSystem referenced by the property KmsTypes.FilterSpec.getHosts() requires System.View.
• The resource ClusterComputeResource referenced by the property KmsTypes.FilterSpec.getClusters() requires System.View.

list

void list(KmsTypes.FilterSpec spec,
          KmsTypes.SummaryType projection,
          AsyncCallback<java.util.List<KmsTypes.Summary>> asyncCallback)

Returns a list of the hosts running a Key Provider Service matching the specified KmsTypes.FilterSpec. This method was added in vSphere API 7.0.0.0.

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

Invocation Result:
List of KmsTypes.Summary of Key Provider Services.

Operation Errors:
Error - if there is a generic error.
InvalidArgument - if the response data will exceed the message limit.
Unauthenticated - if the user can not be authenticated.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires TrustedAdmin.ReadTrustedHosts.
• The resource HostSystem referenced by the property KmsTypes.FilterSpec.getHosts() requires System.View.
• The resource ClusterComputeResource referenced by the property KmsTypes.FilterSpec.getClusters() requires System.View.

Parameters:

spec - Return details about Key Provider Services matching the filter. If return all registered Key Provider Services.

projection - The type of the returned summary - brief, normal, or full. If a normal projection will be used.

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

list

void list(KmsTypes.FilterSpec spec,
          KmsTypes.SummaryType projection,
          AsyncCallback<java.util.List<KmsTypes.Summary>> asyncCallback,
          InvocationConfig invocationConfig)

Returns a list of the hosts running a Key Provider Service matching the specified KmsTypes.FilterSpec. This method was added in vSphere API 7.0.0.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:
List of KmsTypes.Summary of Key Provider Services.

Operation Errors:
Error - if there is a generic error.
InvalidArgument - if the response data will exceed the message limit.
Unauthenticated - if the user can not be authenticated.
Unauthorized - if you do not have all of the privileges described as follows:

• Method execution requires TrustedAdmin.ReadTrustedHosts.
• The resource HostSystem referenced by the property KmsTypes.FilterSpec.getHosts() requires System.View.
• The resource ClusterComputeResource referenced by the property KmsTypes.FilterSpec.getClusters() requires System.View.

Parameters:

spec - Return details about Key Provider Services matching the filter. If return all registered Key Provider Services.

projection - The type of the returned summary - brief, normal, or full. If a normal projection will be used.

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

invocationConfig - Configuration for the method invocation.