Test-Hgs Client Configuration

Module:
hgsclient
Forces the HGS client to attest against the configured attestation servers.

Syntax 

Test-HgsClientConfiguration
    [-UsePrimary]
Test-HgsClientConfiguration
    [-UseFallback]

Description

The Test-HgsClientConfiguration cmdlet forces the HGS client to attest against an HGS server and report back on the attestation attempt. Any cached attestation health certificates from recent attestation attempts will be ignored.

Examples

Example 1 

PS C:\> Test-HgsClientConfiguration

Performs an attestation attempt using the primary HGS server. If the primary HGS server cannot be reached and fallback URLs are configured, the fallback HGS server will be used.

Example 2 

PS C:\> Test-HgsClientConfiguration -UsePrimary

Performs an attestation attempt using the primary HGS server. If the primary HGS server cannot be reached, the cmdlet will fail.

Example 3 

PS C:\> Test-HgsClientConfiguration -UseFallback

Performs an attestation attempt using the fallback HGS server.

Required Parameters

-UseFallback

Specifies that the HGS client should only attest against the fallback attestation server.

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

Optional Parameters

-UsePrimary

Specifies that the HGS client should only attest against the primary attestation server.

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

Inputs

None

Outputs

Microsoft.Management.Infrastructure.CimInstance

An object containing the attestation server URL used and the results of the attestation attempt.