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

Interface CaCertificates

All Superinterfaces:

CaCertificatesTypes, Service

All Known Implementing Classes:

CaCertificatesStub

public interface CaCertificates
extends Service, CaCertificatesTypes

The CaCertificates interface provides methods to manage Trusted Platform Module (TPM) CA certificates.

Endorsement Keys are typically packaged in a certificate that is signed by a certificate authority (CA). This interface allows the CA certificate to be registered with the Attestation Service in order to validate TPM EK certificates when presented at attestation time.

. This interface was added in vSphere API 7.0.0.

Nested Class Summary

Nested classes/interfaces inherited from interface com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.tpm2.CaCertificatesTypes

CaCertificatesTypes._VAPI_OPERATIONS, CaCertificatesTypes.CreateSpec, CaCertificatesTypes.Health, CaCertificatesTypes.Info, CaCertificatesTypes.Summary

Field Summary

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

_VAPI_SERVICE_ID, RESOURCE_TYPE

Method Summary

Modifier and Type	Method and Description
java.lang.String	create_Task(java.lang.String cluster, CaCertificatesTypes.CreateSpec spec) Add a new TPM CA certificate on a cluster.
void	create_Task(java.lang.String cluster, CaCertificatesTypes.CreateSpec spec, AsyncCallback<java.lang.String> asyncCallback) Add a new TPM CA certificate on a cluster.
void	create_Task(java.lang.String cluster, CaCertificatesTypes.CreateSpec spec, AsyncCallback<java.lang.String> asyncCallback, InvocationConfig invocationConfig) Add a new TPM CA certificate on a cluster.
java.lang.String	create_Task(java.lang.String cluster, CaCertificatesTypes.CreateSpec spec, InvocationConfig invocationConfig) Add a new TPM CA certificate on a cluster.
java.lang.String	delete_Task(java.lang.String cluster, java.lang.String name) Remove a TPM CA certificate on a cluster.
void	delete_Task(java.lang.String cluster, java.lang.String name, AsyncCallback<java.lang.String> asyncCallback) Remove a TPM CA certificate on a cluster.
void	delete_Task(java.lang.String cluster, java.lang.String name, AsyncCallback<java.lang.String> asyncCallback, InvocationConfig invocationConfig) Remove a TPM CA certificate on a cluster.
java.lang.String	delete_Task(java.lang.String cluster, java.lang.String name, InvocationConfig invocationConfig) Remove a TPM CA certificate on a cluster.
java.lang.String	get_Task(java.lang.String cluster, java.lang.String name) Get the TPM CA certificate details on a cluster.
void	get_Task(java.lang.String cluster, java.lang.String name, AsyncCallback<java.lang.String> asyncCallback) Get the TPM CA certificate 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 CA certificate details on a cluster.
java.lang.String	get_Task(java.lang.String cluster, java.lang.String name, InvocationConfig invocationConfig) Get the TPM CA certificate details on a cluster.
java.lang.String	list_Task(java.lang.String cluster) Return a list of configured TPM CA certificates on a cluster.
void	list_Task(java.lang.String cluster, AsyncCallback<java.lang.String> asyncCallback) Return a list of configured TPM CA certificates on a cluster.
void	list_Task(java.lang.String cluster, AsyncCallback<java.lang.String> asyncCallback, InvocationConfig invocationConfig) Return a list of configured TPM CA certificates on a cluster.
java.lang.String	list_Task(java.lang.String cluster, InvocationConfig invocationConfig) Return a list of configured TPM CA certificates on a cluster.

Method Detail

list_Task

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

Return a list of configured TPM CA certificates on a cluster. This method was added in vSphere API 7.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 cluster id is empty.

NotFound - if the cluster doesn't match to any cluster in the vCenter or given name 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 CA certificates on a cluster. This method was added in vSphere API 7.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 cluster id is empty.

NotFound - if the cluster doesn't match to any cluster in the vCenter or given name 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 CA certificates on a cluster. This method was added in vSphere API 7.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 cluster id is empty.
NotFound - if the cluster doesn't match to any cluster in the vCenter or given name 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 CA certificates on a cluster. This method was added in vSphere API 7.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 cluster id is empty.
NotFound - if the cluster doesn't match to any cluster in the vCenter or given name 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,
                             CaCertificatesTypes.CreateSpec spec)

Add a new TPM CA certificate on a cluster. This method was added in vSphere API 7.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 new CA certificate details.

Returns:

identifier for the task created by this API invocation

Throws:

AlreadyExists - if the certificate name exists.

Error - if there is a generic error.

InvalidArgument - if the configuration is invalid or the 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,
                             CaCertificatesTypes.CreateSpec spec,
                             InvocationConfig invocationConfig)

Add a new TPM CA certificate on a cluster. This method was added in vSphere API 7.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 new CA certificate details.

invocationConfig - Configuration for the method invocation.

Returns:

identifier for the task created by this API invocation

Throws:

AlreadyExists - if the certificate name exists.

Error - if there is a generic error.

InvalidArgument - if the configuration is invalid or the 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,
                 CaCertificatesTypes.CreateSpec spec,
                 AsyncCallback<java.lang.String> asyncCallback)

Add a new TPM CA certificate on a cluster. This method was added in vSphere API 7.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 certificate name exists.
Error - if there is a generic error.
InvalidArgument - if the configuration is invalid or the 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 new CA certificate details.

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

create_Task

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

Add a new TPM CA certificate on a cluster. This method was added in vSphere API 7.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 certificate name exists.
Error - if there is a generic error.
InvalidArgument - if the configuration is invalid or the 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 new CA certificate details.

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 CA certificate on a cluster. This method was added in vSphere API 7.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 CA certificate name. The parameter must be an identifier for the resource type: com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.tpm2.CaCertificate.

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 cluster doesn't match to any cluster in the vCenter or given name is not found.

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 CA certificate on a cluster. This method was added in vSphere API 7.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 CA certificate name. The parameter must be an identifier for the resource type: com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.tpm2.CaCertificate.

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 cluster doesn't match to any cluster in the vCenter or given name is not found.

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 CA certificate on a cluster. This method was added in vSphere API 7.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 cluster doesn't match to any cluster in the vCenter or given name 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.

name - The CA certificate name. The parameter must be an identifier for the resource type: com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.tpm2.CaCertificate.

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 CA certificate on a cluster. This method was added in vSphere API 7.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 cluster doesn't match to any cluster in the vCenter or given name 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.

name - The CA certificate name. The parameter must be an identifier for the resource type: com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.tpm2.CaCertificate.

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 CA certificate details on a cluster. This method was added in vSphere API 7.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 CA certificate name. The parameter must be an identifier for the resource type: com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.tpm2.CaCertificate.

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 CA certificate 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 CA certificate details on a cluster. This method was added in vSphere API 7.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 CA certificate name. The parameter must be an identifier for the resource type: com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.tpm2.CaCertificate.

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 CA certificate 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 CA certificate details on a cluster. This method was added in vSphere API 7.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 CA certificate 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 CA certificate name. The parameter must be an identifier for the resource type: com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.tpm2.CaCertificate.

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 CA certificate details on a cluster. This method was added in vSphere API 7.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 CA certificate 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 CA certificate name. The parameter must be an identifier for the resource type: com.vmware.vcenter.trusted_infrastructure.trust_authority_clusters.attestation.tpm2.CaCertificate.

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

invocationConfig - Configuration for the method invocation.