RequestTPMStateChange method of the CIM_TPM class
Requests that the state of the TPM be changed to the value specified in the RequestedTPMState parameter. If the method invocation completes successfully, 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.
Syntax
uint32 RequestTPMStateChange(
[in] uint16 RequestedTPMState,
[in] string AuthorizationToken,
[out] CIM_ConcreteJob REF Job,
[in] datetime TimeoutPeriod
);
Parameters
-
RequestedTPMState [in]
-
The requested TPM states.
-
S1 Enabled-Active-Owned (2)
-
S2 Disabled-Active-Owned (3)
-
S3 Enabled-Inactive-Owned (4)
-
S4 Disabled-Inactive-Owned (5)
-
S5 Enabled-Active-Unowned (6)
-
S6 Disabled-Active-Unowned (7)
-
S7 Enabled-Inactive-Unowned (8)
-
S8 Disabled-Inactive-Unowned (9)
-
DMTF Reserved (..)
-
Vendor Reserved (32768..65535)
AuthorizationToken [in]
Authorization 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.
Job [out]
May contain a reference to the CIM_ConcreteJob created to track the state transition initiated by the method invocation.
TimeoutPeriod [in]
A 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.
Return value
On success, returns a 0 or 4096; otherwise, returns an error.
-
Completed with No Error (0)
-
Not Supported (1)
-
Unknown or Unspecified Error (2)
-
Cannot complete within Timeout Period (3)
-
Failed (4)
-
Invalid Parameter (5)
-
In Use (6)
-
DMTF Reserved (..)
-
Method Parameters Checked - Job Started (4096)
-
Invalid State Transition (4097)
-
Use of Timeout Parameter Not Supported (4098)
-
Busy (4099)
-
Method Reserved (4100..32767)
-
Vendor Specific (32768..65535)
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client |
Windows 10 [desktop apps only] |
| Minimum supported server |
Windows Server 2016 |
| Namespace |
Root\virtualization\v2 |
| MOF |
|
| DLL |
|