Export (0) Print
Expand All
Expand Minimize

Remove-BgpCustomRoute

Windows Server 2012 R2 and Windows 8.1

Updated: September 24, 2014

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

Remove-BgpCustomRoute

Removes custom routes from the BGP router.

Syntax

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




Detailed Description

The Remove-BgpCustomRoute cmdlet removes Classless InterDomain Routing (CIDR) prefixes or interfaces for custom routes from the Border Gateway Protocol (BGP) routing table. When you remove a custom route, the BGP router can no longer use the information from the CIDR network or interface to distribute routing information between autonomous systems (AS). In addition, the BGP router sends route withdrawal messages to peers to remove the previously advertised custom routes that you remove.

You must specify at least one of the Interface or Network parameters.

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

-Interface<String[]>

Specifies an array of names of router interfaces. The cmdlet removes the static routes for these interfaces from the BGP routing table.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-Network<String[]>

Specifies an array of network prefixes, in Classless InterDomain Routing (CIDR) notation. For IPv4 networks, you must specify the network prefix and its network mask. The cmdlet removes the routing information for the network prefixes from the BGP routing table.


Aliases

DestinationNetwork

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-RoutingDomain<String>

Specifies the name, as a string, of a routing domain. The name 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 a network prefix

This command removes the network prefix of a custom network from the BGP routing table.


PS C:\> Remove-BgpCustomRoute -Network "172.23.90.0/29"
              


Confirm
Removing specified custom networks from BGP router. Do you want to continue?
[Y] Yes [N] No [S] Suspend [?] Help (default is "Y"):Y

Example 2: Remove the interface for a routing domain

This command removes the router interface named VS01 from the BGP routing table for the routing domain named Rd_002.


PS C:\> Remove-BgpCustomRoute -Interface "VS01" -RoutingDomain Rd_002
              


Confirm
Removing specified custom networks from BGP router of Routing Domain Rd_002. Do you want to continue?
[Y] Yes [N] No [S] Suspend [?] Help (default is "Y"):Y

Related topics

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