COMMAND EVERYTHING.

Set-HgsServer

Sets the Host Guardian Service server configuration.

Windows Server · Risk: High · Documentation Verified

Last verified: 2026-10-26

Microsoft HgsServer reference: Sets the Host Guardian Service server configuration. 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-HgsServer [-Http] [-Https] [-HttpPort <UInt16>] [-HttpsPort <UInt16>]
 [-HttpsCertificateThumbprint <String>] [-WhatIf] [-Confirm] [<CommonParameters>]

Copied 0 times

Required permissions

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

Supported environments

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

Parameters

-Confirm: Prompts you for confirmation before running the cmdlet.
-Http (required): Indicates that the HGS Server is accessible over HTTP.
-HttpPort: Specifies the HTTP port.
-Https (required): Indicates that the HGS Server is accessible over HTTPS.
-HttpsCertificatePassword: Specifies the password to the certificate file specified in HttpsCertificatePath.
-HttpsCertificatePath: Specifies the path to the HTTPS certificate file (.pfx).
-HttpsCertificateThumbprint: Indicates the thumbprint of the HTTPS certificate.
-HttpsPort: Specifies the HTTPS port of the HGS server.
-TrustActiveDirectory (required): Indicates that this cmdlet sets the Attestation service operation mode to Active Directory.
-TrustTpm (required): Indicates that this cmdlet sets the Attestation service operation mode to trusted platform module (TPM).
-UpdateMemoryLimit (required): Indicates that the application pool memory limit for the attestation service should be updated to reflect the current amount of physical memory in the system.
-WhatIf: Shows what would happen if the cmdlet runs. The cmdlet is not run.

Prerequisites

Windows with the HgsServer 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: Configure the HGS server to be accessible over HTTP

Set-HgsServer -Http -HttpPort 81

This command configures the HGS server to be exposed over HTTP on port 81. 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/HgsServer/Set-HgsServer.md

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

Personal collections

Explain or customize this command with AI

Related commands

Add-CauClusterRole

Add-ClusterCheckpoint

Get-FsrmAdrSetting

Clear-HgsServer