com.vmware.vcenter.trusted_infrastructure.hosts package

Subpackages

• com.vmware.vcenter.trusted_infrastructure.hosts.hardware package
  • Submodules
  • com.vmware.vcenter.trusted_infrastructure.hosts.hardware.tpm_client module
    • EndorsementKeys
      • EndorsementKeys.FilterSpec
      • EndorsementKeys.Info
      • EndorsementKeys.PolicyPcrSpec
      • EndorsementKeys.RESOURCE_TYPE
      • EndorsementKeys.Summary
      • EndorsementKeys.Type
        • EndorsementKeys.Type.ECC_NIST_P_256
        • EndorsementKeys.Type.RSA_2048
      • EndorsementKeys.UnsealSpec
      • EndorsementKeys.get()
      • EndorsementKeys.list()
      • EndorsementKeys.unseal()
    • EventLog
      • EventLog.Info
      • EventLog.Type
        • EventLog.Type.EFI_TCG2_EVENT_LOG_FORMAT_TCG_2
      • EventLog.get()
    • HashAlgorithm
      • HashAlgorithm.SHA256
      • HashAlgorithm.SHA384
      • HashAlgorithm.SHA512
      • HashAlgorithm.SM3_256
    • PcrBank
    • StubFactory

Submodules

com.vmware.vcenter.trusted_infrastructure.hosts.hardware_client module

The com.vmware.vcenter.trusted_infrastructure.hosts.hardware_client module provides classes to manage trusted hardware.

class com.vmware.vcenter.trusted_infrastructure.hosts.hardware_client.StubFactory(stub_config)

Bases: StubFactoryBase

Initialize StubFactoryBase

Parameters:

stub_config (vmware.vapi.bindings.stub.StubConfiguration) – Stub config instance

class com.vmware.vcenter.trusted_infrastructure.hosts.hardware_client.Tpm(config)

Bases: VapiInterface

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

Parameters:

config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.

class FilterSpec(major_versions=None, active=None)

Bases: VapiStruct

The Tpm.FilterSpec class contains attributes used to filter the results when listing configured TPMs. This class was added in vSphere API 8.0.0.1.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters:

• major_versions (set of long or None) – The TPM major version number. This attribute was added in vSphere API 8.0.0.1. if None or empty, the result will not be filtered by version number.

• active (bool or None) – The TPM status. This attribute was added in vSphere API 8.0.0.1. if None, the result will not be filtered by status.

class Info(major_version=None, minor_version=None, active=None, manufacturer=None, model=None, firmware_version=None, banks=None)

Bases: VapiStruct

The Tpm.Info class contains information that describes a TPM device. This class was added in vSphere API 8.0.0.1.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters:

• major_version (long) – The TPM major version number. This attribute was added in vSphere API 8.0.0.1.

• minor_version (long) – The TPM minor version number. This attribute was added in vSphere API 8.0.0.1.

• active (bool) –

  The TPM status.

  Inactive TPMs cannot be used for sealing or attestation.. This attribute was added in vSphere API 8.0.0.1.

• manufacturer (str or None) – The TPM manufacturer. This attribute was added in vSphere API 8.0.0.1. if None, manufacturer is not available.

• model (str or None) – The TPM model. This attribute was added in vSphere API 8.0.0.1. if None, model is not available.

• firmware_version (str or None) – The TPM firmware version. This attribute was added in vSphere API 8.0.0.1. if None, firmware version is not available.

• banks (list of com.vmware.vcenter.trusted_infrastructure.hosts.hardware.tpm_client.PcrBank) – The list of the PCR banks of the TPM device. This attribute was added in vSphere API 8.0.0.1.

RESOURCE_TYPE = 'com.vmware.vcenter.trusted_infrastructure.hosts.hardware.Tpm'

Resource type for TPM. This class attribute was added in vSphere API 8.0.0.1.

class Summary(tpm=None, major_version=None, minor_version=None, active=None)

Bases: VapiStruct

The Tpm.Summary class contains information that summarizes a TPM. This class was added in vSphere API 8.0.0.1.

Tip

The arguments are used to initialize data attributes with the same names.

Parameters:

• tpm (str) – A unique identifier for the TPM instance. This attribute was added in vSphere API 8.0.0.1. When clients pass a value of this class as a parameter, the attribute must be an identifier for the resource type: com.vmware.vcenter.trusted_infrastructure.hosts.hardware.Tpm. When methods return a value of this class as a return value, the attribute will be an identifier for the resource type: com.vmware.vcenter.trusted_infrastructure.hosts.hardware.Tpm.

• major_version (long) – The TPM major version number. This attribute was added in vSphere API 8.0.0.1.

• minor_version (long) – The TPM minor version number. This attribute was added in vSphere API 8.0.0.1.

• active (bool) –

  The TPM status.

  Inactive TPMs cannot be used for sealing or attestation.. This attribute was added in vSphere API 8.0.0.1.

get(host, tpm)

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

Parameters:

• host (str) – Identifier of the host. The parameter must be an identifier for the resource type: HostSystem.

• tpm (str) – the TPM identifier. The parameter must be an identifier for the resource type: com.vmware.vcenter.trusted_infrastructure.hosts.hardware.Tpm.

Return type:

Tpm.Info

Returns:

The TPM info.

Raise:

com.vmware.vapi.std.errors_client.Error if there is a generic error.

Raise:

com.vmware.vapi.std.errors_client.InvalidArgument if any argument is invalid.

Raise:

com.vmware.vapi.std.errors_client.NotFound if the TPM is not found or host is not found.

Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable if too many requests are in progress.

Raise:

com.vmware.vapi.std.errors_client.Unauthenticated if the caller is not authenticated.

Raise:

com.vmware.vapi.std.errors_client.Unauthorized if the caller is not authorized.

Raise:

com.vmware.vapi.std.errors_client.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(host, filter=None)

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

Parameters:

• host (str) – Identifier of the host. The parameter must be an identifier for the resource type: HostSystem.

• filter (Tpm.FilterSpec or None) – a filter for the returned list. if None, the behavior is equivalent to a Tpm.FilterSpec with attributes None

Return type:

list of Tpm.Summary

Returns:

A list of configured TPMs.

Raise:

com.vmware.vapi.std.errors_client.Error if there is a generic error.

Raise:

com.vmware.vapi.std.errors_client.InvalidArgument if any argument is invalid.

Raise:

com.vmware.vapi.std.errors_client.NotFound if the host is not found.

Raise:

com.vmware.vapi.std.errors_client.ServiceUnavailable if too many requests are in progress.

Raise:

com.vmware.vapi.std.errors_client.Unauthenticated if the caller is not authenticated.

Raise:

com.vmware.vapi.std.errors_client.Unauthorized if the caller is not authorized.

Raise:

com.vmware.vapi.std.errors_client.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.