New-RASGW

NAME

New-RASGW

SYNOPSIS

Adds a RAS Secure Client Gateway server to a site.

SYNTAX

New-RASGW [-Server] <string> [[-SiteId] <uint>] [-EnableHTML5 <bool>] [-NoFireWallRules <SwitchParameter>] [-NoInstall <SwitchParameter>] [-NoRestart <SwitchParameter>] [<CommonParameters>]

New-RASGW [-Server] <string> [[-SiteId] <uint>] -Password <SecureString> -Username <string> [-EnableHTML5 <bool>] [-NoFireWallRules <SwitchParameter>] [-NoRestart <SwitchParameter>] [<CommonParameters>]

DESCRIPTION

Adds a RAS Secure Client Gateway server to a site.

By default, the cmdlet will install the necessary Gateway software on the server.

If the software is already installed, you can skip the installation by including the -NoInstall parameter.

PARAMETERS


-Server <string>
FQDN or IP address of the server to be added to a site as a RAS Secure Client Gateway. 

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

-SiteId <uint>
The site ID to which the Gateway should be added.

To obtain the ID of a desired site, use the appropriate command to Get Sites.

If the parameter is omitted, the site ID of the Licensing Server will be used. 

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

-Username <string>
An administrator account to push install the Gateway software on the target server.

If this parameter is omitted, your RAS admin username (and password) will be used. 

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

-Password <SecureString>
The password of the account specified in the Username parameter. 

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

-NoInstall <SwitchParameter>
If this parameter is included, the Gateway software will not be installed on the target server.

The parameter should only be included if the server already has the software installed.

If you need to install the software, omit this parameter.

When installing the Gateway software, your RAS admin credentials will be used to push install the software. These are the credentials you used to connect to the RAS farm.

If needed, you can specify different credentials using the Username and Password parameters. 

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

-NoRestart <SwitchParameter>
Specifies not to restart the server after the RAS Gateway is installed.

If this parameter is omitted, the server will be restarted if required. 

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

-NoFireWallRules <SwitchParameter>
Specifies not to add firewall rules to allow the RDS Agent to communicate.

If this parameter is omitted, the firewall rules will not be added. 

        Required?                    false
        Position?                    named
        Default value                False
        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

<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

GW

EXAMPLES


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

New-RASGW "server.company.dom"

Adds the specified RAS Secure Client Gateway server to the Licensing Server site (default).

The Gateway software will be push installed on the server by default using your RAS admin credentials (default).

---------- EXAMPLE 2 ----------

New-RASGW -Server "server.company.dom" -Username "myname" -Password $pass

Adds the specified RAS Secure Client Gateway server to the Licensing Server site (default).

The Gateway software will be installed on the server by default.

-Username and -Password parameters specify credentials to log in to the server to push install the Gateway software.

You only need to specify credentials if you cannot log in to the target server using your RAS admin credentials (see example above).

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

New-RASGW -Server "server.company.dom" -SiteId 2 -NoInstall

Adds a RAS Secure Client Gateway server specified by FQDN to the specified site.

The -SiteId parameter specifies the site ID. To obtain the ID of a desired site, use the Get-RASSites cmdlet.

The -NoInstall parameter specifies not to install the Gateway software on the server (assuming it's already installed).

RELATED LINKS