Set-HgsServer

Module:

HgsServer

Sets the Host Guardian Service server configuration.

Syntax

Set-HgsServer
   [-Http]
   [-Https]
   [-HttpPort <UInt16>]
   [-HttpsPort <UInt16>]
   [-HttpsCertificateThumbprint <String>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Set-HgsServer
   [-Http]
   [-Https]
   [-HttpPort <UInt16>]
   [-HttpsPort <UInt16>]
   [-HttpsCertificatePath <String>]
   [-HttpsCertificatePassword <SecureString>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Set-HgsServer
   [-Http]
   [-HttpPort <UInt16>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Set-HgsServer
   [-Https]
   [-HttpPort <UInt16>]
   [-HttpsPort <UInt16>]
   [-HttpsCertificateThumbprint <String>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Set-HgsServer
   [-Https]
   [-HttpsPort <UInt16>]
   [-HttpsCertificatePath <String>]
   [-HttpsCertificatePassword <SecureString>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Set-HgsServer
   [-TrustActiveDirectory]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Set-HgsServer
   [-TrustTpm]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Set-HgsServer
   [-UpdateMemoryLimit]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

The Set-HgsServer cmdlet sets the Host Guardian Service (HGS) server configuration. The configuration properties changed include the communication protocol, the network ports, and the HTTPS certificate for the Attestation and Key Protection services.

Examples

Example 1: Configure the HGS server to be accessible over HTTP

PS C:\> Set-HgsServer -Http -HttpPort 81

This command configures the HGS server to be exposed over HTTP on port 81.

Example 2: Configure the HGS server to be accessible over HTTP and HTTPS

PS C:\> Set-HgsServer -Http -Https -HttpsCertificatePath $PathToPfx -HttpsCertificatePassword $PfxSecureString

This command configures the HGS server to be exposed over both HTTP and HTTPS on the default ports. HTTPS communication is secured with the certificate specified by $PathToPfx.

Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:	SwitchParameter
Aliases:	cf
Position:	Named
Default value:	False
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Http

Indicates that the HGS Server is accessible over HTTP.

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

-HttpPort

Specifies the HTTP port.

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

-Https

Indicates that the HGS Server is accessible over HTTPS.

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

-HttpsCertificatePassword

Specifies the password to the certificate file specified in HttpsCertificatePath.

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

-HttpsCertificatePath

Specifies the path to the HTTPS certificate file (.pfx).

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

-HttpsCertificateThumbprint

Indicates the thumbprint of the HTTPS certificate.

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

-HttpsPort

Specifies the HTTPS port of the HGS server.

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

-TrustActiveDirectory

Indicates that this cmdlet sets the Attestation service operation mode to Active Directory.

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

-TrustTpm

Indicates that this cmdlet sets the Attestation service operation mode to trusted platform module (TPM).

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

-UpdateMemoryLimit

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.

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

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:	SwitchParameter
Aliases:	wi
Position:	Named
Default value:	False
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

Related Links

• HGS Server Cmdlets