Cmdlets

Choose a cmdlet from the list on the left or search for a specific cmdlet. Choose a cmdlet from the list or search for a specific cmdlet.
About Help  Providers
 

Start-BgpPeer

Start-BgpPeer

ps_bgppeer_v1.0.cdxml

Synopsis

Starts routing sessions for BGP peers.

Syntax

Start-BgpPeer [-Name] [-AsJob] [-CimSession] [-RoutingDomain] [-ThrottleLimit] [<CommonParameters>]

Detailed Description

The Start-BgpPeer cmdlet starts routing sessions for Border Gateway Protocol (BGP) peers. Use the Stop-BgpPeer cmdlet to stop a routing session. By default, when you add a peer by using the Add-BgpPeer cmdlet, exchange of route information begins immediately. If you add a peer in manual peering mode, use this cmdlet to start the session.

Parameters

-AsJob <SwitchParameter>

Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. The cmdlet immediately returns an object that represents the job and then displays the command prompt. You can continue to work in the session while the job completes. To manage the job, use the *-Job cmdlets. To get the job results, use the Receive-Job cmdlet. For more information about Windows PowerShell® background jobs, see about_Jobs.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-CimSession <CimSession[]>

Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a New-CimSession or Get-CimSession cmdlet. The default is the current session on the local computer.

Aliases

Session

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

-Name <String[]>

Specifies an array of names. The cmdlet starts routing sessions for the named peers.

Aliases

PeerList,PeerId,PeerName

Required?

true

Position

2

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-RoutingDomain <String>

Specifies the name of the routing domain as a string. The name is a unique, for the multitenant gateway, user-defined alphanumeric string.

Aliases

RoutingDomainName

Required?

false

Position

named

Default value

None

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-ThrottleLimit <Int32>

Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.

Aliases

None

Required?

false

Position

named

Default value

None

Accept pipeline input?

false

Accept wildcard characters?

false

Input Type


Return Type


Notes

None

Examples

Example 1: Start a routing session

This command starts a BGP routing session for the BGP router named Site17.

PS C:\> Start-BgpPeer -Name "Site17"

Example 2: Start a routing session in a multitenant evironment

This command starts a routing session for the peer named Tenant22 in the specified routing domain of a multitenant environment.

PS C:\> Start-BgpPeer -Name "Tenant22" -RoutingDomain "Rd001"

Online Version
Add-BgpPeer
Get-BgpPeer
Remove-BgpPeer
Set-BgpPeer
Stop-BgpPeer