Class CIM_TPM
extends CIM_LogicalDevice

A class derived from CIM_LogicalDevice that describes the Trusted Platform Module (TPM) hardware as defined by the Trusted Computing Group (TCG).

Table of Contents
Hierarchy
Direct Known Subclasses
Class Qualifiers
Class Properties
Class Methods

Class Hierarchy

CIM_ManagedElement
   |
   +--CIM_ManagedSystemElement
   |
   +--CIM_LogicalElement
   |
   +--CIM_EnabledLogicalElement
   |
   +--CIM_AllocatedLogicalElement
   |
   +--CIM_LogicalDevice
   |
   +--CIM_TPM

Direct Known Subclasses

Class Qualifiers

NameData TypeValue
DescriptionstringA class derived from CIM_LogicalDevice that describes the Trusted Platform Module (TPM) hardware as defined by the Trusted Computing Group (TCG).
Experimentalbooleantrue
UMLPackagePathstringCIM::Device::TPM
Versionstring2.21.0

Class Properties

Local Class Properties

NameData TypeDefault ValueQualifiers
NameData TypeValue
TPMManafucturerMajorRevisionuint32
DescriptionstringThe TPM manufacturer's major revision.
MappingStringsstringTPM.TCG|Part 2 v1dot2|Section 5.3|version|revMajor
TPMManufacturerIduint32
DescriptionstringThe TPM manufacturer Identifier as defined by the TCG.
MappingStringsstringTPM.TCG|Part 2 v1dot2|Section 21.6|TPM_CAP_VERSION_INFO|tpmVendorID
TPMManufacturerInfostring
DescriptionstringThe additional information defined by the TPM manufacturer.
MappingStringsstringTPM.TCG|Part 2 v1.2.TCG|Section 21.6|TPM_CAP_VERSION_INFO|vendorSpecific
TPMManufacturerMinorRevisionuint32
DescriptionstringThe TPM manufacturer's minor revision.
MappingStringsstringTPM.TCG|Part 2 v1dot2|Section 5.3|version|revMinor
TPMSpecMajorVersionuint32
DescriptionstringThe TPM specification's major version to which the TPM device claims to be conformant.
MappingStringsstringTPM.TCG|Part 2 v1dot2|Section 5.3|version|major, TSS.TCG|Level 1 v1.2|Section 2.3.2.18
TPMSpecMinorVersionuint32
DescriptionstringThe TPM specification's minor version to which the TPM device claims to be conformant.
MappingStringsstringTPM.TCG|Part 2 v1dot2|Section 5.3|version|minor, TSS.TCG|Level 1 v1.2|Section 2.3.2.18
TPMStateuint16
DescriptionstringIndicates the TPM's operational mode by indicating whether TPM is Enabled, Active and Owned.
MappingStringsstringTPM.TCG|Part 1 v1dot2|Section 9.4, TPM.TCG|Part 2 v1dot2|Section 7.1|TPM_PERMANENT_FLAGS
ModelCorrespondencestringCIM_TPM.RequestTPMStateChange, CIM_TPM.TransitioningToTPMState
ValueMapstring0, 2, 3, 4, 5, 6, 7, 8, 9, 10, .., 32768..65535
ValuesstringUnknown, S1 Enabled-Active-Owned, S2 Disabled-Active-Owned, S3 Enabled-Inactive-Owned, S4 Disabled-Inactive-Owned, S5 Enabled-Active-Unowned, S6 Disabled-Active-Unowned, S7 Enabled-Inactive-Unowned, S8 Disabled-Inactive-Unowned, Not Applicable, DMTF Reserved, Vendor Reserved
TransitioningToTPMStateuint1612
DescriptionstringTransitioningToState indicates the TPM's target state to which the TPM is transitioning. A value of 11 "No Change" shall indicate that no transition is in progress.A value of 12 "Not Applicable" shall indicate the implementation does not support representing ongoing transitions. A value other than 11 or 10 shall identify the state to which the element is in the process of transitioning.
ModelCorrespondencestringCIM_TPM.RequestTPMStateChange, CIM_TPM.TPMState
ValueMapstring0, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, .., 32768..65535
ValuesstringUnknown, S1 Enabled-Active-Owned, S2 Disabled-Active-Owned, S3 Enabled-Inactive-Owned, S4 Disabled-Inactive-Owned, S5 Enabled-Active-Unowned, S6 Disabled-Active-Unowned, S7 Enabled-Inactive-Unowned, S8 Disabled-Inactive-Unowned, Not Applicable, No Change, DMTF Reserved, Vendor Reserved
AvailableRequestedTPMStatesuint16[]
DescriptionstringAvailableRequestedTPMStates indicates the possible values for the RequestedTPMState parameter of the method RequestTPMStateChange, used to initiate a state change. The values listed shall be a subset of the values contained in the RequestedTPMStatesSupported property of the associated instance of CIM_TPMCapabilities where the values selected are a function of the current TPM state of the TPM.
ModelCorrespondencestringCIM_TPM.RequestTPMStateChange, CIM_TPMCapabilities.RequestedTPMStatesSupported
ValueMapstring0, 2, 3, 4, 5, 6, 7, 8, 9, .., 32768..65535
ValuesstringUnknown, S1 Enabled-Active-Owned, S2 Disabled-Active-Owned, S3 Enabled-Inactive-Owned, S4 Disabled-Inactive-Owned, S5 Enabled-Active-Unowned, S6 Disabled-Active-Unowned, S7 Enabled-Inactive-Unowned, S8 Disabled-Inactive-Unowned, DMTF Reserved, Vendor Reserved

Inherited Properties

NameData TypeClass Origin
AllocationStatestringCIM_LogicalDevice
Availabilityuint16CIM_LogicalDevice
CaptionstringCIM_ManagedElement
CommunicationStatusuint16CIM_ManagedSystemElement
CreationClassNamestringCIM_LogicalDevice
DescriptionstringCIM_ManagedElement
DetailedStatusuint16CIM_ManagedSystemElement
DeviceIDstringCIM_LogicalDevice
ElementNamestringCIM_ManagedElement
EnabledDefaultuint16CIM_EnabledLogicalElement
EnabledStateuint16CIM_EnabledLogicalElement
ErrorClearedbooleanCIM_LogicalDevice
ErrorDescriptionstringCIM_LogicalDevice
Generationuint64CIM_ManagedElement
HealthStateuint16CIM_ManagedSystemElement
InstallDatedatetimeCIM_ManagedSystemElement
InstanceIDstringCIM_ManagedElement
LastErrorCodeuint32CIM_LogicalDevice
LocationIndicatoruint16CIM_LogicalDevice
MaxQuiesceTimeuint64CIM_LogicalDevice
NamestringCIM_ManagedSystemElement
OperatingStatusuint16CIM_ManagedSystemElement
OtherEnabledStatestringCIM_EnabledLogicalElement
PowerManagementSupportedbooleanCIM_LogicalDevice
PowerOnHoursuint64CIM_LogicalDevice
PrimaryStatusuint16CIM_ManagedSystemElement
RequestedStateuint16CIM_EnabledLogicalElement
StatusstringCIM_ManagedSystemElement
StatusInfouint16CIM_LogicalDevice
SystemCreationClassNamestringCIM_LogicalDevice
SystemNamestringCIM_LogicalDevice
TimeOfLastStateChangedatetimeCIM_EnabledLogicalElement
TotalPowerOnHoursuint64CIM_LogicalDevice
TransitioningToStateuint16CIM_EnabledLogicalElement
AdditionalAvailabilityuint16[]CIM_LogicalDevice
AvailableRequestedStatesuint16[]CIM_EnabledLogicalElement
IdentifyingDescriptionsstring[]CIM_LogicalDevice
OperationalStatusuint16[]CIM_ManagedSystemElement
OtherIdentifyingInfostring[]CIM_LogicalDevice
PowerManagementCapabilitiesuint16[]CIM_LogicalDevice
StatusDescriptionsstring[]CIM_ManagedSystemElement

Class Methods

Local Class Methods

RequestTPMStateChange (uint32)

Method Qualifiers (RequestTPMStateChange)

NameData TypeValue
DescriptionstringRequests that the state of the TPM be changed to the value specified in the RequestedTPMState parameter. If the method invokation completes successfuly, the TPMState property shall be equal to the RequestedTPMState parameter. Invoking the RequestTPMStateChange method multiple times could result in earlier requests being overwritten or lost. A return code of 0 shall indicate the state change was successfully initiated. A return code of 3 shall indicate that the state transition cannot complete within the interval specified by the TimeoutPeriod parameter. A return code of 4096 (0x1000) shall indicate the state change was successfully initiated, a ConcreteJob has been created, and its reference returned in the output parameter Job. Any other return code indicates an error condition.
ModelCorrespondencestringCIM_TPM.TPMState
ValueMapstring0, 1, 2, 3, 4, 5, 6, .., 4096, 4097, 4098, 4099, 4100..32767, 32768..65535
ValuesstringCompleted with No Error, Not Supported, Unknown or Unspecified Error, Cannot complete within Timeout Period, Failed, Invalid Parameter, In Use, DMTF Reserved, Method Parameters Checked - Job Started, Invalid State Transition, Use of Timeout Parameter Not Supported, Busy, Method Reserved, Vendor Specific

Method Parameters (RequestTPMStateChange)

NameTypeQualifiers
NameData TypeValue
AuthorizationTokenstring
DescriptionstringAuthorization token that may be required for the action to take effect. The AuthorizationToken parameter may be required to establish Physical Presence, or to pass the OwnerAuth, the TCG defined owner authorization password. In the case of OwnerAuth, the CIM_SharedCredential with non-null value of the CIM_SharedCredential.Secret may be required. The CIM_SharedCredential.Algorithm property may also be specified based on the property CIM_TPMCapabilities.SupportedPasswordAlgorithms.
EmbeddedInstancestringCIM_Credential
INbooleantrue
RequestedTPMStateuint16
DescriptionstringThe requested TPM states.
INbooleantrue
Requiredbooleantrue
ValueMapstring2, 3, 4, 5, 6, 7, 8, 9, .., 32768..65535
ValuesstringS1 Enabled-Active-Owned, S2 Disabled-Active-Owned, S3 Enabled-Inactive-Owned, S4 Disabled-Inactive-Owned, S5 Enabled-Active-Unowned, S6 Disabled-Active-Unowned, S7 Enabled-Inactive-Unowned, S8 Disabled-Inactive-Unowned, DMTF Reserved, Vendor Reserved
TimeoutPerioddatetime
DescriptionstringA timeout period that specifies the maximum amount of time that the client expects the transition to the new state to take. The interval format must be used to specify the TimeoutPeriod. A value of 0 or a null parameter indicates that the client has no time requirements for the transition.
INbooleantrue
Job REF CIM_ConcreteJob
DescriptionstringMay contain a reference to the ConcreteJob created to track the state transition initiated by the method invocation.
INbooleanfalse
OUTbooleantrue

ChangeOwnerAuth (uint32)

Method Qualifiers (ChangeOwnerAuth)

NameData TypeValue
DescriptionstringThis method changes the owner authorization credential of the TPM device. The old and new owner authorization passwords are required.Reference: See Section 17 (Changing AuthData) of Spec (#3).
ValueMapstring0, 1, 2, 3..4095, 4096..32767, 32768..65535
ValuesstringCompleted with No Error, Not Supported, Unknown/Unspecified Error, DMTF Reserved, Method Reserved, Vendor Specified

Method Parameters (ChangeOwnerAuth)

NameTypeQualifiers
NameData TypeValue
NewOwnerAuthstring
DescriptionstringNewOwnerAuth represents new owner authorization credential required to take ownership of the TPM device.The CIM_SharedCredential subclass may be required with non-null value of the CIM_SharedCredential.Secret property for the parameter.
EmbeddedInstancestringCIM_Credential
INbooleantrue
Requiredbooleantrue
OldOwnerAuthstring
DescriptionstringOldOwnerAuth represents old owner authorization credential required to take ownership of the TPM device.The CIM_SharedCredential subclass may be required with non-null value of the CIM_SharedCredential.Secret property for the parameter.
EmbeddedInstancestringCIM_Credential
INbooleantrue
Requiredbooleantrue

Inherited Class Methods

NameReturn TypeClass Origin
EnableDeviceuint32CIM_LogicalDevice
OnlineDeviceuint32CIM_LogicalDevice
QuiesceDeviceuint32CIM_LogicalDevice
RequestStateChangeuint32CIM_EnabledLogicalElement
Resetuint32CIM_LogicalDevice
RestorePropertiesuint32CIM_LogicalDevice
SavePropertiesuint32CIM_LogicalDevice
SetPowerStateuint32CIM_LogicalDevice