Get-RASBrokerStatus

NAME

Get-RASBrokerStatus

SYNOPSIS

Retrieves the RAS Connection Broker status information.

SYNTAX

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

Get-RASBrokerStatus [[-InputObject] <Broker>] [<CommonParameters>]

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

DESCRIPTION

Retrieves the RAS Connection Broker status information.

PARAMETERS


-Server <string>
The name of the server for which to retrieve the information.

This must be the actual 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 RAS Connection Broker info.

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 server for which to retrieve the information. To obtain the ID, use the Get-RASBroker cmdlet. 

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

-InputObject <Broker>
An object of type Broker representing a server for which to retrieve the information.

To obtain the object, use the Get-RASBroker 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

Broker

OUTPUTS

BrokerSysInfo

EXAMPLES


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

Get-RASBrokerStatus -Id 15

Retrieves the RAS Connection Broker status information for the server with ID 15.
---------- EXAMPLE 2 ----------

Get-RASBrokerStatus -Server MyBroker

Retrieves the RAS Connection Broker status information for the server named "MyBroker".
---------- EXAMPLE 3 ----------

Get-RASBrokerStatus -InputObject $Broker

Retrieves the RAS Connection Broker status information for the server represented by the $Broker object.
---------- EXAMPLE 4 ----------

Get-RASBroker -Id 15 | Get-RASBrokerStatus

Retrieves the RAS Connection Broker status information for the server represented by the $Broker object obtained from pipeline output.

RELATED LINKS