Edit

Remove-BgpRouter

  • Reference
Module:
RemoteAccess

Removes a BGP router.

Syntax

Remove-BgpRouter
      [-RoutingDomain <String[]>]
      [-Force]
      [-CimSession <CimSession[]>]
      [-ThrottleLimit <Int32>]
      [-AsJob]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

The Remove-BgpRouter cmdlet removes BGP router routers. In a multitenant deployment, the cmdlet removes a BGP router for the routing domain or a tenant. In a non-multitenant deployment, the cmdlet removes the BGP router for the local computer. When you remove a BGP router, the BGP router can no longer read and distribute routing information between autonomous systems (AS). In addition, the other routers that added the router as a peer delete all the information learned from the router and recalculate their routes accordingly.

Examples

Example 1: Remove BGP routing

PS C:\> Remove-BgpRouter


Confirm
Are you sure you want to remove the BGP router and stop any active BGP peering sessions?
[Y] Yes  [N] No  [S] Suspend  [?] Help (default is "Y"): y

This command removes BGP routing from the local router. The command prompts the user for confirmation before removing the BGP Router.

Example 2: Remove BGP routing without confirmation

PS C:\> Remove-BgpRouter -Force

This command removes BGP routing from the local router. The command does not prompt the user for confirmation before removing BGP routing.

Example 3: Remove BGP routers for routing domains

PS C:\> Remove-BgpRouter -RoutingDomain "Rd_001","Rd_002"



Confirm
Are you sure you want to remove the BGP router for routing domain Rd_001 and stop any active BGP peering sessions?
[Y] Yes  [N] No  [S] Suspend  [?] Help (default is "Y"):

Confirm
Are you sure you want to remove the BGP router for routing domain Rd_002 and stop any active BGP peering sessions?
[Y] Yes  [N] No  [S] Suspend  [?] Help (default is "Y"):

This command removes the BGP routers from the routing domains named Rd_001 and Rd_002. The command prompts the user for confirmation before removing the BGP routers.

Example 4: Remove BGP routers for a routing domain without confirmation

PS C:\> Remove-BgpRouter -RoutingDomain "Rd_002" -Force

This command removes the BGP routers from the routing domain named Rd_002. The command does not prompt the user for confirmation before removing the BGP routers.

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

-RoutingDomain

Specifies an ID, as a string, for a routing domain. The ID of a routing domain is a unique 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[]

Outputs

Object