PowerShell Logo Small

New-RDCertificate



This is the built-in help made by Microsoft for the command 'New-RDCertificate', in PowerShell version 5 - as retrieved from Windows version 'Microsoft Windows Server 2012 R2 Standard' PowerShell help files on 2016-06-23.

For PowerShell version 3 and up, where you have Update-Help, this command was run just before creating the web pages from the help files.

SYNOPSIS

Creates a certificate for an RDS role.

SYNTAX


New-RDCertificate [-Role] <RDCertificateRole> [-ConnectionBroker <String>] [-ExportPath <String>] [-Force] -DnsName <String> -Password <SecureString> [<CommonParameters>]



Search powershellhelp.space

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.



<

RELATED LINKS

Online Version: http://go.microsoft.com/fwlink/?LinkId=294237
Get-RDCertificate
Set-RDCertificate

REMARKS

<

Examples


Example 1: Create a certificate

PS C:\> $Password = ConvertTo-SecureString -String "Wings%%83Potato" -AsPlainText -ForcePS 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 -ForcePS 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.