Get-RDDeploymentGatewayConfiguration

Get-RDDeploymentGatewayConfiguration

Gets configuration settings for the RD Gateway for a Remote Desktop deployment.

Syntax

Parameter Set: Default
Get-RDDeploymentGatewayConfiguration [[-ConnectionBroker] <String> ] [ <CommonParameters>]

Detailed Description

The Get-RDDeploymentGatewayConfiguration cmdlet gets configuration settings for the Remote Desktop Gateway (RD Gateway) for a Remote Desktop deployment.

Parameters

-ConnectionBroker<String>

Specifies the Remote Desktop Connection Broker (RD Connection Broker) server for this Remote Desktop deployment. If this parameter does not appear, the default value is the fully qualified domain name (FQDN) of the local host.

Aliases

none

Required?

false

Position?

1

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see    about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

Outputs

The output type is the type of the objects that the cmdlet emits.

  • System.Object

    Gatewaymode (String) - One of these values: Automatic, DoNotUse or Custom.

    LogonMethod (String) - One of these values: Password, Smartcard or AllowUserToSelectRuntime.

    GatewayExternalFQDN - External FQDN of the RD Gateway server specified for the deployment.

Examples

Example 1: Retrieve Configuration Settings for the RD Gateway

This command retrieves the configuration settings of the RD Gateway server associated with the RD Connection Broker server named rdcb.contoso.com.

PS C:\> Get-RDDeploymentGatewayConfiguration -ConnectionBroker "rdcb.contoso.com"