< Back
Set-RDCertificate
Post
NAME Set-RDCertificate
SYNOPSIS
Imports and secures a certificate to use with an RDS role.
SYNTAX
Set-RDCertificate [-Role] {RDGateway | RDWebAccess | RDRedirector | RDPublishing} [-ConnectionBroker <String>] [-Force] [-Password <SecureString>]
[<CommonParameters>]
Set-RDCertificate [-Role] {RDGateway | RDWebAccess | RDRedirector | RDPublishing} [-ConnectionBroker <String>] [-Force] [-ImportPath <String>]
[-Password <SecureString>] [<CommonParameters>]
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 (RDConnection 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.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-Force [<SwitchParameter>]
Performs the action without a confirmation message.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-ImportPath [<String>]
Specifies the location of a certificate as a file that has a .pfx extension.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-Password [<SecureString>]
Specifies a secure string used to help secure the certificate. See the Examples section.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-Role <RDCertificateRole>
Specifies a certificate type associated with an RDS server role. The acceptable values for this parameter are:
-- RDGateway
-- RDWebAccess
-- RDRedirector
-- RDPublishing
Required? true
Position? 1
Default value none
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
Null
Example 1: Import a certificate to use with RDS
PS C:\\> $Password = ConvertTo-SecureString -String "Cups34Horses&&" -AsPlainText -ForcePS 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 RDConnection 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 -ForcePS 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.
RELATED LINKS
Online Version: http://go.microsoft.com/fwlink/?LinkId=294254
Get-RDCertificate
New-RDCertificate
SYNOPSIS
Imports and secures a certificate to use with an RDS role.
SYNTAX
Set-RDCertificate [-Role] {RDGateway | RDWebAccess | RDRedirector | RDPublishing} [-ConnectionBroker <String>] [-Force] [-Password <SecureString>]
[<CommonParameters>]
Set-RDCertificate [-Role] {RDGateway | RDWebAccess | RDRedirector | RDPublishing} [-ConnectionBroker <String>] [-Force] [-ImportPath <String>]
[-Password <SecureString>] [<CommonParameters>]
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 (RDConnection 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.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-Force [<SwitchParameter>]
Performs the action without a confirmation message.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-ImportPath [<String>]
Specifies the location of a certificate as a file that has a .pfx extension.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-Password [<SecureString>]
Specifies a secure string used to help secure the certificate. See the Examples section.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-Role <RDCertificateRole>
Specifies a certificate type associated with an RDS server role. The acceptable values for this parameter are:
-- RDGateway
-- RDWebAccess
-- RDRedirector
-- RDPublishing
Required? true
Position? 1
Default value none
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
Null
Example 1: Import a certificate to use with RDS
PS C:\\> $Password = ConvertTo-SecureString -String "Cups34Horses&&" -AsPlainText -ForcePS 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 RDConnection 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 -ForcePS 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.
RELATED LINKS
Online Version: http://go.microsoft.com/fwlink/?LinkId=294254
Get-RDCertificate
New-RDCertificate