Get Hosts Hardware TPM
Get the TPM details on a host. if you do not have all of the privileges described as follows: - The resource HostSystem referenced by the parameter host requires Host.Tpm.Read.
Request
URLURL
https://{api_host}/api/vcenter/trusted-infrastructure/hosts/{host}/hardware/tpm/{tpm}
Path Parameters
Path Parameters
string
host
Required
Identifier of the host. The parameter must be an identifier for the resource type: HostSystem.
string
tpm
Required
the TPM identifier. The parameter must be an identifier for the resource type: com.vmware.vcenter.trusted_infrastructure.hosts.hardware.Tpm.
Header Parameters
Header Parameters
string
vmware-api-session-id
Required
Required session ID, acquired from Create Session API under CIS product
vmware-api-session-id example
"b00db39f948d13ea1e59b4d6fce56389"
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK returns
TrustedInfrastructureHostsHardwareTpmInfo
of type application/json
The TPM info.
{
"active": false,
"banks": [
{
"algorithm": "SHA256",
"pcrs": {
"key": "string"
}
}
],
"firmware_version": "string",
"major_version": 0,
"manufacturer": "string",
"minor_version": 0,
"model": "string"
}
boolean
active
Required
The TPM status. Inactive TPMs cannot be used for sealing or attestation.
banks
Required
The list of the PCR banks of the TPM device.
integer
major_version
Required
The TPM major version number.
integer
minor_version
Required
The TPM minor version number.
string
firmware_version
Optional
The TPM firmware version. if unset, firmware version is not available.
string
manufacturer
Optional
The TPM manufacturer. if unset, manufacturer is not available.
string
model
Optional
The TPM model. if unset, model is not available.
Errors
default
‘Default’ means this response is used for all HTTP codes that are not covered individually for this operation.
Code Samples
PowerCLI Client SDK Example
Invoke-GetHostTpmHardware -Host "MyHost" -Tpm "MyTpm"
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/vcenter/trusted-infrastructure/hosts/{host}/hardware/tpm/{tpm}
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: get
Availability
Added in 8.0.0.1
