Note
Access to this page requires authorization. You can try signing in or .
Access to this page requires authorization. You can try .
Set-HgsServer
- Module:
- HgsServer Module
Sets the Host Guardian Service server configuration.
Syntax
httpAndHttpsThumbprint
Set-HgsServer
[-Http]
[-Https]
[-HttpPort <UInt16>]
[-HttpsPort <UInt16>]
[-HttpsCertificateThumbprint <String>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
httpAndHttps
Set-HgsServer
[-Http]
[-Https]
[-HttpPort <UInt16>]
[-HttpsPort <UInt16>]
[-HttpsCertificatePath <String>]
[-HttpsCertificatePassword <SecureString>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
http
Set-HgsServer
[-Http]
[-HttpPort <UInt16>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
httpsThumbprint
Set-HgsServer
[-Https]
[-HttpPort <UInt16>]
[-HttpsPort <UInt16>]
[-HttpsCertificateThumbprint <String>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
https
Set-HgsServer
[-Https]
[-HttpsPort <UInt16>]
[-HttpsCertificatePath <String>]
[-HttpsCertificatePassword <SecureString>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
TrustActiveDirectory
Set-HgsServer
[-TrustActiveDirectory]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
TrustTpm
Set-HgsServer
[-TrustTpm]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
UpdateMemoryLimit
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.
Parameter properties
| Type: | SwitchParameter |
| Default value: | False |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | cf |
Parameter sets
-Http
Indicates that the HGS Server is accessible over HTTP.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-HttpPort
Specifies the HTTP port.
Parameter properties
| Type: | UInt16 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-Https
Indicates that the HGS Server is accessible over HTTPS.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-HttpsCertificatePassword
Specifies the password to the certificate file specified in HttpsCertificatePath.
Parameter properties
| Type: | SecureString |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-HttpsCertificatePath
Specifies the path to the HTTPS certificate file (.pfx).
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-HttpsCertificateThumbprint
Indicates the thumbprint of the HTTPS certificate.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-HttpsPort
Specifies the HTTPS port of the HGS server.
Parameter properties
| Type: | UInt16 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-TrustActiveDirectory
Indicates that this cmdlet sets the Attestation service operation mode to Active Directory.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-TrustTpm
Indicates that this cmdlet sets the Attestation service operation mode to trusted platform module (TPM).
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-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.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Parameter properties
| Type: | SwitchParameter |
| Default value: | False |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | wi |
Parameter sets
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
Related Links
Feedback
Was this page helpful?