Edit

Stop-BgpPeer

  • Reference
Module:
RemoteAccess

Stops routing sessions for BGP peers.

Syntax

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

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.

Examples

Example 1: Stop a routing session

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

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.

Example 2: Stop all sessions

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

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.

Example 3: Stop a routing session in 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

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

Parameters

-AsJob

Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-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.

Type:CimSession[]
Aliases:Session
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Force

Forces the command to run without asking for user confirmation.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Name

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

Type:String[]
Aliases:PeerList, PeerId, PeerName
Position:1
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-RoutingDomain

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

Type:String
Aliases:RoutingDomainName
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-ThrottleLimit

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.

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-WhatIf

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

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

String[]

String

Outputs

Object