-
Cisco IOS XR Routing Command Reference, Release 3.4
-
Preface
-
BGP Commands on Cisco IOS XR Software
-
EIGRP Commands on Cisco IOS XR Software
-
IS-IS Commands on Cisco IOS XR Software
-
OSPF Commands on Cisco IOS XR Software
-
OSPFv3 Commands on Cisco IOS XR Software
-
RIB Commands on Cisco IOS XR Software
-
RIP Commands on Cisco IOS XR Software
-
Routing Policy Language Commands on Cisco IOS XR Software
-
Static Routing Commands on Cisco IOS XR Software
-
Index
-
Table Of Contents
Routing Policy Language Commands on Cisco IOS XR Software
extcommunity soo matches-every
show rpl active extcommunity-set
show rpl as-path-set attachpoints
show rpl as-path-set references
show rpl community-set attachpoints
show rpl community-set references
show rpl inactive community-set
show rpl inactive extcommunity-set
show rpl inactive route-policy
show rpl prefix-set attachpoints
show rpl prefix-set references
show rpl route-policy attachpoints
show rpl route-policy references
show rpl unused extcommunity-set
Routing Policy Language Commands on Cisco IOS XR Software
This chapter describes the Cisco IOS XR software routing policy language (RPL) commands used to create, modify, monitor, and maintain routing policies.
For detailed information about RPL concepts, configuration tasks, and examples, see Implementing Routing Policy on Cisco IOS XR Software.
abort
To discard a route policy or set definition and return to global configuration mode, use the abort command in the appropriate configuration mode.
abort
Syntax Description
This command has no arguments or keywords.
Defaults
No default behavior or values
Command Modes
Route-policy configuration
Prefix set configuration
Route distinguisher set configuration
AS path set configuration
Community set configuration
Extended community set configurationCommand History
Release 3.3.0
This command was introduced on the Cisco CRS-1 and Cisco XR 12000 Series Router.
Release 3.4.0
No modification.
Usage Guidelines
To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS XR Software module of the Cisco IOS XR System Security Configuration Guide.
Task ID
Examples
The following example shows how to discard a route policy definition that was started and return to global configuration mode:
RP/0/RP0/CPU0:router(config)# route-policy policy_1RP/0/RP0/CPU0:router(config-rpl)# if as-path is-local thenRP/0/RP0/CPU0:router(config-rpl-if)# abortRP/0/RP0/CPU0:router(config)#The following example shows how to discard a prefix set definition that was started and return to global configuration mode:
RP/0/RP0/CPU0:router(config)# prefix-set legal-ipv4-prefix-examplesRP/0/RP0/CPU0:router(config-pfx)# 10.0.1.1,RP/0/RP0/CPU0:router(config-pfx)# 10.0.2.0/24,RP/0/RP0/CPU0:router(config-pfx)# abortRP/0/RP0/CPU0:router(config)#Related Commands
add
To add a value to an Routing Information Protocol (RIP) or Enhanced Interior Gateway Protocol (EIGRP) existing metric, use the add command in route-policy configuration mode.
add {eigrp-metric bandwidth delay reliability loading max-transmission | rip-metric {number | parameter}}
Syntax Description
Defaults
No default behavior or values
Command Modes
Route-policy configuration
Command History
Release 3.3.0
This command was introduced on the Cisco CRS-1 and Cisco XR 12000 Series Router.
Release 3.4.0
No modification.
Usage Guidelines
To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS XR Software module of the Cisco IOS XR System Security Configuration Guide.
If the add value is greater than the maximum allowed value, the metric is added. If the resulting metric exceeds the maximum for the routing protocol, then the route is dropped (by the client routing protocol).
Task ID
Examples
The following example shows how to offset the RIP metric value:
RP/0/RP0/CPU0:router(config)# route-policy policy_1RP/0/RP0/CPU0:router(config-rpl)# add rip-metric 4RP/0/RP0/CPU0:router(config-rpl)# end-policyapply
To execute a parameterized or unparameterized policy from within another policy, use the apply command in route-policy configuration mode.
apply name [parameter1, parameter2, . . . , parameterN]
Syntax Description
Defaults
No default behavior or values
Command Modes
Route-policy configuration
Command History
Usage Guidelines
To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS XR Software module of the Cisco IOS XR System Security Configuration Guide.
Use the apply command to execute a policy (either parameterized or unparameterized) from within another policy, which allows for the reuse of common blocks of policy.
Task ID
Examples
In the following example, the policy CustomerIn applies the route-policy SetLocalPref to conditionally set the local preference on a route. The parameters 20, 30, 40, and 50 are passed to the parameterized policy SetLocalPref, where the local preference is set to:
•
20, if the community 217:20 is present in the route
•
•
•
RP/0/RP0/CPU0:router(config)# route-policy CustomerInRP/0/RP0/CPU0:router(config-rpl)# apply SetLocalPref (20, 30, 40, 50)RP/0/RP0/CPU0:router(config-rpl)# end-policyRP/0/RP0/CPU0:router(config)# route-policy SetLocalPref ($lp1, $lp2, $lp3, $lp4)RP/0/RP0/CPU0:router(config-rpl)# if community matches-any (217:$lp1) thenRP/0/RP0/CPU0:router(config-rpl-if)# set local-preference $lp1RP/0/RP0/CPU0:router(config-rpl-elseif)# elseif community matches-any (217:$lp2) thenRP/0/RP0/CPU0:router(config-rpl-elseif)# set local-preference $lp2RP/0/RP0/CPU0:router(config-rpl-elseif)# elseif community matches-any (217:$lp3) thenRP/0/RP0/CPU0:router(config-rpl-elseif)# set local-preference $lp3RP/0/RP0/CPU0:router(config-rpl-elseif)# elseif community matches-any (217:$lp4) thenRP/0/RP0/CPU0:router(config-rpl-elseif)# set local-preference $lp4RP/0/RP0/CPU0:router(config-rpl-elseif)# endifRP/0/RP0/CPU0:router(config-rpl)# end-policyas-path in
To match the AS path of a route to an AS path set, use the as-path in command in route-policy configuration mode.
as-path in {as-path-set-name | inline-as-path-set | parameter}
Syntax Description
Defaults
No default behavior or values
Command Modes
Route-policy configuration
Command History
Usage Guidelines
To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS XR Software module of the Cisco IOS XR System Security Configuration Guide.
Use the as-path in command as a conditional expression within an if statement to match the AS path of a route to an AS path set. The AS path is a sequence of autonomous system numbers traversed by a route.
Note
The as-path in command evaluates to true if at least one of the regular expressions defined in the associated AS path set matches the AS path attribute of the route.
In the case where the AS path set is defined but contains no elements in it, the as-path in conditional expression command returns false.
Task ID
Examples
For example, assume we have an AS path set named my-as-set defined as follows:
RP/0/RP0/CPU0:router(config)# as-path-set my-as-setRP/0/RP0/CPU0:router(config-as)# ios-regex '_12$',RP/0/RP0/CPU0:router(config-as)# ios-regex '_13$'RP/0/RP0/CPU0:router(config-as)# end-setand the following policy excerpt using an as-path-set-name argument:
RP/0/RP0/CPU0:router(config-rpl)# if as-path in my-as-set thenRP/0/RP0/CPU0:router(config-rpl-if)# set local-preference 100RP/0/RP0/CPU0:router(config-rpl-if)# endifRP/0/RP0/CPU0:router(config-rpl)#The AS path in condition evaluates to true if one or more of the regular expression matches in the set my-as-set match the AS path associated with the route. In the case of a defined but empty AS path set, this operator returns false.
The preceding policy excerpt is equivalent to the following version, which uses an inline-as-path set variable:
RP/0/RP0/CPU0:router(config-rpl)# if as-path in (ios-regex `_12$,ios-regex `_13$') thenRP/0/RP0/CPU0:router(config-rpl-if)# set local-preference 100RP/0/RP0/CPU0:router(config-rpl-if)# endifRP/0/RP0/CPU0:router(config-rpl)#as-path is-local
To determine if this router or another router within this autonomous system or confederation originated a Border Gateway Protocol (BGP) route, use the as-path is-local command in route-policy configuration mode.
as-path is-local
Syntax Description
This command has no arguments or keywords.
Defaults
No default behavior or values
Command Modes
Route-policy configuration
Command History
Usage Guidelines
To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS XR Software module of the Cisco IOS XR System Security Configuration Guide.
Use the as-path is-local command as a conditional expression within an if statement to determine if this router (or another router within this autonomous system or confederation) originated the route.
Note
Routes that are locally originated within the autonomous system or confederation carry an empty AS path. For the Border Gateway Protocol (BGP) specification, when a route is advertised across the autonomous system boundary or a confederation boundary, the local autonomous system number or confederation ID is appended to the autonomous system path. The AS path of a locally originated aggregate is also empty unless it has been modified by policy.
The is-local operator evaluates to true for autonomous system paths that are empty. An empty AS path is how an AS path that is local to our autonomous system is represented in BGP.
Task ID
Examples
In the following example, if the AS path is local, then the local preference is set to 100:
RP/0/RP0/CPU0:router(config-rpl)# if as-path is-local thenRP/0/RP0/CPU0:router(config-rpl-if)# set local-preference 100RP/0/RP0/CPU0:router(config-rpl-if)# endifRP/0/RP0/CPU0:router(config-rpl)#as-path length
To compare the number of ASN in the AS path of a Border Gateway Protocol (BGP) route, use the as-path length command in route-policy configuration mode.
as-path length {eq | is | ge | le} {number | parameter}
Syntax Description
Defaults
No default behavior or values
Command Modes
Route-policy configuration
Command History
Usage Guidelines
To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS XR Software module of the Cisco IOS XR System Security Configuration Guide.
Use the as-path length command as a conditional expression within an if statement to perform a conditional check based on the length of the AS path.
Note
This command takes either a specific integer value or a range of integer values specified with the ge and le operators. Any or all these integers can be parameterized. The operator counts one for each autonomous system in the path. In the case where the route may be aggregated and contain one or more AS sets, the length operator adds one for each set present, the occurrence of an AS set typically indicates that this route is an aggregated route, and the aggregated route had a component route that contained one of the autonomous systems in the set. Likewise, in the case of confederations, a count of one is added for each confederation in the path or each confederation set in the path. A null AS path has a length of zero.
Task ID
Examples
In the following example, if the AS path length equals 10, then the local preference is set to 100:RP/0/RP0/CPU0:router(config-rpl)# if as-path length eq 10 thenRP/0/RP0/CPU0:router(config-rpl-if)# set local-preference 100RP/0/RP0/CPU0:router(config-rpl-if)# endifRP/0/RP0/CPU0:router(config-rpl)#Related Commands
as-path neighbor-is
To test autonomous system numbers at the head of the AS path against a sequence of one or more values or parameters, use the as-path neighbor-is command in route-policy configuration mode.
as-path neighbor-is as-number-list [exact]
Syntax Description
Defaults
No default behavior or values
Command Modes
Route-policy configuration
Command History
Usage Guidelines
To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS XR Software module of the Cisco IOS XR System Security Configuration Guide.
Use the as-path neighbor-is command as a conditional expression within an if statement to test the autonomous system number or numbers at the head of the AS path against a sequence of one or more integral values or parameters. In other words, to test to learn if the sequence of autonomous system numbers matches the path beginning with the neighboring autonomous system from which this route was heard.
Note
This command has an equivalent regular expression (ios-regex). For example, AS path neighbor-is `1' would be `^1_'.
Task ID
Examples
The following are incomplete configuration examples:RP/0/RP0/CPU0:router(config-rpl)# if as-path neighbor-is '10' thenRP/0/RP0/CPU0:router(config-rpl-if)# if as-path neighbor-is '$asnum' thenRP/0/RP0/CPU0:router(config-rpl-if)# if as-path neighbor-is '10 20' thenThese statements evaluate to true when the first autonomous system numbers on the AS path match, in the same order, the supplied parameters or integer values in the neighbor-is statement. If the neighboring autonomous system location happens to be an AS-set, the operator evaluates to true if the corresponding argument to the neighbor-is operator is an element of the AS-set.
Without the exact keyword, repeated autonomous system numbers in the AS path are ignored. For example,
RP/0/RP0/CPU0:router(config-rpl)# if as-path neighbor-is '10 20' thenmatches an AS path beginning
10 10 10 20 ...and an AS path beginning:
10 20 ....With the exact keyword, repetitions are not ignored, therefore
RP/0/RP0/CPU0:router(config-rpl)# if as-path neighbor-is '10 20' exact thenmatches the second of these AS paths but not the first.
Related Commands
as-path originates-from
To compare an AS path against the AS sequence beginning with the AS number that originated a route, use the as-path originates-from command in route-policy configuration mode.
as-path originates-from as-number-list [exact]
Syntax Description
Defaults
No default behavior or values
Command Modes
Route-policy configuration
Command History
Usage Guidelines
To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS XR Software module of the Cisco IOS XR System Security Configuration Guide.
Use the as-path originates-from command as a conditional expression within an if statement to compare an AS path to the autonomous system sequence.
Note
The originates-from operator is similar to the neighbor-is operator, except that it looks at the autonomous system number at the opposite end of the AS path. In other words, it is comparing to the autonomous system that originated the route. It can take numbers or parameters, enclosed in single quotation marks, that represent a sequence of autonomous system numbers. When more than one number is specified in the list, the sequence of autonomous system numbers listed must appear as a subsequence in the AS path, with the last number corresponding to the autonomous system that originated the route.
Task ID
Examples
The following are incomplete configuration examples:
RP/0/RP0/CPU0:router(config-rpl)# if as-path originates-from '10 11' thenRP/0/RP0/CPU0:router(config-rpl-if)# if as-path originates-from '$asnum 11' thenThe first line of the preceding example evaluates to true if autonomous system 11 originated the route and then advertised it to autonomous system 10, from which the route was eventually propagated to us. In the case where the route has been aggregated, and the location of the originating autonomous system contains an AS-set, the originates-from operator evaluates to true if the argument to the originates-from operator is contained in the AS-set.
Without the exact keyword, repeated autonomous system numbers in the AS path are ignored. For example,
RP/0/RP0/CPU0:router(config-rpl)# if as-path originates-from '10 11' thenmatches an autonomous system path ending
...10 10 10 11and an autonomous system path ending
...10 11With the exact keyword, repetitions are not ignored, therefore
RP/0/RP0/CPU0:router(config-rpl)# if as-path originates-from '10 11' exact thenmatches the second of these autonomous system paths but not the first.
Related Commands
as-path passes-through
To verify if the supplied integer or parameter appears anywhere in the AS path or if the supplied sequence of integers and parameters appears, in the same order, anywhere in the AS path, use the as-path passes-through command in route-policy configuration mode.
as-path passes-through as-number-list [exact]
Syntax Description
Defaults
No default behavior or values
Command Modes
Route-policy configuration
Command History
Usage Guidelines
To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS XR Software module of the Cisco IOS XR System Security Configuration Guide.
Use the as-path passes-through command as a conditional expression within an if statement to verify if the specified integer or parameter appears anywhere in the AS path or if the sequence of integers and parameters appears.
Note
The passes-through operator takes a sequence of integers or parameters, enclosed in single quotation marks, as an argument. It can also take a single integer or parameter as an argument. It evaluates to true if the supplied integer or parameter appears anywhere in the AS path, or if the supplied sequence of integers and parameters appears, in the same order, anywhere in the AS path. This includes the originates-from or neighbor-is location in the AS path.
Task ID
Examples
The following are incomplete configuration examples:
RP/0/RP0/CPU0:router(config-rpl)# if as-path passes-through '10' thenRP/0/RP0/CPU0:router(config-rpl-if)# if as-path passes-through '$asnum' thenRP/0/RP0/CPU0:router(config-rpl-if)# if as-path passes-through '10 11' thenRP/0/RP0/CPU0:router(config-rpl-if)# if as-path passes-through '10 $asnum 12' thenWithout the exact keyword, repeated autonomous system numbers in the AS path are ignored. For example:
RP/0/RP0/CPU0:router(config-rpl)# if as-path passes-through '9 10 11' thenmatches an AS path containing
...9 10 10 10 11 ....and an AS path containing:
...9 10 11...With the exact keyword, repetitions are not ignored. Therefore:
RP/0/RP0/CPU0:router(config-rpl)# if as-path passes-through '9 10 11' exact thenmatches the second of these AS paths but not the first.
Related Commands
as-path-set
To create a named AS path set, use the as-path-set command in global configuration mode. To remove the named AS path set, use the no form of this command.
as-path-set name
no as-path-set name
Syntax Description
Defaults
No default behavior or values
Command Modes
Global configuration
Command History
Usage Guidelines
To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS XR Software module of the Cisco IOS XR System Security Configuration Guide.
Use the as-path-set command to create a named AS path set.
An AS path set comprises operations for matching an AS path attribute.
This command enters AS path set configuration mode, in which you can use the ios-regex keyword to indicate the type of regular expression. Single quotation marks are required around the regular expression.
The inline set form is a parenthesized list of comma-separated expressions.
See the "Understanding Regular Expressions, Special Characters and Patterns" appendix in Cisco IOS XR Getting Started Guide for information about forming regular expressions.
Task ID
Examples
The following is a sample definition of an AS path set named aset1:
RP/0/RP0/CPU0:router(config)# as-path-set aset1RP/0/RP0/CPU0:router(config-as)# ios-regex '_42$',RP/0/RP0/CPU0:router(config-as)# ios-regex '_127$'RP/0/RP0/CPU0:router(config-as)# end-setThis AS path set is composed of two elements. When used in a matching operation, this AS path set matches any route whose AS path ends with either the autonomous system number 42 or 127.
The following is a sample of an inline set:
RP/0/RP0/CPU0:router(config-rpl)# if as-path in (ios-regex '_42$', ios-regex$ '_127$')RP/0/RP0/CPU0:router(config-rpl-if)# passRP/0/RP0/CPU0:router(config-rpl-if)# endifRP/0/RP0/CPU0:router(config-rpl)#as-path unique-length
To perform specific checks based on the length of the AS path (match against the number of unique ASNs in the AS path), use the as-path unique-length command in route-policy configuration mode.
as-path unique-length {eq | is | ge | le} {number | parameter}
Syntax Description
Defaults
No default behavior or values
Command Modes
Route-policy configuration
Command History
Usage Guidelines
To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS XR Software module of the Cisco IOS XR System Security Configuration Guide.
Use the as-path unique-length command as a conditional expression within an if statement to perform a match based on the length of the AS path.
Note
The unique-length operator is similar to the length operator, except that when an AS path has been padded with the same autonomous system number multiple times, the operator counts only one when the route is padded. Therefore, given an AS path of 333 333 111 222 123 444 444 444, the unique-length operator would return a value of 5, whereas the length operator would return a value of 8.
Task ID
Examples
The following example shows show to perform checks based on the AS path length. If the AS path matches the specified values, the local preference is set to 100:
RP/0/RP0/CPU0:router(config-rpl)# if as-path unique-length eq 10 thenRP/0/RP0/CPU0:router(config-rpl-if)# if as-path unique-length ge 10 thenRP/0/RP0/CPU0:router(config-rpl-if)# if as-path unique-length le 10 thenRP/0/RP0/CPU0:router(config-rpl)# if as-path unique-length eq $integerparam thenRP/0/RP0/CPU0:router(config-rpl-if)# if as-path unique-length ge $geparam thenRP/0/RP0/CPU0:router(config-rpl-if)# if as-path unique-length le $leparam thenRP/0/RP0/CPU0:router(config-rpl)# set local-preference 100RP/0/RP0/CPU0:router(config-rpl)# endifRelated Commands
community is-empty
To check if a route has no community attributes associated with it, use the community is-empty command in route-policy configuration mode.
community is-empty
Syntax Description
This command has no arguments or keywords.
Defaults
No default behavior or values
Command Modes
Route-policy configuration
Command History
Usage Guidelines
To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS XR Software module of the Cisco IOS XR System Security Configuration Guide.
Use the community is-empty command as a conditional expression within an if statement to check if a route has community attributes associated with it.
Note
This command takes no arguments and evaluates to true only if the route has no community attributes associated with it.
Task ID
Examples
In the following example, if the route has no community attributes associated with it, then the local preference is set to 100:
RP/0/RP0/CPU0:router(config-rpl)# if community is-empty thenRP/0/RP0/CPU0:router(config-rpl-if)# set local-preference 100RP/0/RP0/CPU0:router(config-rpl-if)# endifRP/0/RP0/CPU0:router(config-rpl)#community matches-any
To match any elements of a community set, use the community matches-any command in route-policy configuration mode.
community matches-any {community-set-name | inline-community-set | parameter}
Syntax Description
Defaults
No default behavior or values
Command Modes
Route-policy configuration
Command History
Usage Guidelines
To use this command, you must be in a user group associated with a task group that includes the proper task IDs. For detailed information about user groups and task IDs, see the Configuring AAA Services on Cisco IOS XR Software module of the Cisco IOS XR System Security Configuration Guide.
Use the community matches-any command as a conditional expression within an if statement to match any element of a community set.
Note
A simple condition using the matches-any operator evaluates as true if at least one community element of the community attribute for the route matches an element in the community set operand. If no community in the route matches any of the specifications in the named or inline set, then the condition evaluates to false. Likewise, when there is no community at all in the route, the condition evaluates to false.
Matching of a community in the route to a specification in a named or an inline set is intuitive. If the community specification in a set is the familiar colon-separated decimal 16-bit numbers specification, or one of the well-known communities, the community matches the specification if the specification denotes the same 32-bit number as that in the route. If the community specification uses a wildcard, then the community in the route matches if it is one of the many communities denoted by the wildcard specification. In inline sets, community specifications may be parameterized, in which case the relevant matching is done when the value of the parameter has been supplied.
Communities may also be matched using range and regular expression operators. Range specifications are entered as follows: [low-value..high-value]. Either or both colon-separated halves of a community value may contain a range. The following are valid range specifications:
10:[100..1000][10..100]:80[10..100]:[100..2000]In addition, the private-as keyword may be used to specify the range from 64512 to 65534. Regular expressions are specified as the ios-regex keyword followed by a valid regular expression string.
Community values from the route are matched one at a time to the match specifications. Therefore, regex match specifications are expected to represent one individual community value and not a sequence of community values.
Task ID
Examples
In the following example, a named community set called my-community-set and a route policy called community-matches-any-example are created. The policy sets the local-preference to 100 for any route that has one or more of the communities in the my-community-set community set. If the route does not have any of these communities, the policy checks whether it has any communities whose first half is in the range from 10 to 25 and whose second half is the value 35, in which case it sets the local-preference to 200. Otherwise, it checks for a community value in the range of 30:100 to 30:500, in which case it sets the local-preference to 300.
RP/0/RP0/CPU0:router(confi
