Get-RASGateway

NAME

Get-RASGateway

SYNOPSIS

Retrieves information about one or multiple RAS Secure Gateway servers.

SYNTAX

Get-RASGateway [[-Id] <uint>] [<CommonParameters>]

Get-RASGateway [[-Server] <string>] [[-SiteId] <uint>] [<CommonParameters>]

DESCRIPTION

Retrieves information about one or multiple RAS Secure Gateway servers.

Returns an array of objects of type Gateway, each containing properties of a Gateway.

To see the complete list of object properties, use the Format-List cmdlet (see examples).

Note: the returned object contains only the major properties of a Gateway; it does not include all of the settings supported in RAS.

PARAMETERS


-Server <string>
The name of the RAS Secure Gateway server.

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?                    false
        Position?                    0
        Default value                
        Accept pipeline input?       false
        Accept wildcard characters?  false

-SiteId <uint>
The site ID from which to retrieve the Secure Gateway information.

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 a Secure Gateway for which to retrieve the information. 

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

Gateway

EXAMPLES


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

Get-RASGateway "server.company.dom" | Format-List

Retrieves information about the specified RAS Secure Gateway server from the Licensing Server site.

To get the info from a specific site, specify the -SiteId parameter.

The Format-List cmdlet formats the display output to include the complete list of the returned properties.
---------- EXAMPLE 2 ----------

Get-RASGateway -Id 11

Retrieves information about the RAS Secure Gateway specified by ID.
---------- EXAMPLE 3 ----------

Get-RASGateway -Server "server.company.dom" -SiteId 2

Retrieves information about the specified RAS Secure Gateway from the specified site.

RELATED LINKS