List Hosts Hardware TPM
Return a list of configured TPMs 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
Path Parameters
Path Parameters
string
host
Required
Identifier of the host. The parameter must be an identifier for the resource type: HostSystem.
Query Parameters
Query Parameters
boolean
active
Optional
The TPM status. if unset, the result will not be filtered by status.
array of
integer
major_versions
Optional
The TPM major version number. if unset or empty, the result will not be filtered by version number.
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
array of
TrustedInfrastructureHostsHardwareTpmSummary
of type application/json
A list of configured TPMs.
[
{
"active": false,
"major_version": 0,
"minor_version": 0,
"tpm": "string"
}
]
boolean
active
Required
The TPM status. Inactive TPMs cannot be used for sealing or attestation.
integer
major_version
Required
The TPM major version number.
integer
minor_version
Required
The TPM minor version number.
string
tpm
Required
A unique identifier for the TPM instance. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: com.vmware.vcenter.trusted_infrastructure.hosts.hardware.Tpm. When operations return a value of this structure as a result, the field will be an identifier for the resource type: com.vmware.vcenter.trusted_infrastructure.hosts.hardware.Tpm.
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-ListHostTrustedInfrastructureHardwareTpm -Host "MyHost" -MajorVersions 0 -Active $true
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/vcenter/trusted-infrastructure/hosts/{host}/hardware/tpm
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: list
Availability
Added in 8.0.0.1
