Set-RDCertificate

Set-RDCertificate

Imports and secures a certificate to use with an RDS role.

Syntax

Parameter Set: Reapply
Set-RDCertificate [-Role] <RDCertificateRole> [-ConnectionBroker <String> ] [-Force] [-Password <SecureString> ] [ <CommonParameters>]

Parameter Set: Import
Set-RDCertificate [-Role] <RDCertificateRole> [-ConnectionBroker <String> ] [-Force] [-ImportPath <String> ] [-Password <SecureString> ] [ <CommonParameters>]

Detailed Description

The Set-RDCertificate cmdlet imports a certificate to use with a Remote Desktop Services (RDS) role. The cmldet helps secure a certificate by using a secure string supplied by the user. You can use this cmdlet to apply a new secure string for an existing certificate.

Parameters

-ConnectionBroker<String>

Specifies the Remote Desktop Connection Broker (RD Connection Broker) server for a Remote Desktop deployment. If you do not specify a value, the cmdlet uses the fully qualified domain name (FQDN) of the local computer.

-Force

Performs the action without a confirmation message.

-ImportPath<String>

Specifies the location of a certificate as a file that has a .pfx extension.

-Password<SecureString>

Specifies a secure string used to help secure the certificate. See the Examples section.

-Role<RDCertificateRole>

Specifies a certificate type associated with an RDS server role. The acceptable values for this parameter are:

-- RDGateway
-- RDWebAccess
-- RDRedirector
-- RDPublishing

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see    about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

Outputs

The output type is the type of the objects that the cmdlet emits.

• Null

  None.

Examples

Example 1: Import a certificate to use with RDS

This example imports a certificate to use with an RDS role.

The first command uses the ConvertTo-SecureString cmdlet to create a secure string based on a string that the user supplies, and stores it in the $Password variable. For more information, type Get-Help ConvertTo-SecureString.

The second command specifies the file name of the certificate to use for the redirector role for the RD Connection Broker named RDCB.Contoso.com. The command uses the secure string stored in the $Password variable to help secure the certificate.

PS C:\> $Password = ConvertTo-SecureString -String "Cups34Horses&&" -AsPlainText -Force

PS C:\> Set-RDCertificate -Role RDRedirector -ImportPath "C:\Certificates\Redirector07.pfx" -Password $Password -ConnectionBroker "RDCB.Contoso.com" 

Example 2: Apply a secure string to a certificate

This example applies a new secure string to a certificate used for an RDS role.

The first command uses the ConvertTo-SecureString cmdlet to create a secure string based on a string that the user supplies, and stores it in the $Password variable.

The second command uses the secure string stored in the $Password variable to secure the certificate used for the redirector role for the RD Connection Broker named RDCB.Contoso.com.

PS C:\> $Password = ConvertTo-SecureString -String "Wings%%83Potato" -AsPlainText -Force

PS C:\> Set-RDCertificate -Role RDRedirector -Password $Password -ConnectionBroker "RDCB.Contoso.com"

Related topics

Get-RDCertificate

New-RDCertificate