com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.tpm2

Interface EndorsementKeys

All Superinterfaces:

EndorsementKeysTypes, Service

All Known Implementing Classes:

EndorsementKeysStub

public interface EndorsementKeys
extends Service, EndorsementKeysTypes

The EndorsementKeys interface provides methods to manage Trusted Platform Module (TPM) Endorsement Keys (EK) on a cluster level. 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_clusters.attestation.tpm2.EndorsementKeysTypes

EndorsementKeysTypes._VAPI_OPERATIONS, EndorsementKeysTypes.CreateSpec, EndorsementKeysTypes.Health, EndorsementKeysTypes.Info, EndorsementKeysTypes.Summary

Field Summary

Fields inherited from interface com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.tpm2.EndorsementKeysTypes

_VAPI_SERVICE_ID, RESOURCE_TYPE

Method Summary

Modifier and Type	Method and Description
java.lang.String	create_Task(java.lang.String cluster, EndorsementKeysTypes.CreateSpec spec) Add a new TPM endorsement key on a cluster.
void	create_Task(java.lang.String cluster, EndorsementKeysTypes.CreateSpec spec, AsyncCallback<java.lang.String> asyncCallback) Add a new TPM endorsement key on a cluster.
void	create_Task(java.lang.String cluster, EndorsementKeysTypes.CreateSpec spec, AsyncCallback<java.lang.String> asyncCallback, InvocationConfig invocationConfig) Add a new TPM endorsement key on a cluster.
java.lang.String	create_Task(java.lang.String cluster, EndorsementKeysTypes.CreateSpec spec, InvocationConfig invocationConfig) Add a new TPM endorsement key on a cluster.
java.lang.String	delete_Task(java.lang.String cluster, java.lang.String name) Remove a TPM endorsement key on a cluster.
void	delete_Task(java.lang.String cluster, java.lang.String name, AsyncCallback<java.lang.String> asyncCallback) Remove a TPM endorsement key on a cluster.
void	delete_Task(java.lang.String cluster, java.lang.String name, AsyncCallback<java.lang.String> asyncCallback, InvocationConfig invocationConfig) Remove a TPM endorsement key on a cluster.
java.lang.String	delete_Task(java.lang.String cluster, java.lang.String name, InvocationConfig invocationConfig) Remove a TPM endorsement key on a cluster.
java.lang.String	get_Task(java.lang.String cluster, java.lang.String name) Get the TPM endorsement key details on a cluster.
void	get_Task(java.lang.String cluster, java.lang.String name, AsyncCallback<java.lang.String> asyncCallback) Get the TPM endorsement key details on a cluster.
void	get_Task(java.lang.String cluster, java.lang.String name, AsyncCallback<java.lang.String> asyncCallback, InvocationConfig invocationConfig) Get the TPM endorsement key details on a cluster.
java.lang.String	get_Task(java.lang.String cluster, java.lang.String name, InvocationConfig invocationConfig) Get the TPM endorsement key details on a cluster.
java.lang.String	list_Task(java.lang.String cluster) Return a list of configured TPM endorsement keys in a cluster.
void	list_Task(java.lang.String cluster, AsyncCallback<java.lang.String> asyncCallback) Return a list of configured TPM endorsement keys in a cluster.
void	list_Task(java.lang.String cluster, AsyncCallback<java.lang.String> asyncCallback, InvocationConfig invocationConfig) Return a list of configured TPM endorsement keys in a cluster.
java.lang.String	list_Task(java.lang.String cluster, InvocationConfig invocationConfig) Return a list of configured TPM endorsement keys in a cluster.

Method Detail

list_Task

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

Return a list of configured TPM endorsement keys in a 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 id of the cluster on which the operation will be executed. The parameter must be an identifier for the resource type: ClusterComputeResource.

Returns:

identifier for the task created by this API invocation

Throws:

Error - if there is a generic error.

InvalidArgument - if the cluster id is empty.

NotFound - if the cluster is not found.

Unauthenticated - if the caller is not authenticated.

list_Task

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

Return a list of configured TPM endorsement keys in a 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 id of the cluster on which the operation will be executed. 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:

Error - if there is a generic error.

InvalidArgument - if the cluster id is empty.

NotFound - if the cluster is not found.

Unauthenticated - if the caller is not authenticated.

list_Task

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

Return a list of configured TPM endorsement keys in a 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.
InvalidArgument - if the cluster id is empty.
NotFound - if the cluster is not found.
Unauthenticated - if the caller is not authenticated.

Parameters:

cluster - The id of the cluster on which the operation will be executed. 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 configured TPM endorsement keys in a 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.
InvalidArgument - if the cluster id is empty.
NotFound - if the cluster is not found.
Unauthenticated - if the caller is not authenticated.

Parameters:

cluster - The id of the cluster on which the operation will be executed. 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,
                             EndorsementKeysTypes.CreateSpec spec)

Add a new TPM endorsement key on a 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 id of the cluster on which the operation will be executed. The parameter must be an identifier for the resource type: ClusterComputeResource.

spec - The configuration.

Returns:

identifier for the task created by this API invocation

Throws:

AlreadyExists - if the endorsement key name exists.

Error - if there is a generic error.

InvalidArgument - if the configuration is invalid or cluster id is empty.

NotFound - if cluster doesn't match to any cluster in the vCenter.

Unauthenticated - if the caller is not authenticated.

create_Task

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

Add a new TPM endorsement key on a 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 id of the cluster on which the operation will be executed. The parameter must be an identifier for the resource type: ClusterComputeResource.

spec - The configuration.

invocationConfig - Configuration for the method invocation.

Returns:

identifier for the task created by this API invocation

Throws:

AlreadyExists - if the endorsement key name exists.

Error - if there is a generic error.

InvalidArgument - if the configuration is invalid or cluster id is empty.

NotFound - if cluster doesn't match to any cluster in the vCenter.

Unauthenticated - if the caller is not authenticated.

create_Task

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

Add a new TPM endorsement key on a 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:
AlreadyExists - if the endorsement key name exists.
Error - if there is a generic error.
InvalidArgument - if the configuration is invalid or cluster id is empty.
NotFound - if cluster doesn't match to any cluster in the vCenter.
Unauthenticated - if the caller is not authenticated.

Parameters:

cluster - The id of the cluster on which the operation will be executed. The parameter must be an identifier for the resource type: ClusterComputeResource.

spec - The configuration.

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

create_Task

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

Add a new TPM endorsement key on a 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:
AlreadyExists - if the endorsement key name exists.
Error - if there is a generic error.
InvalidArgument - if the configuration is invalid or cluster id is empty.
NotFound - if cluster doesn't match to any cluster in the vCenter.
Unauthenticated - if the caller is not authenticated.

Parameters:

cluster - The id of the cluster on which the operation will be executed. The parameter must be an identifier for the resource type: ClusterComputeResource.

spec - The configuration.

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

Remove a TPM endorsement key on a 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 id of the cluster on which the operation will be executed. The parameter must be an identifier for the resource type: ClusterComputeResource.

name - The endorsement key name. The parameter must be an identifier for the resource type: com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.tpm2.EndorsementKey.

Returns:

identifier for the task created by this API invocation

Throws:

Error - if there is a generic error.

InvalidArgument - if the name is invalid or cluster id is empty.

NotFound - if the name is not found or cluster doesn't match to any cluster in the vCenter.

Unauthenticated - if the caller is not authenticated.

delete_Task

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

Remove a TPM endorsement key on a 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 id of the cluster on which the operation will be executed. The parameter must be an identifier for the resource type: ClusterComputeResource.

name - The endorsement key name. The parameter must be an identifier for the resource type: com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.tpm2.EndorsementKey.

invocationConfig - Configuration for the method invocation.

Returns:

identifier for the task created by this API invocation

Throws:

Error - if there is a generic error.

InvalidArgument - if the name is invalid or cluster id is empty.

NotFound - if the name is not found or cluster doesn't match to any cluster in the vCenter.

Unauthenticated - if the caller is not authenticated.

delete_Task

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

Remove a TPM endorsement key on a 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.
InvalidArgument - if the name is invalid or cluster id is empty.
NotFound - if the name is not found or cluster doesn't match to any cluster in the vCenter.
Unauthenticated - if the caller is not authenticated.

Parameters:

cluster - The id of the cluster on which the operation will be executed. The parameter must be an identifier for the resource type: ClusterComputeResource.

name - The endorsement key name. The parameter must be an identifier for the resource type: com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.tpm2.EndorsementKey.

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

delete_Task

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

Remove a TPM endorsement key on a 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.
InvalidArgument - if the name is invalid or cluster id is empty.
NotFound - if the name is not found or cluster doesn't match to any cluster in the vCenter.
Unauthenticated - if the caller is not authenticated.

Parameters:

cluster - The id of the cluster on which the operation will be executed. The parameter must be an identifier for the resource type: ClusterComputeResource.

name - The endorsement key name. The parameter must be an identifier for the resource type: com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.tpm2.EndorsementKey.

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

Get the TPM endorsement key details on a 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 id of the cluster on which the operation will be executed. The parameter must be an identifier for the resource type: ClusterComputeResource.

name - The endorsement key name. The parameter must be an identifier for the resource type: com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.tpm2.EndorsementKey.

Returns:

identifier for the task created by this API invocation

Throws:

Error - if there is a generic error.

InvalidArgument - if the name is invalid or cluster id is empty.

NotFound - if the endorsement key is not found or cluster doesn't match to any cluster in the vCenter.

Unauthenticated - if the caller is not authenticated.

get_Task

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

Get the TPM endorsement key details on a 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 id of the cluster on which the operation will be executed. The parameter must be an identifier for the resource type: ClusterComputeResource.

name - The endorsement key name. The parameter must be an identifier for the resource type: com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.tpm2.EndorsementKey.

invocationConfig - Configuration for the method invocation.

Returns:

identifier for the task created by this API invocation

Throws:

Error - if there is a generic error.

InvalidArgument - if the name is invalid or cluster id is empty.

NotFound - if the endorsement key is not found or cluster doesn't match to any cluster in the vCenter.

Unauthenticated - if the caller is not authenticated.

get_Task

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

Get the TPM endorsement key details on a 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.
InvalidArgument - if the name is invalid or cluster id is empty.
NotFound - if the endorsement key is not found or cluster doesn't match to any cluster in the vCenter.
Unauthenticated - if the caller is not authenticated.

Parameters:

cluster - The id of the cluster on which the operation will be executed. The parameter must be an identifier for the resource type: ClusterComputeResource.

name - The endorsement key name. The parameter must be an identifier for the resource type: com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.tpm2.EndorsementKey.

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

get_Task

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

Get the TPM endorsement key details on a 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.
InvalidArgument - if the name is invalid or cluster id is empty.
NotFound - if the endorsement key is not found or cluster doesn't match to any cluster in the vCenter.
Unauthenticated - if the caller is not authenticated.

Parameters:

cluster - The id of the cluster on which the operation will be executed. The parameter must be an identifier for the resource type: ClusterComputeResource.

name - The endorsement key name. The parameter must be an identifier for the resource type: com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.tpm2.EndorsementKey.

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

invocationConfig - Configuration for the method invocation.