Set-RDSHCertificate¶
Synopsis¶
Configure RD Session Host service to use the specified certificate.
Syntax¶
Set-RDSHCertificate [[-CertThumbprint] <String>] [[-PfxFile] <String>] [[-PfxPass] <SecureString>]
[-TerminalName <String>] [-RemoveOldCert] [<CommonParameters>]
Description¶
Intended to be used with the output from Posh-ACME's New-PACertificate or Submit-Renewal.
Examples¶
EXAMPLE 1¶
New-PACertificate site1.example.com | Set-RDSHCertificate
Create a new certificate and configure it for RD Session Host on this system.
EXAMPLE 2¶
Submit-Renewal site1.example.com | Set-RDSHCertificate
Renew a certificate and configure it for RD Session Host on this system.
Parameters¶
-CertThumbprint¶
Thumbprint/Fingerprint for the certificate to configure.
Type: String
Parameter Sets: (All)
Aliases: Thumbprint
Required: False
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-PfxFile¶
Path to a PFX containing a certificate and private key. Not required if the certificate is already in the local system's Personal certificate store.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-PfxPass¶
The export password for the specified PfxFile parameter. Not required if the Pfx does not require an export password.
Type: SecureString
Parameter Sets: (All)
Aliases:
Required: False
Position: 3
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-RemoveOldCert¶
If specified, the old certificate will be deleted from the local system's Personal certificate store. Ignored if the old certificate has already been removed or otherwise can't be found.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-TerminalName¶
The name of the RDP terminal to configure. Defaults to 'RDP-Tcp'.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: RDP-tcp
Accept pipeline input: False
Accept wildcard characters: False
CommonParameters¶
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.