Cisco IOS IP Routing Protocols Command Reference
BGP Commands: C through I

Table Of Contents

clear bgp nsap

clear bgp nsap dampening

clear bgp nsap external

clear bgp nsap flap-statistics

clear bgp nsap peer-group

clear ip bgp

clear ip bgp dampening

clear ip bgp external

clear ip bgp flap-statistics

clear ip bgp in prefix-filter

clear ip bgp ipv4

clear ip bgp ipv6

clear ip bgp l2vpn

clear ip bgp peer-group

clear ip bgp table-map

clear ip bgp update-group

clear ip bgp vpnv4

clear ip bgp vpnv6

clear ip prefix-list

continue

default-information originate (BGP)

default-metric (BGP)

distance bgp

distribute-list in (BGP)

distribute-list out (BGP)

exit-peer-policy

exit-peer-session

export map

ha-mode graceful-restart

import ipv4

inherit peer-policy

inherit peer-session

ip as-path access-list

ip bgp fast-external-fallover

ip bgp-community new-format

ip community-list

ip extcommunity-list

ip policy-list

ip prefix-list

ip prefix-list description

ip prefix-list sequence-number

ip verify unicast vrf


clear bgp nsap

To clear and then reset Connectionless Network Service (CLNS) network service access point (NSAP) Border Gateway Protocol (BGP) sessions, use the clear bgp nsap command in privileged EXEC mode.

clear bgp nsap {* | as-number | ip-address} [soft] [in | out]

Syntax Description

*

Clears and then resets all current BGP sessions.

as-number

Clears and then resets BGP sessions for BGP neighbors within the specified autonomous system.

ip-address

Clears the TCP connection to the specified BGP neighbor and removes all routes learned from the connection from the BGP table. The TCP connections are then reset.

soft

(Optional) Soft reset. Allows routing tables to be reconfigured and activated without clearing the BGP session.

in | out

(Optional) Triggers inbound or outbound soft reconfiguration. If the in or out option is not specified, both inbound and outbound soft reset are triggered.


Command Modes

Privileged EXEC

Command History

Release
Modification

12.2(8)T

This command was introduced.

12.2(33)SRB

This command was integrated into Cisco IOS Release 12.2(33)SRB.


Usage Guidelines

The clear bgp nsap command is similar to the clear ip bgp command, except that it is NSAP address family-specific.

Use of the clear bgp nsap command allows a reset of the neighbor sessions with varying degrees of severity, depending on the specified keywords and arguments.

Use the * keyword to reset all neighbor sessions. The software will clear and then reset the neighbor connections. Use this form of the command in the following situations:

BGP timer specification change

BGP administrative distance changes

Use the soft out keywords to clear and reset only the outbound neighbor connections. Inbound neighbor sessions will not be reset. Use this form of the command in the following situations:

Additions or changes are made to the BGP-related access lists

BGP-related weights change

BGP-related distribution lists change

BGP-related route maps change

Use the in keyword to clear only the inbound neighbor connections. Outbound neighbor sessions will not be reset. Use this form of the command in the following situations:

BGP-related access lists change or get additions

BGP-related weights change

BGP-related distribution lists change

BGP-related route maps change

Examples

In the following example, the inbound session with the neighbor 172.20.16.6 is cleared without the outbound session being reset:

Router# clear bgp nsap 172.20.16.6 in

In the following example, a soft clear is applied to outbound sessions with the neighbors in autonomous system 65000 without the inbound session being reset:

Router# clear bgp nsap 65000 soft out

Related Commands

Command
Description

show bgp nsap

Displays entries in the BGP routing table for the NSAP address family.


clear bgp nsap dampening

To clear Border Gateway Protocol (BGP) route dampening information for the network service access point (NSAP) address family and unsuppress the suppressed routes, use the clear bgp nsap dampening command in privileged EXEC mode.

clear bgp nsap dampening [nsap-prefix]

Syntax Description

nsap-prefix

(Optional) NSAP prefix about which to clear dampening information. This argument can be up to 20 octets long.


Command Default

When the nsap-prefix argument is not specified, the clear bgp nsap dampening command clears route dampening information for the entire BGP routing table for the NSAP address family.

Command Modes

Privileged EXEC

Command History

Release
Modification

12.2(8)T

This command was introduced.

12.2(33)SRB

This command was integrated into Cisco IOS Release 12.2(33)SRB.


Usage Guidelines

The clear bgp nsap dampening command is similar to the clear ip bgp dampening command, except that it is specific to the NSAP address family.

Examples

In the following example, route dampening information is cleared for the route to NSAP prefix 49.6001 and locally suppressed routes are unsuppressed:

Router# clear bgp nsap dampening 49.6001

Related Commands

Command
Description

bgp dampening

Enables BGP route dampening or changes various BGP route dampening factors.

show bgp nsap dampened-paths

Displays BGP dampened routes for the NSAP address family.


clear bgp nsap external

To clear all external BGP (eBGP) peers for the network service access point (NSAP) address family, use the clear bgp nsap external command in privileged EXEC mode.

clear bgp nsap external [soft] [in | out]

Syntax Description

soft

(Optional) Soft reset. Does not reset the session.

in | out

(Optional) Triggers inbound or outbound soft reconfiguration. If the in or out option is not specified, both inbound and outbound soft reset are triggered.


Command Modes

Privileged EXEC

Command History

Release
Modification

12.2(8)T

This command was introduced.

12.2(33)SRB

This command was integrated into Cisco IOS Release 12.2(33)SRB.


Usage Guidelines

The clear bgp nsap external command is similar to the clear ip bgp external command, except that it is specific to the NSAP address family.

Examples

In the following example, the inbound sessions with external BGP peers are cleared without the outbound sessions being reset:

Router# clear bgp nsap external soft in

Related Commands

Command
Description

clear bgp nsap

Resets an NSAP BGP connection by dropping all neighbor sessions.


clear bgp nsap flap-statistics

To clear Border Gateway Protocol (BGP) flap statistics for the network service access point (NSAP) address family, use the clear bgp nsap flap-statistics command in privileged EXEC mode.

clear bgp nsap flap-statistics [nsap-prefix] [regexp regexp | filter-list access-list-number]

Syntax Description

nsap-prefix

(Optional) NSAP prefix about which to clear dampening information. This argument can be up to 20 octets long.

regexp regexp

(Optional) Clears flap statistics for all the paths that match the regular expression.

filter-list access-list-number

(Optional) Clears flap statistics for all the paths that pass the access list. The acceptable access list number range is from 1 to 199.


Command Default

No statistics are cleared.

If no arguments or keywords are specified, the software clears flap statistics for all routes.

Command Modes

Privileged EXEC

Command History

Release
Modification

12.2(8)T

This command was introduced.

12.2(33)SRB

This command was integrated into Cisco IOS Release 12.2(33)SRB.


Usage Guidelines

The clear bgp nsap flap-statistics command is similar to the clear ip bgp flap-statistics command, except that it is specific to the NSAP address family.

The flap statistics for a route are also cleared when an NSAP BGP peer is reset. Although the reset withdraws the route, no penalty is applied in this instance even though route flap dampening is enabled.

Examples

In the following example, all of the flap statistics for paths that pass access list 3 are cleared:

Router# clear bgp nsap flap-statistics filter-list 3

Related Commands

Command
Description

bgp dampening

Enables BGP route dampening or changes various BGP route dampening factors.

show bgp nsap flap-statistics

Displays BGP flap statistics for the NSAP address family.


clear bgp nsap peer-group

To clear the Border Gateway Protocol (BGP) TCP connections to all members of a BGP peer group for the network service access point (NSAP) address family, use the clear bgp nsap peer-group command in privileged EXEC mode.

clear bgp nsap peer-group peer-group-name

Syntax Description

peer-group-name

Name of the NSAP BGP peer group.


Command Default

No BGP TCP connections are cleared.

Command Modes

Privileged EXEC

Command History

Release
Modification

12.2(8)T

This command was introduced.

12.2(33)SRB

This command was integrated into Cisco IOS Release 12.2(33)SRB.


Usage Guidelines

The clear bgp nsap peer-group command is similar to the clear ip bgp peer-group command, except that it is specific to the NSAP address family.

Examples

In the following example, the BGP TCP connections are cleared for all members of the NSAP BGP peer group named internal:

Router# clear bgp nsap peer-group internal

Related Commands

Command
Description

neighbor peer-group (assigning members)

Configures a BGP neighbor to be a member of a peer group.


clear ip bgp

To reset Border Gateway Protocol (BGP) connections using hard or soft reconfiguration, use the clear ip bgp command in privileged EXEC mode.

clear ip bgp {* | all | autonomous-system-number | neighbor-address} [in [prefix-filter]] [out]} [soft [in [prefix-filter] | out]]

Syntax Description

*

Specifies that all current BGP sessions will be reset.

all

(Optional) Specifies the reset of all address family sessions.

autonomous-system-number

Specifies that sessions with BGP peers in the specified autonomous system will be reset.

neighbor-address

Specifies that only the identified BGP neighbor will be reset. The value for this argument can be an IPv4 or IPv6 address.

in

(Optional) Initiates inbound reconfiguration. If neither the in nor out keywords are specified, both inbound and outbound sessions are reset.

prefix-filter

(Optional) Clears the existing outbound route filter (ORF) prefix list to trigger a new route refresh or soft reconfiguration, which updates the ORF prefix list.

out

(Optional) Initiates inbound or outbound reconfiguration. If neither the in nor out keywords are specified, both inbound and outbound sessions are reset.

soft

(Optional) Initiates a soft reset. Does not tear down the session.


Command Modes

Privileged EXEC

Command History

Release
Modification

10.0

This command was introduced.

12.0(2)S

This command was integrated into Cisco IOS Release 12.0(2)S, and dynamic inbound soft reset capability was added.

12.0(7)T

The dynamic inbound soft reset capability was integrated into Cisco IOS Release 12.0(7)T.

12.0(22)S

The vpnv4 and ipv4 keywords were added.

12.0(29)S

The mdt keyword was added.

12.2(33)SRA

This command was integrated into Cisco IOS Release 12.2(33)SRA.

12.2SX

This command is supported in the Cisco IOS Release 12.2SX train. Support in a specific 12.2SX release of this train depends on your feature set, platform, and platform hardware.


Usage Guidelines

The clear ip bgp command can be used to initiate a hard reset or soft reconfiguration. A hard reset tears down and rebuilds the specified peering sessions and rebuilds the BGP routing tables. A soft reconfiguration uses stored prefix information to reconfigure and activate BGP routing tables without tearing down existing peering sessions. Soft reconfiguration uses stored update information, at the cost of additional memory for storing the updates, to allow you to apply new BGP policy without disrupting the network. Soft reconfiguration can be configured for inbound or outbound sessions.


Note Due to the complexity of some of the keywords available for the clear ip bgp command, some of the keywords are documented as separate commands. All of the complex keywords that are documented separately start with clear ip bgp. For example, for information on resetting BGP connections using hard or soft reconfiguration for all BGP neighbors in IPv4 address family sessions, refer to the clear ip bgp ipv4 command.


Generating Updates from Stored Information

To generate new inbound updates from stored update information (rather than dynamically) without resetting the BGP session, you must preconfigure the local BGP router using the neighbor soft-reconfiguration inbound command. This preconfiguration causes the software to store all received updates without modification regardless of whether an update is accepted by the inbound policy. Storing updates is memory intensive and should be avoided if possible.

Outbound BGP soft configuration has no memory overhead and does not require any preconfiguration. You can trigger an outbound reconfiguration on the other side of the BGP session to make the new inbound policy take effect.

Use this command whenever any of the following changes occur:

Additions or changes to the BGP-related access lists

Changes to BGP-related weights

Changes to BGP-related distribution lists

Changes to BGP-related route maps

Dynamic Inbound Soft Reset

The route refresh capability, as defined in RFC 2918, allows the local router to reset inbound routing tables dynamically by exchanging route refresh requests to supporting peers. The route refresh capability does not store update information locally for non-disruptive policy changes. It instead relies on dynamic exchange with supporting peers. Route refresh is advertised through BGP capability negotiation. All BGP routers must support the route refresh capability.

To determine if a BGP router supports this capability, use the show ip bgp neighbors command. The following message is displayed in the output when the router supports the route refresh capability:

Received route refresh capability from peer.

If all BGP routers support the route refresh capability, use the clear ip bgp command with the in keyword. You need not use the soft keyword, because soft reset is automatically assumed when the route refresh capability is supported.


Note After configuring a soft reset (inbound or outbound), it is normal for the BGP routing process to hold memory. The amount of memory that is held depends on the size of routing tables and the percentage of the memory chunks that are utilized. Partially used memory chunks will be used or released before more memory is allocated from the global router pool.


Examples

In the following example, a soft reconfiguration is initiated for the inbound session with the neighbor 10.100.0.1, and the outbound session is unaffected:

Router# clear ip bgp 10.100.0.1 soft in

In the following example, the route refresh capability is enabled on the BGP neighbor routers and a soft reconfiguration is initiated for the inbound session with the neighbor 172.16.10.2, and the outbound session is unaffected:

Router# clear ip bgp 172.16.10.2 in

In the following example, a hard reset is initiated for sessions with all routers in the autonomous system numbered 35700:

Router# clear ip bgp 35700

Related Commands

Command
Description

clear ip bgp ipv4

Resets BGP connections using hard or soft reconfiguration for IPv4 address family sessions.

clear ip bgp ipv6

Resets BGP connections using hard or soft reconfiguration for IPv6 address family sessions.

clear ip bgp vpnv4

Resets BGP connections using hard or soft reconfiguration for VPNv4 address family sessions.

clear ip bgp vpnv6

Resets BGP connections using hard or soft reconfiguration for VPNv6 address family sessions.

neighbor soft-reconfiguration

Configures the Cisco IOS software to start storing updates.

show ip bgp

Displays entries in the BGP routing table.

show ip bgp neighbors

Displays information about BGP and TCP connections to neighbors.


clear ip bgp dampening

To clear BGP route dampening information and to unsuppress suppressed routes, use the clear ip bgp dampening command in privileged EXEC mode.

Syntax Without Address Family Syntax

clear ip bgp dampening [network-address] [ipv4-mask]

Syntax With Address Family Syntax

clear ip bgp [ipv4 {multicast | unicast} | vpnv4 unicast] dampening [network-address] [ipv4-mask]

Syntax Description

network-address

(Optional) IPv4 address of the network or neighbor to clear dampening information. If no address family keyword is specified when entering the neighbor-address argument, you will be prompted for an IPv4 address.

ipv4-mask

(Optional) IPv4 network mask.

ipv4

(Optional) Specifies the reset of IPv4 address family sessions.

multicast

(Optional) Specifies multicast address family sessions.

unicast

(Optional) Specifies unicast address family sessions.

vpn4

(Optional) Specifies the reset of Virtual Private Network Version 4 (VPNv4) address family sessions.


Command Modes

Privileged EXEC

Command History

Release
Modification

11.0

This command was introduced.

12.2(33)SRA

This command was integrated into Cisco IOS Release 12.2(33)SRA.

12.2SX

This command is supported in the Cisco IOS Release 12.2SX train. Support in a specific 12.2SX release of this train depends on your feature set, platform, and platform hardware.


Usage Guidelines

The clear ip bgp dampening is used to clear stored route dampening information. If no keywords or arguments are entered, route dampening information for the entire routing table is cleared.

Examples

The following example clears route dampening information for VPNv4 address family prefixes from network 192.168.10.0/24 and unsuppress suppressed routes.

Router# clear ip bgp vpnv4 unicast dampening 192.168.10.0 255.255.255.0 

Related Commands

Command
Description

bgp dampening

Enables BGP route dampening or configures BGP route dampening parameters.

clear ip bgp flap-statistics

Resets BGP route dampening flap-statistics.

set dampening

Sets set BGP route dampening parameters in a route map.

show ip bgp dampened-paths

Displays BGP dampened routes.


clear ip bgp external

To reset external Border Gateway Protocol (eBGP) peering sessions using hard or soft reconfiguration, use the clear ip bgp external command in privileged EXEC mode.

Syntax Without Address Family Syntax

clear ip bgp external [in [prefix-filter]] [out] [soft [in [prefix-filter] | out]]

Syntax With Address Family Syntax

clear ip bgp external [all | ipv4 {multicast | mdt | unicast} | ipv6 {multicast | unicast} | vpnv4 unicast | vpnv6 unicast] [in [prefix-filter]] [out] [soft [in [prefix-filter] | out]]

Syntax Description

in

(Optional) Initiates inbound reconfiguration. If neither the in nor out keywords are specified, both inbound and outbound sessions are reset.

prefix-filter

(Optional) Clears the existing outbound route filter (ORF) prefix list to trigger a new route refresh or soft reconfiguration, which updates the ORF prefix list.

out

(Optional) Initiates inbound or outbound reconfiguration. If neither the in nor out keywords are specified, both inbound and outbound sessions are reset.

soft

(Optional) Initiates a soft reset. Does not tear down the session.

all

(Optional) Specifies the reset of eBGP peering sessions for all address families.

ipv4

(Optional) Specifies the reset of eBGP peering sessions for IPv4 address family sessions.

multicast

(Optional) Specifies multicast address family sessions.

mdt

(Optional) Specifies multicast distribution tree (MDT) address family sessions.

unicast

(Optional) Specifies unicast address family sessions.

ipv6

(Optional) Specifies the reset of eBGP peering sessions for IPv6 address family sessions.

vpnv4

(Optional) Specifies the reset of eBGP peering sessions for Virtual Private Network Version 4 (VPNv4) address family sessions.

vpnv6

(Optional) Specifies the reset of eBGP peering sessions for Virtual Private Network Version 6 (VPNv6) address family sessions.


Command Modes

Privileged EXEC

Command History

Release
Modification

12.0(2)S

This command was introduced.

12.0(22)S

The vpnv4 and ipv4 keywords were added.

12.0(29)S

The mdt keyword was added.

12.2(33)SRA

This command was integrated into Cisco IOS Release 12.2(33)SRA.

12.2SX

This command is supported in the Cisco IOS Release 12.2SX train. Support in a specific 12.2SX release of this train depends on your feature set, platform, and platform hardware.


Usage Guidelines

The clear ip bgp external command can be used to initiate a hard reset or soft reconfiguration of eBGP neighbor sessions. A hard reset tears down and rebuilds the specified peering sessions and rebuilds the BGP routing tables. A soft reconfiguration uses stored prefix information to reconfigure and activate BGP routing tables without tearing down existing peering sessions. Soft reconfiguration uses stored update information, at the cost of additional memory for storing the updates, to allow you to apply new BGP policy without disrupting the network. Soft reconfiguration can be configured for inbound or outbound sessions.

Generating Updates from Stored Information

To generate new inbound updates from stored update information (rather than dynamically) without resetting the BGP session, you must preconfigure the local BGP router using the neighbor soft-reconfiguration inbound command. This preconfiguration causes the software to store all received updates without modification regardless of whether an update is accepted by the inbound policy. Storing updates is memory intensive and should be avoided if possible.

Outbound BGP soft configuration has no memory overhead and does not require any preconfiguration. You can trigger an outbound reconfiguration on the other side of the BGP session to make the new inbound policy take effect.

Use this command whenever any of the following changes occur:

Additions or changes to the BGP-related access lists

Changes to BGP-related weights

Changes to BGP-related distribution lists

Changes to BGP-related route maps

Dynamic Inbound Soft Reset

The route refresh capability, as defined in RFC 2918, allows the local router to reset inbound routing tables dynamically by exchanging route refresh requests to supporting peers. The route refresh capability does not store update information locally for non-disruptive policy changes. It instead relies on dynamic exchange with supporting peers. Route refresh is advertised through BGP capability negotiation. All BGP routers must support the route refresh capability.

To determine if a BGP router supports this capability, use the show ip bgp neighbors command. The following message is displayed in the output when the router supports the route refresh capability:

Received route refresh capability from peer.

If all BGP routers support the route refresh capability, use the clear ip bgp command with the in keyword. You need not use the soft keyword, because soft reset is automatically assumed when the route refresh capability is supported.


Note After configuring a soft reset (inbound or outbound), it is normal for the BGP routing process to hold memory. The amount of memory that is held depends on the size of routing tables and the percentage of the memory chunks that are utilized. Partially used memory chunks will be used or released before more memory is allocated from the global router pool.


Examples

In the following example, a soft reconfiguration is configured for all inbound eBGP peering sessions:

Router# clear ip bgp external soft in 

In the following example, all outbound address family IPv4 multicast eBGP peering sessions are cleared:

Router# clear ip bgp external ipv4 multicast out

Related Commands

Command
Description

clear ip bgp

Resets BGP connections using hard or soft reconfiguration.

neighbor soft-reconfiguration

Configures the Cisco IOS software to start storing updates.

show ip bgp neighbors

Displays information about BGP and TCP connections to neighbors.


clear ip bgp flap-statistics

To clear BGP route dampening flap statistics, use the clear ip bgp flap-statistics command in privileged EXEC mode.

Syntax Without Address Family Syntax

clear ip bgp flap-statistics [neighbor-address [ipv4-mask]] [regexp regexp | filter-list extcom-number]

Syntax With Address Family Syntax

clear ip bgp [neighbor-address] [all | ipv4 {multicast | mdt | unicast} | ipv6 {multicast | unicast} | vpnv4 unicast | vpnv6 unicast] flap-statistics

Syntax Description

neighbor-address

(Optional) Clears flap statistics for the specified IP address. If this argument is placed before flap-statistics keyword, the router clears flap statistics for all paths from the specified neighbor or network. The value for this argument can be an IPv4 or IPv6 address.

ipv4-mask

(Optional) IPv4 network mask.

regexp

(Optional) Clears flap statistics for all the paths that match the regular expression.

regexp

(Optional) Regular expression.

filter-list

(Optional) Clears flap statistics for all the paths that pass the access list. The access list is specified using an extended community list number.

extcom-number

(Optional) Extended community list number.

all

(Optional) Clears flap statistics for all address family sessions.

ipv4

(Optional) Clears flap statistics for IPv4 address family sessions.

multicast

(Optional) Clears flap statistics for multicast address family sessions.

mdt

(Optional) Clears flap statistics for multicast distribution tree (MDT) address family sessions.

unicast

(Optional) Clears flap statistics for unicast address family sessions.

ipv6

(Optional) Clears flap statistics for IPv6 address family sessions.

vpnv4

(Optional) Clears flap statistics for Virtual Private Network Version 4 (VPNv4) address family sessions.

vpnv6

(Optional) Clears flap statistics for Virtual Private Network Version 6 (VPNv6) address family sessions.


Command Modes

Privileged EXEC

Command History

Release
Modification

11.0

This command was introduced.

12.0(22)S

The vpnv4 and ipv4 keywords were added.

12.0(29)S

The mdt keyword was added.

12.2(33)SRA

This command was integrated into Cisco IOS Release 12.2(33)SRA.

12.2SX

This command is supported in the Cisco IOS Release 12.2SX train. Support in a specific 12.2SX release of this train depends on your feature set, platform, and platform hardware.


Usage Guidelines

The clear ip bgp flap-statistics command is used to clear the accumulated penalty for routes that are received on a router that has BGP dampening enabled. If no arguments or keywords are specified, flap statistics are cleared for all routes. Flap statistics are also cleared when the peer is stable for the half-life time period.

Examples

In the following example, all of the flap statistics are cleared for paths that pass filter list 3:

Router# clear ip bgp flap-statistics filter-list 3 

In the following example, all of the flap statistics are cleared for the paths to the BGP neighbor at 10.2.1.3:

Router# clear ip bgp 10.2.1.3 flap-statistics

In the following example, all of the flap statistics are cleared for the paths to the BGP neighbor at 10.2.1.3 under IPv4 multicast address family:

Router# clear ip bgp 10.2.1.3 ipv4 multicast flap-statistics

Related Commands

Command
Description

bgp dampening

Enables BGP route dampening or changes various BGP route dampening factors.

clear ip bgp dampening

Clears BGP route dampening information and to unsuppress suppressed routes.

set dampening

Sets set BGP route dampening parameters in a route map.

show ip bgp dampened-paths

Displays BGP dampened routes.


clear ip bgp in prefix-filter

The in and prefix-filter keywords for the clear ip bgp command are no longer documented as a separate command.

The information for using the in and prefix-filter keywords with the clear ip bgp command has been incorporated into all the appropriate clear ip bgp command documentation. Due to the complexity of some of the keywords available for the clear ip bgp command, some of the keywords are documented as separate commands. All of the complex keywords that are documented separately start with clear ip bgp. For example, for information on resetting BGP connections using hard or soft reconfiguration for all BGP neighbors in IPv4 address family sessions, refer to the clear ip bgp ipv4 command.

clear ip bgp ipv4

To reset Border Gateway Protocol (BGP) connections using hard or soft reconfiguration for IPv4 address family sessions, use the clear ip bgp ipv4 command in privileged EXEC mode.

clear ip bgp ipv4 {multicast | mdt | unicast} autonomous-system-number [in [prefix-filter]] [out] [soft [in [prefix-filter] | out]]

Syntax Description

multicast

Resets multicast address family sessions.

mdt

Resets multicast distribution tree (MDT) address family sessions.

unicast

Resets unicast address family sessions.

autonomous-system-number

Resets BGP peers with the specified autonomous system number.

in

(Optional) Initiates inbound reconfiguration. If neither the in keyword nor the out keyword is specified, both inbound and outbound sessions are reset.

prefix-filter

(Optional) Clears the existing outbound route filter (ORF) prefix list to trigger a new route refresh or soft reconfiguration, which updates the ORF prefix list.

out

(Optional) Initiates outbound reconfiguration. If neither the in keyword nor the out keyword is specified, both inbound and outbound sessions are reset.

soft

(Optional) Initiates a soft reset. Does not tear down the session.


Command Modes

Privileged EXEC (#)

Command History

Release
Modification

12.0(22)S

This command was introduced.

12.0(29)S

The mdt keyword was added.

12.2(33)SRA

This command was integrated into Cisco IOS Release 12.2(33)SRA.

12.2(31)SB2

This command was integrated into Cisco IOS Release 12.2(31)SB2.

12.2SX

This command is supported in the Cisco IOS Release 12.2SX train. Support in a specific 12.2SX release of this train depends on your feature set, platform, and platform hardware.

12.4(20)T

The mdt keyword was added.


Usage Guidelines

The clear ip bgp ipv4 command can be used to initiate a hard reset or soft reconfiguration. A hard reset tears down and rebuilds the specified peering sessions and rebuilds the BGP routing tables. A soft reconfiguration uses stored prefix information to reconfigure and activate BGP routing tables without tearing down existing peering sessions. Soft reconfiguration uses stored update information, at the cost of additional memory for storing the updates, to allow you to apply new BGP policy without disrupting the network. Soft reconfiguration can be configured for inbound or outbound sessions.

Generating Updates from Stored Information

To generate new inbound updates from stored update information (rather than dynamically generating inbound updates) without resetting the BGP session, you must preconfigure the local BGP router using the neighbor soft-reconfiguration inbound command. This preconfiguration causes the software to store all received updates without modification regardless of whether an update is accepted by the inbound policy. Storing updates is memory intensive and should be avoided if possible.

Outbound BGP soft configuration has no memory overhead and does not require any preconfiguration. You can trigger an outbound reconfiguration on the other side of the BGP session to make the new inbound policy take effect.

Use this command whenever any of the following changes occur:

Additions or changes to the BGP-related access lists

Changes to BGP-related weights

Changes to BGP-related distribution lists

Changes to BGP-related route maps

Dynamic Inbound Soft Reset

The route refresh capability, as defined in RFC 2918, allows the local router to reset inbound routing tables dynamically by exchanging route refresh requests to supporting peers. The route refresh capability does not store update information locally for nondisruptive policy changes. It instead relies on dynamic exchange with supporting peers. Route refresh is advertised through BGP capability negotiation. All BGP routers must support the route refresh capability.

To determine if a BGP router supports this capability, use the show ip bgp neighbors command. The following message is displayed in the output when the router supports the route refresh capability:

Received route refresh capability from peer.

If all BGP routers support the route refresh capability, use the clear ip bgp ipv4 command with the in keyword. You need not use the soft keyword, because soft reset is automatically assumed when the route refresh capability is supported.


Note After configuring a soft reset (inbound or outbound), it is normal for the BGP routing process to hold memory. The amount of memory that is held depends on the size of the routing tables and the percentage of the memory chunks that are utilized. Partially used memory chunks will be used or released before more memory is allocated from the global router pool.


Examples

In the following example, a soft reconfiguration is initiated for the inbound sessions for BGP neighbors in IPv4 unicast address family sessions in autonomous system 65400, and the outbound session is unaffected:

Router# clear ip bgp ipv4 unicast 65400 soft in

In the following example, the route refresh capability is enabled on the IPv4 multicast address family BGP neighbors in autonomous system 65000, a soft reconfiguration is initiated for all inbound sessions with the IPv4 multicast address family neighbors, and the outbound session is unaffected:

Router# clear ip bgp ipv4 multicast 65000 in

In the following example, a hard reset is initiated for all BGP neighbor in IPv4 MDT address family sessions in the autonomous system numbered 65700:

Router# clear ip bgp ipv4 mdt 65700

Related Commands

Command
Description

neighbor soft-reconfiguration

Configures the Cisco IOS software to start storing updates.

show ip bgp ipv4

Displays entries in the IPv4 BGP routing table.

show ip bgp neighbors

Displays information about BGP and TCP connections to neighbors.


clear ip bgp ipv6

To reset Border Gateway Protocol (BGP) connections using hard or soft reconfiguration for IPv6 address family sessions, use the clear ip bgp ipv6 command in privileged EXEC mode.

clear ip bgp ipv6 {multicast | unicast} autonomous-system-number [in [prefix-filter]] [out]
[soft [in [prefix-filter] | out]]

Syntax Description

multicast

(Optional) Specifies the reset of multicast address family sessions.

unicast

(Optional) Specifies the reset of unicast address family sessions.

autonomous-system-number

Specifies that sessions with BGP peers in the specified autonomous system will be reset.

in

(Optional) Initiates inbound reconfiguration. If neither the in nor out keywords are specified, both inbound and outbound sessions are reset.

prefix-filter

(Optional) Clears the existing outbound route filter (ORF) prefix list to trigger a new route refresh or soft reconfiguration, which updates the ORF prefix list.

out

(Optional) Initiates inbound or outbound reconfiguration. If neither the in nor out keywords are specified, both inbound and outbound sessions are reset.

soft

(Optional) Initiates a soft reset. Does not tear down the session.


Command Modes

Privileged EXEC

Command History

Release
Modification

12.2(2)T

This command was introduced.

12.2(33)SRA

This command was integrated into Cisco IOS Release 12.2(33)SRA.

12.2SX

This command is supported in the Cisco IOS Release 12.2SX train. Support in a specific 12.2SX release of this train depends on your feature set, platform, and platform hardware.


Usage Guidelines

The clear ip bgp ipv6 command can be used to initiate a hard reset or soft reconfiguration of IPv6 address family sessions. A hard reset tears down and rebuilds the specified peering sessions and rebuilds the BGP routing tables. A soft reconfiguration uses stored prefix information to reconfigure and activate BGP routing tables without tearing down existing peering sessions. Soft reconfiguration uses stored update information, at the cost of additional memory for storing the updates, to allow you to apply new BGP policy without disrupting the network. Soft reconfiguration can be configured for inbound or outbound sessions.

Generating Updates from Stored Information

To generate new inbound updates from stored update information (rather than dynamically) without resetting the BGP session, you must preconfigure the local BGP router using the neighbor soft-reconfiguration inbound command. This preconfiguration causes the software to store all received updates without modification regardless of whether an update is accepted by the inbound policy. Storing updates is memory intensive and should be avoided if possible.

Outbound BGP soft configuration has no memory overhead and does not require any preconfiguration. You can trigger an outbound reconfiguration on the other side of the BGP session to make the new inbound policy take effect.

Use this command whenever any of the following changes occur:

Additions or changes to the BGP-related access lists

Changes to BGP-related weights

Changes to BGP-related distribution lists

Changes to BGP-related route maps

Dynamic Inbound Soft Reset

The route refresh capability, as defined in RFC 2918, allows the local router to reset inbound routing tables dynamically by exchanging route refresh requests to supporting peers. The route refresh capability does not store update information locally for non-disruptive policy changes. It instead relies on dynamic exchange with supporting peers. Route refresh is advertised through BGP capability negotiation. All BGP routers must support the route refresh capability.

To determine if a BGP router supports this capability, use the show ip bgp neighbors command. The following message is displayed in the output when the router supports the route refresh capability:

Received route refresh capability from peer.

If all BGP routers support the route refresh capability, use the clear ip bgp ipv6 command with the in keyword. You need not use the soft keyword, because soft reset is automatically assumed when the route refresh capability is supported.


Note After configuring a soft reset (inbound or outbound), it is normal for the BGP routing process to hold memory. The amount of memory that is held depends on the size of routing tables and the percentage of the memory chunks that are utilized. Partially used memory chunks will be used or released before more memory is allocated from the global router pool.


Examples

In the following example, a soft reconfiguration is initiated for the inbound sessions for BGP neighbors in IPv6 unicast address family sessions, and the outbound session is unaffected:

Router# clear ip bgp ipv6 unicast soft in

In the following example, the route refresh capability is enabled on the IPv6 multicast address family BGP neighbors and a soft reconfiguration is initiated for all inbound session with the IPv6 multicast address family neighbors, and the outbound session is unaffected:

Router# clear ip bgp ipv6 multicast in

In the following example, a hard reset is initiated for neighbor sessions with all IPv6 unicast address family routers in the autonomous system numbered 35700:

Router# clear ip bgp ipv6 unicast 35700

Related Commands

Command
Description

neighbor soft-reconfiguration

Configures the Cisco IOS software to start storing updates.

show ip bgp neighbors

Displays information about BGP and TCP connections to neighbors.


clear ip bgp l2vpn

To reset Border Gateway Protocol (BGP) neighbor session information for Layer 2 Virtual Private Network (L2VPN) address family, use the clear ip bgp l2vpn command in privileged EXEC mode.

clear ip bgp l2vpn vpls {autonomous-system-number | peer-group peer-group-name | update-group [number | ip-address]} [in [prefix-filter] | out | soft [in [prefix-filter] | out]]

Syntax Description

vpls

Specifies that Virtual Private LAN Service (VPLS) subsequent address family identifier (SAFI) information will be cleared.

autonomous-system-
number

Autonomous system number in which peers are reset.

peer-group peer-group-name

Clears peer group information for the peer group specified with the peer-group-name argument.

update-group

Clears update group session information.

number

(Optional) Clears update-group session information for the specified update group number.

ip-address

(Optional) Clears update-group session information for the peer specified with the ip-address argument.

in

(Optional) Initiates inbound reconfiguration. If neither the in keyword nor out keyword is specified, both inbound and outbound sessions are reset.

prefix-filter

(Optional) Clears the inbound prefix filter.

out

(Optional) Initiates outbound reconfiguration. If neither the in keyword nor out keyword is specified, both inbound and outbound sessions are reset.

soft

(Optional) Initiates a soft reset. Does not tear down the session.


Command Default

If no arguments or keywords are specified, all BGP L2VPN VPLS neighbor session information is cleared.

Command Modes

Privileged EXEC

Command History

Release
Modification

12.2(33)SRB

This command was introduced.


Usage Guidelines

The clear ip bgp l2vpn command clears BGP session information for the L2VPN address family and VPLS SAFI. This command can be used to initiate a hard reset or soft reconfiguration. A hard reset tears down and rebuilds the specified peering sessions and rebuilds the BGP routing tables. A soft reconfiguration uses stored prefix information to reconfigure and activate BGP routing tables without tearing down existing peering sessions. Soft reconfiguration uses stored update information, at the cost of additional memory for storing the updates, to allow you to apply new BGP policy without disrupting the network. Soft reconfiguration can be configured for inbound or outbound sessions.

Generating Updates from Stored Information

To generate new inbound updates from stored update information (rather than dynamically) without resetting the BGP session, you must preconfigure the local BGP router using the neighbor soft-reconfiguration inbound command. This preconfiguration causes the software to store all received updates without modification regardless of whether an update is accepted by the inbound policy. Storing updates is memory intensive and should be avoided if possible.

Outbound BGP soft configuration has no memory overhead and does not require any preconfiguration. You can trigger an outbound reconfiguration on the other side of the BGP session to make the new inbound policy take effect.

Use the clear ip bgp l2vpn command whenever any of the following changes occur:

Additions or changes to the BGP-related access lists

Changes to BGP-related weights

Changes to BGP-related distribution lists

Changes to BGP-related route maps