Set-RASGatewayDefaultSettings

NAME

SYNOPSIS

Modifies default settings used to configure a RAS Secure Gateway.

SYNTAX

Set-RASGatewayDefaultSettings [AllowAppsInNewTab (bool)] [AllowCORS (bool)] [AllowedDomainsForCORS (List`1)] [AllowEmbed (bool)] [AllowLaunchMethod (bool)] [AlternateNLBHost (string)] [AlternateNLBPort (uint)] [AutoCertificate (SwitchParameter)] [AutoPreferredConnectionBroker (SwitchParameter)] [BlockAccessSessionLaunchCBAPI (bool)] [BlockAccessSessionLaunchWebAPI (bool)] [BlockAccessStandardRASSessions (bool)] [BlockAccessUserPortal (bool)] [Broadcast (bool)] [BrowserCacheTimeInMonths (uint)] [CertificateId (uint)] [CertificateObj (Certificate)] [Cipher (string)] [CipherPreference (bool)] [CipherStrength {Low | Medium | High | Custom}] [ClientDetectionTimeout (uint)] [ClientIPPDetectionServiceURL (string)] [ClipboardDirection {None | ClientToServer | ServerToClient | Bidirectional}] [DetectClientMode {Automatic | Manual}] [DisableWyseCertWarn (bool)] [DOSPro (bool)] [EnableAlternateNLBHost (bool)] [EnableAlternateNLBPort (bool)] [EnableDeviceManagerPort (bool)] [EnableGatewayPort (bool)] [EnableHSTS (bool)] [EnableRDP (bool)] [EnableRDPUDP (bool)] [EnableSSL (bool)] [EnableUserPortal (bool)] [EnableWyseSupport (bool)] [FileTransferMode {Disabled | ClientToServer | ServerToClient | Bidirectional}] [ForwardGatewayServers (string)] [ForwardHttpServers (string)] [GatewayPort (uint)] [HSTSIncludeSubdomains (bool)] [HSTSMaxAge (uint)] [HSTSPreload (bool)] [LaunchMethod {ParallelsClientAndWebClient | ParallelsClient | WebClient}] [MACAllowExcept (string[])] [MACAllowOnly (string[])] [MinSSLVersion {TLSv1 | TLSv1_1 | TLSv1_2 | TLSv1_3}] [Mode {Normal | Forwarding}] [NormalModeForwarding (bool)] [OnlyAllowAcmeHttp (bool)] [PreferredConnectionBrokerId (uint)] [PreferredConnectionBrokerObj (ConnectionBroker)] [RDPPort (uint)] [SecurityMode {AllowAllExcept | AllowOnly}] [SiteId (uint)] [SSLPort (uint)] [UseAutoKeyboardDetect (bool)] [UseClientIPDetectionService (bool)] [UsePreWin2000LoginFormat (bool)] [UserPortalPort (uint)] [UseSecureWebCookie (bool)] [WebCookie (string)] [WebRequestsURL (string)] [(CommonParameters)] **

DESCRIPTION

Modifies default settings used to configure a RAS Secure Gateway.

For each setting, the cmdlet has a corresponding input parameter. To modify a setting, specify a matching parameter and its value.

Default settings are defined on a site level and are applied to a Gateway when it is initially added to the site.

To retrieve the current defaults settings, use the Get-RASGatewayDefaultSettings cmdlet.

PARAMETERS

SiteId (uint)

Site ID for which to modify the default Gateway settings.

        Required?                    false

        Position?                    named

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

Mode (GatewayMode)

Gateway Mode. Accepted values: Normal, Forwarding.

Possible values: Normal, Forwarding

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

NormalModeForwarding (bool)

Forward requests to HTTP server.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

ForwardGatewayServers (string)

One or multiple (separated by comma) Forwarding Gateway Servers.

E.g. localhost:80, web1

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

AutoPreferredConnectionBroker (SwitchParameter)

Set preferred Connection Broker Automatically.

        Required?                    false

        Position?                    named

        Default value                False

        Accept pipeline input?       false

        Accept wildcard characters?  false

AutoPreferredBroker (SwitchParameter)

Set preferred Connection Broker Automatically.

This is an alias of the AutoPreferredConnectionBroker parameter.

        Required?                    false

        Position?                    named

        Default value                False

        Accept pipeline input?       false

        Accept wildcard characters?  false

PreferredConnectionBrokerObj (ConnectionBroker)

The preferred Connection Broker.

To obtain an object of type Broker representing the Preferred Connection Broker, use the Get-RASBroker cmdlet.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

PreferredBrokerObj (ConnectionBroker)

The preferred Connection Broker.

To obtain an object of type Broker representing the Preferred Connection Broker, use the Get-RASBroker cmdlet.

This is an alias of the PreferredConnectionBrokerObj parameter.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

PreferredConnectionBrokerId (uint)

The preferred Connection Broker ID.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

PreferredBrokerId (uint)

The preferred Connection Broker ID.

This is an alias of the PreferredConnectionBrokerId parameter.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

ForwardHttpServers (string)

One or multiple (separated by comma) Forwarding HTTP Servers.

E.g. localhost:81, web1

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

EnableGatewayPort (bool)

Enable or disable a custom RAS Secure Gateway port.

To specify a custom port, set this parameter to True and use the GatewayPort parameter to specify the port number.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

GatewayPort (uint)

A custom Gateway port number. For this port to take effect, the EnableGatewayPort parameters must be set to $True.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

OnlyAllowAcmeHttp (bool)

Whether to ignore all incoming requests except for Acme ones received on 'GatewayPort'

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

EnableRDP (bool)

Enable or disable a custom RDP port.

To specify a custom port number, use the RDPPort parameter.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

RDPPort (uint)

A custom RDP port number. For this port to take effect, the EnableRDPPort parameter must be set to True.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

Broadcast (bool)

Enable or disable the 'Broadcast RAS Secure Gateway Address' option.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

EnableRDPUDP (bool)

Enable or disable the 'RDP UDP Data Tunneling' option.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

EnableDeviceManagerPort (bool)

Enable or disable the 'Device Manager Port' option.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

DOSPro (bool)

Enable or disable the 'RDP DOS Attack Filter' option.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

EnableSSL (bool)

Enable or disable SSL on the port specified in the SSLPort parameter.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

SSLPort (uint)

SSL port number. To enable the port, set the EnableSSL port parameter to True.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

MinSSLVersion (AcceptedSSLVersion)

Minimum SSL version. Accepted values: TLSv1_3 (TLS v1.3 only, strong), TLSv1_2 (TLS v1.2 - TLS v1.3), TLSv1_1 (TLS v1.1 - TLS v1.3), TLSv1 (TLS v1 - TLS v1.3).

Possible values: TLSv1, TLSv1_1, TLSv1_2, TLSv1_3

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

CipherStrength (CipherStrength)

Cipher strength. Accepted values: Low, Medium, High, Custom.

Possible values: Low, Medium, High, Custom

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

Cipher (string)

Cipher string.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

CipherPreference (bool)

Enable or disable Use ciphers according to server preference.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

AutoCertificate (SwitchParameter)

Set Certificate Automatically.

        Required?                    false

        Position?                    named

        Default value                False

        Accept pipeline input?       false

        Accept wildcard characters?  false

CertificateObj (Certificate)

The Certificate.

To obtain an object of type Certificate, use the Get-Certificate cmdlet.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

CertificateId (uint)

The Certificate ID.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

EnableHSTS (bool)

Enable or disable HSTS.

To specify a custom HSTS Age, set this parameter to True and use the HSTSMaxAge parameter to specify the HSTS maximum age.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

HSTSMaxAge (uint)

Specifies the HSTS maximum age.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

HSTSIncludeSubdomains (bool)

Enable or disable the HSTS sub-domains.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

HSTSPreload (bool)

Enable or disable the HSTS preload.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

EnableUserPortal (bool)

Enable or disable User Portal connectivity on the Gateway.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

UserPortalPort (uint)

A custom User Portal port number.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

LaunchMethod (LaunchMethod)

Launch method.

Possible values: ParallelsClientAndWebClient, ParallelsClient, WebClient

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

AllowLaunchMethod (bool)

Allow users to select a resource launch method.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

AllowAppsInNewTab (bool)

Allow users to start applications in a new browser tab.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

UsePreWin2000LoginFormat (bool)

Enable or disable the 'Use Pre Windows 2000 Login Format' option.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

AllowEmbed (bool)

Allow embedding of Web Client into other web pages.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

UseAutoKeyboardDetect (bool)

Use automatic keyboard layout detection.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

FileTransferMode (FileTransferControlMode)

File Transfer option. Possible values are: 0 (Disabled), 1 (client to Server only), 2 {Server To Client only), 3 (Bidirectional).

Possible values: Disabled, ClientToServer, ServerToClient, Bidirectional

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

ClipboardDirection (ClipboardDirections)

State of clipboard direction.

Possible values: None, ClientToServer, ServerToClient, Bidirectional

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

AllowCORS (bool)

Allow cross-origin resource sharing.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

AllowedDomainsForCORS (List`1)

Allowed domains for cross-origin resource sharing.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

UseClientIPDetectionService (bool)

Use Client IP detection service.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

ClientIPPDetectionServiceURL (string)

Client IP detection service URL.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

DetectClientMode (DetectClientMode)

Detection mode.

Automatically on sign in

Manually on user prompt (Default)

Possible values: Automatic, Manual

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

ClientDetectionTimeout (uint)

Client detection timeout in seconds.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

BrowserCacheTimeInMonths (uint)

How long should the browser preserve the cache (in months).

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

EnableAlternateNLBHost (bool)

Enable or disable Alternate NLB host name specified in the EnableAlternateNLBHost parameter.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

AlternateNLBHost (string)

Alternate NLB host name. To enable the host name, set the EnableAlternateNLBHost port parameter to True.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

EnableAlternateNLBPort (bool)

Enable or disable Alternate NLB on the port specified in the AlternateNLBPort parameter.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

AlternateNLBPort (uint)

Alternate NLB port number. To enable the port, set the EnableAlternateNLBPort port parameter to True.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

EnableWyseSupport (bool)

Enable or disable Wyse ThinOS support.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

DisableWyseCertWarn (bool)

Enable or disable the warning if server certificate is not verified.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

SecurityMode (GatewaySecurityMode)

Security Mode. Accepted values: AllowAllExcept, AllowOnly.

Possible values: AllowAllExcept, AllowOnly

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

MACAllowExcept (string[])

Specifies the Security 'MAC Allow Except' MAC addresses.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

MACAllowOnly (string[])

Specifies the Security 'MAC Allow Only' MAC addresses.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

BlockAccessStandardRASSessions (bool)

Blocks new authentication to standard RAS sessions, preventing application listing and remote session launch. Existing sessions are not affected.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

BlockAccessUserPortal (bool)

Blocks access to the User Portal user interface, including portal login and related pages such as cookie policy and download. Other APIs may still be used.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

BlockAccessSessionLaunchWebAPI (bool)

Blocks new session launch through the Web API. Existing sessions are not affected.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

BlockAccessSessionLaunchCBAPI (bool)

Blocks new session launch through the Connection Broker API. Existing sessions are not affected.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

WebRequestsURL (string)

Set a URL for Web requests.

This is the URL that will open when a user enters the IP address

of the RAS Secure Gateway server in a web browser.

For the URL to work, the gateway mode must be set to Normal.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

WebCookie (string)

Set the Web Cookie Name used by RAS.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

UseSecureWebCookie (bool)

Enable or disable the addition of the secure attribute to the cookie to the Web Cookie.

        Required?                    false

        Position?                    named

        Default value                

        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 documentation.

INPUTS

-none-

OUTPUTS