Edit

Share via

Get-HgsAttestationTpmHost

  • Reference
Module:
HgsAttestation

Gets guarded hosts with TPM 2.0 from the Attestation service HGS.

Syntax

Get-HgsAttestationTpmHost
   [-Name <String>]
   [-PolicyVersion <PolicyVersion>]
   [-Stage]
   [<CommonParameters>]
Get-HgsAttestationTpmHost
   [-Name <String>]
   -Path <String>
   [-PolicyVersion <PolicyVersion>]
   [-Stage]
   [<CommonParameters>]
Get-HgsAttestationTpmHost
   [-Name <String>]
   -Xml <XmlDocument>
   [-PolicyVersion <PolicyVersion>]
   [-Stage]
   [<CommonParameters>]

Description

The Get-HgsAttestationTpmHost cmdlet retrieves guarded hosts from the Attestation service in the Host Guardian Service (HGS). Use this cmdlet for hosts that have trusted platform module (TPM) 2.0 hardware, and that were added by using the Add-HgsAttestationTpmHost cmdlet.

Parameters

-Name

Specifies the friendly name of the guarded host that this cmdlet gets from the Attestation service.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Path

Specifies the full path of an .xml file for which this cmdlet gets hosts. Create this file by using the Get-PlatformIdentifier cmdlet. For more information, type Get-Help Get-PlatformIdentifier.

Type:String
Aliases:FilePath
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-PolicyVersion

Reserved for future use.

Type:PolicyVersion
Accepted values:None, PolicyVersion1503, PolicyVersion1704
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Stage

Reserved for future use.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Xml

Specifies the full path of an .xml file that contains binary data for which this cmdlet gets hosts. Create this file by using Get-PlatformIdentifier.

Type:XmlDocument
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

Outputs

String[]

This cmdlet returns an array of strings.