RequestTPMStateChange method of the CIM_TPM class
Requests that the state of the TPM be changed to the value specified in the RequestedTPMState parameter.
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
- 10 32767
-
Vendor Reserved
- 32768 65535
AuthorizationToken [in]
The authorization token if it is required for the state change.
Job [out]
An optional concrete job that tracks the state transition initiated by the method invocation.
TimeoutPeriod [in]
The timeout interval that specifies the maximum amount of time that the client expects the transition to the new state to take. A value of 0 or a null parameter indicates that the client has no time requirements for the transition.
Return value
The possible values are:
-
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 (7 4095)
-
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
| Minimum supported client |
None supported |
| Minimum supported server |
Windows Server 2016 |
| Namespace |
Root\HyperVCluster\v2 |
| MOF |
|
| DLL |
|