Get-VTpm Command | Vmware PowerCLI Reference

Get-VTpm

This cmdlet retrieves the virtual TPM (vTPM) devices available on the given virtual machines. This cmdlet returns vTPM devices that correspond to the filter criteria specified by the provided parameters.

Syntax

Get-VTpm
-Id < String[] >
[-ProgressAction < ActionPreference > ]
[-Server < VIServer[] > ]
[CommonParameters]

Parameters

Required Parameter Name Type Position Features Description
required
 Id String[] named
Specifies the IDs of the vTPM device that you want to retrieve.
optional ProgressAction ActionPreference named
optional Server VIServer[] named
  • wildcards
 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-VTpm
-VM < VirtualMachine[] >
[-ProgressAction < ActionPreference > ]
[-Server < VIServer[] > ]
[CommonParameters]

Parameters

Required Parameter Name Type Position Features Description
required
 VM VirtualMachine[] named
  • pipeline
  • wildcards
 Specifies the virtual machines from which you want to retrieve the vTPM device.
optional ProgressAction ActionPreference named
optional Server VIServer[] named
  • wildcards
 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.Entity.VTpm

Examples

Example 1 

$vm = Get-VM "MyVM"
Get-VTpm -VM $vm

Retrieves the vTPM device of the virtual machine named "MyVM".

Related Commands

VTpm

This cmdlet retrieves the virtual TPM (vTPM) devices available on the given virtual machines.

This cmdlet creates a new vTPM device on the specified virtual machine.

This cmdlet removes the specified vTPM devices.

This cmdlet modifies the properties of the specified vTPM device.

VTpmCSR

This cmdlet retrieves the certficate signing requests (CSR) from the given vTPM devices.

VTpmCertificate

This cmdlet retrieves the certificate information from the given vTPM devices.