Edit

Share via

Get-RDCertificate

Module:
RemoteDesktop Module

Gets certificates associated with RDS roles.

Syntax

Default (Default) 

Get-RDCertificate
    [[-Role] <RDCertificateRole>]
    [-ConnectionBroker <String>]
    [<CommonParameters>]

Description

The Get-RDCertificate cmdlet gets certificates associated with Remote Desktop Services (RDS) roles.

This cmdlet modifies 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.

Examples

Example 1: Get certificates for an RD Connection Broker

PS C:\> Get-RDCertificate -ConnectionBroker "RDConnectionBroker.Contoso.com"

This command gets certificates for server roles for the RD Connection Broker server named RDConnectionBroker.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.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Role

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

  • RDGateway
  • RDWebAccess
  • RDRedirector
  • RDPublishing

Parameter properties

Type:RDCertificateRole
Default value:None
Accepted values:RDGateway, RDWebAccess, RDRedirector, RDPublishing
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:0
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Outputs

Object