Remove-GW

NAME

Remove-GW

SYNOPSIS

Removes a RAS Secure Client Gateway server from a site.

SYNTAX

Remove-GW [-Server] <string> [[-SiteId] <uint>] [-NoUninstall <SwitchParameter>] [<CommonParameters>]

Remove-GW [-Server] <string> [[-SiteId] <uint>] -Password <SecureString> -Username <string> [<CommonParameters>]

Remove-GW [-Id] <uint> [-NoUninstall <SwitchParameter>] [<CommonParameters>]

Remove-GW [-Id] <uint> -Password <SecureString> -Username <string> [<CommonParameters>]

Remove-GW [-InputObject] <GW> [-NoUninstall <SwitchParameter>] [<CommonParameters>]

Remove-GW [-InputObject] <GW> -Password <SecureString> -Username <string> [<CommonParameters>]

DESCRIPTION

Removes a specified RAS Secure Client Gateway server from a site.

The cmdlet will also uninstall the Gateway software from the server by default.

You can optionally keep the Gateway software by including the -NoUninstall parameter.

PARAMETERS


-Server <string>
The name of a Gateway server to remove from the site.

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>
Site ID from which to remove the specified Gateway.

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

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

To obtain the ID of a Gateway, use the Get-GW cmdlet. 

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

-NoUninstall <SwitchParameter>
When this parameter is included, the Gateway software will NOT be removed from the server.

If you want to remove the software, omit this parameter.

When removing the software, your RAS admin credentials will be used to remotely execute the uninstaller on the target server.

You can specify different credentials if needed using the Username and Password parameters. 

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

-Username <string>
An administrator account name to remotely uninstall the Gateway software from the 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

-InputObject <GW>
The GW object to remove from a site.

To obtain an object of type GW representing a Gateway, use the Get-GW cmdlet. 

        Required?                    true
        Position?                    0
        Default value                
        Accept pipeline input?       true (ByValue)
        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 ----------

Remove-GW "server.company.dom"

Removes the specified RAS Secure Client Gateway server from the Licensing Server site (default).

To remove the server from a specific site, specify the -SiteId parameter.

The Gateway software will be uninstalled from the server by default. The uninstaller will be remotely executed using your RAS admin credentials (default).

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

Remove-GW -Server "server.company.dom" -SiteId 3 -Username "myname" -Password $pass

Removes the specified RAS Secure Client Gateway server from the specified site.

The Gateway software will be remotely uninstalled from the server using the specified credentials.

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

Remove-GW -Id "6" -NoUninstall

Removes a RAS Secure Client Gateway specified by ID. To obtain the ID of a Gateway, use the Get-GW cmdlet.

The Gateway software will NOT be uninstalled from the server.

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

Remove-GW -InputObject $Gateway

Removes a RAS Secure Client Gateway. The $Gateway variable must contain the gateway object to be removed.

To obtain a GW object representing a Gateway, use the Get-GW cmdlet

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

Get-GW -Id 11 | Remove-GW

Removes the RAS Secure Client Gateway, which is identified by an object obtained from the pipeline output.

RELATED LINKS