Test-HgsClientConfiguration

Module:

HgsClient Module

Forces the HGS client to attest against the configured attestation servers.

Syntax

Primary

Test-HgsClientConfiguration
    [-UsePrimary]

Fallback

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.

Parameters

-UseFallback

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

Parameter properties

Type:	SwitchParameter
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

Fallback

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-UsePrimary

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

Parameter properties

Type:	SwitchParameter
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

Primary

Position:	Named
Mandatory:	False
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

Inputs

None

Outputs

CimInstance

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