Export (0) Print
Expand All
Expand Minimize

Remove-BgpRouter

Windows Server 2012 R2 and Windows 8.1

Updated: October 17, 2013

Applies To: Windows 8.1, Windows PowerShell 4.0, Windows Server 2012 R2

Remove-BgpRouter

Removes a BGP router.

Syntax

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




Detailed 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 reacalculate their routes accordingly.

Parameters

-AsJob

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

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

-RoutingDomain<String[]>

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

Prompts you for confirmation before running the cmdlet.


Required?

false

Position?

named

Default Value

false

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-WhatIf

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


Required?

false

Position?

named

Default Value

false

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see    about_CommonParameters.

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

Outputs

The output type is the type of the objects that the cmdlet emits.

Examples

Example 1: Remove BGP routing

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


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

Example 2: Remove BGP routing without confirmation

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


PS C:\> Remove-BgpRouter -Force

Example 3: Remove BGP routers for routing domains

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.


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"):

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

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.


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

Related topics

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft