Set-RDCertificate
Imports and secures a certificate to use with an RDS role.
Syntax
Set-RDCertificate
[-Role] <RDCertificateRole>
[-Password <SecureString>]
[-ConnectionBroker <String>]
[-Force]
[<CommonParameters>]
Set-RDCertificate
[-Role] <RDCertificateRole>
[-ImportPath <String>]
[-Password <SecureString>]
[-ConnectionBroker <String>]
[-Force]
[<CommonParameters>]
Description
The Set-RDCertificate cmdlet imports a certificate to use with a Remote Desktop Services (RDS) role. The cmdlet 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.
Examples
Example 1: Import a certificate to use with RDS
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"
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.
Example 2: Apply a secure string to a certificate
PS C:\> $Password = ConvertTo-SecureString -String "Wings%%83Potato" -AsPlainText -Force PS C:\>Set-RDCertificate -Role RDRedirector -Password $Password -ConnectionBroker "RDCB.Contoso.com"
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.
Parameters
-ConnectionBroker
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.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Force
Performs the action without a confirmation message.
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ImportPath
Specifies the location of a certificate as a file that has a .pfx extension.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Password
Specifies a secure string used to help secure the certificate. See the Examples section.
Type: | SecureString |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Role
Specifies a certificate type associated with an RDS server role. The acceptable values for this parameter are:
- RDGateway
- RDWebAccess
- RDRedirector
- RDPublishing
Type: | RDCertificateRole |
Accepted values: | RDGateway, RDWebAccess, RDRedirector, RDPublishing |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Outputs
Null
None.
Related Links
Feedback
https://aka.ms/ContentUserFeedback.
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see:Submit and view feedback for