com.vmware.vcenter.trusted_infrastructure.kms

Interface Services

All Superinterfaces:

Service, ServicesTypes

All Known Implementing Classes:

ServicesStub

public interface Services
extends Service, ServicesTypes

The Services interface contains information about the registered instances of the Key Provider Service in vCenter. 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.kms.ServicesTypes

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

Field Summary

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

_VAPI_SERVICE_ID, RESOURCE_TYPE

Method Summary

Modifier and Type	Method and Description
java.lang.String	create(ServicesTypes.CreateSpec spec) Registers a Key Provider Service instance in this vCenter.
void	create(ServicesTypes.CreateSpec spec, AsyncCallback<java.lang.String> asyncCallback) Registers a Key Provider Service instance in this vCenter.
void	create(ServicesTypes.CreateSpec spec, AsyncCallback<java.lang.String> asyncCallback, InvocationConfig invocationConfig) Registers a Key Provider Service instance in this vCenter.
java.lang.String	create(ServicesTypes.CreateSpec spec, InvocationConfig invocationConfig) Registers a Key Provider Service instance in this vCenter.
void	delete(java.lang.String service) Removes a currently registered Key Provider Service instance from this vCenter.
void	delete(java.lang.String service, AsyncCallback<java.lang.Void> asyncCallback) Removes a currently registered Key Provider Service instance from this vCenter.
void	delete(java.lang.String service, AsyncCallback<java.lang.Void> asyncCallback, InvocationConfig invocationConfig) Removes a currently registered Key Provider Service instance from this vCenter.
void	delete(java.lang.String service, InvocationConfig invocationConfig) Removes a currently registered Key Provider Service instance from this vCenter.
ServicesTypes.Info	get(java.lang.String service) Returns the detailed information about a registered Key Provider Service instance in this vCenter.
void	get(java.lang.String service, AsyncCallback<ServicesTypes.Info> asyncCallback) Returns the detailed information about a registered Key Provider Service instance in this vCenter.
void	get(java.lang.String service, AsyncCallback<ServicesTypes.Info> asyncCallback, InvocationConfig invocationConfig) Returns the detailed information about a registered Key Provider Service instance in this vCenter.
ServicesTypes.Info	get(java.lang.String service, InvocationConfig invocationConfig) Returns the detailed information about a registered Key Provider Service instance in this vCenter.
java.util.List<ServicesTypes.Summary>	list(ServicesTypes.FilterSpec spec) Returns basic information about all registered Key Provider Service instances in this vCenter.
void	list(ServicesTypes.FilterSpec spec, AsyncCallback<java.util.List<ServicesTypes.Summary>> asyncCallback) Returns basic information about all registered Key Provider Service instances in this vCenter.
void	list(ServicesTypes.FilterSpec spec, AsyncCallback<java.util.List<ServicesTypes.Summary>> asyncCallback, InvocationConfig invocationConfig) Returns basic information about all registered Key Provider Service instances in this vCenter.
java.util.List<ServicesTypes.Summary>	list(ServicesTypes.FilterSpec spec, InvocationConfig invocationConfig) Returns basic information about all registered Key Provider Service instances in this vCenter.

Method Detail

list

java.util.List<ServicesTypes.Summary> list(ServicesTypes.FilterSpec spec)

Returns basic information about all registered Key Provider Service instances in this vCenter. 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 only services matching the specified filters. If return all services.

Returns:

Basic information about all registered Key Provider Service instances in this vCenter.

Throws:

Error - if an error occurred while getting the data.

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.

list

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

Returns basic information about all registered Key Provider Service instances in this vCenter. 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 only services matching the specified filters. If return all services.

invocationConfig - Configuration for the method invocation.

Returns:

Basic information about all registered Key Provider Service instances in this vCenter.

Throws:

Error - if an error occurred while getting the data.

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.

list

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

Returns basic information about all registered Key Provider Service instances in this vCenter. 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 registered Key Provider Service instances in this vCenter.

Operation Errors:
Error - if an error occurred while getting the data.
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.

Parameters:

spec - Return only services matching the specified filters. If return all services.

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

list

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

Returns basic information about all registered Key Provider Service instances in this vCenter. 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 registered Key Provider Service instances in this vCenter.

Operation Errors:
Error - if an error occurred while getting the data.
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.

Parameters:

spec - Return only services matching the specified 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 service)

Returns the detailed information about a registered Key Provider Service instance in this vCenter. 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:

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

Returns:

Detailed information about the specified Key Provider Service instance.

Throws:

Error - if an error occurred while getting the data.

NotFound - if there is no Key Provider Service instance with the specified ID.

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.

get

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

Returns the detailed information about a registered Key Provider Service instance in this vCenter. 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:

service - the 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:

Detailed information about the specified Key Provider Service instance.

Throws:

Error - if an error occurred while getting the data.

NotFound - if there is no Key Provider Service instance with the specified ID.

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.

get

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

Returns the detailed information about a registered Key Provider Service instance in this vCenter. 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 specified Key Provider Service instance.

Operation Errors:
Error - if an error occurred while getting the data.
NotFound - if there is no Key Provider Service instance with the specified ID.
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.

Parameters:

service - the 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.

get

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

Returns the detailed information about a registered Key Provider Service instance in this vCenter. 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 specified Key Provider Service instance.

Operation Errors:
Error - if an error occurred while getting the data.
NotFound - if there is no Key Provider Service instance with the specified ID.
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.

Parameters:

service - the 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.

create

java.lang.String create(ServicesTypes.CreateSpec spec)

Registers a Key Provider Service instance in this vCenter. 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 - The CreateSpec for the new service.

Returns:

ID of the newly registered Key Provider Service instance. The return value will be an identifier for the resource type: com.vmware.vcenter.trusted_infrastructure.kms.Service.

Throws:

AlreadyExists - if there is already a Key Provider Service instance with the same Address.

Error - if there is a generic error.

InvalidArgument - if the CreateSpec contains invalid data.

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.ManageTrustedHosts.

create

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

Registers a Key Provider Service instance in this vCenter. 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 - The CreateSpec for the new service.

invocationConfig - Configuration for the method invocation.

Returns:

ID of the newly registered Key Provider Service instance. The return value will be an identifier for the resource type: com.vmware.vcenter.trusted_infrastructure.kms.Service.

Throws:

AlreadyExists - if there is already a Key Provider Service instance with the same Address.

Error - if there is a generic error.

InvalidArgument - if the CreateSpec contains invalid data.

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.ManageTrustedHosts.

create

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

Registers a Key Provider Service instance in this vCenter. 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:
ID of the newly registered Key Provider Service instance. The return value will be an identifier for the resource type: com.vmware.vcenter.trusted_infrastructure.kms.Service.

Operation Errors:
AlreadyExists - if there is already a Key Provider Service instance with the same Address.
Error - if there is a generic error.
InvalidArgument - if the CreateSpec contains invalid data.
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.ManageTrustedHosts.

Parameters:

spec - The CreateSpec for the new service.

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

create

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

Registers a Key Provider Service instance in this vCenter. 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:
ID of the newly registered Key Provider Service instance. The return value will be an identifier for the resource type: com.vmware.vcenter.trusted_infrastructure.kms.Service.

Operation Errors:
AlreadyExists - if there is already a Key Provider Service instance with the same Address.
Error - if there is a generic error.
InvalidArgument - if the CreateSpec contains invalid data.
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.ManageTrustedHosts.

Parameters:

spec - The CreateSpec for the new service.

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

invocationConfig - Configuration for the method invocation.

delete

void delete(java.lang.String service)

Removes a currently registered Key Provider Service instance from this vCenter. 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:

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

Throws:

Error - if an error occurred while deleting the service.

NotFound - if the Key Provider Service instance is not found.

ResourceBusy - if the Key Provider Service instance is used by a configuration on a cluster level.

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.ManageTrustedHosts.

delete

void delete(java.lang.String service,
            InvocationConfig invocationConfig)

Removes a currently registered Key Provider Service instance from this vCenter. 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:

service - the 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.

Throws:

Error - if an error occurred while deleting the service.

NotFound - if the Key Provider Service instance is not found.

ResourceBusy - if the Key Provider Service instance is used by a configuration on a cluster level.

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.ManageTrustedHosts.

delete

void delete(java.lang.String service,
            AsyncCallback<java.lang.Void> asyncCallback)

Removes a currently registered Key Provider Service instance from this vCenter. 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.

Operation Errors:
Error - if an error occurred while deleting the service.
NotFound - if the Key Provider Service instance is not found.
ResourceBusy - if the Key Provider Service instance is used by a configuration on a cluster level.
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.ManageTrustedHosts.

Parameters:

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

void delete(java.lang.String service,
            AsyncCallback<java.lang.Void> asyncCallback,
            InvocationConfig invocationConfig)

Removes a currently registered Key Provider Service instance from this vCenter. 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.

Operation Errors:
Error - if an error occurred while deleting the service.
NotFound - if the Key Provider Service instance is not found.
ResourceBusy - if the Key Provider Service instance is used by a configuration on a cluster level.
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.ManageTrustedHosts.

Parameters:

service - the 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.