Remove-BgpRouter
Removes a BGP router.
Syntax
Default (Default)
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.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | 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.
Parameter properties
| Type: | CimSession[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | Session |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Confirm
Prompts you for confirmation before running the cmdlet.
Parameter properties
| Type: | SwitchParameter |
| Default value: | False |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | cf |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Force
Forces the command to run without asking for user confirmation.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | 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.
Parameter properties
| Type: | String[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | RoutingDomainName |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | 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.
Parameter properties
| Type: | Int32 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Parameter properties
| Type: | SwitchParameter |
| Default value: | False |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | wi |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.