Get-RASGatewayStatus

NAME

Get-RASGatewayStatus

SYNOPSIS

Retrieves RAS Secure Gateway summary and state information.

SYNTAX

Get-RASGatewayStatus [[-Id] <uint>] [<CommonParameters>] Get-RASGatewayStatus [[-InputObject] <Gateway>] [<CommonParameters>] Get-RASGatewayStatus [[-Server] <string>] [[-SiteId] <uint>] [<CommonParameters>]

DESCRIPTION

Retrieves the summary and state information for one or all RAS Secure Gateways. The information includes ID, site ID, RAS Secure Gateway server name, agent version, and state ("OK" meaning the gateway is functioning properly). To obtain the information for all available gateways, execute the cmdlet with no parameters.

PARAMETERS

-Server <string> The name of the gateway for which to retrieve the information. This must be the actual gateway server name used in the RAS farm.

        Required?                    false

        Position?                    0

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

-SiteId <uint> Site ID from which to retrieve the specified 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 the gateway for which to retrieve the information. To obtain the ID, use the Get-RASGateway cmdlet.

        Required?                    false

        Position?                    0

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

-InputObject <Gateway> An object of type Gateway identifying the gateway. To obtain the object, use the Get-RASGateway cmdlet.

        Required?                    false

        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 . 

INPUTS

Gateway

OUTPUTS

GatewaySysInfo

EXAMPLES

---------- EXAMPLE 1 ---------- Get-RASGatewayStatus -Id 15 Retrieves the information for the RAS Secure Gateway with ID 15. ---------- EXAMPLE 2 ---------- Get-RASGatewayStatus -Server MyGateway Retrieves the information for the RAS Secure Gateway named "MyGateway". ---------- EXAMPLE 3 ---------- Get-RASGatewayStatus -InputObject $Gateway Retrieves the information for the RAS Secure Gateway identified by the $Gateway object. ---------- EXAMPLE 4 ---------- Get-RASGateway -Id 15 | Get-RASGatewayStatus Retrieves the information for the RAS Secure Gateway identified by the object obtained from the pipeline output.