7.5. Route Map Commands

Command Purpose

To define the conditions for redistributing routes from one routing protocol into another, or to enable policy routing in bgp, use the route-map command in Global Config mode and the match and set command in route-map configuration modes.

To delete an entry, use the no form of this command.

Prerequisites

Command Syntax

route-map MAP-TAG [ permit | deny ] [ sequence-NUMBER ]

no route-map MAP-TAG [ permit | deny ] [ SEQUENCE_NUMBER ]

Command Mode

Global Config

Default

The permit keyword is the default.

Usage

None

Examples

The following example shows how to create a route-map and enter route-map configuration mode:

Switch# configure terminal
Switch(config)# route-map rip-to-ospf permit
Switch(config-route-map)# match metric 1
Switch(config-route-map)# set metric 2

Related Commands

match as-path

match community

match interface

match ip address

match local-preference

match metric

match origin

match route-type

match tag

set aggregator

set as-path

set atomic-aggregate

set comm-list

set community

set dampening

set extcommunity

set ip address

set local-preference

set metric

set metric-type

set origin

set originator-id

set tag

set vpnv4

set weight

Command Purpose

Use this command to match an autonomous system path access list.

Use the no parameter with this command to remove a path list entry.

The match as-path command specifies the autonomous system path to be matched. If there is a match for the specified AS path, and permit is specified, the route is redistributed or controlled, as specified by the set action. If the match criteria are met, and deny is specified, the route is not redistributed or controlled. If the match criteria are not met then the route is neither accepted nor forwarded, irrespective of permit or deny specifications.

The route specified by the policies might not be the same as specified by the routing protocols. Setting policies enable packets to take different routes, depending on their length or content. Packet forwarding based on configured policies overrides packet forwarding specified in routing tables.

Prerequisites

Command Syntax

match as-path LISTNAME

no match as-path

Command Mode

Route-map Configuration

Default

No match as-path is specified by default.

Usage

This command is valid only for BGP.

Examples

Switch# configure terminal
Switch(config)# route-map myroute deny 34
Switch(config-route-map)# match as-path myaccesslist

Related Commands

match metric

match ip address

match community

set as-path

set community

Command Purpose

Use this command to specify the community to be matched.

Use the no parameter with this command to remove the community list entry.

Communities are used to group and filter routes. They are designed to provide the ability to apply policies to large numbers of routes by using match and set commands. Community lists are used to identify and filter routes by their common attributes.

Use the match community command to allow matching based on community lists.

The values set by the match community command overrides the global values. The route that does not match at least one match clause is ignored.

Prerequisites

Command Syntax

match community WORD

no match community

Command Mode

Route-map Configuration

Default

No match community is specified by default.

Usage

This command is valid only for BGP.

Examples

Switch# configure terminal
Switch(config)# route-map myroute permit 3
Switch(config-route-map)# match community mylist

Related Commands

match ip address

match as-path

set as-path

set community

match metric

Command Purpose

Use this command to define the interface match criterion.

Use the no parameter with this command to remove the specified match criterion.

The match interface command specifies the next-hop interface name of a route to be matched.

Prerequisites

Command Syntax

match interface IFNAME

no match interface

Command Mode

Route-map Configuration

Default

No match interface is specified by default.

Usage

None

Examples

Switch# configure terminal
Switch(config)# route-map mymap1 permit 10
Switch(config-route-map)# match interface eth-0-1

Related Commands

match tag

match route-type external

Command Purpose

Use this command to specify the match address of route.

Use the no parameter with this command to remove the match ipv6 address entry.

The match ipv6 address command specifies the IPv6 address to be matched. If there is a match for the specified IPv6 address, and permit is specified, the route is redistributed or controlled, as specified by the set action. If the match criteria are met, and deny is specified then the route is not redistributed or controlled. If the match criteria are not met, the route is neither accepted nor forwarded, irrespective of permit or deny specifications.

The route specified by the policies might not be the same as specified by the routing protocols. Setting policies enable packets to take different routes, depending on their length or content. Packet forwarding based on configured policies overrides packet forwarding specified in routing tables.

Prerequisites

Command Syntax

match ipv6 address ACCESSSLISTID

no match ipv6 address

Command Mode

Route-map Configuration

Default

No match ipv6 address is specified by default.

Usage

This command is valid for BGP, OSPFv3 and RIPng only.

Examples

Switch# configure terminal
Switch(config)# route-map myroute permit 3
Switch(config-route-map)# match ipv6 address List1

Related Commands

match community

match as-path

set as-path

set community

match metric

Command Purpose

Use this command to match entries of ipv6 prefix-lists.

Use the no parameter with this command to disable this function

This command specifies the entries of prefix-lists to be matched. If there is a match for the specified ipv6 prefix-list entries, and permit is specified, the route is redistributed or controlled, as specified by the set action. If the match criteria are met, and deny is specified, the route is not redistributed or controlled. If the match criteria are not met, the route is neither accepted nor forwarded, irrespective of permit or deny specifications.

The route specified by the policies might not be the same as specified by the routing protocols. Setting policies enable packets to take different routes depending on their length or content. Packet forwarding based on configured policies overrides packet forwarding specified in routing tables.

Prerequisites

Command Syntax

match ipv6 address prefix-list LISTNAME

no match ipv6 address prefix-list（LISTNAME | ）

Command Mode

Route-map Configuration

Default

No match ipv6 address prefix-list is specified by default.

Usage

This command is valid for BGP, OSPFv3 and RIPng only.

Examples

Switch# configure terminal
Switch(config)# route-map rmap1 permit 3
Switch(config-route-map)#match ipv6 address prefix-list mylist

Related Commands

match community

match as-path

set as-path

set community

match metric

Command Purpose

Use this command to specify a ipv6 next-hop address to be matched in a route-map.

Use the no parameter with this command to disable this function.

The match ipv6 next-hop command specifies the next-hop address to be matched. If there is a match for the specified next-hop address, and permit is specified, the route is redistributed or controlled as specified by the set action. If the match criteria are met, and deny is specified, the route is not redistributed or controlled. If the match criteria are not met, the route is neither accepted nor forwarded, irrespective of permit or deny specifications.

The route specified by the policies might not be the same as specified by the routing protocols. Setting policies enable packets to take different routes depending on their length or content. Packet forwarding based on configured policies overrides packet forwarding specified in routing tables.

Prerequisites

Command Syntax

match ipv6 next-hop ( IPV6_ADDR | ACCESSSLISTID )

no match ipv6 next-hop [ IPv6-ADDRESS | ACCESSSLISTID ]

Command Mode

Route-map Configuration

Default

No match ipv6 next-hop is specified by default.

Usage

This command is valid for BGP, OSPFv3 and RIPng only.

Examples

Switch# configure terminal
Switch(config)# route-map rmap1 permit 3
Switch(config-route-map)# match ipv6 next-hop mylist

Related Commands

match community

match as-path

set as-path

set community

match metric

Command Purpose

Use this command to specify the next-hop IPv6 address match criterion, using the prefix-list.

Use the no parameter with this command to remove the specified match criterion.

Use the match ipv6 next-hop prefix-list command to match the next-hop IPv6 address of a route.

Prerequisites

Command Syntax

match ipv6 next-hop prefix-list LISTNAME

no match ipv6 next-hop prefix-list [ LISTNAME ]

Command Mode

Route-map Configuration

Default

No match ipv6 next-hop prefix-list is specified by default.

Usage

This command is valid for RIPng only.

Examples

Switch# configure terminal
Switch(config)# route-map mymap permit 3
Switch(config-route-map)# match ipv6 next-hop prefix-list list1

Related Commands

match metric

match interface

match ip next-hop

Command Purpose

Use this command to specify the local-preference match criterion.

Use the no parameter with this command to remove the specified match criterion.

Use the match local-preference command to match the local preference of a route.

Prerequisites

Command Syntax

match local-preference LOCAL-PREFERENCE

no match local-preference

Command Mode

Route-map Configuration

Default

No match local-preference is specified by default.

Usage

This command is valid for BGP only.

Examples

Switch# configure terminal
Switch(config)# route-map mymap permit 3
Switch(config-route-map)# match local-preference 100

Related Commands

match community

match as-path

set as-path

set community

match ip next-hop

Command Purpose

Use this command to match a metric of a route.

Use the no parameter with this command to disable this function.

The match metric command specifies the metric to be matched. If there is a match for the specified metric, and permit is specified, the route is redistributed or controlled as specified by the set action. If the match criteria are met, and deny is specified, the route is not redistributed or controlled. If the match criteria are not met, the route is neither accepted nor forwarded, irrespective of permit or deny specifications.

The route specified by the policies might not be the same as specified by the routing protocols. Setting policies enable packets to take different routes depending on their length or content. Packet forwarding based on configured policies overrides packet forwarding specified in routing tables.

Prerequisites

Command Syntax

match metric METRICVAL

no match metric

Command Mode

Route-map Configuration

Default

No match metric is specified by default.

Usage

This command is valid for BGP, OSPF and RIP only.

Examples

Switch# configure terminal
Switch(config)# route-map myroute permit 3
Switch(config-route-map)# no match metric

Related Commands

match community

match as-path

set as-path

set community

match ip next-hop

Command Purpose

Use this command to match origin code.

Use the no parameter with this command to disable this matching.

The origin attribute defines the origin of the path information. The egp parameter is indicated as an e in the routing table, and it indicates that the origin of the information is learned via Exterior Gateway Protocol. The igp parameter is indicated as an i in the routing table, and it indicates the origin of the path information is interior to the originating AS.

The incomplete parameter is indicated as a ? in the routing table, and indicates that the origin of the path information is unknown or learned through other means. If a static route is redistributed into BGP, the origin of the route is incomplete.

The match origin command specifies the origin to be matched. If there is a match for the specified origin, and permit is specified, the route is redistributed or controlled as specified by the set action. If the match criteria are met, and deny is specified, the route is not redistributed or controlled. If the match criteria are not met, the route is neither accepted nor forwarded, irrespective of permit or deny specifications.

The route specified by the policies might not be the same as specified by the routing protocols. Setting policies enable packets to take different routes depending on their length or content. Packet forwarding based on configured policies overrides packet forwarding specified in routing tables.

Prerequisites

Command Syntax

match origin { egp | igp | incomplete }

no match origin

Command Mode

Route-map Configuration

Default

No match origin is specified by default.

Usage

None

Examples

Switch# configure terminal
Switch(config)# route-map myroute deny 34
Switch(config-route-map)# match origin egp

Related Commands

None

Command Purpose

Use this command to match specified external route type.

Use the no parameter with this command to turn off the matching.

Use the match route-type external command to match specific external route types. AS-external LSA is either Type-1 or Type-2. External type-1 matches only Type 1 external routes, and external type-2 matches only Type 2 external routes.

Prerequisites

Command Syntax

match route-type external { type-1 | type-2 }

no match route-type external

Command Mode

Route-map Configuration

Default

No match route-type is specified by default.

Usage

This command is valid for OSPF only.

Examples

Switch# configure terminal
Switch(config)# route-map mymap1 permit 10
Switch(config-route-map)# match route-type external type-1

Related Commands

match tag

Command Purpose

Use this command to match the specified tag value.

Use the no parameter with this command to turn off the declaration.

Use the match tag command to match the specified tag value.

Prerequisites

Command Syntax

match tag TAG

no match tag

Command Mode

Route-map Configuration

Default

No match tag is specified by default.

Usage

This command is valid for OSPF RIP only.

Examples

Switch# configure terminal
Switch(config)# route-map mymap1 permit 10
Switch(config-route-map)# match tag 100

Related Commands

match metric

match route-type external

Command Purpose

Use this command to set the AS number for the route map and router ID.

Use the no parameter with this command to disable this function.

An Autonomous System (AS) is a collection of networks under a common administration sharing a common routing strategy. It is subdivided by areas, and is assigned a unique 16-bit number. Use the set aggregator command to

assign an AS number for the aggregator.

To use the set aggregator command, you must first have a match clause. Match and set commands set the conditions for redistributing routes from one routing protocol to another. The match command specifies the match criteria under which redistribution is allowed for the current route-map. The set command specifies the set redistribution actions to be performed, if the match criteria are met.

If the packets do not match any of the defined criteria, they are routed through the normal routing process.

Prerequisites

Command Syntax

set ipv6 aggregator as ASNUM IPV6_ADDR

no set ipv6 aggregator

Command Mode

Route-map Configuration

Default

No set aggregator is specified by default.

Usage

This command is valid for BGP only.

Examples

Switch# configure terminal
Switch(config)# route-map myroute permit 3
Switch(config-route-map)# set aggregator as 43 2001:db8::1

Related Commands

None

Command Purpose

Use this command to modify an autonomous system path for a route.

Use the no parameter with this command to disable this function.

Use the set as-path command to specify an autonomous system path. By specifying the length of the AS-Path, the router influences the best path selection by a neighbor. Use the prepend parameter with this command to prepend an AS path string to routes increasing the AS path length.

To use the set as-path command, you must first have a match clause. Match and set commands set the conditions for redistributing routes from one routing protocol to another. The match command specifies the match criteria under which redistribution is allowed for the current route-map. The set command specifies the set redistribution actions to be performed, if the match criteria are met.

If the packets do not match any of the defined criteria, they are routed through the normal routing process.

Prerequisites

Command Syntax

set as-path prepend ASN [ …ASN ]

no set as-path

Command Mode

Route-map Configuration

Default

No set as-path is specified by default.

Usage

This command is valid for BGP only.

Examples

Switch# configure terminal
Switch(config)# route-map myroute permit 3
Switch(config-route-map)# set as-path prepend 8 24

Related Commands

None

Command Purpose

Use this command to set an atomic aggregate attribute.

Use the no parameter with this command to disable this function

To use the set atomic aggregate command, you must first have a match clause. Match and set commands set the conditions for redistributing routes from one routing protocol to another. The match command specifies the match criteria under which redistribution is allowed for the current route-map. The set command specifies the set redistribution actions to be performed, if the match criteria are met.

If the packets do not match any of the defined criteria, they are routed through the normal routing process.

Prerequisites

Command Syntax

set atomic-aggregate

no set atomic-aggregate

Command Mode

Route-map Configuration

Default

No set atomic-aggregate is specified by default.

Usage

This command is valid for BGP only.

Examples

Switch# configure terminal
Switch(config)# route-map rmap1 permit 3
Switch(config-route-map)# set atomic-aggregate

Related Commands

None

Command Purpose

Use this command to delete the matched communities from the community attribute of an inbound or outbound update when applying route-map.

Use the no parameter with this command to disable this feature.

Prerequisites

Command Syntax

set comm-list { STANDARD | EXPANDED | WORD } delete

no set comm-list

Command Mode

Route-map Configuration

Default

No set comm-list is specified by default.

Usage

This command is valid for BGP only.

Examples

Switch# configure terminal
Switch(config)# route-map rmap1 permit 3
Switch(config-route-map)# set comm-list 34 delete

Related Commands

None

Command Purpose

Use this command to set the communities attribute.

Use the no parameter with this command to delete the entry.

Use this command to set the community attribute and group destinations in a certain community, as well as, apply routing decisions according to those communities.

To use the set community command, you must first have a match clause. Match and set commands set the conditions for redistributing routes from one routing protocol to another. The match command specifies the match criteria under which redistribution is allowed for the current route-map. The set command specifies the set redistribution actions to be performed, if the match criteria are met.

If the packets do not match any of the defined criteria, they are routed through the normal routing process.

Prerequisites

Command Syntax

set community [ AA:NN | internet | local-AS | no-advertise | no-export ]

set community none

no set community

Command Mode

Route-map Configuration

Default

No set community is specified by default.

Usage

This command is valid for BGP only.

Examples

The following examples show the use of the set community command with different parameters:

Switch# configure terminal
Switch(config)# route-map rmap1 permit 3
Switch(config-route-map)# set community no-export no-advertise
Switch# configure terminal
Switch(config)# route-map rmap1 permit 3
Switch(config-route-map)# set community no-advertise
Switch# configure terminal
Switch(config)# route-map rmap1 permit 3
Switch(config-route-map)# set community 10:01 23:34 12:14 no-export

Related Commands

None

Command Purpose

Use this command to enable route-flap dampening and set parameters.

Use the no parameter with this command to disable it.

Set the unreachability half-life time to be equal to, or greater than, reachability half-life time. The suppress-limit value must be greater than or equal to the reuse limit value.

Prerequisites

Command Syntax

set dampening REACHTIME REUSE SUPPRESS MAXSUPPRESS [ UNREACHTIME ]

no set dampening

Command Mode

Route-map Configuration

Default

Reference to the syntax description above.

Usage

This command is valid for BGP only.

Examples

Switch# configure terminal
Switch(config)# route-map R1 permit 24
Switch(config-route-map)# set dampening 20 333 534 30

Related Commands

None

Command Purpose

Use this command to set an extended community attribute.

Use the no parameter with this command to disable this function

To use the set extcommunity command, you must first have a match clause. Match and set commands set the conditions for redistributing routes from one routing protocol to another. The match command specifies the match criteria under which redistribution is allowed for the current route-map. The set command specifies the set redistribution actions to be performed, if the match criteria are met.

If the packets do not match any of the defined criteria, they are routed through the normal routing process.

Prerequisites

Command Syntax

set extcommunity { rt | soo } EXTCOMMNUMBER [ …EXTCOMMNUMBER ]

no set extcommunity { rt | soo }

Command Mode

Route-map Configuration

Default

No set extcommunity is specified by default.

Usage

This command is valid for BGP only.

Examples

Switch# configure terminal
Switch(config)# route-map rmap1 permit 3
Switch(config-route-map)# set extcommunity rt 06:01
Switch# configure terminal
Switch(config)# route-map rmap1 permit 3
Switch(config-route-map)# set extcommunity rt 0.0.0.6:01
Switch# configure terminal
Switch(config)# route-map rmap1 permit 3
Switch(config-route-map)# set extcommunity soo 06:01
Switch# configure terminal
Switch(config-route-map)# route-map rmap1 permit 3
Switch(config-route-map)# set extcommunity soo 0.0.0.6:01

Related Commands

None

Command Purpose

Use this command to set the specified next-hop ipv6 address value.

Use the no parameter with this command to turn off the setting.

Use this command to set the next-hop IPv6 address to the routes.

Prerequisites

Command Syntax

set ipv6 next-hop [ local ] IPV6_ADDR

no set ipv6 next-hop [ local ]

Command Mode

Route-map Configuration

Default

No set ipv6 next-hop is specified by default.

Usage

This command is valid for BGP, OSPFv3, and RIPng only.

Examples

Switch# configure terminal
Switch(config)# route-map mymap permit 3
Switch(config-route-map)# set ipv6 next-hop 2001:db8::1

Related Commands

None

Command Purpose

Use this command to set the specified local-preference value.

Use the no parameter with this command to turn off the setting.

Use this command to set the local-preference value of the routes

Prerequisites

Command Syntax

set local-preference LOCAL-PREFERENCE

no set local-preference

Command Mode

Route-map Configuration

Default

No set local-preference is specified by default.

Usage

This command is valid for BGP only.

Examples

Switch# configure terminal
Switch(config)# route-map mymap permit 3
Switch(config-route-map)# set local-preference 100

Related Commands

None

Command Purpose

Use this command to set a metric value for a route.

Use the no parameter with this command to disable this function.

This command sets the metric value for a route, and influences external neighbors about the preferred path into an Autonomous System (AS). The preferred path is the one with a lower metric value. A router compares metrics for paths from neighbors in the same ASs. To compare metrics from neighbors coming from different ASs, use the bgp always-compare-med command.

To use the set metric command, you must first have a match clause. Match and set commands set the conditions for redistributing routes from one routing protocol to another. The match command specifies the match criteria under which redistribution is allowed for the current route-map. The set command specifies the set redistribution actions to be performed, if the match criteria are met.

If the packets do not match any of the defined criteria, they are routed through the normal routing process.

Prerequisites

Command Syntax

set metric METRICVAL

no set metric

Command Mode

Route-map Configuration

Default

No set metric is specified by default.

Usage

This command is valid for BGP, OSPF and RIP.

Examples

Switch# configure terminal
Switch(config)# route-map rmap1 permit 3
Switch(config-route-map)# set metric 600

Related Commands

None

Command Purpose

Use this command to set the metric type for the destination routing protocol.

Use the no parameter with this command to return to the default.

This command sets the type to either Type-1 or Type-2 in the AS-external-LSA when the route-map matches the condition.

Prerequisites