Get-RASBroker

NAME

Get-RASBroker

SYNOPSIS

Retrieves information about one or multiple RAS Connection Broker servers.

SYNTAX

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

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

DESCRIPTION

Retrieves the information about one or multiple RAS Connection Broker servers.

It returns an array of objects of type Broker, each containing properties of a RAS Connection Broker server.

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

Note: the result set contains only the major server properties; it does not include all of the settings supported in RAS.

PARAMETERS

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

This must be the actual server name used in the Parallels 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 RAS Connection Broker server information.

If the parameter is omitted, the Licensing Server site ID will be used.

        Required?                    false

        Position?                    1

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

-Id <uint> The ID of the RAS Connection Broker server 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

Broker

EXAMPLES

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

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

Retrieves properties of the specified RAS Connection Broker server.

The Format-List cmdlet formats the display output to include all available server properties. ---------- EXAMPLE 2 ----------

Get-RASBroker -Id 5

Retrieves properties of the RAS Connection Broker server specified by ID.

RELATED LINKS

• New-RASBroker

• Set-RASBroker

• Remove-RASBroker