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
 

Stop-BgpPeer

Stop-BgpPeer

ps_bgppeer_v1.0.cdxml

Synopsis

Stops routing sessions for BGP peers.

Syntax

Stop-BgpPeer [-Name] [-AsJob] [-CimSession] [-Force] [-RoutingDomain] [-ThrottleLimit] [-Confirm] [-WhatIf] [<CommonParameters>]

Detailed Description

The Stop-BgpPeer cmdlet stops routing sessions for Border Gateway Protocol (BGP) peers. Use the Start-BgpPeer cmdlet to start a routing session. When you stop a session, both peer routers lose all the information learned from each other.

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

-Force <SwitchParameter>

Forces the command to run without asking for user confirmation.

Aliases

None

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

-Confirm <SwitchParameter>

Prompts you for confirmation before running the cmdlet.

Aliases

None

Required?

false

Position

named

Default value

false

Accept pipeline input?

false

Accept wildcard characters?

false

-WhatIf <SwitchParameter>

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Aliases

None

Required?

false

Position

named

Default value

false

Accept pipeline input?

false

Accept wildcard characters?

false

Input Type


Return Type


Notes

None

Examples

Example 1: Stop a routing session

This command stops the session for the peer named Tenant18. This command specifies the Force parameter, so the command does not prompt you for confirmation.

PS C:\> Stop-BgpPeer -Name "Tenant18" -Force

Example 2: Stop all sessions

This command gets all the peers by using the Get-BgpPeer cmdlet, and then passes them to the current cmdlet by using the pipeline operator. The command stops the sessions for all the peers. This command does not specify the Force parameter, so it prompts the user for confirmation of each session to stop.

PS C:\> Get-BgpPeer | Stop-BgpPeer
Confirm
BGP peering session could be active for peer Tenant18. Do you want to stop the peering?
[Y] Yes  [N] No  [S] Suspend  [?] Help (default is "Y"):Y

Example 3: Stop a routing session in a multitenant evironment

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

PS C:\> Stop-BgpPeer -Name "TenantSite22" -RoutingDomain "Rd001"
Confirm
BGP peering session could be active for peer TenantSite22 of routing domain Rd001. Do you want to stop the peering?
[Y] Yes  [N] No  [S] Suspend  [?] Help (default is "Y"):Y

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