COMMAND EVERYTHING.

Set-HgsClientConfiguration

Modifies the configuration of a Host Guardian Service client.

PowerShell · Risk: High · Documentation Verified

Last verified: 2026-10-26

Microsoft HgsClient reference: Modifies the configuration of a Host Guardian Service client. The syntax and selected example below are adapted from the pinned Windows Server 2025 reference. Module availability, target configuration and delegated permissions determine whether it can run in your environment. Documentation and parameter text: Microsoft, CC BY 4.0; formatting adapted by Cmdlet World. No execution testing is claimed.

Set-HgsClientConfiguration -KeyProtectionServerUrl <String> -AttestationServerUrl <String>
 -FallbackKeyProtectionServerUrl <String> -FallbackAttestationServerUrl <String> [-WhatIf] [-Confirm]
 [<CommonParameters>]

Copied 0 times

Required permissions

Use an account with the target resource permissions documented for Set-HgsClientConfiguration. Modifying administrative cmdlets may require elevation or delegated administration. This catalog does not assert that ordinary users can execute the command.

Supported environments

Windows / HgsClient · Windows Server 2025 documentation; feature/module prerequisites apply

Parameters

-AttestationServerUrl (required): Specifies the URL of an attestation server. A Host Guardian Service client in Secure Hosting Service mode uses the server that this parameter specifies.
-Confirm: Prompts you for confirmation before running the cmdlet.
-EnableLocalMode: Indicates that this cmdlet changes the mode of client from Host Guardian Service to Local mode. A change in mode to Local resets the attestation server and key protection server URLs.
-FallbackAttestationServerUrl (required): Specifies the URL of an attestation server to use if the primary attestation server cannot be reached.
-FallbackKeyProtectionServerUrl (required): Specifies the URL of a key protection server to use if the primary attestation server cannot be reached.
-KeyProtectionServerUrl (required): Specifies the URL of a key protection server. A Host Guardian Service client in Secure Hosting Service mode uses the server that this parameter specifies.
-WhatIf: Shows what would happen if the cmdlet runs. The cmdlet is not run.

Prerequisites

Windows with the HgsClient module and the Windows feature or management tools that provide it. Confirm target connectivity and version compatibility using the linked Microsoft reference.

Security considerations

This cmdlet changes system state. Review every target and parameter in the official reference, test outside production, and prepare an appropriate backup or rollback. Do not execute the example automatically.

Examples

Example 1: Set an attestation and key protection servers

Set-HgsClientConfiguration -AttestationServerUrl "https://DemoHgs.Contoso.com/Attestation" -KeyProtectionServerUrl "https://DemoHgs.Contoso.com/KeyProtection"

This command configures the URLs used by the attestation client and the key protection client. Use this command to configure the local host to run in Host Guardian Service mode. Source: Microsoft, CC BY 4.0; transcript prompt/output removed. This example was not executed.

Sources

https://github.com/MicrosoftDocs/windows-powershell-docs/blob/b7645dd8c687139b28e845119da30ec670526507/docset/winserver2025-ps/HgsClient/Set-HgsClientConfiguration.md

https://learn.microsoft.com/powershell/module/hgsclient/set-hgsclientconfiguration?view=windowsserver2025-ps

Personal collections

Explain or customize this command with AI

Related commands