Edit

Share via

Set-RDCertificate

Module:
RDMgmt Module

Imports or applies a certificate to use with an RDS role.

Syntax

Reapply (default) (Default) 

Set-RDCertificate
    [-Role] <RDCertificateRole>
    [-Password <SecureString>]
    [-ConnectionBroker <String>]
    [-Force]
    [<CommonParameters>]

Import 

Set-RDCertificate
    [-Role] <RDCertificateRole>
    [-ImportPath <String>]
    [-Password <SecureString>]
    [-ConnectionBroker <String>]
    [-Force]
    [<CommonParameters>]

Thumbprint 

Set-RDCertificate
    [-Role] <RDCertificateRole>
    [-Thumbprint <String>]
    [-ConnectionBroker <String>]
    [-Force]
    [<CommonParameters>]

Description

The Set-RDCertificate cmdlet imports a certificate or applies an installed certificate to use with a Remote Desktop Services (RDS) role. You can use this cmdlet to secure an existing certificate by using a secure string supplied by the user.

Parameters

-ConnectionBroker

This parameter specifies the Remote Desktop Connection Broker (RD Connection Broker) server for a Remote Desktop deployment.

If you don't specify a value, the cmdlet uses the local computer's fully qualified domain name (FQDN).

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

-Force

This parameter performs the action without a confirmation message.

Parameter properties

Type:SwitchParameter
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

-ImportPath

This parameter specifies the location of a certificate as a file that has a .pfx extension.

Parameter properties

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

Parameter sets

Import
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Password

This parameter specifies a secure string used to help secure the certificate.

See the Examples section.

Parameter properties

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

Parameter sets

Reapply
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
Import
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Role

This parameter 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:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Thumbprint

This parameter specifies the thumbprint of the certificate to use. Currently, it is only available in Windows Server 2019.

Parameter properties

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

Parameter sets

Thumbprint
Position:Named
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.

Inputs

None

Outputs

Object