Add-HgsAttestationTpmHost

Adds a guarded host with TPM 2.0 to the Attestation service in HGS.

Syntax

Add-HgsAttestationTpmHost
   [-Name <String>]
   [-ForeignKey <String>]
   -Path <String>
   [-Force]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Add-HgsAttestationTpmHost
   [-Name <String>]
   [-ForeignKey <String>]
   -Xml <XmlDocument>
   [-Force]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

The Add-HgsAttestationTpmHost cmdlet adds a guarded host to the Attestation service in Host Guardian Service (HGS). To use this cmdlet, this host must have trusted platform module (TPM) 2.0 hardware.

Examples

Example 1: Add a TPM host

PS C:\> Add-HgsAttestationTpmHost -Name "TpmHost21" -Path "C:\TpmHost21.xml"

This command adds a TPM host to the Attestation service. This command uses an .xml file that is output of the Get-PlatformIdentifier cmdlet.

Required Parameters

-Path

Specifies the full path of an .xml file. 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
Accept pipeline input:True (ByValue)
Accept wildcard characters:False
-Xml

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

Type:XmlDocument
Position:Named
Default value:None
Accept pipeline input:True (ByValue)
Accept wildcard characters:False

Optional Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Accept pipeline input:False
Accept wildcard characters:False
-Force

Forces the command to run without asking for user confirmation.

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

Specifies a foreign key.

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

Specifies the friendly name of the guarded host that this cmdlet adds to the Attestation service. This host must have TPM 2.0 hardware.

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

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Accept pipeline input:False
Accept wildcard characters:False

Outputs

String

This cmdlet returns a string.