Set-RASGateway
NAME
Set-RASGateway
SYNOPSIS
Modifies properties of a RAS Secure Gateway.
SYNTAX
Set-RASGateway [-Id] <uint> [-AllowAppsInNewTab <bool>] [-AllowCORS <bool>] [-AllowedDomainsForCORS <List`1>] [-AllowEmbed <bool>] [-AllowLaunchMethod <bool>] [-AlternateNLBHost <string>] [-AlternateNLBPort <uint>] [-AutoCertificate <SwitchParameter>] [-AutoPreferredBroker <SwitchParameter>] [-BindV4Addresses <string>] [-BindV6Addresses <string>] [-Broadcast <bool>] [-BrowserCacheTimeInMonths <uint>] [-CertificateFile <string>] [-CertificateId <uint>] [-CertificateObj <Certificate>] [-Cipher <string>] [-CipherPreference <bool>] [-CipherStrength {Low | Medium | High | Custom}] [-ClientDetectionTimeout <uint>] [-ClientIPPDetectionServiceURL <string>] [-ClipboardDirection {None | ClientToServer | ServerToClient | Bidirectional}] [-Description <string>] [-DetectClientMode {Automatic | Manual}] [-DisableWyseCertWarn <bool>] [-DOSPro <bool>] [-EnableAlternateNLBHost <bool>] [-EnableAlternateNLBPort <bool>] [-Enabled <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>] [-InheritDefaultModeSettings <bool>] [-InheritDefaultNetworkSettings <bool>] [-InheritDefaultSecuritySettings <bool>] [-InheritDefaultSslTlsSettings <bool>] [-InheritDefaultUserPortalSettings <bool>] [-InheritDefaultWebSettings <bool>] [-InheritDefaultWyseSettings <bool>] [-IPs <string>] [-IPVersion {Version4 | Version6 | BothVersions}] [-LaunchMethod {ParallelsClientAndWebClient | ParallelsClientAndHTML5 | ParallelsClient | WebClient | HTML5}] [-MACAllowExcept <string[]>] [-MACAllowOnly <string[]>] [-MinSSLVersion {TLSv1 | TLSv1_1 | TLSv1_2 | TLSv1_3}] [-Mode {Normal | Forwarding}] [-NewServer <string>] [-NormalModeForwarding <bool>] [-OnlyAllowAcmeHttp <bool>] [-OptimizeConnectionIPv4 <string>] [-OptimizeConnectionIPv6 <string>] [-PfxFile <string>] [-PfxPassword <SecureString>] [-PreferredBrokerId <uint>] [-PreferredBrokerObj <Broker>] [-PrivateKeyFile <string>] [-PublicAddress <string>] [-RDPPort <uint>] [-SecurityMode {AllowAllExcept | AllowOnly}] [-SSLPort <uint>] [-UseClientIPDetectionService <bool>] [-UsePreWin2000LoginFormat <bool>] [-UserPortalPort <uint>] [-UseSecureWebCookie <bool>] [-WebCookie <string>] [-WebRequestsURL <string>] [<CommonParameters>]
Set-RASGateway [-InputObject] <Gateway> [-AllowAppsInNewTab <bool>] [-AllowCORS <bool>] [-AllowedDomainsForCORS <List`1>] [-AllowEmbed <bool>] [-AllowLaunchMethod <bool>] [-AlternateNLBHost <string>] [-AlternateNLBPort <uint>] [-AutoCertificate <SwitchParameter>] [-AutoPreferredBroker <SwitchParameter>] [-BindV4Addresses <string>] [-BindV6Addresses <string>] [-Broadcast <bool>] [-BrowserCacheTimeInMonths <uint>] [-CertificateFile <string>] [-CertificateId <uint>] [-CertificateObj <Certificate>] [-Cipher <string>] [-CipherPreference <bool>] [-CipherStrength {Low | Medium | High | Custom}] [-ClientDetectionTimeout <uint>] [-ClientIPPDetectionServiceURL <string>] [-ClipboardDirection {None | ClientToServer | ServerToClient | Bidirectional}] [-Description <string>] [-DetectClientMode {Automatic | Manual}] [-DisableWyseCertWarn <bool>] [-DOSPro <bool>] [-EnableAlternateNLBHost <bool>] [-EnableAlternateNLBPort <bool>] [-Enabled <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>] [-InheritDefaultModeSettings <bool>] [-InheritDefaultNetworkSettings <bool>] [-InheritDefaultSecuritySettings <bool>] [-InheritDefaultSslTlsSettings <bool>] [-InheritDefaultUserPortalSettings <bool>] [-InheritDefaultWebSettings <bool>] [-InheritDefaultWyseSettings <bool>] [-IPs <string>] [-IPVersion {Version4 | Version6 | BothVersions}] [-LaunchMethod {ParallelsClientAndWebClient | ParallelsClientAndHTML5 | ParallelsClient | WebClient | HTML5}] [-MACAllowExcept <string[]>] [-MACAllowOnly <string[]>] [-MinSSLVersion {TLSv1 | TLSv1_1 | TLSv1_2 | TLSv1_3}] [-Mode {Normal | Forwarding}] [-NewServer <string>] [-NormalModeForwarding <bool>] [-OnlyAllowAcmeHttp <bool>] [-OptimizeConnectionIPv4 <string>] [-OptimizeConnectionIPv6 <string>] [-PfxFile <string>] [-PfxPassword <SecureString>] [-PreferredBrokerId <uint>] [-PreferredBrokerObj <Broker>] [-PrivateKeyFile <string>] [-PublicAddress <string>] [-RDPPort <uint>] [-SecurityMode {AllowAllExcept | AllowOnly}] [-SSLPort <uint>] [-UseClientIPDetectionService <bool>] [-UsePreWin2000LoginFormat <bool>] [-UserPortalPort <uint>] [-UseSecureWebCookie <bool>] [-WebCookie <string>] [-WebRequestsURL <string>] [<CommonParameters>]
Set-RASGateway [-Server] <string> [[-SiteId] <uint>] [-AllowAppsInNewTab <bool>] [-AllowCORS <bool>] [-AllowedDomainsForCORS <List`1>] [-AllowEmbed <bool>] [-AllowLaunchMethod <bool>] [-AlternateNLBHost <string>] [-AlternateNLBPort <uint>] [-AutoCertificate <SwitchParameter>] [-AutoPreferredBroker <SwitchParameter>] [-BindV4Addresses <string>] [-BindV6Addresses <string>] [-Broadcast <bool>] [-BrowserCacheTimeInMonths <uint>] [-CertificateFile <string>] [-CertificateId <uint>] [-CertificateObj <Certificate>] [-Cipher <string>] [-CipherPreference <bool>] [-CipherStrength {Low | Medium | High | Custom}] [-ClientDetectionTimeout <uint>] [-ClientIPPDetectionServiceURL <string>] [-ClipboardDirection {None | ClientToServer | ServerToClient | Bidirectional}] [-Description <string>] [-DetectClientMode {Automatic | Manual}] [-DisableWyseCertWarn <bool>] [-DOSPro <bool>] [-EnableAlternateNLBHost <bool>] [-EnableAlternateNLBPort <bool>] [-Enabled <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>] [-InheritDefaultModeSettings <bool>] [-InheritDefaultNetworkSettings <bool>] [-InheritDefaultSecuritySettings <bool>] [-InheritDefaultSslTlsSettings <bool>] [-InheritDefaultUserPortalSettings <bool>] [-InheritDefaultWebSettings <bool>] [-InheritDefaultWyseSettings <bool>] [-IPs <string>] [-IPVersion {Version4 | Version6 | BothVersions}] [-LaunchMethod {ParallelsClientAndWebClient | ParallelsClientAndHTML5 | ParallelsClient | WebClient | HTML5}] [-MACAllowExcept <string[]>] [-MACAllowOnly <string[]>] [-MinSSLVersion {TLSv1 | TLSv1_1 | TLSv1_2 | TLSv1_3}] [-Mode {Normal | Forwarding}] [-NewServer <string>] [-NormalModeForwarding <bool>] [-OnlyAllowAcmeHttp <bool>] [-OptimizeConnectionIPv4 <string>] [-OptimizeConnectionIPv6 <string>] [-PfxFile <string>] [-PfxPassword <SecureString>] [-PreferredBrokerId <uint>] [-PreferredBrokerObj <Broker>] [-PrivateKeyFile <string>] [-PublicAddress <string>] [-RDPPort <uint>] [-SecurityMode {AllowAllExcept | AllowOnly}] [-SSLPort <uint>] [-UseClientIPDetectionService <bool>] [-UsePreWin2000LoginFormat <bool>] [-UserPortalPort <uint>] [-UseSecureWebCookie <bool>] [-WebCookie <string>] [-WebRequestsURL <string>] [<CommonParameters>]
DESCRIPTION
Modifies properties of a RAS Secure Gateway.
When executing the cmdlet, you can include only the parameters that you want to modify.
PARAMETERS
-Server <string> The name of the RAS Secure Gateway to modify.
The name can be either FQDN or IP address, but you have to enter the actual name this server has in the RAS farm.
-SiteId <uint> The site ID to which the Secure Gateway belongs.
-Id <uint> The ID of the Secure Gateway to modify.
-InputObject <Gateway> The Secure Gateway object to be modified.
A Secure Gateway object representing a Secure Gateway is obtained using the Get-RASGateway cmdlet.
-Enabled <bool> Enable or disable the specified Secure Gateway.
-NewServer <string> The new Secure Gateway name. The name must be either a valid FQDN or a valid IP address.
-Description <string> A user-defined Secure Gateway description.
-PublicAddress <string> The Public Address of the Secure Gateway.
-IPVersion <IPVersion> The IP version for the Secure Gateway to use. Accepted values: Version4 (IPv4), Version6 (IPv6), BothVersions (both IPv4 and IPv6).
Possible values: Version4, Version6, BothVersions
-IPs <string> One or multiple (separated by comma) IP addresses.
-BindV4Addresses <string> IPv4 address to bind to.
If '0.0.0.0' is passed, will bind to all available addresses.
When using a specific address, it has to be available in the IPv4 address list.
-OptimizeConnectionIPv4 <string> Optimize connection for the list of IPv4 (comma separated values).
-BindV6Addresses <string> IPv6 address to bind to.
If '::' is passed, will bind to all available addresses.
When using a specific address, it has to be available in the IPv6 address list.
-OptimizeConnectionIPv6 <string> Optimize connection for the list of IPv6 (comma separated values).
-InheritDefaultModeSettings <bool> Enable or disable default mode settings.
-InheritDefaultNetworkSettings <bool> Enable or disable default network settings.
-InheritDefaultSslTlsSettings <bool> Enable or disable default SSL/TLS setting.
-InheritDefaultUserPortalSettings <bool> Enable or disable default User Portal settings.
-InheritDefaultWyseSettings <bool> Enable or disable default wyse settings.
-InheritDefaultSecuritySettings <bool> Enable or disable default security settingsd.
-InheritDefaultWebSettings <bool> Enable or disable default web settings.
-Mode <Gateway> Gateway Mode. Accepted values: Normal, Forwarding.
Possible values: Normal, Forwarding
-NormalModeForwarding <bool> Forward requests to HTTP server.
-ForwardGatewayServers <string> One or multiple (separated by comma) Forwarding Gateway Servers.
E.g. localhost:80, web1
-AutoPreferredBroker <SwitchParameter> Set preferred Connection Broker Automatically.
-PreferredBrokerObj <Broker> The preferred Connection Broker.
To obtain an object of type Broker representing the Preferred Connection Broker, use the Get-RASBroker cmdlet.
-PreferredBrokerId <uint> The preferred Connection Broker ID.
-ForwardHttpServers <string> One or multiple (separated by comma) Forwarding HTTP Servers.
E.g. localhost:81, web1
-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.
-GatewayPort <uint> A custom Gateway port number. For this port to take effect, the EnableGatewayPort parameters must be set to $True.
-OnlyAllowAcmeHttp <bool> Whether to ignore all incoming requests except for Acme ones received on 'GatewayPort'
-EnableRDP <bool> Enable or disable a custom RDP port.
To specify a custom port number, use the RDPPort parameter.
-RDPPort <uint> A custom RDP port number. For this port to take effect, the EnableRDPPort parameter must be set to True.
-Broadcast <bool> Enable or disable the 'Broadcast RAS Secure Gateway Address' option.
-EnableRDPUDP <bool> Enable or disable the 'RDP UDP Data Tunneling' option.
-EnableDeviceManagerPort <bool> Enable or disable the 'Device Manager Port' option.
-DOSPro <bool> Enable or disable the 'RDP DOS Attack Filter' option.
-EnableSSL <bool> Enable or disable SSL on the port specified in the SSLPort parameter.
-SSLPort <uint> SSL port number. To enable the port, set the EnableSSL port parameter to True.
-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
-CipherStrength <CipherStrength> Cipher strength. Accepted values: Low, Medium, High, Custom.
Possible values: Low, Medium, High, Custom
-Cipher <string> Cipher string.
-CipherPreference <bool> Enable or disable Use ciphers according to server preference.
-AutoCertificate <SwitchParameter> Set Certificate Automatically.
-CertificateObj <Certificate> The Certificate.
To obtain an object of type Certificate, use the Get-Certificate cmdlet.
Certificate Set Priority 1. This value will be used if specified.
-CertificateId <uint> The Certificate ID.
Certificate Set Priority 2. This value will be ignored if a CertificateObj is specified.
-PfxFile <string> Certificate file name in pfx format.
Certificate Set Priority 3. This value will be ignored if a CertificateObj/CertificateId is specified.
-PfxPassword <SecureString> The password of the pfx file specified in the PfxFile parameter.
-CertificateFile <string> Certificate file name.
Certificate Set Priority 4. This value will be ignored if a CertificateObj/CertificateId/PfxFile is specified.
-PrivateKeyFile <string> Private key file name.
-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.
-HSTSMaxAge <uint> Specifies the HSTS maximum age.
-HSTSIncludeSubdomains <bool> Enable or disable the HSTS sub-domains.
-HSTSPreload <bool> Enable or disable the HSTS preload.
-EnableUserPortal <bool> Enable or disable User Portal connectivity on the Gateway.
-UserPortalPort <uint> A custom User Portal port number.
-LaunchMethod <LaunchMethod> Launch method.
Possible values: ParallelsClientAndWebClient, ParallelsClientAndHTML5, ParallelsClient, WebClient, HTML5
-AllowLaunchMethod <bool> Allow users to select a resource launch method.
-AllowAppsInNewTab <bool> Allow users to start applications in a new browser tab.
-UsePreWin2000LoginFormat <bool> Enable or disable the 'Use Pre Windows 2000 Login Format' option.
-AllowEmbed <bool> Allow embedding of Web Client into other web pages.
-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
-ClipboardDirection <ClipboardDirections> State of clipboard direction.
Possible values: None, ClientToServer, ServerToClient, Bidirectional
-AllowCORS <bool> Allow cross-origin resource sharing.
-AllowedDomainsForCORS <List`1> Allowed domains for cross-origin resource sharing.
-UseClientIPDetectionService <bool> Use Client IP detection service.
-ClientIPPDetectionServiceURL <string> Client IP detection service URL.
-DetectClientMode <DetectClientMode> Detection mode.
Automatically on sign in
Manually on user prompt (Default)
Possible values: Automatic, Manual
-ClientDetectionTimeout <uint> Client detection timeout in seconds.
-BrowserCacheTimeInMonths <uint> How long should the browser preserve the cache (in months).
-EnableAlternateNLBHost <bool> Enable or disable Alternate NLB host name specified in the EnableAlternateNLBHost parameter.
-AlternateNLBHost <string> Alternate NLB host name. To enable the host name, set the EnableAlternateNLBHost port parameter to True.
-EnableAlternateNLBPort <bool> Enable or disable Alternate NLB on the port specified in the AlternateNLBPort parameter.
-AlternateNLBPort <uint> Alternate NLB port number. To enable the port, set the EnableAlternateNLBPort port parameter to True.
-EnableWyseSupport <bool> Enable or disable Wyse ThinOS support.
-DisableWyseCertWarn <bool> Enable or disable the warning if server certificate is not verified.
-SecurityMode <Gateway> Security Mode. Accepted values: AllowAllExcept, AllowOnly.
Possible values: AllowAllExcept, AllowOnly
-MACAllowExcept <string[]> Specifies the Security 'MAC Allow Except' MAC addresses.
-MACAllowOnly <string[]> Specifies the Security 'MAC Allow Only' MAC addresses.
-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.
-WebCookie <string> Set the Web Cookie Name used by RAS.
-UseSecureWebCookie <bool> Enable or disable the addition of the secure attribute to the cookie to the Web Cookie.
<CommonParameters>
INPUTS
OUTPUTS
-none-
EXAMPLES
---------- EXAMPLE 1 ----------
Set-RASGateway "server.company.dom" -Enable $False
Disables the specified RAS Secure Gateway in the Licensing Server site.
To disable a RAS Secure Gateway in a specific site, specify the -SiteId parameter.
All parameters except -Server are optional and only passed if they need to be updated. ---------- EXAMPLE 2 ----------
Set-RASGateway -Id "1" -Enable $True
Enables the RAS Secure Gateway specified by ID. ---------- EXAMPLE 3 ----------
Set-RASGateway $Gateway -Enable $False
Disables a RAS Secure Gateway specified by Gateway object ($Gateway variable).
A Gateway object representing a RAS Secure Gateway is obtained using the Get-RASGateway cmdlet. ---------- EXAMPLE 4 ----------
Get-RASGateway -Id 1 | Set-RASGateway -Enable $False
Disables the RAS Secure Gateway which is identified by an object obtained from the pipeline output. ---------- EXAMPLE 5 ----------
Get-RASGateway -Id 1 | Set-RASGateway -Description "My new Gateway description"
Modifies the description of the RAS Secure Gateway obtained from the pipeline output.
RELATED LINKS
Last updated