Edit

Share via

Get-HgsAttestationPolicy

  • Reference
Module:
HgsAttestation

Gets HGS attestation policies.

Syntax

Get-HgsAttestationPolicy
   [[-Name] <String>]
   [-State <AttestationPolicyState>]
   [-PolicyType <AttestationPolicyType[]>]
   [-PolicyVersion <PolicyVersion>]
   [-Stage]
   [<CommonParameters>]

Description

The Get-HgsAttestationPolicy cmdlet gets Host Guardian Service (HGS) attestation policies.

Examples

Example 1: Get all policies

PS C:\> Get-HgsAttestationPolicy

This command gets all policies that are currently configured for the Attestation service.

Example 2: Get a policy by name

PS C:\> Get-HgsAttestationPolicy -Name "BaselineTpmPolicy16"

This command gets the policy named BaselineTpmPolicy16.

Example 3: Get policies by type

PS C:\> Get-HgsAttestationPolicy -PolicyType SecureBootSettings

This command gets policies that have the type Tpm.

Example 4: Get all enabled policies

PS C:\> Get-HgsAttestationPolicy -State Enabled

This command gets all enabled policies.

Parameters

-Name

Specifies the name of the policy that this cmdlet gets. Use wildcard characters to get more than one policy.

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

-PolicyType

Specifies the type of the policies that this cmdlet gets.

Type:AttestationPolicyType[]
Accepted values:Unknown, SecureBootEnabled, SecureBootSettings, CiPolicy, UefiDebugDisabled, FullBoot, VsmIdkPresent, BitLockerEnabled, IommuEnabled, PagefileEncryptionEnabled, HypervisorEnforcedCiPolicy, NoHibernation, NoDumps, DumpEncryption, DumpEncryptionKey
Position:Named
Default value:None
Required:False
Accept pipeline input:False
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

-State

Specifies the state of the policies that this cmdlet gets. The acceptable values for this parameter are:

  • Enabled
  • Disabled
  • Locked
Type:AttestationPolicyState
Accepted values:Disabled, Enabled, Locked
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

String

You can pipe strings to this cmdlet.

Outputs

AttestationPolicyInfo

This cmdlet returns attestation policy information.