< Back
New-RDCertificate
Post
NAME New-RDCertificate
SYNOPSIS
Creates a certificate for an RDS role.
SYNTAX
New-RDCertificate [-Role] {RDGateway | RDWebAccess | RDRedirector | RDPublishing} [-ConnectionBroker <String>] [-ExportPath <String>] [-Force]
-DnsName <String> -Password <SecureString> [<CommonParameters>]
DESCRIPTION
The New-RDCertificate cmdlet creates a certificate for a Remote Desktop Services (RDS) role.
This cmdlet creates an object that contains the following information:
-- Subject. The subject of the certificate.
-- SubjectAlternateName. A list of subject alternative name entries of the certificate.
-- IssuedBy. Common name of the issuer of the certificate.
-- IssuedTo. Common name of the IssuedTo field of the certificate.
-- ExpiresOn. Expiration date of the certificate.
-- Thumbprint. Thumbprint of the certificate.
-- Role. Remote desktop role service name. The possible roles are: RDGateway, RDWebAccess, RDRedirector, and RDPublishing.
-- Level. Certification level.
The certification levels are:
-- Not Configured. The role service is not configured with a certificate or the certificate is not valid.
-- Untrusted. The role service is configured with a self-signed certificate.
-- Trusted. The role service is configured with either enterprise certificate or public 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
-DnsName <String>
Specifies the Domain Name Service (DNS) name for a computer. The cmdlet creates a self-signed certificate for this computer.
Required? true
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-ExportPath [<String>]
Specifies a full file path for the certificate. The file has a .pfx extension.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-Force [<SwitchParameter>]
Forces the command to run without asking for user confirmation.
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? true
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
System.Object
Example 1: Create a certificate
PS C:\\> $Password = ConvertTo-SecureString -String "Wings%%83Potato" -AsPlainText -Force
PS C:\\> New-RDCertificate -Role RDPublishing -DnsName "RDWA01.Contoso.com " -Password $Password -ConnectionBroker "RDCB.Contoso.com"
This example creates a certificate 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. For more information, type Get-Help ConvertTo-SecureString.
The second command creates a certificate for the publishing role and uses the secure string stored in $Password to help secure it. The command
specifies the DNS name of the RDS host and the name of the connection broker.
Example 2: Create and export a certificate
PS C:\\> $Password = ConvertTo-SecureString -String "Cups34Horses&&" -AsPlainText -Force
PS C:\\> New-RDCertificate -Role RDWebAccess -DnsName "RDWA01.Contoso.com" -Password $Password -ExportPath "C:\\Certificates\\RDWA102.pfx"
-ConnectionBroker "RDCB.Contoso.com"
This example creates a certificate for an RDS role and exports it to a specified file.
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 creates a certificate for the web access role and uses the secure string stored in $Password to help secure it. The command
specifies the DNS name of the RDS host and the name of the connection broker. This command also exports the certificate to the specified .pfx file.
RELATED LINKS
Online Version: http://go.microsoft.com/fwlink/?LinkId=294237
Get-RDCertificate
Set-RDCertificate
SYNOPSIS
Creates a certificate for an RDS role.
SYNTAX
New-RDCertificate [-Role] {RDGateway | RDWebAccess | RDRedirector | RDPublishing} [-ConnectionBroker <String>] [-ExportPath <String>] [-Force]
-DnsName <String> -Password <SecureString> [<CommonParameters>]
DESCRIPTION
The New-RDCertificate cmdlet creates a certificate for a Remote Desktop Services (RDS) role.
This cmdlet creates an object that contains the following information:
-- Subject. The subject of the certificate.
-- SubjectAlternateName. A list of subject alternative name entries of the certificate.
-- IssuedBy. Common name of the issuer of the certificate.
-- IssuedTo. Common name of the IssuedTo field of the certificate.
-- ExpiresOn. Expiration date of the certificate.
-- Thumbprint. Thumbprint of the certificate.
-- Role. Remote desktop role service name. The possible roles are: RDGateway, RDWebAccess, RDRedirector, and RDPublishing.
-- Level. Certification level.
The certification levels are:
-- Not Configured. The role service is not configured with a certificate or the certificate is not valid.
-- Untrusted. The role service is configured with a self-signed certificate.
-- Trusted. The role service is configured with either enterprise certificate or public 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
-DnsName <String>
Specifies the Domain Name Service (DNS) name for a computer. The cmdlet creates a self-signed certificate for this computer.
Required? true
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-ExportPath [<String>]
Specifies a full file path for the certificate. The file has a .pfx extension.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-Force [<SwitchParameter>]
Forces the command to run without asking for user confirmation.
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? true
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
System.Object
Example 1: Create a certificate
PS C:\\> $Password = ConvertTo-SecureString -String "Wings%%83Potato" -AsPlainText -Force
PS C:\\> New-RDCertificate -Role RDPublishing -DnsName "RDWA01.Contoso.com " -Password $Password -ConnectionBroker "RDCB.Contoso.com"
This example creates a certificate 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. For more information, type Get-Help ConvertTo-SecureString.
The second command creates a certificate for the publishing role and uses the secure string stored in $Password to help secure it. The command
specifies the DNS name of the RDS host and the name of the connection broker.
Example 2: Create and export a certificate
PS C:\\> $Password = ConvertTo-SecureString -String "Cups34Horses&&" -AsPlainText -Force
PS C:\\> New-RDCertificate -Role RDWebAccess -DnsName "RDWA01.Contoso.com" -Password $Password -ExportPath "C:\\Certificates\\RDWA102.pfx"
-ConnectionBroker "RDCB.Contoso.com"
This example creates a certificate for an RDS role and exports it to a specified file.
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 creates a certificate for the web access role and uses the secure string stored in $Password to help secure it. The command
specifies the DNS name of the RDS host and the name of the connection broker. This command also exports the certificate to the specified .pfx file.
RELATED LINKS
Online Version: http://go.microsoft.com/fwlink/?LinkId=294237
Get-RDCertificate
Set-RDCertificate