Invoke-RASConnectionBroker

NAME

Invoke-RASConnectionBroker

SYNOPSIS

Invokes a Connection Broker command.

SYNTAX

Invoke-RASConnectionBroker [Id] (uint) -GenerateAPIToken (SwitchParameter) [(CommonParameters)] **

Invoke-RASConnectionBroker [-InputObject] (ConnectionBroker) -GenerateAPIToken (SwitchParameter) [(CommonParameters)] **

Invoke-RASConnectionBroker [Server] (string) [[-SiteId] (uint)] -GenerateAPIToken (SwitchParameter) [(CommonParameters)] **

DESCRIPTION

Invokes a Connection Broker command.

PARAMETERS

Server (string)

The name of the RAS Connection Broker server.

This must be the actual server name used in the Parallels RAS farm.

        Required?                    true

        Position?                    0

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

SiteId (uint)

Site ID of the RAS Connection Broker server.

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.

        Required?                    true

        Position?                    0

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

InputObject (ConnectionBroker)

An object of type Broker representing the RAS Connection Broker.

To obtain the object, use the Get-RASBroker cmdlet.

        Required?                    true

        Position?                    0

        Default value                

        Accept pipeline input?       true (ByValue)

        Accept wildcard characters?  false

GenerateAPIToken (SwitchParameter)

Generate API token SwitchParameter.

        Required?                    true

        Position?                    named

        Default value                False

        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

ConnectionBroker

OUTPUTS

-none-

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

Invoke-RASConnectionBroker -Id 1 -GenerateAPIToken

Generates the API token for the provided provider (by ID). ---------- EXAMPLE 2 ----------

Invoke-RASConnectionBroker -Server "1.1.1.1" -SiteId 1 -GenerateAPIToken

Generates the API token for the provided provider (by Server). ---------- EXAMPLE 3 ----------

Invoke-RASConnectionBroker -InputObject $cb -GenerateAPIToken

Generates the API token for the provided provider (by InputObject).

RELATED LINKS

• Get-RASBroker