Get-GWStatus

NAME

Get-GWStatus

SYNOPSIS

Retrieves RAS Secure Client Gateway summary and state information.

SYNTAX

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

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

Get-GWStatus [[-InputObject] <GW>] [<CommonParameters>]

DESCRIPTION

Retrieves the summary and state information for one or all RAS Secure Client Gateways.

The information includes ID, site ID, 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-GW cmdlet. 

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

-InputObject <GW>
An object of type GW identifying the gateway.

To obtain the object, use the Get-GW 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 documentation.

INPUTS

GW

OUTPUTS

GWSysInfo

EXAMPLES


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

Get-GWStatus -Id 15

Retrieves the information for the gateway with ID 15.

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

Get-GWStatus -Server MyGW

Retrieves the information for the gateway named "MyGW".

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

Get-GWStatus -InputObject $GW

Retrieves the information for the gateway identified by the $GW object.

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

Get-GW -Id 15 | Get-GWStatus

Retrieves the information for the gateway identified by the object obtained from the pipeline output.

RELATED LINKS