List Hosts Hardware TPM Endorsement Keys
Return a list of configured endorsement keys 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}/endorsement-keys
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.
Query Parameters
Query Parameters
types
Optional
Type of the endorsement key. if unset or empty, the result will not be filtered by EndorsementKeys.FilterSpec.types.
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
TrustedInfrastructureHostsHardwareTpmEndorsementKeysSummary
of type application/json
A list of configured endorsement keys.
[
{
"key": "string",
"type": "RSA_2048"
}
]
string
key
Required
A unique identifier for the TPM endorsement key. 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.EndorsementKey. 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.EndorsementKey.
type
Required
The EndorsementKeys.Type enumerated type defines the endorsement key type based on key algorithms.
RSA_2048 : The RSA 2048 bit key.
ECC_NIST_P_256 : The ECC NISTP-256 bit key.
Possible values are: RSA_2048 , ECC_NIST_P_256
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-ListHostTpmHardwareHostEndorsementKeys -Host "MyHost" -Tpm "MyTpm" -Types "RSA_2048"
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/vcenter/trusted-infrastructure/hosts/{host}/hardware/tpm/{tpm}/endorsement-keys
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
