Set-RASBroker

NAME

Set-RASBroker

SYNOPSIS

Modifies settings of a RAS Connection Broker server.

SYNTAX

Set-RASBroker [Id] (uint)** [AlternativeIPs (string)] [Description (string)] [Enabled (bool)] [IP (string)] [Standby (bool)] [(CommonParameters)]

Set-RASBroker [-InputObject]** (Broker) [AlternativeIPs (string)] [Description (string)] [Enabled (bool)] [IP (string)] [Standby (bool)] [(CommonParameters)]

Set-RASBroker [Server] (string)** [[-SiteId] (uint)] [AlternativeIPs (string)] [Description (string)] [Enabled (bool)] [IP (string)] [Standby (bool)] [(CommonParameters)]

DESCRIPTION

Modifies settings of a RAS Connection Broker server.

For each setting, the cmdlet has a corresponding input parameter. To modify a setting, specify a parameter and its value.

PARAMETERS

Server (string)

The name of the target 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 in which the target RAS Connection Broker resides.

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 RAS Connection Broker server ID. To obtain the ID, use the command to Get-RASBroker.

        Required?                    true

        Position?                    0

        Default value                0

        Accept pipeline input?       false

        Accept wildcard characters?  false

InputObject (Broker)

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

Enabled (bool)

Enable or disable the specified RAS Connection Broker.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

Description (string)

A user-defined RAS Connection Broker description.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

IP (string)

An IP address of the RAS Connection Broker server.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

AlternativeIPs (string)

A list of alternative IP addresses separated by a comma.

        Required?                    false

        Position?                    named

        Default value                

        Accept pipeline input?       false

        Accept wildcard characters?  false

Standby (bool)

Set the specified RAS Secondary Connection Broker in Standby (or vice versa).

        Required?                    false

        Position?                    named

        Default value                

        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

Broker

OUTPUTS

-none-

EXAMPLES

**---------- EXAMPLE 1 ----------

Set-RASBroker -Server "server.company.dom" -Enable $False

Disables the specified RAS Connection Broker in the Licensing Server site.

**---------- EXAMPLE 2 ----------

Set-RASBroker -Id 3 -Enable $False

Disables the RAS Connection Broker specified by ID.

**---------- EXAMPLE 3 ----------

Set-RASBroker $Broker -Enable $True

Enables the RAS Connection Broker specified by the $Broker variable, which is an object of type Broker.

The object is obtained using the Get-RASBroker cmdlet. **---------- EXAMPLE 4 ----------

Get-RASBroker -Id 3 | Set-RASBroker -Enable $True

Enables the RAS Connection Broker represented by a Broker object obtained from the pipeline output.

RELATED LINKS

• New-RASBroker

• Get-RASBroker

• Remove-RASBroker