Get-Tpm2EndorsementKey Command | Vmware PowerCLI Reference

Get-Tpm2EndorsementKey

This cmdlet retrieves the TPM 2.0 endorsement key from the TPM 2.0 chip in the specified host. You can use this cmdlet by connecting either directly to an ESXi host or to its vCenter Server system.

Syntax

Get-Tpm2EndorsementKey
-VMHostTPM < VMHostTPM[] >
[-ProgressAction < ActionPreference > ]
[-Server < VIServer[] > ]
[CommonParameters]

Parameters

Required Parameter Name Type Position Features Description
required
VMHostTPM VMHostTPM[] named
  • pipeline
Specifies the TPM from which you want to Get the TPM 2.0 endorsement key.
optional ProgressAction ActionPreference named
optional Server VIServer[] named
Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-VIServer cmdlet.
Get-Tpm2EndorsementKey
-VMHost < VMHost[] >
[-ProgressAction < ActionPreference > ]
[-Server < VIServer[] > ]
[CommonParameters]

Parameters

Required Parameter Name Type Position Features Description
required
VMHost VMHost[] named
  • pipeline
Specifies the hosts on which you want to export the TPM 2.0 endorsement key from the TPM 2.0 chip.
optional ProgressAction ActionPreference named
optional Server VIServer[] named
Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-VIServer cmdlet.

Output

VMware.VimAutomation.Security.Types.V1.TrustedInfrastructure.Tpm2EndorsementKey

Examples

Example 1

Connect-VIServer -Server $esxiAddress -User myroot -Password mypassword
Get-Tpm2EndorsementKey -VMHost $esxiAddress -Server $esxiAddress

Retrieves the TPM 2.0 endorsement key information from the TPM 2.0 chip of the specified host when connected directly to this host.

Example 2

Connect-VIServer -Server $vCenterAddress -User myroot -Password mypassword
Get-Tpm2EndorsementKey -VMHost $esxiAddress

Retrieves the TPM 2.0 endorsement key information from the TPM 2.0 chip of the specified host in the connected vCenter.

Example 3

Connect-VIServer -Server $vCenterAddress -User myroot -Password mypassword
Get-Tpm2EndorsementKey -VMHostTPM myTpm

Retrieves the TPM 2.0 endorsement key information from the TPM 2.0 chip corresponding to the specified TPM.

Related Commands

Tpm2CACertificate

This cmdlet exports the CA certificate from either the certificate in the specified TPM 2.0 endorsement key or the specified certificate to a file.

Tpm2EndorsementKey

This cmdlet exports the TPM 2.0 endorsement key from the TPM 2.0 chip in the specified host. It only works when you connect to the specified host directly by using the Connect-VIServer cmdlet.

This cmdlet retrieves the TPM 2.0 endorsement key from the TPM 2.0 chip in the specified host. You can use this cmdlet by connecting either directly to an ESXi host or to its vCenter Server system.