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
 

Remove-BgpPeer

Remove-BgpPeer

ps_bgppeer_v1.0.cdxml

Synopsis

Removes BGP peers from a router.

Syntax

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

Detailed Description

The Remove-BgpPeer cmdlet removes Border Gateway Protocol (BGP) peers from a BGP router. Specify a peer to remove by using its name. This cmdlet does not uninstall the peer router software. When you remove a peer, the router removes all information collected from the peer.

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 removes 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: Remove specified peers

This command removes the peers named TenantSite22 and TenantSite23. This command does not specify the Force parameter, so it prompts you before it removes the peers.

PS C:\> Remove-BgpPeer -Name TenantSite22,TenantSite23
Confirm
BGP peering session is active with peer TenantSite22. Do you want to stop peering and remove this peer?
[Y] Yes  [N] No  [S] Suspend  [?] Help (default is "Y"): y

Confirm
BGP peering session is active with peer TenantSite23. Do you want to stop peering and remove this peer?
[Y] Yes  [N] No  [S] Suspend  [?] Help (default is "Y"): y

Example 2: Remove all peers

This command gets all the peers by using the Get-BgpPeer cmdlet, and passes them to the current cmdlet by using the pipeline operator. The command removes all the peers. Because the command specifies the Force parameter, it does not prompt you for confirmation before it removes the peers.

PS C:\> Get-BgpPeer | Remove-BgpPeer -Force

Example 3: Remove all peers in a routing domain

This command removes the peer named Tenant16 in the routing domain Rd001 without prompting you for confirmation.

PS C:\> Remove-BgpPeer -Name "Tenant16" -Force -RoutingDomain "Rd001"

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