Add-HgsAttestationTpmPolicy

Reference

Module:: HgsAttestation

Adds an attestation policy based on TPM 2.0 hardware to HGS.

Syntax

Add-HgsAttestationTpmPolicy
   [-InputObject] <Byte[]>
   -Name <String>
   [-PolicyVersion <PolicyVersion>]
   [-Stage]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Add-HgsAttestationTpmPolicy
   [-Path] <String>
   [-Name <String>]
   [-PolicyVersion <PolicyVersion>]
   [-Stage]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

The Add-HgsAttestationTpmPolicy cmdlet adds an attestation policy based on trusted platform module (TPM) 2.0 hardware to the Host Guardian Service (HGS). Specify a log, in Trusted Computing Group (TCG) format, that you obtain by using the Get-HgsAttestationBaselinePolicy cmdlet.

Examples

Example 1: Add a policy

PS C:\> Add-HgsAttestationTpmPolicy -Name "BaselineTpmPolicy17" -Path "C:\Hgs\BaselineTcgLog"

This command adds a policy named BaselineTpmPolicy17 to the Attestation service. The Path parameter specifies the TCG log that you create by using Get-HgsAttestationBaselinePolicy cmdlet.

Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

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

-InputObject

Specifies a TCG log, in binary form, on which this cmdlet bases a policy.

Type:	Byte[]
Position:	0
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-Name

Specifies the name of the policy that this cmdlet adds.

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

-Path

Specifies the path of a file that contains a TCG log, in binary form.

Type:	String
Aliases:	FilePath, PSPath
Position:	0
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

-WhatIf

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

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

Inputs

Byte[], String

This cmdlet accepts a TCG log as a Byte array or a file name.

Outputs

AttestationPolicyInfo

This cmdlet returns attestation policy information.