com.vmware.vcenter.trusted_infrastructure.trusted_clusters.kms

Interface Services

All Superinterfaces:

Service, ServicesTypes

All Known Implementing Classes:

ServicesStub

public interface Services
extends Service, ServicesTypes

The Services interface manages the Key Provider Service instances a Trusted Cluster is configured to use. 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.trusted_clusters.kms.ServicesTypes

ServicesTypes._VAPI_OPERATIONS, ServicesTypes.CreateSpec, ServicesTypes.FilterSpec, ServicesTypes.Info, ServicesTypes.Summary

Field Summary

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

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method and Description
java.lang.String	create_Task(java.lang.String cluster, ServicesTypes.CreateSpec spec) Configures the cluster to use a the given registered Key Provider Service.
void	create_Task(java.lang.String cluster, ServicesTypes.CreateSpec spec, AsyncCallback<java.lang.String> asyncCallback) Configures the cluster to use a the given registered Key Provider Service.
void	create_Task(java.lang.String cluster, ServicesTypes.CreateSpec spec, AsyncCallback<java.lang.String> asyncCallback, InvocationConfig invocationConfig) Configures the cluster to use a the given registered Key Provider Service.
java.lang.String	create_Task(java.lang.String cluster, ServicesTypes.CreateSpec spec, InvocationConfig invocationConfig) Configures the cluster to use a the given registered Key Provider Service.
java.lang.String	delete_Task(java.lang.String cluster, java.lang.String service) Removes the Key Provider Service instance from the configuration of the given cluster.
void	delete_Task(java.lang.String cluster, java.lang.String service, AsyncCallback<java.lang.String> asyncCallback) Removes the Key Provider Service instance from the configuration of the given cluster.
void	delete_Task(java.lang.String cluster, java.lang.String service, AsyncCallback<java.lang.String> asyncCallback, InvocationConfig invocationConfig) Removes the Key Provider Service instance from the configuration of the given cluster.
java.lang.String	delete_Task(java.lang.String cluster, java.lang.String service, InvocationConfig invocationConfig) Removes the Key Provider Service instance from the configuration of the given cluster.
ServicesTypes.Info	get(java.lang.String cluster, java.lang.String service) Returns detailed information about the given Key Provider Service instance used by the given cluster.
void	get(java.lang.String cluster, java.lang.String service, AsyncCallback<ServicesTypes.Info> asyncCallback) Returns detailed information about the given Key Provider Service instance used by the given cluster.
void	get(java.lang.String cluster, java.lang.String service, AsyncCallback<ServicesTypes.Info> asyncCallback, InvocationConfig invocationConfig) Returns detailed information about the given Key Provider Service instance used by the given cluster.
ServicesTypes.Info	get(java.lang.String cluster, java.lang.String service, InvocationConfig invocationConfig) Returns detailed information about the given Key Provider Service instance used by the given cluster.
java.util.List<ServicesTypes.Summary>	list(java.lang.String cluster, ServicesTypes.FilterSpec spec) Returns basic information about all configured Key Provider Service instances used by this cluster.
void	list(java.lang.String cluster, ServicesTypes.FilterSpec spec, AsyncCallback<java.util.List<ServicesTypes.Summary>> asyncCallback) Returns basic information about all configured Key Provider Service instances used by this cluster.
void	list(java.lang.String cluster, ServicesTypes.FilterSpec spec, AsyncCallback<java.util.List<ServicesTypes.Summary>> asyncCallback, InvocationConfig invocationConfig) Returns basic information about all configured Key Provider Service instances used by this cluster.
java.util.List<ServicesTypes.Summary>	list(java.lang.String cluster, ServicesTypes.FilterSpec spec, InvocationConfig invocationConfig) Returns basic information about all configured Key Provider Service instances used by this cluster.

Method Detail

list

java.util.List<ServicesTypes.Summary> list(java.lang.String cluster,
                                           ServicesTypes.FilterSpec spec)

Returns basic information about all configured Key Provider Service instances used by this cluster. 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:

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

spec - Only return services matching the filters. If return all services.

Returns:

basic information about all configured Key Provider Service instances used by this cluster

Throws:

Error - if there is a generic error.

NotFound - if the cluster ID is invalid.

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 ClusterComputeResource referenced by the parameter cluster requires System.View.

list

java.util.List<ServicesTypes.Summary> list(java.lang.String cluster,
                                           ServicesTypes.FilterSpec spec,
                                           InvocationConfig invocationConfig)

Returns basic information about all configured Key Provider Service instances used by this cluster. 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:

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

spec - Only return services matching the filters. If return all services.

invocationConfig - Configuration for the method invocation.

Returns:

basic information about all configured Key Provider Service instances used by this cluster

Throws:

Error - if there is a generic error.

NotFound - if the cluster ID is invalid.

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 ClusterComputeResource referenced by the parameter cluster requires System.View.

list

void list(java.lang.String cluster,
          ServicesTypes.FilterSpec spec,
          AsyncCallback<java.util.List<ServicesTypes.Summary>> asyncCallback)

Returns basic information about all configured Key Provider Service instances used by this cluster. 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:
basic information about all configured Key Provider Service instances used by this cluster

Operation Errors:
Error - if there is a generic error.
NotFound - if the cluster ID is invalid.
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 ClusterComputeResource referenced by the parameter cluster requires System.View.

Parameters:

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

spec - Only return services matching the filters. If return all services.

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

list

void list(java.lang.String cluster,
          ServicesTypes.FilterSpec spec,
          AsyncCallback<java.util.List<ServicesTypes.Summary>> asyncCallback,
          InvocationConfig invocationConfig)

Returns basic information about all configured Key Provider Service instances used by this cluster. 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:
basic information about all configured Key Provider Service instances used by this cluster

Operation Errors:
Error - if there is a generic error.
NotFound - if the cluster ID is invalid.
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 ClusterComputeResource referenced by the parameter cluster requires System.View.

Parameters:

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

spec - Only return services matching the filters. If return all services.

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

invocationConfig - Configuration for the method invocation.

get

ServicesTypes.Info get(java.lang.String cluster,
                       java.lang.String service)

Returns detailed information about the given Key Provider Service instance used by the given cluster. 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:

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

service - The ID of the service. The parameter must be an identifier for the resource type: com.vmware.vcenter.trusted_infrastructure.kms.Service.

Returns:

Detailed information about the given Key Provider Service instance used by the given cluster.

Throws:

Error - if there is a generic error.

NotFound - if the cluster or the service ID is invalid.

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 ClusterComputeResource referenced by the parameter cluster requires System.View.

get

ServicesTypes.Info get(java.lang.String cluster,
                       java.lang.String service,
                       InvocationConfig invocationConfig)

Returns detailed information about the given Key Provider Service instance used by the given cluster. 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:

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

service - The ID of the service. The parameter must be an identifier for the resource type: com.vmware.vcenter.trusted_infrastructure.kms.Service.

invocationConfig - Configuration for the method invocation.

Returns:

Detailed information about the given Key Provider Service instance used by the given cluster.

Throws:

Error - if there is a generic error.

NotFound - if the cluster or the service ID is invalid.

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 ClusterComputeResource referenced by the parameter cluster requires System.View.

get

void get(java.lang.String cluster,
         java.lang.String service,
         AsyncCallback<ServicesTypes.Info> asyncCallback)

Returns detailed information about the given Key Provider Service instance used by the given cluster. 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:
Detailed information about the given Key Provider Service instance used by the given cluster.

Operation Errors:
Error - if there is a generic error.
NotFound - if the cluster or the service ID is invalid.
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 ClusterComputeResource referenced by the parameter cluster requires System.View.

Parameters:

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

service - The ID of the service. The parameter must be an identifier for the resource type: com.vmware.vcenter.trusted_infrastructure.kms.Service.

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

get

void get(java.lang.String cluster,
         java.lang.String service,
         AsyncCallback<ServicesTypes.Info> asyncCallback,
         InvocationConfig invocationConfig)

Returns detailed information about the given Key Provider Service instance used by the given cluster. 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:
Detailed information about the given Key Provider Service instance used by the given cluster.

Operation Errors:
Error - if there is a generic error.
NotFound - if the cluster or the service ID is invalid.
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 ClusterComputeResource referenced by the parameter cluster requires System.View.

Parameters:

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

service - The ID of the service. The parameter must be an identifier for the resource type: com.vmware.vcenter.trusted_infrastructure.kms.Service.

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,
                             ServicesTypes.CreateSpec spec)

Configures the cluster to use a the given registered Key Provider Service. This method was added in vSphere API 7.0.0.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. The parameter must be an identifier for the resource type: ClusterComputeResource.

spec - Describes the registered instance of the Key Provider Service

Returns:

identifier for the task created by this API invocation

Throws:

AlreadyExists - if the Key Provider Service is already configured for this cluster

Error - for any other error.

InvalidArgument - if the CreateSpec is not valid.

NotFound - if the cluster ID is not valid.

UnableToAllocateResource - if all the hosts in the cluster do not have VMware vSphere Trust Authority enabled license.

Unauthenticated - if the user can not be authenticated.

create_Task

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

Configures the cluster to use a the given registered Key Provider Service. This method was added in vSphere API 7.0.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 - The ID of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.

spec - Describes the registered instance of the Key Provider Service

invocationConfig - Configuration for the method invocation.

Returns:

identifier for the task created by this API invocation

Throws:

AlreadyExists - if the Key Provider Service is already configured for this cluster

Error - for any other error.

InvalidArgument - if the CreateSpec is not valid.

NotFound - if the cluster ID is not valid.

UnableToAllocateResource - if all the hosts in the cluster do not have VMware vSphere Trust Authority enabled license.

Unauthenticated - if the user can not be authenticated.

create_Task

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

Configures the cluster to use a the given registered Key Provider Service. This method was added in vSphere API 7.0.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 Key Provider Service is already configured for this cluster
Error - for any other error.
InvalidArgument - if the CreateSpec is not valid.
NotFound - if the cluster ID is not valid.
UnableToAllocateResource - if all the hosts in the cluster do not have VMware vSphere Trust Authority enabled license.
Unauthenticated - if the user can not be authenticated.

Parameters:

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

spec - Describes the registered instance of the Key Provider Service

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

create_Task

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

Configures the cluster to use a the given registered Key Provider Service. This method was added in vSphere API 7.0.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 Key Provider Service is already configured for this cluster
Error - for any other error.
InvalidArgument - if the CreateSpec is not valid.
NotFound - if the cluster ID is not valid.
UnableToAllocateResource - if all the hosts in the cluster do not have VMware vSphere Trust Authority enabled license.
Unauthenticated - if the user can not be authenticated.

Parameters:

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

spec - Describes the registered instance of the Key Provider Service

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 service)

Removes the Key Provider Service instance from the configuration of the given cluster. This method was added in vSphere API 7.0.0.0.

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

Parameters:

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

service - the registered Key Provider Service instance unique identifier. The parameter must be an identifier for the resource type: com.vmware.vcenter.trusted_infrastructure.kms.Service.

Returns:

identifier for the task created by this API invocation

Throws:

Error - if there is a generic error.

NotFound - if the Key Provider Service instance or the cluster are not found.

Unauthenticated - if the user can not be authenticated.

delete_Task

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

Removes the Key Provider Service instance from the configuration of the given cluster. This method was added in vSphere API 7.0.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 - the unique ID of the cluster. The parameter must be an identifier for the resource type: ClusterComputeResource.

service - the registered Key Provider Service instance unique identifier. The parameter must be an identifier for the resource type: com.vmware.vcenter.trusted_infrastructure.kms.Service.

invocationConfig - Configuration for the method invocation.

Returns:

identifier for the task created by this API invocation

Throws:

Error - if there is a generic error.

NotFound - if the Key Provider Service instance or the cluster are not found.

Unauthenticated - if the user can not be authenticated.

delete_Task

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

Removes the Key Provider Service instance from the configuration of the given cluster. This method was added in vSphere API 7.0.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:
Error - if there is a generic error.
NotFound - if the Key Provider Service instance or the cluster are not found.
Unauthenticated - if the user can not be authenticated.

Parameters:

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

service - the registered Key Provider Service instance unique identifier. The parameter must be an identifier for the resource type: com.vmware.vcenter.trusted_infrastructure.kms.Service.

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

delete_Task

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

Removes the Key Provider Service instance from the configuration of the given cluster. This method was added in vSphere API 7.0.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:
Error - if there is a generic error.
NotFound - if the Key Provider Service instance or the cluster are not found.
Unauthenticated - if the user can not be authenticated.

Parameters:

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

service - the registered Key Provider Service instance unique identifier. The parameter must be an identifier for the resource type: com.vmware.vcenter.trusted_infrastructure.kms.Service.

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

invocationConfig - Configuration for the method invocation.