Set-GW

NAME

Set-GW

SYNOPSIS

Modifies properties of a RAS Secure Client Gateway.

SYNTAX

Set-GW [-Server] <string> [[-SiteId] <uint>] [-AllowAppsInNewTab <bool>] [-AllowClipboard <bool>] [-AllowEmbed <bool>] [-AllowFileTransfer <bool>] [-AllowLaunchMethod <bool>] [-AlternateNLBHost <string>] [-AlternateNLBPort <uint>] [-AutoPreferredPA <SwitchParameter>] [-BindV4Addresses <string>] [-BindV6Addresses <string>] [-Broadcast <bool>] [-CertificateFile <string>] [-Cipher <string>] [-CipherStrength <CipherStrength> {Low | Medium | High | Custom}] [-Description <string>] [-DOSPro <bool>] [-EnableAlternateNLBHost <bool>] [-EnableAlternateNLBPort <bool>] [-EnableClientManagerPort <bool>] [-Enabled <bool>] [-EnableGWPort <bool>] [-EnableHSTS <bool>] [-EnableHTML5 <bool>] [-EnableRDP <bool>] [-EnableRDPUDP <bool>] [-EnableSSL <bool>] [-EnableWyseSupport <bool>] [-ForwardGatewayServers <string>] [-ForwardHttpServers <string>] [-GWMode <GatewayMode> {Normal | Forwarding}] [-GWPort <uint>] [-HSTSIncludeSubdomains <bool>] [-HSTSMaxAge <uint>] [-HSTSPreload <bool>] [-HTML5Port <uint>] [-IPs <string>] [-IPVersion <IPVersion> {Version4 | Version6 | BothVersions}] [-LaunchMethod <LaunchMethod> {ParallelsClientAndHTML5 | ParallelsClient | HTML5}] [-MACAllowExcept <string[]>] [-MACAllowOnly <string[]>] [-MinSSLVersion <AcceptedSSLVersions> {SSLv2 | SSLv3 | TLSv1 | TLSv1_1 | TLSv1_2}] [-NewServer <string>] [-NormalModeForwarding <bool>] [-OptimizeConnectionIPv4 <string>] [-OptimizeConnectionIPv6 <string>] [-PfxFile <string>] [-PfxPassword <SecureString>] [-PreferredPAId <uint>] [-PreferredPAObj <PA>] [-PrivateKeyFile <string>] [-RDPPort <uint>] [-SecurityMode <GWSecurityMode> {AllowAllExcept | AllowOnly}] [-SSLPort <uint>] [-UsePreWin2000LoginFormat <bool>] [-WebRequestsURL <string>] [<CommonParameters>]

Set-GW [-Id] <uint> [-AllowAppsInNewTab <bool>] [-AllowClipboard <bool>] [-AllowEmbed <bool>] [-AllowFileTransfer <bool>] [-AllowLaunchMethod <bool>] [-AlternateNLBHost <string>] [-AlternateNLBPort <uint>] [-AutoPreferredPA <SwitchParameter>] [-BindV4Addresses <string>] [-BindV6Addresses <string>] [-Broadcast <bool>] [-CertificateFile <string>] [-Cipher <string>] [-CipherStrength <CipherStrength> {Low | Medium | High | Custom}] [-Description <string>] [-DOSPro <bool>] [-EnableAlternateNLBHost <bool>] [-EnableAlternateNLBPort <bool>] [-EnableClientManagerPort <bool>] [-Enabled <bool>] [-EnableGWPort <bool>] [-EnableHSTS <bool>] [-EnableHTML5 <bool>] [-EnableRDP <bool>] [-EnableRDPUDP <bool>] [-EnableSSL <bool>] [-EnableWyseSupport <bool>] [-ForwardGatewayServers <string>] [-ForwardHttpServers <string>] [-GWMode <GatewayMode> {Normal | Forwarding}] [-GWPort <uint>] [-HSTSIncludeSubdomains <bool>] [-HSTSMaxAge <uint>] [-HSTSPreload <bool>] [-HTML5Port <uint>] [-IPs <string>] [-IPVersion <IPVersion> {Version4 | Version6 | BothVersions}] [-LaunchMethod <LaunchMethod> {ParallelsClientAndHTML5 | ParallelsClient | HTML5}] [-MACAllowExcept <string[]>] [-MACAllowOnly <string[]>] [-MinSSLVersion <AcceptedSSLVersions> {SSLv2 | SSLv3 | TLSv1 | TLSv1_1 | TLSv1_2}] [-NewServer <string>] [-NormalModeForwarding <bool>] [-OptimizeConnectionIPv4 <string>] [-OptimizeConnectionIPv6 <string>] [-PfxFile <string>] [-PfxPassword <SecureString>] [-PreferredPAId <uint>] [-PreferredPAObj <PA>] [-PrivateKeyFile <string>] [-RDPPort <uint>] [-SecurityMode <GWSecurityMode> {AllowAllExcept | AllowOnly}] [-SSLPort <uint>] [-UsePreWin2000LoginFormat <bool>] [-WebRequestsURL <string>] [<CommonParameters>]

Set-GW [-InputObject] <GW> [-AllowAppsInNewTab <bool>] [-AllowClipboard <bool>] [-AllowEmbed <bool>] [-AllowFileTransfer <bool>] [-AllowLaunchMethod <bool>] [-AlternateNLBHost <string>] [-AlternateNLBPort <uint>] [-AutoPreferredPA <SwitchParameter>] [-BindV4Addresses <string>] [-BindV6Addresses <string>] [-Broadcast <bool>] [-CertificateFile <string>] [-Cipher <string>] [-CipherStrength <CipherStrength> {Low | Medium | High | Custom}] [-Description <string>] [-DOSPro <bool>] [-EnableAlternateNLBHost <bool>] [-EnableAlternateNLBPort <bool>] [-EnableClientManagerPort <bool>] [-Enabled <bool>] [-EnableGWPort <bool>] [-EnableHSTS <bool>] [-EnableHTML5 <bool>] [-EnableRDP <bool>] [-EnableRDPUDP <bool>] [-EnableSSL <bool>] [-EnableWyseSupport <bool>] [-ForwardGatewayServers <string>] [-ForwardHttpServers <string>] [-GWMode <GatewayMode> {Normal | Forwarding}] [-GWPort <uint>] [-HSTSIncludeSubdomains <bool>] [-HSTSMaxAge <uint>] [-HSTSPreload <bool>] [-HTML5Port <uint>] [-IPs <string>] [-IPVersion <IPVersion> {Version4 | Version6 | BothVersions}] [-LaunchMethod <LaunchMethod> {ParallelsClientAndHTML5 | ParallelsClient | HTML5}] [-MACAllowExcept <string[]>] [-MACAllowOnly <string[]>] [-MinSSLVersion <AcceptedSSLVersions> {SSLv2 | SSLv3 | TLSv1 | TLSv1_1 | TLSv1_2}] [-NewServer <string>] [-NormalModeForwarding <bool>] [-OptimizeConnectionIPv4 <string>] [-OptimizeConnectionIPv6 <string>] [-PfxFile <string>] [-PfxPassword <SecureString>] [-PreferredPAId <uint>] [-PreferredPAObj <PA>] [-PrivateKeyFile <string>] [-RDPPort <uint>] [-SecurityMode <GWSecurityMode> {AllowAllExcept | AllowOnly}] [-SSLPort <uint>] [-UsePreWin2000LoginFormat <bool>] [-WebRequestsURL <string>] [<CommonParameters>]

DESCRIPTION

Modifies properties of a RAS Secure Client 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 Client 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. 

        Required?                    true
        Position?                    0
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-SiteId <uint>
The site ID to which the Gateway belongs. 

        Required?                    false
        Position?                    1
        Default value                0
        Accept pipeline input?       false
        Accept wildcard characters?  false

-Id <uint>
The ID of the Gateway to modify. 

        Required?                    true
        Position?                    0
        Default value                0
        Accept pipeline input?       false
        Accept wildcard characters?  false

-InputObject <GW>
The GW object to be modified.

A GW object representing a Gateway is obtained using the Get-GW cmdlet. 

        Required?                    true
        Position?                    0
        Default value                
        Accept pipeline input?       true (ByValue)
        Accept wildcard characters?  false

-Enabled <bool>
Enable or disable the specified Gateway. 

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-Enable <bool>
Enable or disable the specified Gateway.

This is an alias of the Enabled parameter. 

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-NewServer <string>
The new Gateway name. The name must be either a valid FQDN or a valid IP address. 

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-Description <string>
A user-defined Gateway description. 

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-IPVersion <IPVersion>
The IP version for the Gateway to use. Accepted values: Version4 (IPv4), Version6 (IPv6), BothVersions (both IPv4 and IPv6).

Possible values: Version4, Version6, BothVersions 

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-IPs <string>
One or multiple (separated by comma) IP addresses. 

        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

-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

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

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

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

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-EnableGWPort <bool>
Enable or disable a custom RAS Secure Client Gateway port.

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

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-Broadcast <bool>
Enable or disable the 'Broadcast RAS Secure Client Gateway Address' option. 

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-EnableClientManagerPort <bool>
Enable or disable the 'Client Manager Port' option. 

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-EnableCMPort <bool>
Enable or disable the 'Client Manager Port' option.

This is an alias of the EnableClientManagerPort parameter. 

        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

-EnableDOSPro <bool>
Enable or disable the 'RDP DOS Attack Filter' option.

This is an alias of the DOSPro parameter. 

        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

-EnableRDPPort <bool>
Enable or disable a custom RDP port.

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

This is an alias of the EnableRDP parameter. 

        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

-GWPort <uint>
A custom Gateway port number. For this port to take effect, the EnableGWPort parameters must be set to $True. 

        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

-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

-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

-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 <AcceptedSSLVersions>
Minimum SSL version. Accepted values: TLSv1_2 (TLS v1.2 only, strong), TLSv1_1 (TLS v1.1 - TLS v1.2), TLSv1 (TLS v1 - TLS v1.2), SSLv3 (SSL v3 - TLS v1.2), SSLv2 (SSL v2 - TLS v1.2).

Possible values: SSLv2, SSLv3, TLSv1, TLSv1_1, TLSv1_2 

        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

-PfxFile <string>
Certificate file name in pfx format. 

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-PfxPassword <SecureString>
The password of the pfx file specified in the PfxFile parameter. 

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-PrivateKeyFile <string>
Private key file name. 

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-CertificateFile <string>
Certificate file name. 

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-EnableHTML5 <bool>
Enable or disable HTML5 connectivity on the Gateway. 

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-HTML5Port <uint>
A custom HTML5 port number. 

        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

-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

-AllowFileTransfer <bool>
Enables or disables the 'Allow file transfer' option. 

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-AllowClipboard <bool>
Enables or disables the 'Allow Clipboard' option. 

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-UsePreWin2000LoginFormat <bool>
Enables or disables the 'Use Pre Windows 2000 Login Format' option. 

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-UsePreWin2000Login <bool>
Enables or disables the 'Use Pre Windows 2000 Login Format' option.

This is an alias of the UsePreWin2000LoginFormat parameter. 

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-LaunchMethod <LaunchMethod>
Launch method. Accepted values: ParallelsClientAndHTML5 (Parallels Client and fallback to HTML5), ParallelsClient (Parallels Client only), HTML5 (HTML5 Client only).

Possible values: ParallelsClientAndHTML5, ParallelsClient, HTML5 

        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

-WebRequestsURL <string>
Sets a URL for Web requests.

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

of the RAS Secure Client 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

-AutoPreferredPA <SwitchParameter>
Set preferred PA as Automatically. 

        Required?                    false
        Position?                    named
        Default value                False
        Accept pipeline input?       false
        Accept wildcard characters?  false

-PreferredPAObj <PA>
The preferred PA server.

To obtain an object of type PA representing the Preferred Publishing Agent, use the Get-PA cmdlet. 

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-PreferredPAId <uint>
The preferred PA server Id 

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-OptimizeConnectionIPv4 <string>
Optimize connection for the list of IPv4 (comma separated values). 

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-OptimizeConnectionIPv6 <string>
Optimize connection for the list of IPv6 (comma separated values). 

        Required?                    false
        Position?                    named
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-GWMode <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

-SecurityMode <GW>
Securit 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

-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

-HSTSPreload <bool>
Enable or disable the HSTS preload. 

        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

-HSTSSubdomains <bool>
Enable or disable the HSTS sub-domains.

This is an alias of the HSTSIncludeSubdomains parameter. 

        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

GW

OUTPUTS

-none-

EXAMPLES


---------- EXAMPLE 1 ----------

Set-GW "server.company.dom" -Enable $False

Disables the specified RAS Secure Client Gateway in the Licensing Server site.

To disable a 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-GW -Id "1" -Enable $True

Enables the Gateway specified by ID.

---------- EXAMPLE 3 ----------

Set-GW $GW -Enable $False

Disables a Gateway specified by GW object ($GW variable).

A GW object representing a Gateway is obtained using the Get-GW cmdlet.

---------- EXAMPLE 4 ----------

Get-GW -Id 1 | Set-GW -Enable $False

Disables the Gateway which is identified by an object obtained from the pipeline output.

---------- EXAMPLE 5 ----------

Get-GW -Id 1 | Set-GW -Description "My new Gateway description"

Modifies the description of the Gateway obtained from the pipeline output.

RELATED LINKS