com.vmware.vcenter.trusted_infrastructure.hosts.hardware

Interface Tpm

All Superinterfaces:

Service, TpmTypes

All Known Implementing Classes:

TpmStub

public interface Tpm
extends Service, TpmTypes

The Tpm interface provides methods to get available Trusted Platform Module (TPM) information on a host. This interface was added in vSphere API 8.0.0.1.

Nested Class Summary

Nested classes/interfaces inherited from interface com.vmware.vcenter.trusted_infrastructure.hosts.hardware.TpmTypes

TpmTypes.FilterSpec, TpmTypes.Info, TpmTypes.Summary

Field Summary

Fields inherited from interface com.vmware.vcenter.trusted_infrastructure.hosts.hardware.TpmTypes

_VAPI_SERVICE_ID, RESOURCE_TYPE

Method Summary

Modifier and Type	Method and Description
TpmTypes.Info	get(java.lang.String host, java.lang.String tpm) Get the TPM details on a host.
void	get(java.lang.String host, java.lang.String tpm, AsyncCallback<TpmTypes.Info> asyncCallback) Get the TPM details on a host.
void	get(java.lang.String host, java.lang.String tpm, AsyncCallback<TpmTypes.Info> asyncCallback, InvocationConfig invocationConfig) Get the TPM details on a host.
TpmTypes.Info	get(java.lang.String host, java.lang.String tpm, InvocationConfig invocationConfig) Get the TPM details on a host.
java.util.List<TpmTypes.Summary>	list(java.lang.String host, TpmTypes.FilterSpec filter) Return a list of configured TPMs on a host.
void	list(java.lang.String host, TpmTypes.FilterSpec filter, AsyncCallback<java.util.List<TpmTypes.Summary>> asyncCallback) Return a list of configured TPMs on a host.
void	list(java.lang.String host, TpmTypes.FilterSpec filter, AsyncCallback<java.util.List<TpmTypes.Summary>> asyncCallback, InvocationConfig invocationConfig) Return a list of configured TPMs on a host.
java.util.List<TpmTypes.Summary>	list(java.lang.String host, TpmTypes.FilterSpec filter, InvocationConfig invocationConfig) Return a list of configured TPMs on a host.

Method Detail

list

java.util.List<TpmTypes.Summary> list(java.lang.String host,
                                      TpmTypes.FilterSpec filter)

Return a list of configured TPMs on a host. This method was added in vSphere API 8.0.0.1.

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

Parameters:

host - Identifier of the host. The parameter must be an identifier for the resource type: HostSystem.

filter - a filter for the returned list. if @term.unset}, the behavior is equivalent to a TpmTypes.FilterSpec with properties null

Returns:

A list of configured TPMs.

Throws:

Error - if there is a generic error.

InvalidArgument - if any argument is invalid.

NotFound - if the host is not found.

ServiceUnavailable - if too many requests are in progress.

Unauthenticated - if the caller is not authenticated.

Unauthorized - if the caller is not authorized.

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

• The resource HostSystem referenced by the parameter host requires Host.Tpm.Read.

list

java.util.List<TpmTypes.Summary> list(java.lang.String host,
                                      TpmTypes.FilterSpec filter,
                                      InvocationConfig invocationConfig)

Return a list of configured TPMs on a host. This method was added in vSphere API 8.0.0.1.

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 - Identifier of the host. The parameter must be an identifier for the resource type: HostSystem.

filter - a filter for the returned list. if @term.unset}, the behavior is equivalent to a TpmTypes.FilterSpec with properties null

invocationConfig - Configuration for the method invocation.

Returns:

A list of configured TPMs.

Throws:

Error - if there is a generic error.

InvalidArgument - if any argument is invalid.

NotFound - if the host is not found.

ServiceUnavailable - if too many requests are in progress.

Unauthenticated - if the caller is not authenticated.

Unauthorized - if the caller is not authorized.

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

• The resource HostSystem referenced by the parameter host requires Host.Tpm.Read.

list

void list(java.lang.String host,
          TpmTypes.FilterSpec filter,
          AsyncCallback<java.util.List<TpmTypes.Summary>> asyncCallback)

Return a list of configured TPMs on a host. This method was added in vSphere API 8.0.0.1.

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

Invocation Result:
A list of configured TPMs.

Operation Errors:
Error - if there is a generic error.
InvalidArgument - if any argument is invalid.
NotFound - if the host is not found.
ServiceUnavailable - if too many requests are in progress.
Unauthenticated - if the caller is not authenticated.
Unauthorized - if the caller is not authorized.
Unauthorized - if you do not have all of the privileges described as follows:

• The resource HostSystem referenced by the parameter host requires Host.Tpm.Read.

Parameters:

host - Identifier of the host. The parameter must be an identifier for the resource type: HostSystem.

filter - a filter for the returned list. if @term.unset}, the behavior is equivalent to a TpmTypes.FilterSpec with properties null

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

list

void list(java.lang.String host,
          TpmTypes.FilterSpec filter,
          AsyncCallback<java.util.List<TpmTypes.Summary>> asyncCallback,
          InvocationConfig invocationConfig)

Return a list of configured TPMs on a host. This method was added in vSphere API 8.0.0.1.

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:
A list of configured TPMs.

Operation Errors:
Error - if there is a generic error.
InvalidArgument - if any argument is invalid.
NotFound - if the host is not found.
ServiceUnavailable - if too many requests are in progress.
Unauthenticated - if the caller is not authenticated.
Unauthorized - if the caller is not authorized.
Unauthorized - if you do not have all of the privileges described as follows:

• The resource HostSystem referenced by the parameter host requires Host.Tpm.Read.

Parameters:

host - Identifier of the host. The parameter must be an identifier for the resource type: HostSystem.

filter - a filter for the returned list. if @term.unset}, the behavior is equivalent to a TpmTypes.FilterSpec with properties null

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

invocationConfig - Configuration for the method invocation.

get

TpmTypes.Info get(java.lang.String host,
                  java.lang.String tpm)

Get the TPM details on a host. This method was added in vSphere API 8.0.0.1.

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

Parameters:

host - Identifier of the host. The parameter must be an identifier for the resource type: HostSystem.

tpm - the TPM identifier. The parameter must be an identifier for the resource type: com.vmware.vcenter.trusted_infrastructure.hosts.hardware.Tpm.

Returns:

The TPM info.

Throws:

Error - if there is a generic error.

InvalidArgument - if any argument is invalid.

NotFound - if the TPM is not found or host is not found.

ServiceUnavailable - if too many requests are in progress.

Unauthenticated - if the caller is not authenticated.

Unauthorized - if the caller is not authorized.

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

• The resource HostSystem referenced by the parameter host requires Host.Tpm.Read.

get

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

Get the TPM details on a host. This method was added in vSphere API 8.0.0.1.

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 - Identifier of the host. The parameter must be an identifier for the resource type: HostSystem.

tpm - the TPM identifier. The parameter must be an identifier for the resource type: com.vmware.vcenter.trusted_infrastructure.hosts.hardware.Tpm.

invocationConfig - Configuration for the method invocation.

Returns:

The TPM info.

Throws:

Error - if there is a generic error.

InvalidArgument - if any argument is invalid.

NotFound - if the TPM is not found or host is not found.

ServiceUnavailable - if too many requests are in progress.

Unauthenticated - if the caller is not authenticated.

Unauthorized - if the caller is not authorized.

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

• The resource HostSystem referenced by the parameter host requires Host.Tpm.Read.

get

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

Get the TPM details on a host. This method was added in vSphere API 8.0.0.1.

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

Invocation Result:
The TPM info.

Operation Errors:
Error - if there is a generic error.
InvalidArgument - if any argument is invalid.
NotFound - if the TPM is not found or host is not found.
ServiceUnavailable - if too many requests are in progress.
Unauthenticated - if the caller is not authenticated.
Unauthorized - if the caller is not authorized.
Unauthorized - if you do not have all of the privileges described as follows:

• The resource HostSystem referenced by the parameter host requires Host.Tpm.Read.

Parameters:

host - Identifier of the host. The parameter must be an identifier for the resource type: HostSystem.

tpm - the TPM identifier. The parameter must be an identifier for the resource type: com.vmware.vcenter.trusted_infrastructure.hosts.hardware.Tpm.

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

get

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

Get the TPM details on a host. This method was added in vSphere API 8.0.0.1.

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 TPM info.

Operation Errors:
Error - if there is a generic error.
InvalidArgument - if any argument is invalid.
NotFound - if the TPM is not found or host is not found.
ServiceUnavailable - if too many requests are in progress.
Unauthenticated - if the caller is not authenticated.
Unauthorized - if the caller is not authorized.
Unauthorized - if you do not have all of the privileges described as follows:

• The resource HostSystem referenced by the parameter host requires Host.Tpm.Read.

Parameters:

host - Identifier of the host. The parameter must be an identifier for the resource type: HostSystem.

tpm - the TPM identifier. The parameter must be an identifier for the resource type: com.vmware.vcenter.trusted_infrastructure.hosts.hardware.Tpm.

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

invocationConfig - Configuration for the method invocation.