abort (RPL)

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.

Command Default

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 configuration

Command History

Release

Modification

Release 3.3.0

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Task ID

Task ID

Operations

route-policy

read, write

Examples

The following example shows how to discard a route policy definition that was started and return to global configuration mode:

Syntax Description

Reliability metric. 255 is 100-percent reliable. Range is from 0 to 255.

loading

Effective bandwidth (loading). 255 is 100-percent loaded. Range is from 0 to 255.

max-transmission

Maximum transmission of the path. Range is from 0 to 65535.

rip-metric

Specifies an RIP metric attribute.

number

Value assigned to a four-bit unsigned integer. Range is from 0 to 16.

parameter

Parameter name. The parameter name must be preceded with a “$.”

Command Default

No default behavior or values

Command Modes

Route-policy configuration

Command History

Release

Modification

Release 3.3.0

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

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).

apply

To execute a parameterized or unparameterized policy from within another policy, use the apply command in route-policy configuration mode.

applypolicy_name
[ argument1, argument2, . . . , argumentN ]

Syntax Description

policy_name

Name of a route policy.

argument

(Optional) Parameter name. The argument can be a value (for example, '100' ) or a parameter (for example, '$parameter')

Command Default

No default behavior or values

Command Modes

Route-policy configuration

Command History

Release

Modification

Release 3.2

This command was introduced.

Release 4.2.1

Wildcard support was added for apply policy-names.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

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.

Wildcards can be used in apply policy names. This supports the nested wildcard apply scenario. A wildcard is specified by inserting an asterisk (*) in place of one of the portions of the apply policy name; the wildcard indicates that any value for that portion of the apply policy name matches. The nested wildcard apply policy allows wildcard (*) based apply nesting. The wildcard operation permits declaration of a generic apply statement that calls all policies that contain a specific defined set of alphanumeric characters, defined on the router.

Task ID

Task ID

Operations

route-policy

read, write

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:

as-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-pathin
{ as-path-set-name | inline-as-path-set | parameter }

Syntax Description

as-path-set-name

Name of an AS path set.

inline-as-path-set

Inline AS path set. The inline AS path set must be enclosed in parentheses.

parameter

Parameter name. The parameter name must be preceded with a “$.”

Command Default

No default behavior or values

Command Modes

Route-policy configuration

Command History

Release

Modification

Release 3.2

This command was introduced.

Release 3.4.0

The parameter argument was added.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

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

For a list of all conditional expressions available within an if statement, see the if command.

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

Task ID

Operations

route-policy

read, write

Examples

For example, assume we have an AS path set named my-as-set defined as follows:

RP/0/0/CPU0:router(config-rpl)# if as-path in my-as-set thenRP/0/0/CPU0:router(config-rpl-if)# set local-preference 100RP/0/0/CPU0:router(config-rpl-if)# endifRP/0/0/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:

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-pathis-local

Syntax Description

This command has no arguments or keywords.

Command Default

No default behavior or values

Command Modes

Route-policy configuration

Command History

Release

Modification

Release 3.2

This command was supported.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

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

For a list of all conditional expressions available within an if statement, see the if command.

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

Task ID

Operations

route-policy

read, write

Examples

In the following example, if the AS path is local, then the local preference is set to 100:

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-pathlength
{ eq | is | ge | le }
{ number | parameter }

Syntax Description

eq | is | ge | le

Equal to; greater than or equal to; less than or equal to.

number

Value assigned to an 11-bit unsigned integer. Range is from 0 to 2047.

parameter

Parameter name. The parameter name must be preceded with a “$.”

Command Default

No default behavior or values

Command Modes

Route-policy configuration

Command History

Release

Modification

Release 3.2

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

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

For a list of all conditional expressions available within an if statement, see the if command.

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

Task ID

Operations

route-policy

read, write

Examples

In the following example, if the AS path length equals 10, then the local preference is set to 100:

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-pathneighbor-isas-number-list
[ exact ]

Syntax Description

as-number-list

Numbers or parameters, enclosed in single quotation marks, that represent a sequence of autonomous system numbers.

Range for 2-byte Autonomous system numbers (ASNs) is 1 to 65535.

Range for 4-byte Autonomous system numbers (ASNs) in asplain format is 1 to 4294967295.

Range for 4-byte Autonomous system numbers (ASNs) is asdot format is 1.0 to 65535.65535.

exact

(Optional) Specifies that with the exact keyword, the as-number-list value must identically match the AS path for the route; without the exact keyword, any element in the as-number-list argument matches one or more occurrences of that element in the AS path for the route.

Command Default

No default behavior or values

Command Modes

Route-policy configuration

Command History

Release

Modification

Release 3.2

This command was introduced.

Release 3.4.0

The as-number-list 4-byte number range 1.0 to 65535.65535 was supported.

Release 3.9.0

Asplain format for 4-byte Autonomous system numbers notation was supported.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

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

For a list of all conditional expressions available within an if statement, see the if command.

This command has an equivalent regular expression (ios-regex). For example, AS path neighbor-is ‘1’ would be ‘^1_’.

Task ID

Task ID

Operations

route-policy

read, write

Examples

The following are incomplete configuration examples:

RP/0/0/CPU0:router(config-rpl)# if as-path neighbor-is '10' then RP/0/0/CPU0:router(config-rpl-if)# if as-path neighbor-is '$asnum' then RP/0/0/CPU0:router(config-rpl-if)# if as-path neighbor-is '10 20' then

These 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,

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-pathoriginates-fromas-number-list
[ exact ]

Syntax Description

as-number-list

Numbers or parameters, enclosed in single quotation marks, that represent a sequence of autonomous system numbers.

Range for 2-byte Autonomous system numbers (ASNs) is 1 to 65535.

Range for 4-byte Autonomous system numbers (ASNs) in asplain format is 1 to 4294967295.

Range for 4-byte Autonomous system numbers (ASNs) is asdot format is 1.0 to 65535.65535.

exact

(Optional) Specifies that with the exact keyword, the as-number-list value must identically match the AS path for the route; without the exact keyword, any element in the as-number-list argument matches one or more occurrences of that element in the AS path for the route.

Command Default

No default behavior or values

Command Modes

Route-policy configuration

Command History

Release

Modification

Release 3.2

This command was introduced.

Release 3.4.0

The as-number-list 4-byte number range 1.0 to 65535.65535 was supported.

Release 3.9.0

Asplain format for 4-byte Autonomous system numbers notation was supported.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

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

For a list of all conditional expressions available within an if statement, see the if command.

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.

The 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,

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-pathpasses-throughas-number-list
[ exact ]

Syntax Description

as-number-list

Numbers or parameters, enclosed in single quotation marks, that represent a sequence of autonomous system numbers.

Range for 2-byte Autonomous system numbers (ASNs) is 1 to 65535.

Range for 4-byte Autonomous system numbers (ASNs) in asplain format is 1 to 4294967295.

Range for 4-byte Autonomous system numbers (ASNs) is asdot format is 1.0 to 65535.65535.

exact

(Optional) Specifies that with the exact keyword, the as-number-list value must identically match the AS path for the route; without the exact keyword, any element in the as-number-list argument matches one or more occurrences of that element in the AS path for the route.

Command Default

No default behavior or values

Command Modes

Route-policy configuration

Command History

Release

Modification

Release 3.2

This command was introduced.

Release 3.4.0

The as-number-list 4-byte number range 1.0 to 65535.65535 was supported.

Release 3.9.0

Asplain format for 4-byte Autonomous system numbers notation was supported.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

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

For a list of all conditional expressions available within an if statement, see the if command.

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.

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-setname

noas-path-setname

Syntax Description

name

Name of the AS path set.

Command Default

No default behavior or values

Command Modes

Global configuration

Command History

Release

Modification

Release 3.2

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

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-regexkeyword 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 the Cisco IOS XR Getting Started Guide for the Cisco XR 12000 Series Router for information about forming regular expressions.

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-pathunique-length
{ eq | is | ge | le }
{ number | parameter }

Syntax Description

eq | is | ge | le

Equal to; greater than or equal to; less than or equal to.

number

Value assigned to an 11-bit unsigned integer. Range is from 0 to 2047.

parameter

Parameter name. The parameter name must be preceded with a “$.”

Command Default

No default behavior or values

Command Modes

Route-policy configuration

Command History

Release

Modification

Release 3.2

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

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

For a list of all conditional expressions available within an if statement, see the if command.

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

Task ID

Operations

route-policy

read, write

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:

Related 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.

communityis-empty

Syntax Description

This command has no arguments or keywords.

Command Default

No default behavior or values

Command Modes

Route-policy configuration

Command History

Release

Modification

Release 3.2

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

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

For a list of all conditional expressions available within an if statement, see the if command.

This command takes no arguments and evaluates to true only if the route has no community attributes associated with it.

Task ID

Task ID

Operations

route-policy

read, write

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/0/CPU0:router(config-rpl)# if community is-empty thenRP/0/0/CPU0:router(config-rpl-if)# set local-preference 100RP/0/0/CPU0:router(config-rpl-if)# endif

community matches-any

To match any elements of a community set, use the community matches-any command in route-policy configuration mode.

Syntax Description

Inline community set. The inline community set must be enclosed in parentheses.

parameter

Parameter name. The parameter name must be preceded with a “$.”

Command Default

No default behavior or values

Command Modes

Route-policy configuration

Command History

Release

Modification

Release 3.2

This command was introduced.

The BGP community matching operators were enhanced to allow comparisons on ranges and regular expressions.

Release 3.4.0

The parameter argument was added.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Use the community matches-any command as a conditional expression within an if statement to match any element of a community set.

Note

For a list of all conditional expressions available within an if statement, see the if command.

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

Task ID

Operations

route-policy

read, write

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.

Syntax Description

Inline community set. The inline community set must be enclosed in parentheses.

parameter

Parameter name. The parameter name must be preceded with a “$.”

Command Default

No default behavior or values

Command Modes

Route-policy configuration

Command History

Release

Modification

Release 3.2

This command was introduced.

The BGP community matching operators were enhanced to allow comparisons on ranges and regular expressions.

Release 3.4.0

The parameter argument was added.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Use the community matches-every command as a conditional expression within an if statement to match every element of a community set.

Note

For a list of all conditional expressions available within an if statement, see the if command.

A simple condition using the matches-every operator evaluates as true if every specification in the named set or inline set specified matches at least one community value in the route. If any community specification in the named or inline set is not matched, then the operation 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]

Therefore, a matches-every operation with two community range specifications means that a community must be present in the route that corresponds to each range. For example, in the following statement:

if community matches-every (10:[100..200],20:[100..200]) then

the statement evaluates as true if one or more communities in the route lie in the range 10:[100.200] and one or more communities in the route lie in the range 20:[100..200].

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 single-quoted regular expression string. Community values from the route are matched one at a time against the match specifications. Therefore, regex match specifications are expected to represent one individual community value and not a sequence of community values.

Task ID

Task ID

Operations

route-policy

read, write

Examples

In the following example, the route policy named community-matches-every-example sets the local-preference value to 100 for all routes that have all three communities in the my-community-set community set. Routes that do not have all three communities but have a community that matches the first regular expression match have the local-preference value set to 200. Finally, any remaining routes that match the last regular expression have the local-preference values set to 300.

Related Commands

community-set

To define a community set, use the community-set command in global configuration mode. To remove the community set, use the no form of this command.

community-setname

nocommunity-setname

Syntax Description

name

Name of the community set.

Command Default

No default behavior or values

Command Modes

Global configuration

Command History

Release

Modification

Release 3.2

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Regular expressions and ranges can be specified to match the communities. An attempt to use a community set that contains a range or regular expression to set a community value is rejected when an attempt to attach such a policy is made.

A community set holds community values for matching against the Border Gateway Protocol (BGP) community attribute. A community is a 32-bit quantity. For notational convenience, each community value must be split in half and expressed as two unsigned decimal integers in the range from 0 to 65535, separated by a colon.

The inline form of a community set also supports parameterization. Each 16-bit portion of the community may be parameterized.

The routing policy language (RPL) provides symbolic names for the standard well-known community values: accept-own is 0xFFFF0001, internet is 0:0, no-export is 65535:65281, no-advertise is 65535:65282, and local-as is 65535:65283.

RPL also provides a facility for using wildcards in community specifications. A wildcard is specified by inserting an asterisk (*) in place of one of the 16-bit portions of the community specification, which indicates that any value for that portion of the community matches.

Every community set must contain at least one community value. An empty community set is invalid and the policy configuration system rejects it.

Community sets can be entered in these formats:

Format

Description

#-remark

Remark beginning with '#'

*

Wildcard (any community or part thereof)

0-65535

16-bit half-community number

[

Left bracket to begin range

accept-own

Accept-Own (BGP well-known community)

dfa-regex

DFA (deterministic finite automata) style regular expression

internet

Internet (BGP well-known community)

ios-regex

Traditional IOS style regular expression

local-AS

Do not send outside local AS (BGP well-known community)

no-advertise

Do not advertise to any peer (BGP well-known community)

no-export

Do not export to next AS (BGP well-known community)

private-as

Match within BGP private AS range [64512..65534]

Note

The dfa-regex and ios-regex syntax for community set is "['][^':&<> ]*:[^':&<> ]*[']". This means that regex starts with a single-quote (") followed by a string of any character (that does not include single-quote, colon, ampersand, less-than, greater-than, or space) followed by a colon, and a string of any characters (that does not include single-quote, colon, ampersand, less-than, greater-than, or space) followed by single-quote.

Task ID

Task ID

Operations

route-policy

read, write

Examples

In the follwoing example, a community set named cset_accept_own is created:

Syntax Description

Removes any communities associated with the route that are listed in either the named community set or the inline community set.

community-set-name

Name of a community set.

inline-community-set

Inline community set. The inline community set must be enclosed in parentheses.

parameter

Parameter name. The parameter name must be preceded with a “$.”

not in

Removes all communities that are not listed in either the named community set or the inline community set, and are not well-known communities.

Command Default

No default behavior or values

Command Modes

Route-policy configuration

Command History

Release

Modification

Release 3.2

This command was introduced.

The BGP community deletion operations were extended to allow communities that match a range specification or a regular expression to be deleted.

Release 3.4.0

The parameter argument was added.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Use the delete community command to delete community attributes associated with a BGP route.

Note

The delete community command can be used as an action statement within an if statement. For a list of all action statements available within an if statement, see the if command.

Communities are 32-bit values carried in Border Gateway Protocol (BGP) routes. Each route may have zero or more communities in an unordered list.

You can remove a well-known community (internet, no-export, no-advertise, or local-as) from a route, but this removal must be done explicitly. This command should be used with a degree of caution. In general, few circumstances exist in which you would need to remove a well-known community.

Task ID

Task ID

Operations

route-policy

read, write

Examples

The following example shows how to delete any communities associated with the routes that are listed in either the named community set or inline community set, respectively.

RP/0/0/CPU0:router(config-rpl)# delete community in my_community_setRP/0/0/CPU0:router(config-rpl)# delete community in (10:[0..50],20:[60..80])

The following example shows how to remove all communities including well-known communities.

Syntax Description

Removes any extended communities associated with the routes that are listed in either the named extended community set or the inline extended community set.

extcommunity-set-name

Name of an extended community set.

inline-extcommunity-set

Inline extended community set. The inline extended community set must be enclosed in parentheses.

parameter

Parameter name. The parameter name must be preceded with a “$.”

not in

Removes all extended communities that are not listed in either the named extended community set or the inline extended community set, and are not well-known extended communities.

Command Default

No default behavior or values

Command Modes

Route-policy configuration

Command History

Release

Modification

Release 3.2

This command was introduced.

Release 3.4.0

The parameter argument was added.

Release 3.5.0

Support was added for the usage of Wildcards (*) and regular expressions for extended community set elements.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Use the delete extcommunity rt command to delete extended community values from a BGP route target extended community list in a route.

Note

The delete extcommunity rt command can be used as an action statement within an if statement. For a list of all action statements available within an if statement, see the if command.

Extended communities are similar to regular Border Gateway Protocol (BGP) communities but contain more data and have a richer structure for encoding information in them.

Extended communities can be in the following forms: SoO:AS:tag, SoO:IP:tag, RT:AS:tag, or RT:IP:tag.

Wildcards (*) and regular expressions are allowed for extended community set elements.

The forms of this command that take a named extended community set or an inline extended community set value as arguments are equivalent. They delete any extended communities that are listed in either the named set or the inline set, respectively.

Task ID

Task ID

Operations

route-policy

read, write

Examples

In the following example, all extended communities are deleted:

RP/0/0/CPU0:router(config-rpl)# delete extcommunity rt all

In this example, any extended communities that are listed in my-extcommunity-set are deleted:

destination in

To match a destination entry in a named prefix set or inline prefix set, use the destination in command in route-policy configuration mode.

destinationin
{ prefix-set-name | inline-prefix-set | parameter }

Syntax Description

prefix-set-name

Name of a prefix set.

inline-prefix-set

Inline prefix set. The inline prefix set must be enclosed in parentheses.

parameter

parameter

Parameter name. The parameter name must be preceded with a “$.”

Command Default

No default behavior or values

Command Modes

Route-policy configuration

Command History

Release

Modification

Release 3.2

This command was introduced.

Release 3.4.0

The parameter argument was added.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Use the destination in command as a conditional expression within an if statement to match a destination entry in a named prefix set or inline prefix set.

Note

For a list of all conditional expressions available within an if statement, see the if command.

This command takes either a named prefix set or an inline prefix set value as an argument. The condition returns true if the destination entry matches any entry in the prefix set or inline prefix set. An attempt to match a destination using a prefix set that is defined but contains no elements returns false.

The routing policy language (RPL) provides the ability to test destinations for a match to a list of prefix match specifications using the in operator. The destination in command is protocol-independent.

In Border Gateway Protocol (BGP), the destination of a route is also known as its network-layer reachability information (NLRI). It comprises a prefix value and a mask length.

Task ID

Task ID

Operations

route-policy

read, write

Examples

In the following example, a prefix set named my-prefix-set is defined and a route policy named use-destination-in is created. Within the use-destination-in route policy, the destination in command is used within an if statement to learn if the destination is in the prefix-set named my-prefix-set. If it is, then local preference is set to 100. If it is not in my-prefix-set but does match the next prefix specifications, then local preference is set to 200.

In the following example, a prefix set named ipv6-prefix-set is defined and a route policy named ipv6-destination-in is created. Within the ipv6-destination-in route policy, the destination in command is used within an if statement to learn if the destination is in the prefix-set named ipv6-prefix-set. If it is, then the next-hop is set to 2001:abcd:fedc::1. If it is not in ipv6-prefix-set but does match the next prefix specifications, then the next-hop is set to 1111:2222:3333:4444:5555:6666:7777:8888.

done

To stop executing a policy and accept the route, use the done command in route-policy configuration mode.

done

Syntax Description

This command has no arguments or keywords.

Command Default

No default behavior or values

Command Modes

Route-policy configuration

Command History

Release

Modification

Release 3.5.0

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Use the done command to stop executing the policy and accept the route.

Note

The done command can be used as an action statement within an if statement. For a list of all action statements available within an if statement, see the if command.

When encountering a done statement the route is passed and no further policy statements are executed. All modifications made to the route prior to the done statement are still valid.

Note

The default action of a route policy is to drop or discard any routes that have not been either explicitly passed or for which no attempt has been made to modify with an action. The routing policy language (RPL) does not have specific “match clauses,” which means the default drop behavior is controlled by whether a route has been explicitly passed or an attempt has been to modify the route using an action statement.

Task ID

Task ID

Operations

route-policy

read, write

Examples

In the following example, if the destination match succeeds for 29.0.0.0/8 le 32, the execution continues past set community 102:12 and onto the next statement. If the destination match succeeds for 39.0.0.0/8 le 32 execution, then the policy execution stops when in encounters the done statement.

RP/0/0/CPU0:router(config)# route-policy done_st_exampleRP/0/0/CPU0:router(config-rpl)# if destination in (29.0.0.0/8 le 32) thenRP/0/0/CPU0:router(config-rpl-if)# set community 102:12RP/0/0/CPU0:router(config-rpl-if)# endifRP/0/0/CPU0:router(config-rpl)# if destination in (39.0.0.0/8 le 32) thenRP/0/0/CPU0:router(config-rpl-if)# set community 102:39RP/0/0/CPU0:router(config-rpl-if)# doneRP/0/0/CPU0:router(config-rpl-if)# endifRP/0/0/CPU0:router(config-rpl)# if destination in (49.0.0.0/8 le 32) thenRP/0/0/CPU0:router(config-rpl-if)# set community 102:49RP/0/0/CPU0:router(config-rpl-if)# endifRP/0/0/CPU0:router(config-rpl)# if destination in (59.0.0.0/8 le 32) thenRP/0/0/CPU0:router(config-rpl-if)# set community 102:59RP/0/0/CPU0:router(config-rpl-if)# endifRP/0/0/CPU0:router(config-rpl)# end-policy

drop

To discard a route, use the drop command in route-policy configuration mode.

drop

Syntax Description

This command has no arguments or keywords.

Command Default

No default behavior or values

Command Modes

Route-policy configuration

Command History

Release

Modification

Release 3.2

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Use the drop command within a route policy to drop a route.

Note

The drop command can be used as an action statement within an if statement. For a list of all action statements available within an if statement, see the if command.

This command causes the route to be dropped. After a route is dropped, no further execution of policy occurs. Therefore, if after executing the first two statements of a policy the drop statement is encountered, the route is discarded and execution stops immediately even when the policy contains further statements.

Note

The default action of a route policy is to drop or discard any routes that have not been either explicitly passed or attempted to be modified with an action. The routing policy language (RPL) does not have specific “match clauses,” which means the default drop behavior is controlled by whether a route has been explicitly passed or an attempt has been to modify the route using an action statement.

Task ID

Task ID

Operations

route-policy

read, write

Examples

In the following example, any route with a destination address contained within the prefix set pset1 is dropped:

Edits the contents of an extended community set of the specified type.

rt

Edits the BGP route target (RT) extended community.

soo

Edits the BGP site of origin (SoS) extended community.

policy-global

Edits the contents of policy-global definitions.

rd-set

Edits the contents of a route-distinguisher set.

name

Name of a route policy, a prefix set, an AS path set, a community set, or an extended community set, RD set, or global parameters.

nano

(Optional) Uses GNU Nano text editor.

emacs

(Optional) Uses Micro Emacs editor.

vim

(Optional) Uses VI Improved editor.

inline

(Optional) Uses the command line.

add

Appends the element to the set.

prepend

Prepends the element to the set.

remove

Removes the element from the set.

set-element

Value of the set element.

Note

To inline edit multiple set elements separated with comma, use quotes to club the entries as a single argument. Example:

edit extcommunity-set rt rt_set inline add "4:4,5:4"

Command Default

Default editor is GNU nano text editor

Command Modes

EXEC

Command History

Release

Modification

Release 3.2

This command was introduced.

Release 3.3.0

Added vim keyword.

Release 3.4.0

The policy-global keyword was added.

Release 3.5.0

The nano keyword was added and GNU nano text editor became the default editor type.

Release 3.6.0

The following keywords and arguments were added:

inline

add

prepend

remove

set-element

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Use the edit command to edit the contents of a route policy, a prefix set, an AS path set, a community set, an extended community set, a global policy, or a route destination set.

After editing with Nano, save the edit buffer and exit the editor using the Ctrl-X keystroke.

After editing with Emacs, save the editor buffer by using the Ctrl-X and Ctrl-S keystrokes. To save and exit the editor, use the Ctrl-X and Ctrl-C keystrokes.

After editing with VIM, to write to a current file and exit use the :wq or :x or ZZ keystrokes. To quit and confirm, use the :q keystrokes. To quit and discard changes, use the :q! keystrokes.

Task ID

Task ID

Operations

route-policy

read, write

Examples

In the following example, the policy_A policy is opened in the editor:

If you answer yes , the editor continues on the text buffer from where you left off. If you answer no, the running configuration is not changed and the editing session is ended.

After the policy is opened, it may be manipulated using normal editor commands, then saved and committed to the running configuration.

end-global

To end the definition of global parameters and exit global parameter configuration mode, use the end-global command in global parameter configuration mode.

end-global

Syntax Description

This command has no arguments or keywords.

Command Default

No default behavior or values

Command Modes

Global parameter configuration

Command History

Release

Modification

Release 3.4.0

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Use the end-global command to end the definition of global parameters and exit global parameter configuration mode.

Task ID

Task ID

Operations

route-policy

read, write

Examples

In the following example, the end-global command ends the definition of global parameters:

Related Commands

end-policy

To end the definition of a route policy and exit route-policy configuration mode, use the end-policy command in route-policy configuration mode.

end-policy

Syntax Description

This command has no arguments or keywords.

Command Default

No default behavior or values

Command Modes

Route-policy configuration

Command History

Release

Modification

Release 3.2

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Use the end-policy command to end the definition of a route policy and exit route-policy configuration mode.

Task ID

Task ID

Operations

route-policy

read, write

Examples

In the following example, the end-policy command ends the definition of a route policy:

Related Commands

end-set

To end the definition of an AS path set, a prefix set, a community set, an extended community set, or an RD set and return to global configuration mode, use the end-set command in route-policy configuration mode.

end-set

Syntax Description

This command has no arguments or keywords.

Command Default

No default behavior or values

Command Modes

AS path set configuration

Prefix set configuration

Community set configuration

Extended community set configuration

Route distinguisher set configuration

Command History

Release

Modification

Release 3.2

This command was introduced.

Release 3.3.0

Added support functionality for the rd-set command.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Use the end-set command to end the definition of an AS path set, a prefix set, a community set, or an extended community set.

Task ID

Task ID

Operations

route-policy

read, write

Examples

In the following example, the end-set command ends the definition of an AS path set named aset1:

extcommunity rt is-empty

To check if a Border Gateway Protocol (BGP) route has route target (RT) extended community attributes associated with it, use the extcommunity rt is-empty command in route-policy configuration mode.

extcommunityrtis-empty

Syntax Description

This command has no arguments or keywords.

Command Default

No default behavior or value

Command Modes

Route-policy configuration

Command History

Release

Modification

Release 3.3.0

This command was introduced.

This command replaced the extcommunity is-empty command.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Use the extcommunity rt is-empty command as a conditional expression within an if statement to check if a BGP route has extended community attributes associated with it.

Note

For a list of all conditional expressions available within an if statement, see the if command.

The is-empty operator takes no arguments and evaluates to true if the route has no extended community attributes associated with it.

Task ID

Task ID

Operations

route-policy

read, write

Examples

In the following example, if the extended community is empty, then the local preference is set to 100:

Syntax Description

Inline RT extended community set. The inline extended community set must be enclosed in parentheses.

parameter

Parameter name. The parameter name must be preceded with a “$.”

Command Default

No default behavior or values

Command Modes

Route-policy configuration

Command History

Release

Modification

Release 3.3.0

This command was introduced.

This command replaced the extcommunity matches-any command.

Release 3.4.0

The parameter argument was added.

Release 3.5.0

Wildcards (*) and regular expressions are allowed for extended community set elements.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Use the extcommunity rt matches-any command as a conditional expression within an if statement to match elements of an extended community set.

Note

For a list of all conditional expressions available within an if statement, see the if command.

A simple condition using the matches-any operator evaluates as true if at least one extended community in the route matches an extended community specification in the named or inline set. If no extended community in the route matches any of the specifications in the named or inline set, then this simple condition evaluates to false. Likewise, when there is no extended community at all in the route, the condition evaluates to false.

Matching an extended community in the route to a specification in a named or an inline set is intuitive. In inline sets, extended community specifications may be parameterized, in which case the relevant matching is done when the value of the parameter has been supplied.

Task ID

Task ID

Operations

route-policy

read, write

Examples

In the following example, an extended community set named my-extcommunity-set and a parameterized route-policy named my-extcommunity-set-example($tag,$ip) are defined. The extcommunity rt matches-any command is used in an if statement such that if at least one extended community in the route matches an extended community specification in the named set, then the local preference is set to 100. If there is no extended community in the route that matches any of the specifications in the named set, then the condition evaluates as false and the extended community is compared to the inline extended sets.

Syntax Description

Inline RT extended community set. The inline extended community set must be enclosed in parentheses.

parameter

Parameter name. The parameter name must be preceded with a “$.”

Command Default

No default behavior or values

Command Modes

Route-policy configuration

Command History

Release

Modification

Release 3.3.0

This command was introduced.

This command replaced the extcommunity matches-every command.

Release 3.4.0

The parameter argument was added.

Release 3.5.0

Support was added for the usage of Wildcards (*) and regular expressions for extended community set elements.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Use the extcommunity rt matches-every command as a conditional expression within an if statement to match every element of an RT extended community set.

Note

For a list of all conditional expressions available within an if statement, see the if command.

A simple condition using the matches-every operator evaluates as true if every extended community value in the extended community attribute for the route matches at least one element of the extended community set or inline set. If no extended community in the route matches any of the specifications in the named or inline set, then this simple condition evaluates to false. Likewise, when there is no extended community at all in the route, the condition evaluates to false.

Matching an extended community in the route to a specification in a named or an inline set is intuitive. In inline sets, extended community specifications may be parameterized, in which case the relevant matching is done when the value of the parameter has been supplied.

Task ID

Task ID

Operations

route-policy

read, write

Examples

In the following example, an extended community set named my-extcommunity-set and a parameterized route policy named extcommunity-matches-every-example ($as, $tag) are defined. The condition extcommunity rt matches-every is used in an if statement in this policy. If it evaluates to true, the local-preference value is set to 100. If it evaluates to false, the extended community is evaluated using an inline set. If that condition evaluates to true, the local-preference value is set to 200. If it evaluates to false, the local-preference value is set to 300.

Syntax Description

Command Default

None

Command Modes

Route-policy configuration

Command History

Release

Modification

Release 4.2.0

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Use the extcommunity rt matches-within command as a conditional expression within an if statement to match elements of an extended community set.

Note

For a list of all conditional expressions available within an if statement, see the if command.

A simple condition using the matches-within operator evaluates as true if all the elements in extended community from the route match any element in the extended community set. For example, let 'c' be the RTs from the route and 'm' be the RT set from the policy. With the extcommunity rt matches-within configuration, each value in 'c' must match any (or at least one) value in 'm'.

Matching an extended community in the route to a specification in a named or an inline set is intuitive. In inline sets, extended community specifications may be parameterized, in which case the relevant matching is done when the value of the parameter has been supplied.

Task ID

Task ID

Operation

route-policy

read, write

Examples

In the following example, an extended community set named my-extcommunity-set and a parameterized route-policy named my-extcommunity-set-example($tag,$ip) are defined. The extcommunity rt matches-within command is used in an if statement such that if all extended community values in the route match any element of the extended community specification in the named set, then the local preference is set to 100.

extcommunity-set cost

To define a cost extended community set, use the extcommunity-set cost command in global configuration mode. To remove the cost extended community set, use the no form of this command.

extcommunity-setcostname

noextcommunity-setcostname

Syntax Description

name

Name of a cost extended community set. The name argument is case sensitive, can contain any alphanumeric characters, and can be up to 63 characters in length.

Command Default

No default behavior or values

Command Modes

Global configuration

Command History

Release

Modification

Release 3.3.0

This command was introduced.

Release 3.5.0

Support was added for the usage of Wildcards (*) and regular expressions for extended community set elements.

Release 3.9.0

Support was added for more cost extended community formats.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Use the extcommunity-set cost command to define a cost extended community set.

An extended community set is analogous to a community set except that it contains extended community values instead of regular community values. Extended community values are 64-bit structured values. An extended community set also supports named forms and inline forms.

Cost extended communities can be entered in these formats:

#-remark ---Remark beginning with '#'

0-255---Decimal number

abort ---Discard RPL definition and return to top level config

end-set ---End of set definition

exit ---Exit from the submode

igp:---Cost Community with IGP as point of insertion

pre-bestpath: ---Cost Community with Pre-Bestpath as point of insertion

show ---Show partial RPL configuration

Multiple cost community set clauses can be configured in each route policy block or sequence. Each cost community set clause must have a different ID (0-255). The cost community set clause with the lowest cost-value is preferred by the best path selection process when all other attributes are equal.

As with community sets, the inline form supports parameterization within parameterized policies. Either portion of the extended community value can be parameterized.

Every extended community set must contain at least one extended community value. Empty extended community sets are invalid and the policy configuration system rejects them.

Wildcards (*) and regular expressions are allowed for extended community set elements.

Examples

In the following example, a cost extended community set named extcomm-cost is defined:

extcommunity-set rt

To define a Border Gateway Protocol (BGP) route target (RT) extended community set, use the extcommunity-set rt command in global configuration mode. To remove the RT community set, use the no form of this command.

extcommunity-setrtname

noextcommunity-setrtname

Syntax Description

name

Name of an RT extended community set.

Command Default

No default behavior or values

Command Modes

Global configuration

Command History

Release

Modification

Release 3.3.0

This command was introduced.

This command replaced the extcommunity-set command.

Release 3.9.0

Support was added for more rt extended community formats.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Use the extcommunity-set rt command to define an RT extended community set for BGP.

Regular expressions and ranges can be specified to match the extended communities. Regular expressions and ranges can be specified in an extended community set to support the matching of communities. An attempt to use an extended community set that contains a range or regular expression to set an extended community set value is rejected when an attempt to attach such a policy is made.

An extcommunity set RT holds RT extended community values to match against the Border Gateway Protocol (BGP) RT extended community attribute. RT extended communities can be entered in these formats:

The dfa-regex and ios-regex syntax for community set is "['][^':&<> ]*:[^':&<> ]*[']". This means that regex starts with a single-quote (") followed by a string of any character (that does not include single-quote, colon, ampersand, less-than, greater-than, or space) followed by a colon, and a string of any characters (that does not include single-quote, colon, ampersand, less-than, greater-than, or space) followed by single-quote.

N is a number within the range of 1 to 65535.

Examples

In the following example, an RT extended community set named extcomm-rt is defined:

extcommunity-set soo

To define a Border Gateway Protocol (BGP) Site-of-Origin (SoO) extended community set, use the extcommunity-set soo command in global configuration mode. To remove the SoO extended community set, use the no form of this command.

extcommunity-setsooname

noextcommunity-setsooname

Syntax Description

name

Name of an SoO extended community set.

Command Default

No default behavior or values

Command Modes

Global configuration

Command History

Release

Modification

Release 3.3.0

This command was introduced.

This command replaced the extcommunity-set command.

Release 3.9.0

Support was added for more soo extended community formats.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Use the extcommunity-set soo command to define an SoO extended community set.

An extcommunity set soo holds SoO extended community values to match against the Border Gateway Protocol (BGP) SoO extended community attribute. SoO extended communities can be entered in these formats:

#-remark ---Remark beginning with '#'

*--- Wildcard (any community or part thereof)

1-4294967295---32-bit decimal number

1-65535 ---16-bit decimal number

A.B.C.D/M:N ---Extended community - IPv4 prefix format

A.B.C.D:N---Extended community - IPv4 format

ASN:N ---Extended community - ASPLAIN format

X.Y:N ---Extended community - ASDOT format

abort ---Discard RPL definition and return to top level config

dfa-regex ---DFA style regular expression

end-set ---End of set definition

exit ---Exit from the submode

ios-regex---Traditional IOS style regular expression

show ---Show partial RPL configuration

N is a site-specific number.

Examples

In the following example, a SoO extended community set named extcomm-soo is defined:

extcommunity soo is-empty

To determine if a Border Gateway Protocol (BGP) route has any Site-of-Origin (SoO) extended communities associated with it, use the extcommunity soo is-empty command in route-policy configuration mode.

extcommunitysoois-empty

Syntax Description

This command has no arguments or keywords.

Command Default

No default behavior or values

Command Modes

Route-policy configuration

Command History

Release

Modification

Release 3.3.0

This command was introduced.

This command replaced the extcommunity is-empty command.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Use the extcommunity soo is-empty command as a conditional expression within an if statement to check if a BGP SoO route has extended community attributes associated with it.

Note

For a list of all conditional expressions available within an if statement, see the if command.

The is-empty operator takes no arguments and evaluates to true if the route has no SoO extended community attributes associated with it.

Task ID

Task ID

Operations

route-policy

read, write

Examples

In the following example, if a route has no SoO extended communities associated with it, the local preference is set to 100:

Syntax Description

Inline SoO extended community set. The inline extended community set must be enclosed in parentheses.

parameter

Parameter name. The parameter name must be preceded with a “$.”

Command Default

No default behavior or values

Command Modes

Route-policy configuration

Command History

Release

Modification

Release 3.3.0

This command was introduced.

This command replaced the extcommunity matches-any command.

Release 3.4.0

The parameter argument was added.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Use the extcommunity soo matches-any command as a conditional expression within an if statement to match elements of an extended community set.

Note

For a list of all conditional expressions available within an if statement, see the if command.

A simple condition using the matches-any operator evaluates as true if at least one extended community in the route matches an extended community specification in the named or inline set. If no extended community in the route matches any of the specifications in the named or inline set, then this simple condition evaluates to false. Likewise, when there is no extended community at all in the route, the condition evaluates to false.

Matching an extended community in the route to a specification in a named or an inline set is intuitive. In inline sets, extended community specifications may be parameterized, in which case the relevant matching is done when the value of the parameter has been supplied.

Task ID

Task ID

Operations

route-policy

read, write

Examples

In the following example, an SoO extended community set named extcomm-soo and a parameterized route policy named my-extcommunity-set-example($tag,$ip) are defined.

The condition route policy named extcommunity soo matches-any is used in an if statement in this policy. If it evaluates to true, the local preference value is set to 100.

If it evaluates to false, the SoO extended community is evaluated using an inline set. If it evaluates to true, the local preference value is set to 200.

If it evaluates to false, the SoO extended community is evaluated using a different inline set. If it evaluates to true, the local preference value is set to 300.

If it evaluates to false, the SoO extended community is evaluated using a different inline set. If it evaluates to true, the local preference value is set to 400.

Syntax Description

Inline SoO extended community set. The inline extended community set must be enclosed in parentheses.

parameter

Parameter name. The parameter name must be preceded with a “$.”

Command Default

No default behavior or values

Command Modes

Route-policy configuration

Command History

Release

Modification

Release 3.3.0

This command was introduced.

This command replaced the extcommunity matches-every command.

Release 3.4.0

The parameter argument was added.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Use the extcommunity soo matches-every command as a conditional expression within an if statement to match every element of a SoO extended community set.

Note

For a list of all conditional expressions available within an if statement, see the if command.

A simple condition using the matches-every operator evaluates as true if every extended community value in the extended community attribute for the route matches at least one element of the extended community set or inline set. If no extended community in the route matches any of the specifications in the named or inline set, then this simple condition evaluates to false. Likewise, when there is no extended community at all in the route, the condition evaluates to false.

Matching an extended community in the route to a specification in a named or an inline set is intuitive. In inline sets, extended community specifications may be parameterized, in which case the relevant matching is done when the value of the parameter has been supplied.

Examples

In the following example, an extended community set named my-extcomm-rt-set and a parameterized route policy named extcommunity-matches-every-example($as, $tag) are defined. The condition extcommunity soo matches-every is used in an if statement in this policy and if it evaluates to true, the local-preference value is set to 100. If it evaluates to false, the extended community is evaluated using an inline set. If that condition evaluates to true, the local-preference value is set to 200. If it evaluates to false, the local-preference value is set to 300.

Syntax Description

Expression to decide which actions or dispositions should be taken for the given route.

then

Executes an action statement if the if condition is true.

elseif

Strings together a sequence of tests.

else

Executes an action statement if the if condition is false.

endif

Ends the if statement.

action-statement

Sequence of operations that modify a route.

Command Default

No default behavior or values

Command Modes

Route-policy configuration

Command History

Release

Modification

Release 3.2

This command was introduced.

Release 4.2.0

Support was added for Apply Condition Policies that allow the usage of a route-policy in an "if" statement of another route-policy.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

The if command uses a conditional expression to decide which actions or dispositions should be taken for a given route. Table 1 lists the conditional expressions.

An action statement is a sequence of operations that modify a route, most of which are distinguished by the set keyword. In a route policy, these operations can be grouped. Table 2 lists the action statements.

Apply Condition policies allow usage of a route-policy in an "if" statement of another route-policy.

Route-policy policy_name
If apply policyA and apply policyB then
Set med 100
Else if not apply policyD then
Set med 200
Else
Set med 300
Endif
End-policy

The policy configuration shown sets the value of the local preference attribute to 100 on any route that has a community value of 12:34 or 56:78 associated with it. However, if any of these routes has a Multi Exit Descriminator (MED) value of 150, then each route with both the community value of 12:34 or 56:78 and a MED of 150 is dropped.

local-preference

To compare the local-preference attribute of a BGP route to an integer value or a parameterized value, use the local-preference command in route-policy configuration mode.

local-preference
{ eq | is | ge | le }
{ number | parameter }

Syntax Description

eq | is | ge | le

Equal to; exact match; greater than or equal to; less than or equal to.

number

Value assigned to a 32-bit unsigned integer. Range is 0 to 4294967295.

parameter

Parameter name. The parameter name must be preceded with a “$.”

Command Default

No default behavior or values

Command Modes

Route-policy configuration

Command History

Release

Modification

Release 3.2

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Use the local- preference command as a conditional expression within an if statement to compare the local-preference attribute to an integer value or a parameterized value.

Note

For a list of all conditional expressions available within an if statement, see the if command.

The MED is a 32-bit unsigned integer. The eq operation compares the local-preference to either a static value or a parameterized value passed to a parameterized policy for equality with that value. A greater than or equal to comparison can also be done with the ge operator, and a less than or equal to comparison can be performed using the le operator.

Examples

The following example shows that if the local-preference is 10, local-preference is set to 100:

med

To compare the Multi Exit Discriminator (MED) to an integer value or a parameterized value or compare the MED attribute of a BGP route to an integer value, use the med command in route-policy configuration mode.

med
{ eq | is | ge | le }
{ number | parameter }

Syntax Description

eq | is | ge | le

Equal to; exact match; greater than or equal to; less than or equal to.

number

Value assigned to a 32-bit unsigned integer. Range is 0 to 4294967295.

parameter

Parameter name. The parameter name must be preceded with a “$.”

Command Default

No default behavior or values

Command Modes

Route-policy configuration

Command History

Release

Modification

Release 3.2

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Use the med command as a conditional expression within an if statement to compare the MED to an integer value or a parameterized value.

Note

For a list of all conditional expressions available within an if statement, see the if command.

The MED is a 32-bit unsigned integer. The eq operation compares the MED to either a static value or a parameterized value passed to a parameterized policy for equality with that value. A greater than or equal to comparison can also be done with the ge operator, and a less than or equal to comparison can be performed using the le operator.

Task ID

Task ID

Operations

route-policy

read, write

Examples

The following example shows that if the med commands match, the local preference is set to 100:

next-hop in

To compare the next-hop associated with the route to data contained in either an inline or a named prefix set, use the next-hop in command in route-policy configuration mode.

next-hopin
{ prefix-set-name | inline-prefix-set | parameter }

Syntax Description

prefix-set-name

Name of a prefix set.

inline-prefix-set

Inline prefix set. The inline prefix set must be enclosed in parentheses.

parameter

Parameter name. The parameter name must be preceded with a “$.”

Command Default

No default behavior or values

Command Modes

Route-policy configuration

Command History

Release

Modification

Release 3.2

This command was introduced.

Release 3.4.0

The parameter argument was added.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Use the next-hop in command as a conditional expression within an if statement to compare the next-hop associated with the route to data contained in either an inline or a named prefix set. The result is true if any value in the prefix set matches the next-hop of the route. A comparison that refers to a named prefix set that has no elements in it returns false.

Note

For a list of all conditional expressions available within an if statement, see the if command.

The next-hop is an IPv4 address entered as a dotted-decimal or an IPv6 address entered as a colon-separated hexadecimal.

Task ID

Task ID

Operations

route-policy

read, write

Examples

The following example shows that if the next-hop in commands match, the local preference is set to 100

RP/0/0/CPU0:router(config-rpl)# if next-hop in some-prefix-set thenRP/0/0/CPU0:router(config-rpl-if)# if next-hop in (10.0.0.5, fe80::230/64) thenRP/0/0/CPU0:router(config-rpl-if)# set local-preference 0RP/0/0/CPU0:router(config-rpl-if)# endifRP/0/0/CPU0:router(config-rpl)#

orf prefix in

To configure an outbound route filter (ORF), use the orf prefix in command in route-policy configuration mode.

orfprefixin
{ prefix-set-name | inline-prefix-set }

Syntax Description

prefix-set-name

Name of a prefix set.

inline-prefix-set

Inline prefix set. The inline prefix set must be enclosed in parentheses.

Command Default

No default behavior or values

Command Modes

Route-policy configuration

Command History

Release

Modification

Release 3.3.0

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Use the orf prefix in command to match a prefix in a prefix set or an inline prefix set.

This command takes either a named prefix set or an inline prefix set value as an argument. It returns true if the destination NLRI matches any entry in the prefix set. An attempt to match destination using a prefix set that is defined but contains no elements returns false.

This command is used in the context of the orf route-policy attach point in BGP. The destination of a route is also known in Border Gateway Protocol (BGP) as its network-layer reachability information (NLRI). It comprises a prefix value and a mask length. The routing policy language (RPL) provides one operation on prefixes, testing them for matching against a list of prefix-match specifications using the in operator.

Examples

In the following example, the prefix set orfpreset1 and the route policy named orfpolicy are defined. Next, the orfpolicy is applied to the neighbor orf attach point.

If the prefix of the route matches any of the prefixes specified in orfpreset1 (211.105.1.0/24, 211.105.5.0/24, 211.105.11.0/24), then the prefix is dropped. If the prefix matches in(211.105.3.0/24, 211.105.7.0/24, 211.105.13.0/24), then the prefix is accepted. In addition to this inbound filtering, BGP sends these prefix entries to the upstream neighbor indicating a permit or deny so that the neighbor can make the same filter updates.

Related Commands

origin is

To match a specific origin type, use the origin is command in route-policy configuration mode.

originis
{ igp | egp | incomplete | parameter }

Syntax Description

igp

Specifies Interior Gateway Protocol.

egp

Specifies Exterior Gateway Protocol.

incomplete

Specifies that Border Gateway Protocol (BGP) first learned the route by means other than BGP or Interior Gateway Protocol (IGP); for example, the route is learned through configuration.

parameter

Parameter name. The parameter name must be preceded with a “$.”

Command Default

No default behavior or values

Command Modes

Route-policy configuration

Command History

Release

Modification

Release 3.2

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Use the origin is command as a conditional expression within an if statement to test the value of the origin attribute.

Note

For a list of all conditional expressions available within an if statement, see the if command.

The origin of a BGP route is an enumeration; it is igp, egp, or incomplete.

This command can be parameterized.

Task ID

Task ID

Operations

route-policy

read, write

Examples

In the following example, the origin is tested within an if statement to learn if it is either igp or egp:

RP/0/0/CPU0:router(config-rpl)# if origin is igp or origin is egp then

In the following example, a parameter is used to match a specific origin type:

pass

To pass a route for further processing, use the pass command in route-policy configuration mode.

pass

Syntax Description

This command has no arguments or keywords.

Command Default

No default behavior or values

Command Modes

Route-policy configuration

Command History

Release

Modification

Release 3.2

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Use the pass command to signify that even though this route has not been modified, the user wants to continue executing in this policy block.

Note

The pass command can be used as an action statement within an if statement. For a list of all action statements available within an if statement, see the if command.

When a policy block has finished executing, any route that has been modified in this policy block or has received a pass disposition in this policy block passes the policy and execution finishes for that policy. If this policy block is applied from within another policy block and the route is either passed or modified, then execution continues in the policy block that applied this policy block.

Task ID

Task ID

Operations

route-policy

read, write

Examples

The following example shows how to accept the route unconditionally without modifying it:

RP/0/0/CPU0:router(config-rpl)# pass

This example accepts the route unconditionally, without modifying it, if the destination is in prefix-set permitted:

path-type is

To match path types, use the path-type is command in route-policy configuration mode.

path-typeis
{ ibgp | ebgp | parameter }

Syntax Description

ibgp

Specifies an internal BGP path.

ebgp

Specifies an external BGP path.

parameter

Parameter name. The parameter name must be preceded with a “$.”

Command Default

No default behavior or values

Command Modes

Route-policy configuration

Command History

Release

Modification

Release 3.4.0

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Use the path-type is command as a conditional expression within an if statement to match path types.

Note

For a list of all conditional expressions available within an if statement, see the if command.

Task ID

Task ID

Operations

route-policy

read, write

Examples

In the following example, if the path is an external BGP path the route is accepted:

policy-global

To define global parameters and enter global parameter configuration mode, use the policy-global command in global configuration mode. To remove global parameters, use the no form of this command.

policy-global

nopolicy-global

Syntax Description

This command has no arguments or keywords.

Command Default

No default behavior or values

Command Modes

Global configuration

Command History

Release

Modification

Release 3.4.0

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

RPL supports the definition of systemwide global parameters that can be used inside a policy definition. The global parameter values can be used directly inside a policy definition similar to the local parameters of parameterized policy. When a parameterized policy has a parameter name “collision” with a global parameter name, parameters local to policy definition take precedence, effectively ‘masking off’ global parameters. In addition, a validation mechanism is in place to prevent the deletion of a particular global parameter if it is referred by any policy. For more information on global parameters and parameterization, see the Implementing Routing Policy on Cisco ASR 9000 Series RouterCisco IOS XR Softwaremodule of the Cisco IOS XR Routing Configuration Guide for the Cisco XR 12000 Series Router

Related Commands

prefix-set

To enter prefix set configuration mode and define a prefix set, use the prefix-set command in global configuration mode. To remove a named prefix set, use the no form of this command.

prefix-setname

noprefix-setname

Syntax Description

name

Name of a prefix set.

Command Default

No default behavior or values

Command Modes

Global configuration

Command History

Release

Modification

Release 3.2

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Use the prefix-set command to enter prefix set configuration mode and define a prefix set.

A prefix set is a comma-separated list of prefix match specifications. It holds IPv4 or IPv6 prefix match specifications, each of which has four parts: an address, a mask length, a minimum matching length, and a maximum matching length. The address is required, but the other three parts are optional. The address is a standard four-part, dotted-decimal numeric IPv4 address or a colon-separated hexadecimal IPv6 address. The mask length, if present, is a nonnegative decimal integer in the range from 0 to 32 for IPv4 prefixes or 0 to 128 for IPv6 prefixes following the address and separated from it by a slash. The optional minimum matching length follows the address and optional mask length and is expressed as the keyword ge (mnemonic for greater than or equal to), followed by a nonnegative decimal integer in the range from 0 to 32 for IPv4 or 0 to 128 for IPv6. The optional maximum matching length follows the rest and is expressed by the keyword le (mnemonic for less than or equal to), followed by yet another nonnegative decimal integer in the range from 0 to 32 for IPv4 or 0 to 128 for IPv6. A syntactic shortcut for specifying an exact length for prefixes to match is the eq keyword, mnemonic for equal to.

If a prefix match specification has no mask length, then the default mask length is 32 for IPv4 or 128 for IPv6. The default minimum matching length is the mask length. If a minimum matching length is specified, then the default maximum matching length must be less than 32 for IPv4 prefixes or 128 for IPv6 prefixes. Otherwise, if neither a minimum nor maximum length is specified, the default maximum length is the mask length.

Task ID

Task ID

Operations

route-policy

read, write

Examples

The following example shows a prefix set named legal-ipv4-prefix-examples:

The first element of the prefix set matches only one possible value, 10.0.1.1/32 or the host address 10.0.1.1. The second element matches only one possible value, 10.0.2.0/24. The third element matches a range of prefix values, from 10.0.3.0/28 to 10.0.3.255/32. The fourth element matches a range of values, from 10.0.4.0/24 to 10.0.4.240/28. The fifth element matches prefixes in the range from 10.0.5.0/26 to 10.0.5.252/30. The sixth element matches any prefix of length 28 in the range from 10.0.6.0/28 through 10.0.6.240/28.

The following prefix set consists entirely of invalid prefix match specifications:

Neither the minimum length nor the maximum length is legal without a mask length. The maximum length must be at least the mask length. The minimum length must be less than 32, the maximum length of an IPv4 prefix. The maximum length must be equal to or greater than the minimum length.

The following example shows a valid IPv6 prefix set named legal-ipv6-prefix-examples:

Syntax Description

Range for 4-byte Autonomous system numbers (ASNs) in asplain format is 1 to 4294967295.

Range for 4-byte Autonomous system numbers (ASNs) is asdot format is 1.0 to 65535.65535.

parameter

Parameter name. The parameter name must be preceded with a “$.”

most-recent

Specifies that the most recent autonomous system number should be prepended.

number

(Optional) Number of times the autonomous system number should be prepended. Range is 1 to 63.

Command Default

The default number is 1.

Command Modes

Route-policy configuration

Command History

Release

Modification

Release 3.2

This command was introduced.

Release 3.4.0

The as-number 4-byte number range 1.0 to 65535.65535 was supported.

The most-recent keyword was added.

Release 3.9.0

Asplain format for 4-byte Autonomous system numbers notation was supported.

Usage Guidelines

Use the prepend as-path command to prepend the AS path with additional autonomous system numbers.

Note

The prepend as-path command can be used as an action statement within an if statement. For a list of all action statements available within an if statement, see the if command.

This command can take one or two arguments. The first argument (either a number or parameter) is the autonomous system number to prepend to the path. The optional second argument (either a number or parameter) is the number of times the autonomous system number should be prepended.

Task ID

Task ID

Operations

route-policy

read, write

Examples

The following example shows how to prepend the autonomous system number 666.1 to the AS path three times:

RP/0/0/CPU0:router(config-rpl)# prepend as-path 666.1 3

The following example shows how to prepend the autonomous system number 666.0 to the AS path one time:

RP/0/0/CPU0:router(config-rpl)# prepend as-path 666.0 1

protocol

To check the protocol that installs the route, use the protocol command in route-policy configuration mode.

protocol
{ in | (protocol-set) | is | protocol-name }

Syntax Description

in(protocol-set)

Specifies a member of a set. The protocol-set argument accepts the following keywords within parentheses:

bgp—Border Gateway Protocol (BGP)

connected—Connected routes

eigrp—Enhanced Interior Gateway Routing Protocol (EIGRP)

isis—ISO Intermediate System-to-Intermediate System (IS-IS)

ospf—Open Shortest Path First (OSPF)

ospfv3—Open Shortest Path First version 3 (OSPFv3)

rip—Routing Information Protocol (RIP)

static—Static routes

Keywords must be separated by a comma.

is protocol-name

Specifies a single protocol name, and accepted keywords are similar to the protocol-set argument.

Command Default

No default behavior or values

Command Modes

Route-policy configuration

Command History

Release

Modification

Release 3.3.0

This command was introduced.

Release 3.6.0

Support for the ospfv3 keyword was added to the protocol-set argument.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Use the protocol command as a conditional expression within an if statement to specify a protocol to install a route.

Use the in keyword to determine if a protocol listed in the protocol-set is the originator of the route being filtered.

Use the is keyword to determine if protocol-name is an exact match.

Note

For a list of all conditional expressions available within an if statement, see the if command.

Task ID

Task ID

Operations

route-policy

read, write

Examples

The following example shows how to use the protocol command as a conditional expression within if statements:

rd in

To compare the route distinguisher (RD) associated with the route to RDs contained in either a named or an inline RD set, use the rd in command in route-policy configuration mode.

rdin
{ rd-set-name | inline-rd-set | parameter }

Syntax Description

rd-set-name

Name of an RD set.

inline-rd-set

Inline RD set. The inline RD set must be enclosed in parentheses.

parameter

Parameter name. The parameter name must be preceded with a “$.”

Command Default

No default behavior or values

Command Modes

Route-policy configuration

Command History

Release

Modification

Release 3.3.0

This command was introduced.

Release 3.4.0

The parameter argument was added.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Use the rd in command as a conditional expression within an if statement to match a destination entry in a named prefix set or inline prefix set.

Note

For a list of all conditional expressions available within an if statement, see the if command.

This command takes either a named RD set or an inline RD set value as an argument. The condition returns true if the destination entry matches any entry in the RD set or inline RD set. An attempt to match an RD using an RD set that is defined but contains no elements returns false.

Task ID

Task ID

Operations

route-policy

read, write

Examples

The following example shows the rd in command with an inline RD set value as an argument:

rd-set

To define a route distinguisher (RD) set and enter RD configuration mode, use the rd-set command in global configuration mode.

rd-setname

nord-setname

Syntax Description

name

Name of an RD community set.

Command Default

No default behavior or values

Command Modes

Global configuration

Command History

Release

Modification

Release 3.3.0

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Use the rd-set command to create a set with RD elements and enter RD configuration mode. An RD set is a 64-bit value prepended to an IPv4 address to create a globally unique Border Gateway Protocol (BGP) VPN IPv4 address.

Note

For m, the mask length is supported.

You can define RD values with the following commands:

a.b.c.d/m:*—BGP VPN RD in IPv4 format with a wildcard character. For example, 10.0.0.2/24.0:*.

a.b.c.d/m:n—BGP VPN RD in IPv4 format with a mask. For example, 10.0.0.2/24:666.

replace as-path

To replace a sequence of AS numbers or private AS numbers in the AS path with the configured local AS number, use the replace as-path command in route-policy configuration mode.

replaceas-path
{ [ as-number-listparameter ] | private-as }

Syntax Description

as-number-list

(Optional) Sequence of AS numbers to replace. The sequence must be enclosed in single quotes (‘ ’). You can use 2-byte or 4-byte AS numbers.

The 2-byte value is entered as a 16-bit unsigned decimal value. The range is 0 to 65535.

The 4-byte value is entered as two 16-bit unsigned decimal values separated by a period. The range is 1.0 to 65535.65535.

parameter

(Optional) Parameter name. The parameter name must be preceded with a “$.”

private-as

Matches within the BGP private AS range. Range is from 64512 to 65534.

Command Default

None.

Command Modes

Route-policy configuration

Command History

Release

Modification

Release 3.4.0

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Use the replace as-path command to replace a sequence of AS numbers or private AS numbers in the AS path with the local AS numbers. For example, if the AS path is ‘67 65534 100 65533 5 78 89 90’ and the local AS number is 900, then:

replace as-path ‘5 78’

replaces‘5 78’ in the AS path with 900 (from the local AS), and the new path would be‘67 65534 100 65533 900 89 90’.

Consider following statement:

replace as-path private-as

Because 65534 and 65533 are within the private AS range, they are replaced with 900. The path is ‘67 900 100 900 5 78 89 90’. The length of the path remains the same.

The replace as-path command can be used as an action statement within an if statement. For a list of all action statements available within an if statement, see the if command.

Caution

The replace as-path command changes the AS path content which can lead to routing loops.

Task ID

Task ID

Operations

route-policy

read, write

Examples

The following example shows how to use the replace as-path command to replace AS numbers in the AS path:

rib-has-route

To check if a route listed in the prefix set exists in the Routing Information Base (RIB), use the rib-has-route command in route-policy configuration mode.

rib-has-routein
{ prefix-set-name | inline-prefix-set | parameter }

Syntax Description

prefix-set-name

Name of a prefix set.

inline-prefix-set

Inline prefix set. The inline prefix set must be enclosed in parentheses.

parameter

Parameter name. The parameter name must be preceded with a “$.”

Command Default

No default behavior or values

Command Modes

Route-policy configuration

Command History

Release

Modification

Release 3.2

This command was introduced.

Release 3.4.0

The name argument was removed. The following arguments were added:

prefix-set-name

inline-prefix-set

parameter

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

If routes are active, then they are advertised. Routes are considered active if they are already installed in the Routing Information Base (RIB).

The prefix sets used in the rib-has-route command contain two match specifications. The first is where an exact route match is requested (for example, 10.10.0.0/16 will match exactly one route) and the second is where a route match or any more-specific route match is allowed (for example, 10.10.0.0/16 le 32 will match the 10.10.0.0/16 route and any longer prefix).

Use the rib-has-route command as a conditional expression within an if statement to check if there is an active route with a specific prefix contained in the RIB. If the statement reveals an active route that meets that criteria, additional actions are executed.

For a list of all conditional expressions available within an if statement, see the if command.

Task ID

Task ID

Operations

route-policy

read, write

Examples

In the following example, an if statement is used to learn if a route contained in a prefix set 10.10.0.0/16 is in the RIB:

route-has-label

To check if there is a Multiprotocol Label Switching (MPLS) label in a route during redistribution, use the route-has-label command in route-policy configuration mode.

route-has-label

Syntax Description

This command has no arguments or keywords.

Command Default

No default behavior or values

Command Modes

Route-policy configuration

Command History

Release

Modification

Release 3.3.0

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Use the route-has-label command as a conditional expression within an if statement to check if there is an MPLS label in a route during redistribution.

For a list of all conditional expressions available within an if statement, see the if command.

Task ID

Task ID

Operations

route-policy

read, write

Examples

In the following example, an if statement learns if an MPLS label is present in a route:

route-policy (RPL)

To define a route policy and enter route-policy configuration mode, use the route-policy command in global configuration mode. To remove a policy definition, use the no form of this command.

route-policyname
[ (parameter1, parameter2, . . . , parameterN) ]

noroute-policyname(parameter1, parameter2, . . . , parameterN)

Syntax Description

name

Name of a route policy.

parameter

(Optional) Parameter name. The parameter name must be preceded with a “$.” The parameters must be enclosed in parenthesis “()”.

Command Default

No default behavior or values

Command Modes

Global configuration

Command History

Release

Modification

Release 3.2

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Use the route-policy command to define a route policy and enter route-policy configuration mode.

Policy definitions create named bundles of policy statements. A policy definition consists of the route-policy command followed by a name, a group of policy statements, and the end-policy command.

The policy name serves as a handle for binding the policy to protocols.

Task ID

Task ID

Operations

route-policy

read, write

Examples

The following example shows a simple policy named drop-everything that drops any route it encounters:

Policies may also refer to other policies such that common blocks of policy can be reused. This reference to other policies is accomplished by using the apply command. The following is a simple example:

The apply command indicates that the policy check-communities should be executed if the route under consideration passed through autonomous system 1234 before it was received. If so, the communities of the route are checked, and based on the findings the route may be accepted unmodified, accepted with changes, or dropped.

Related Commands

route-type is

To match route types when redistribution is being performed into Border Gateway Protocol (BGP), Open Shortest Path First (OSPF), or Integrated Intermediate System-to-Intermediate System (IS-IS), use the route-type is command in route-policy configuration mode.

Command Default

Command Modes

Route-policy configuration

Command History

Release

Modification

Release 3.2

This command was introduced.

The level-1-2 keyword was replaced with the interarea keyword.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Use the route-type is command as a conditional expression within an if statement to compare route types when redistribution is being performed into BGP, OSPF, or IS-IS.

Note

For a list of all conditional expressions available within an if statement, see the if command.

The valid keywords are local, internal, interarea, type-1, type-2, level-1, and level-2. A parameterized value that fills in one of these values may also be used. The local value is used to match locally generated BGP routes. The internal value is used to match OSPF intra- and interarea routes. The type-1 and type-2 values are used to match Type 1 and Type 2 OSPF external routes. The level-1, level-2, and interarea values are used to match IS-IS routes of those respective types.

Because the route type is a matching operator, it appears in conditional clauses of if and then statements.

rpl editor

To set the default routing policy language (RPL) editor, use the rpl editor command in global configuration mode.

rpleditor
{ nano | emacs | vim }

Syntax Description

nano

Sets the default RPL editor to GNU nano.

emacs

Sets the default RPL editor to EMACS.

vim

Sets the default RPL editor to VIM.

Command Default

The Nano editor is the default.

Command Modes

Global configuration

Command History

Release

Modification

Release 3.3.0

This command was introduced.

Release 3.5.0

The nano keyword was added and the GNU nano text editor became the default editor type.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

rpl maximum

To configure system limits on the routing policy subsystem, use the rpl maximum command in global configuration mode.

rplmaximum
{ lines | policies }
number

Syntax Description

linesnumber

Configures the number of lines of configuration limit. Range is from 1 to 131072.

policiesnumber

Configures the number of policies limit. Range is from 1 to 5000.

Command Default

linesnumber: 65536

policiesnumbers: 3500

Command Modes

Global configuration

Command History

Release

Modification

Release 3.2

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Use the rpl maximum command to configure system limits on the routing policy subsystem. As such, rpl maximum configuration lines do not appear as statements within a routing policy. This command places resource limits on the routing policy subsystem. Use the rpl maximum command to configure the maximum number of lines of configuration and number of policies.

The number of lines of configuration includes the beginning and ending statements, for example, route-policy and end-policy. Each line of configuration for sets is also counted.

A line of configuration is counted only once; it is not counted each time it is used. Similarly, any multiple use of policy in an apply statement counts only as one policy.

A user can change the default values for lines and policies but cannot exceed the maximum value, nor can the value for lines and policies be configured lower than the number of lines or policies that are currently configured.

Task ID

Task ID

Operations

route-policy

read, write

Examples

In the following example, the maximum number of RPL system limits are modified:

Syntax Description

Inline community set. The inline community set must be enclosed in parentheses.

parameter

Parameter name. The parameter name must be preceded with a “$.”

additive

(Optional) Adds communities to communities in the route.

Command Default

No default behavior or values

Command Modes

Route-policy configuration

Command History

Release

Modification

Release 3.2

This command was introduced.

Release 3.4.0

The parameter argument was added.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Use the set community command to set the BGP community attribute.

Note

The set community command can be used as an action statement within an if statement. For a list of all action statements available within an if statement, see the if command.

Communities are 32-bit values carried in BGP routes. Each route may have zero or more communities in an unordered list.

Use this command to replace the communities in a route or add to them using the optional additive keyword.

As with the other community forms that support inline sets, either or both 16-bit portions of the community can be parameterized. Likewise, the names of the well-known communities internet (0:0), no-advertise (65535:65281), no-export (65535:65282), and local-AS (65535:65283) can also be used. In an inline community set, each 16-bit portion can also be specified as the peeras to express the AS number of the neighbor from which the route was received. If the neighbor AS employs a 4-byte ASN, the IANA-assigned 16-bit value 23456 (AS_TRANS) is used as peeras instead.

Without the additive keyword, any existing communities (other than the well-known communities) are removed and replaced with the given communities. The additive keyword specifies that all communities already present in the route be maintained and the list of communities be added to them.

Task ID

Task ID

Operations

route-policy

read, write

Examples

The following are incomplete configuration examples using the set community command:

RP/0/0/CPU0:router(config-rpl)# set community (10:24)RP/0/0/CPU0:router(config-rpl)# set community (10:24, $as:24, $as:$tag)RP/0/0/CPU0:router(config-rpl)# set community (10:24, internet) additiveRP/0/0/CPU0:router(config-rpl)# set community (10:24, $as:24) additiveRP/0/0/CPU0:router(config-rpl)# set community (10:24, peeras:24) additive

set core-tree

To set a Multicast Distribution Tree (MDT) type, use the set core-tree command in route-policy configuration mode.

Command Default

None

Command Modes

Route-policy configuration

Command History

Release

Modification

Release 4.1.0

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Task ID

Task ID

Operation

route-policy

read, write

Examples

In this example, the Multicast Distribution Tree type is set to IP GRE Rosen core:

Syntax Description

halflifeminutes

Specifies the time (in minutes) after which a penalty is decreased. After the route has been assigned a penalty, the penalty is decreased by half after the half-life period. The process of reducing the penalty happens every 5 seconds. Range is 1 to 45 minutes.

parameter

Parameter name. The parameter name must be preceded with a “$.”

max-suppressminutes

Specifies the maximum time (in minutes) a route can be suppressed. Range is 1 to 20000. If the half-life value is allowed to default, the maximum suppress time defaults to 60 minutes.

reuseseconds

Unsuppresses a route if the penalty for flapping the route decreases enough to fall below the configured value (in seconds). The process of unsuppressing routes occurs at 10-second increments. Range is 1 to 20000.

suppresspenalty-units

Specifies a penalty of 1000 each time a route flaps. When a route penalty exceeds the configured limit, it is suppressed. Range is 1 to 20000.

others default

If all four keyword values are not specified in the command, then the command must end with others default. This designation indicates that any keyword not defined is set to its default.

Command Default

half-life: 15 minutes

max-suppress: 60 minutes (four times the half-life)

reuse: 750 seconds

suppress: 2000 penalty units

Command Modes

Route-policy configuration

Command History

Release

Modification

Release 3.2

This command was introduced.

Release 3.4.0

The parameter argument was supported.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

The BGP protocol supports route dampening using an exponential backoff algorithm. The algorithm is controlled by setting the four supported BGP values: half-life, max-suppress, reuse, and suppress. Use the set dampening command to configure BGP route dampening.

Note

The set dampening command can be used as an action statement within an if statement. For a list of all action statements available within an if statement, see the if command.

A value for at least one of the four keywords must be set. If the set dampening command defines values for three or fewer of the supported keywords, then the configuration must end with the others default, which indicates that any keyword value not defined in the command is set to its default value.

The keywords may appear in the command in any order.

Task ID

Task ID

Operations

route-policy

read, write

Examples

In the following examples, the half-life is set to 20 minutes and the maximum suppress time is set to

90 minutes. Each command must end with others default because three or fewer keywords are defined.

set eigrp-metric

To set Enhanced Interior Gateway Routing Protocol (EIGRP) route metrics, use the set eigrp-metric command in route-policy configuration mode.

seteigrp-metricbandwidthdelayreliabilityloadingmtu

Syntax Description

bandwidth

Minimum bandwidth of the route in kilobits per second. Range is 1 to 4294967295.

delay

Route delay in tens of microseconds. Delay is 1 or any positive number that is a multiple of 39.1 nanoseconds. Range is 1 to 4294967295.

reliability

Likelihood of successful packet transmission expressed as a number between 0 and 255. The value 255 means 100 percent reliability; 0 means no reliability.

loading

Effective bandwidth of the route expressed as a number from 1 to 255 (255 is 100 percent loading).

mtu

Minimum maximum transmission unit (MTU) size of the route in bytes. Range is from 1 to 65535.

Command Default

No default behavior or values

Command Modes

Route-policy configuration

Command History

Release

Modification

Release 3.3.0

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

You can use the add command to further offset an existing EIGRP metric value.

Task ID

Task ID

Operations

route-policy

read, write

Examples

In the following example, the EIGRP metrics are adjusted for route policy policy_1:

Syntax Description

Inline cost extended community set. The inline cost extended community set must be enclosed in parentheses.

parameter

Parameter name. The parameter name must be preceded with a “$.”

additive

(Optional) Adds extended communities for cost to extended communities in the route.

Command Default

No default behavior or values

Command Modes

Route-policy configuration

Command History

Release

Modification

Release 3.3.0

This command was introduced.

This command replaced the set extcommunity command.

Release 3.4.0

The parameter argument was added.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Use the set extcommunity cost command to either replace the extended communities on the route or add to them using the optional additive keyword. Cost community is an extended community used to tie break the best path selection process in BGP so as to have a localized custom decision for packet forwarding. The extended community format defines generic points of insertion (POI) that influence the decision at different points of the bestpath algorithm.

Note

The set extcommunity cost command can be used as an action statement within an if statement. For a list of all action statements available within an if statement, see the if command.

As with the other extended community forms that support inline sets, either or both portions of the community can be parameterized. Similarly to regular communities, the additive keyword can be used to signify adding these extended communities to those that are already present, as opposed to replacing them. Without the additive keyword, any existing extended communities for cost (other than the well-known communities) are removed and replaced with the given communities. The additive keyword specifies that all extended communities for cost already present in the route be maintained and the set of extended communities be added to them. Well-known communities include internet, local-AS, no-advertise, and no-export.

Task ID

Task ID

Operations

route-policy

read, write

Examples

The following are incomplete configuration examples using the set extcommunity cost command:

Syntax Description

Inline route target extended community set. The inline route target extended community set must be enclosed in parentheses.

parameter

Parameter name. The parameter name must be preceded with a “$.”

additive

(Optional) Adds extended communities for an RT to extended communities in the route.

Command Default

No default behavior or values

Command Modes

Route-policy configuration

Command History

Release

Modification

Release 3.3.0

This command was introduced.

This command replaced the set extcommunity command.

Release 3.4.0

The parameter argument was added.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Use the set extcommunity rt command to either replace the extended communities on the route or add to them using the optional additive keyword.

Note

The set extcommunity rt command can be used as an action statement within an if statement. For a list of all action statements available within an if statement, see the if command.

As with the other extended community forms that support inline sets, either or both portions of the community can be parameterized. Similarly to regular communities, the additive keyword can be used to signify adding these extended communities to those that are already present, as opposed to replacing them.

Task ID

Task ID

Operations

route-policy

read, write

Examples

The following are incomplete configuration examples using the set extcommunity rt command:

Without the additive keyword, any existing extended communities for cost (other than the well-known communities) are removed and replaced with the given communities. The additive keyword specifies that all extended communities for cost already present in the route be maintained and the list of extended communities be added to them.

set ip-precedence

To set the IP precedence, use the set ip-precedence command in route-policy configuration mode.

setip-precedence
{ number | parameter }

Syntax Description

number

Value of the precedence. The precedence value can be a number from 0 to 7:

7—network (set packets with network control precedence)

6—internet (set packets with internetwork control precedence)

5—critical (set packets with critical precedence)

4—flash-override (set packets with flash override precedence)

3—flash (set packets with flash precedence)

2—immediate (set packets with immediate precedence)

1—priority (set packets with priority precedence)

0—routine (set packets with routine precedence)

parameter

Parameter name. The parameter name must be preceded with a “$.”

Command Default

No default behavior or values

Command Modes

Route-policy configuration

Command History

Release

Modification

Release 3.6.0

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Use the set ip-precedence command to set the IP precedence to classify packets. This command is supported at the BGP table-policy attachpoint. Prefixes are marked for subsequent processing in the forwarding plane. After QoS Policy Propagation through Border Gateway Protocol (BGP) (QPPB) is enabled on an interface, corresponding traffic shaping and policing is completed using packet classification based on the IP precedence or QoS group ID. See Cisco IOS XR Modular Quality of Service Configuration Guide for the Cisco XR 12000 Series Router for information on QPPB.

set isis-metric

To set the Intermediate System-to-Intermediate System (IS-IS) metric attribute value, use the set is-is metric command in route-policy configuration mode.

setisis-metric
{ number | parameter }

Syntax Description

number

24-bit integer number. Range is from 0 to 16777215.

parameter

Parameter name. The parameter name must be preceded with a “$.”

Command Default

No default behavior or values

Command Modes

Route-policy configuration

Command History

Release

Modification

Release 3.3.0

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Use the set isis-metric command to set the IS-IS metric attribute value for routes that are redistributed into IS-IS.

Task ID

Task ID

Operations

route-policy

read, write

Examples

In the following example, the IS-IS metric attribute value is set to 1000:

set label

To set the Border Gateway Protocol (BGP) label attribute value, use the set label command in route-policy configuration mode.

setlabel
{ explicit-null | implicit-null | parameter }

Syntax Description

explicit-null

Sets the label to the well-known explicit value of 0.

implicit-null

Sets the label to the well-known implicit value of 3.

parameter

Parameter name. The parameter name must be preceded with a “$.”

Command Default

No default behavior or values

Command Modes

Route-policy configuration

Command History

Release

Modification

Release 3.3.0

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Use the set label command in a route policy at the allocate label attachpoint to set the label to explicit-null or implicit-null based on deployment preference. During inter-AS operation, the ASBR sends some of its own loopbacks to other its peers and labels them either implicit null or explicit null.

set level

To configure the Intermediate System-to-Intermediate System (IS-IS) link-state packet (LSP) level advertised to redistributed routes, use the set level command in route-policy configuration mode.

setlevel
{ level-1 | level-2 | level-1-2 | parameter }

Syntax Description

level-1

Specifies that redistributed routes are advertised in the Level 1 LSP of the router.

level-2

Specifies that redistributed routes are advertised in the Level 2 LSP of the router.

level-1-2

Specifies that redistributed routes are advertised in Level 1 and Level 2 LSPs of the router.

parameter

Parameter name. The parameter name must be preceded with a “$.”

Command Default

No default behavior or values

Command Modes

Route-policy configuration

Command History

Release

Modification

Release 3.2

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Use the IS-IS set level command to configure the LSP level advertised to redistributed routes.

Note

The set level command can be used as an action statement within an if statement. For a list of all action statements available within an if statement, see the if command.

set local-preference

To set the Border Gateway Protocol (BGP) local preference attribute in a route, use the set local-preference command in route-policy configuration mode.

setlocal-preference
{ number | parameter }

Syntax Description

number

Value assigned to a 32-bit unsigned integer. Range is 0 to 4294967295.

parameter

Parameter name. The parameter name must be preceded with a “$.”

Command Default

Default value is 100.

Command Modes

Route-policy configuration

Command History

Release

Modification

Release 3.2

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Use the set local-preference command to specify a preference value for the autonomous system path. Local preference is a nontransitive (does not cross autonomous system boundaries) attribute and is the second metric considered in the BGP best path calculation (the highest local preference is chosen). Weight is the first metric evaluated for best path, but it is local to the router and propagates only to iBGP peers. See the Implementing BGP on Cisco ASR 9000 Series RouterCisco IOS XR Softwaremodule of the Cisco IOS XR Routing Configuration Guide for the Cisco XR 12000 Series Router for information on the BGP best path calculation.

Note

The set local-preference command can be used as an action statement within an if statement. For a list of all action statements available within an if statement, see the if command.

The local preference is a 32-bit unsigned integer.

Task ID

Task ID

Operations

route-policy

read, write

Examples

In the following example, the local preference value is set to 10:

RP/0/0/CPU0:router(config-rpl)# set local-preference 10

set med

To set the Border Gateway Protocol (BGP) Multi Exit Discriminator (MED) attribute, use the set med command in route-policy configuration mode.

Syntax Description

Value assigned to a 32-bit unsigned integer. Range is 0 to 4294967295.

parameter

Parameter name. The parameter name must be preceded with a “$.”

igp-cost

Sets the MED value to the cost for the Interior Gateway Protocol (IGP) route to resolve the next-hop of the BGP route.

+ | -

Sets the MED to the MED plus or minus a static offset. An integer or parameter must follow the plus or minus.

max-reachable

Sets the MED value to the maximum possible value of 4294967295.

Command Default

No default behavior or values

Command Modes

Route-policy configuration

Command History

Release

Modification

Release 3.2

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Use the set med command to set the MED value, which is a 32-bit unsigned integer.

Note

The set med command can be used as an action statement within an if statement. For a list of all action statements available within an if statement, see the if command.

This command can take the following as argument values: an integer, a parameter, the igp-cost keyword, or a mathematical operator (either plus or minus) followed by an integer or a parameter. Setting the MED to the IGP cost is supported on outbound BGP policies only. The MED cannot be set to the IGP cost in policies applied to other BGP attach points.

The max-reachable keyword sets the MED to the maximum value while leaving the route reachable.

The plus or minus variants allow the user to set the MED to the MED plus or minus a static offset. The variants that allow a user to add or subtract offsets to the MED value are also range checked for underflow or overflow. If the value underflows as a result of subtraction, then the MED value is set to zero. If the value overflows, the value is set to 4294967295, which is the maximum value for MED. when MED is set to 4294967295, the route is unreachable.

Task ID

Task ID

Operations

route-policy

read, write

Examples

The following two examples show how to set the MED to a value that is either specified directly (using the integer 156) or passed to the policy as a parameter:

Command Default

Command Modes

Command History

Release

Modification

Release 3.2

This command was introduced.

Release 3.8.0

The rib-metric-as-internal and rib-metric-as-external keywords were added.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Use the IS-IS set metric-type command to control whether IS-IS treats the metric as an internal or external metric.

Use the rib-metric-as-external and rib-metric-as-internal keywords to preserve RIB metrics when redistributing routes from another ISIS router instance or another protocol.

Note

The set metric-type command can be used as an action statement within an if statement. For a list of all action statements available within an if statement, see the if command.

This command does not support parameterization.

Task ID

Task ID

Operations

route-policy

read, write

Examples

In the following example, the IS-IS metric type is set to internal:

RP/0/0/CPU0:router(config-rpl)# set metric-type internal

set metric-type (OSPF)

To control how Open Shortest Path First (OSPF) computes the cost for a route, use the set metric-type command in route-policy configuration mode.

setmetric-type
{ type-1 | type-2 | parameter }

Syntax Description

type-1

Uses the cost set on the route plus the topology-related costs in the calculation for Type 1 metrics.

type-2

Uses only the cost set on the route in the calculation for Type 2 metrics.

parameter

Parameter name. The parameter name must be preceded with a “$.”

Command Default

No default behavior or values

Command Modes

Route-policy configuration

Command History

Release

Modification

Release 3.2

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Use the OSPF set metric-type command to control whether OSPF treats the cost as a Type 1 or Type 2 metric.

Note

The set metric-type command can be used as an action statement within an if statement. For a list of all action statements available within an if statement, see the if command.

The value of Type 1 or Type 2 controls how OSPF computes the cost for this route. For Type 2 metrics, only the cost set on the route is used. For Type 1 metrics, the cost set on the route plus the topology- related costs are used in the calculation.

This command does not support parameterization.

Task ID

Task ID

Operations

route-policy

read, write

Examples

In the following example, the OSPF metric type is set to Type 1:

RP/0/0/CPU0:router(config-rpl)# set metric-type type-1

set next-hop

To replace the next-hop associated with a given route, use the set next-hop command in route-policy configuration mode.

Syntax Description

Sets the next-hop to the IP address of the remote Border Gateway Protocol (BGP) peer.

parameter

Parameter name. The parameter name must be preceded with a “$.”

self

Sets itself as the next-hop.

destination-vrf

(Optional) Specifies that the next-hop of the route should be resolved in destination VRF context. This keyword is available when an IPv4 or IPv6 address or parameter is used.

Command Default

No default behavior or values

Command Modes

Route-policy configuration

Command History

Release

Modification

Release 3.2

This command was introduced.

Release 3.3.0

The self keyword was added.

Release 3.4.0

The destination-vrf keyword was added.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Use the set next-hop command to replace the next-hop associated with a specific address.

Note

The set next-hop command can be used as an action statement within an if statement. For a list of all action statements available within an if statement, see the if command.

Use the set next-hop peer-address command to set the next-hop to the address of the BGP neighbor, where this policy is attached.

The next-hop is a valid IPv4 address entered as a dotted decimal or an IPv6 address entered as a colon-separated hexadecimal.

It is not possible to use this command to set the BGP IPv6 link-local next-hop.

The destination-vrf keyword is used mainly in Layer 3 VPN networks when importing routes.

Task ID

Task ID

Operations

route-policy

read, write

Examples

In the following example, the next-hop is set to a valid IPv4 address:

RP/0/0/CPU0:router(config-rpl)# set next-hop 10.0.0.5

In this example, the next-hop is set to a parameter value $nexthop:

RP/0/0/CPU0:router(config-rpl)# set next-hop $nexthop

In this example, the next-hop is set to a valid IPv4 address with a destination VRF context:

RP/0/0/CPU0:router(config-rpl)# set next-hop 10.0.0.5 destination-vrf

set origin

To change the Border Gateway Protocol (BGP) origin attribute, use the set origin command in route-policy configuration mode.

setorigin
{ igp | incomplete | egp | parameter }

Syntax Description

igp

Sets the origin type to Interior Gateway Protocol (IGP).

incomplete

Sets the origin type to incomplete.

egp

Sets the origin type to Exterior Gateway Protocol (EGP).

parameter

Parameter name. The parameter name must be preceded with a “$.”

Command Default

No default behavior or values

Command Modes

Route-policy configuration

Command History

Release

Modification

Release 3.2

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Use the set origin command to change the origin attribute.

Note

The set origin command can be used as an action statement within an if statement. For a list of all action statements available within an if statement, see the if command.

The origin of a Border Gateway Protocol (BGP) route is igp, egp, or incomplete.

Task ID

Task ID

Operations

route-policy

read, write

Examples

In the following example, the origin attribute is set to EGP:

RP/0/0/CPU0:router(config-rpl)# set origin egp

set ospf-metric

To set an Open Shortest Path First (OSPF) protocol metric attribute value, use the set ospf-metric command in route-policy configuration mode.

setospf-metric
{ number | parameter }

Syntax Description

number

Value assigned to a 24-bit unsigned integer. Range is 0 to 4294967295.

parameter

Parameter name. The parameter name must be preceded with a “$.”

Command Default

No default behavior or values

Command Modes

Route-policy configuration

Command History

Release

Modification

Release 3.3.0

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Use the set ospf-metric command to set the metric for routes that are redistributed into OSPF. The OSPF metric operator accepts either an integer value or a parameter.

Task ID

Task ID

Operations

route-policy

read, write

Examples

In the following example, the OSPF metric attribute value is set to 1000:

Command Default

None

Command Modes

Route-policy configuration

Command History

Release

Modification

Release 4.0.0

This command was introduced.

Release 4.0.1

The multipath-protect keyword was added.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Task ID

Task ID

Operation

route-policy

read, write

Examples

The following example shows how to set the path selection as advertise backup path 3 for route-polcicy path_selection_plcy:

Related Commands

Configures send capability of multiple paths for a prefix to the capable peers,

additional-paths receive

Configures receive capability of multiple paths for a prefix to the capable peers.

advertise best-external

Advertises the best–external path to the iBGP and route-reflector peers,

set qos-group (RPL)

To set the quality of service (QoS) group, use the set qos-group command in route-policy configuration mode:

setqos-group
{ number | parameter }

Syntax Description

number

QoS group ID. Range is from 0 to 31.

parameter

Parameter name. The parameter name must be preceded with a “$.”

Command Default

No default behavior or values

Command Modes

Route-policy configuration

Command History

Release

Modification

Release 3.6.0

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Use the set qos-group command to set the QoS group to classify packets.

This command is supported at the BGP table-policy attachpoint. Prefixes are marked for subsequent processing in the forwarding plane. After QoS Policy Propagation through Border Gateway Protocol (BGP) (QPPB) is enabled on an interface, corresponding traffic shaping and policing is completed using packet classification based on the IP precedence or QoS group ID. See the Cisco IOS XR Modular Quality of Service Configuration Guide for the Cisco XR 12000 Series Router for information on QPPB.

set rib-metric

To set the Routing Information Base (RIB) metric attribute value for a table policy, use the set rib-metric command in route-policy configuration mode:

setrib-metric
{ number | parameter }

Syntax Description

number

Value assigned to a 32-bit unsigned integer. Range is 0 to 4294967295.

parameter

Parameter name. The parameter name must be preceded with a “$.”

Command Default

No default behavior or values

Command Modes

Route-policy configuration

Command History

Release

Modification

Release 3.3.0

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Use the set rib-metric command set the RIB metric attribute value for BGP routes.

Every route in the RIB has a metric associated with it, signifying the cost to reach a specific destination based on link characteristics. The set rib-metric command modifies the RIB metric while installing BGP routes into RIB, enabling the upgrading or downgrading of the BGP route installed in RIB.

set rip-metric

To set Routing Information Protocol (RIP) metric attributes, use the set rip-metric command in route-policy configuration mode.

setrip-metric
{ number | parameter }

Syntax Description

number

Value assigned to a 4-bit unsigned integer. Range is from 0 to 16.

parameter

Parameter name. The parameter name must be preceded with a “$.”

Command Default

No default behavior or values

Command Modes

Route-policy configuration

Command History

Release

Modification

Release 3.3.0

This command was introduced.

Release 3.4.0

The number range of 0 to 15 was changed to 0 to 16.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Use the set rip-metric command to set the cost attribute for routes that are redistributed into RIP.

You can use the add command to increment the RIP metric value.

Task ID

Task ID

Operations

route-policy

read, write

Examples

In the following example, the RIP metric number is adjusted for route policy policy_1:

Related Commands

set rip-tag

To set a route tag attribute for Routing Information Protocol (RIP) routes, use the set rip-tag command in route-policy configuration mode.

setrip-tag
{ number | parameter }

Syntax Description

number

Value assigned to a 16-bit unsigned integer. Range is from 0 to 65535.

parameter

Parameter name. The parameter name must be preceded with a “$.”

Command Default

No default behavior or values

Command Modes

Route-policy configuration

Command History

Release

Modification

Release 3.3.0

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Use the set rip-tag command to set the RIP tag attribute for routes that are redistributed into RIP. The RIP tag operator accepts either an integer value or a parameter.

Task ID

Task ID

Operations

route-policy

read, write

Examples

In the following example, the RIP tag is adjusted for route policy policy_1:

Specifies the default or nondefault topology table for the source or group.

table-name

Alphanumeric name string.

Command Default

Default or current topology setting.

Command Modes

Routing policy configuration

Command History

Release

Modification

Release 3.7.0

This command was introduced.

Release 3.8.0

This command was supported for MVPN extranet routing configuration.

The vrfvrf-name keyword and argument were added.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

When using this command for MVPN extranet routing configuration, only the vrfvrf-name keyword and argument are required.

When using this command in the context of multitopology routing, all keywords and arguments with the exception of vrfvrf-name keyword and argument are required.

Task ID

Task ID

Operations

multicast

read

Examples

The following example shows how to execute the set rpf-topology command:

Related Commands

Assigns a route policy in PIM to select a reverse-path forwarding (RPF) topology.

set spf-priority

To set OSPF Shortest Path First (SPF) priority, use the set spf-priority command in route-policy configuration mode.

setspf-priority
{ critical | high | medium }

Syntax Description

critical

Sets critical priority for SPF

high

Sets high priority for SPF

medium

Sets medium priority for SPF

Command Default

None

Command Modes

Route-policy configuration

Command History

Release

Modification

Release 3.7.0

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Related Commands

set tag

To set the tag attribute, use the set tag command in route-policy configuration mode.

settag
{ number | parameter }

Syntax Description

number

Value assigned to a 32-bit unsigned integer. Range is from 0 to 4294967295.

parameter

Parameter name. The parameter name must be preceded with a “$.”

Command Default

No default behavior or values

Command Modes

Route-policy configuration

Command History

Release

Modification

Release 3.2

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Use the set tag command to set the tag attribute.

Note

The set tag command can be used as an action statement within an if statement. For a list of all action statements available within an if statement, see the if command.

Tags are routing-protocol independent 32-bit integers that can be associated with a given route in the Routing Information Base (RIB).

For the Border Gateway Protocol (BGP), the tag attribute can be set only at the table-policy attach point.

Task ID

Task ID

Operations

route-policy

read, write

Examples

In the following example, the tag attribute is set to 10:

RP/0/0/CPU0:router(config-rpl)# set tag 10

In this example, the tag attribute is set to a parameter value $tag_param:

RP/0/0/CPU0:router(config-rpl)# set tag $tag_param

set traffic-index

To set the traffic index attribute, use the set traffic-index command in route-policy configuration mode.

settraffic-index
{ number | parameter | ignore }

Syntax Description

number

Integer value assigned to the traffic index attribute. Range is 1 to 63.

Command Default

No default behavior or values

Command Modes

Route-policy configuration

Command History

Release

Modification

Release 3.2

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Use the set traffic-index command to set the traffic index attribute.

Note

The set traffic-index command can be used as an action statement within an if statement. For a list of all action statements available within an if statement, see the if command.

Traffic index is a special attribute for BGP. It is used as an index to a set of counters that are maintained by forwarding hardware. It is also used to track packet and byte counters that are forwarded using routes with specific attributes. These counters can be enabled and disabled on an individual interface basis.

The traffic index attribute can be set only at the table-policy attach point, and can take a value from 1 to 63, or a value of ignore. If the traffic index is set to ignore, then BGP policy accounting is not done. Parameterization of this value is also supported.

Task ID

Task ID

Operations

route-policy

read, write

Examples

In the following example, a policy is created in which the traffic index is set to 10 for all routes that originated in autonomous system 1234:

This policy could then be attached using the BGP table-policy command. The counters could then be enabled on various interfaces with the appropriate commands.

set vpn-distinguisher

To change the Border Gateway Protocol (BGP) VPN distinguisher attribute, use the set vpn-distinguisher command in route-policy configuration mode.

setvpn-distinguisher
{ number | parameter }

Syntax Description

number

Value assigned to a 32-bit unsigned integer. Range is from 1 to 4294967295.

parameter

Parameter name. The parameter name must be preceded with a “$.”

Command Default

No default behavior or values

Command Modes

Route-policy configuration

Command History

Release

Modification

Release 3.4.0

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Use the set vpn-distinguisher command to change the VPN distinguisher attribute.

Note

The set origin command can be used as an action statement within an if statement. For a list of all action statements available within an if statement, see the if command.

A VPN distinguisher is used in Layer 3 VPN networks for enhanced individual VPN control and to avoid route target mapping at AS boundaries in inter-AS VPN networks. Route target extended communities are removed at neighbor outbound, and the VPN distinguisher value is applied on the BGP route as an extended community. When the route is received on a neighboring router in another AS, the VPN distinguisher is removed and mapped to a route target extended community.

Task ID

Task ID

Operations

route-policy

read, write

Examples

In the following example, the VPN distinguisher attribute is set to 456:

RP/0/0/CPU0:router(config-rpl)# set vpn-distinguisher 456

set weight

To set the weight value for Border Gateway Protocol (BGP) routes, use the set weight command in route-policy configuration mode.

setweight
{ number | parameter }

Syntax Description

number

Number assigned to the weight value for BGP routes. Weight is 16 bits. Range is 0 to 65535.

parameter

Parameter name. The parameter name must be preceded with a “$.”

Command Default

No default behavior or values

Command Modes

Route-policy configuration

Command History

Release

Modification

Release 3.2

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Use the set weight command to set the weight value for BGP routes.

Note

The set weight command can be used as an action statement within an if statement. For a list of all action statements available within an if statement, see the if command.

A weight is a value that can be applied to a route to override the BGP local preference. This is not a BGP attribute announced to BGP peer routers. RPL can be used to set the weight value.

Given two BGP routes with the same network layer reachability information (NLRI), a route with a higher weight is selected, no matter what the values of other BGP attributes may be. However, weight only has significance on the local router. It is not sent from one BGP speaker to another, even within the same autonomous system.

On Cisco routers, if a BGP route is sourced by the local router, its weight is automatically set to 32768; if the BGP route is learned from another router, its weight is automatically set to 0. Thus, by default, locally sourced routes are preferred over BGP learned routes.

Task ID

Task ID

Operations

route-policy

read, write

Examples

In the following example, the weight of the route is set to 10 and then to a parameter value $weight_param:

Syntax Description

(Optional) Displays the maximum number of lines of configuration and number of policies.

linesconfiguration-limit

(Optional) Displays the number of lines to which configuration is limited. Range is 1 to 131072.

The configuration-limit argument is available if the running-config keyword is specified.

policiespolicies-limit

(Optional) Displays the limit on the number of policies. Range is 1 to 5000.

The configuration-limit argument is available if the running-config keyword is specified.

editor

(Optional) Specifies the default RPL editor. This keyword is available if the running-config keyword is specified.

emacs

(Optional) Displays the default RPL editor to Micro Emacs.

nano

(Optional) Displays the default RPL editor to nano.

vim

(Optional) Displays the default RPL editor to Vim.

Command Default

No default behavior or values

Command Modes

EXEC

Command History

Release

Modification

Release 3.2

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Task ID

Task ID

Operations

route-policy

read, write

Examples

The following shows the output of the show running-config rpl command:

Related Commands

Displays the maximum limits for lines of configuration and number of policies.

show rpl active as-path-set

To display the AS path sets that are referenced by at least one policy that is being used at an attach point, use the show rpl active as-path-set command in EXEC mode.

showrplactiveas-path-set [detail]

Syntax Description

detail

(Optional) Displays the content of the object and all referenced objects for active AS path sets.

Command Default

No default behavior or values

Command Modes

EXEC

Command History

Release

Modification

Release 3.2

This command was introduced.

Release 3.3.0

Added the detail keyword.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Use the show rpl active as-path-set command to display all AS path sets that are in use in the system and referenced either directly or indirectly at a policy attach point.

Given this sample configuration, the show rpl active as-path-set command displays the following information:

RP/0/0/CPU0:router# show rpl active as-path-set
ACTIVE -- Referenced by at least one policy which is attached
INACTIVE -- Only referenced by policies which are not attached
UNUSED -- Not attached (directly or indirectly) and not referenced
The following as-path-sets are ACTIVE
-------------------------------------
as_path_set_ex1

Displays the prefix sets that are referenced by at least one policy that is being used at an attach point.

show rpl active community-set

To display the community sets that are referenced by at least one policy that is being used at an attach point, use the show rpl active community-set command in EXEC mode.

showrplactivecommunity-set [detail]

Syntax Description

detail

(Optional) Displays the content of the object and all referenced objects for active community sets.

Command Default

No default behavior or values

Command Modes

EXEC

Command History

Release

Modification

Release 3.2

This command was introduced.

Release 3.3.0

The detail keyword was added.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Use the show rpl active community-set command to display all community sets that are in use in the system and referenced either directly or indirectly at a policy attach point.

Given this sample configuration, the show rpl active community-set command displays the following information:

RP/0/0/CPU0:router# show rpl active community-set
ACTIVE -- Referenced by at least one policy which is attached
INACTIVE -- Only referenced by policies which are not attached
UNUSED -- Not attached (directly or indirectly) and not referenced
The following community-sets are ACTIVE
---------------------------------------
comm_set_ex1

Displays the route distinguisher sets that are referenced by at least one policy that is being used at an attach point.

show rpl active extcommunity-set

To display the extended community sets for cost, route target (RT), and Site-of-Origin (SoO) that are referenced by at least one route policy used at an attach point, use the show rpl active extcommunity-set command in EXEC mode.

showrplactiveextcommunity-set
[ cost | rt | soo ]
[detail]

Syntax Description

cost

(Optional) Displays all extended community cost sets.

rt

(Optional) Displays all extended community RT sets.

soo

(Optional) Displays all extended community SoO sets.

detail

(Optional) Displays the content of the object and all referenced objects for active extended community sets.

Command Default

All extended community sets are displayed.

Command Modes

EXEC

Command History

Release

Modification

Release 3.2

This command was introduced.

Release 3.3.0

Added the cost, rt, soo, and detail keywords.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Use the show rpl active extcommunity-set command to display all extended community sets that are in use in the system and referenced either directly or indirectly at a policy attach point.

Given this sample configuration, the show rpl active extcommunity-set command displays the following information:

RP/0/0/CPU0:router# show rpl active extcommunity-set
ACTIVE -- Referenced by at least one policy which is attached
INACTIVE -- Only referenced by policies which are not attached
UNUSED -- Not attached (directly or indirectly) and not referenced
The following extcommunity-sets are ACTIVE
------------------------------------------
ext_comm_set_rt_ex1

Displays the route distinguisher sets that are referenced by at least one policy that is being used at an attach point.

show rpl active prefix-set

To display the prefix sets that are referenced by at least one policy that is being used at an attach point, use the show rpl active prefix-set command in EXEC mode.

showrplactiveprefix-set [detail]

Syntax Description

detail

(Optional) Displays the content of the object and all referenced objects for active prefix sets.

Command Default

No default behavior or values

Command Modes

EXEC

Command History

Release

Modification

Release 3.2

This command was introduced.

Release 3.3.0

The detail keyword was added.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Use the show rpl active prefix-set command to display all prefix sets that are in use in the system and referenced either directly or indirectly at a policy attach point.

RP/0/0/CPU0:router# show rpl active prefix-set
ACTIVE -- Referenced by at least one policy which is attached
INACTIVE -- Only referenced by policies which are not attached
UNUSED -- Not attached (directly or indirectly) and not referenced
The following prefix-sets are ACTIVE
------------------------------------
prefix_set_1

Displays the route distinguisher sets that are referenced by at least one policy that is being used at an attach point.

show rpl active rd-set

To display the route distinguisher (RD) sets that are referenced by at least one policy that is being used at an attach point, use the show rpl active rd-set command in EXEC mode.

showrplactiverd-set [detail]

Syntax Description

detail

(Optional) Displays the content of the object and all referenced objects for active route policies.

Command Default

No default behavior or values

Command Modes

EXEC

Command History

Release

Modification

Release 3.6.0

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Use the show rpl active rd-set command to display all RD sets that are in use in the system and that are referenced either directly or indirectly at a policy attach point.

Given this sample configuration, the show rpl active rd-set command displays the following information:

RP/0/0/CPU0:router# show rpl active rd-set
ACTIVE -- Referenced by at least one policy which is attached INACTIVE -- Only referenced by policies which are not attached UNUSED -- Not attached (directly or indirectly) and not referenced
The following rd-sets are ACTIVE
------------------------------------------
rdset1
rdset2

Displays the route policies that are referenced by at least one policy that is being used at an attach point.

show rpl active route-policy

To display the route policies that are referenced by at least one policy that is being used at an attach point, use the show rpl active route-policy command in EXEC mode.

showrplactiveroute-policy [detail]

Syntax Description

detail

(Optional) Displays the content of the object and all referenced objects for active route policies.

Command Default

No default behavior or values

Command Modes

EXEC

Command History

Release

Modification

Release 3.2

This command was introduced.

The policy keyword was changed to route-policy.

Release 3.3.0

The detail keyword was added.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Use the show rpl active route-policy command to display all policies that are in use in the system and that are referenced either directly or indirectly at a policy attach point.

Given this sample configuration, the show rpl active route-policy command displays the following information:

RP/0/0/CPU0:router# show rpl active route-policy
ACTIVE -- Referenced by at least one policy which is attached
INACTIVE -- Only referenced by policies which are not attached
UNUSED -- Not attached (directly or indirectly) and not referenced
The following policies are (ACTIVE)
-----------------------------------
policy_1
policy_2

Displays the route distinguisher sets that are referenced by at least one policy that is being used at an attach point.

show rpl as-path-set

To display the contents of AS path sets, use the show rpl as-path-set command in EXEC mode.

showrplas-path-set
[ name | states | brief ]

Syntax Description

name

(Optional) Name of the AS path set.

states

(Optional) Displays all unused, inactive, and active states.

brief

(Optional) Limits the display to a list of the names of all AS path sets without their configurations.

Command Default

No default behavior or values

Command Modes

EXEC

Command History

Release

Modification

Release 3.2

This command was introduced.

The summary keyword was replaced with brief. The * keyword was removed and the states keyword was added.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Use the optional brief keyword to limit the display to a list of the names of all AS path sets without their configurations.

Task ID

Task ID

Operations

route-policy

read

Examples

This example shows the following sample configuration:

RP/0/0/CPU0:router# show rpl route-policy policy_1
route-policy policy_1
if (destination in prefix_set_ex1) then
set local-preference 100
endif
if (as-path in as_path_set_ex1) then
set community (10:333) additive
endif
end-policy

Given this sample configuration, the show rpl as-path-set as_path_set_ex1 command displays the following information:

show rpl as-path-set attachpoints

To display all of the policies used at an attach point that reference the named AS path set, use the show rpl as-path-set attachpoints command in EXEC mode.

showrplas-path-setnameattachpoints

Syntax Description

name

Name of an AS path set.

Command Default

No default behavior or values

Command Modes

EXEC

Command History

Release

Modification

Release 3.2

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Use the show rpl as-path-set attachpoints command to display all policies used at an attach point that reference the named set either directly or indirectly.

Displays all the policies used at an attach point that reference the named prefix set.

show rpl as-path-set references

To list all of the policies that reference the named AS path set, use the show rpl as-path-set references command in EXEC mode.

showrplas-path-setnamereferences [brief]

Syntax Description

name

Name of the prefix set.

brief

(Optional) Limits the output to just the brief table and not the detailed information for the named AS path set.

Command Default

No default behavior or values

Command Modes

EXEC

Command History

Release

Modification

Release 3.2

This command was introduced.

The summary keyword was replaced with brief.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Use the show rpl as-path-set references command to display all policies that reference the named AS path set either directly or indirectly.

Use the optional brief keyword to limit the output to just a summary table and not the detailed information for the AS path set.

show rpl community-set

To display the configuration of community sets, use the show rpl community-set command in EXEC mode.

showrplcommunity-set
[ name | states | brief ]

Syntax Description

name

(Optional) Name of the community set.

states

(Optional) Shows all unused, inactive, and active states.

brief

(Optional) Limits the display to a list of the names of all community sets without their configurations.

Command Default

No default behavior or values

Command Modes

EXEC

Command History

Release

Modification

Release 3.2

This command was introduced.

The summary keyword was replaced with brief.

The * keyword was removed and the states keyword was added.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Use the optional brief keyword to limit the display to a list of the names of community sets without their configurations.

Task ID

Task ID

Operations

route-policy

read

Examples

This example shows the following sample configuration:

route-policy policy_4
if (destination in prefix_set_ex2) then
if (community matches-any comm_set_ex2) then
set community (10:666) additive
endif
if (extcommunity matches-any ext_comm_set_rt_ex2) then
set community (10:999) additive
endif
endif
end-policy

Given this sample configuration, the show rpl community-set comm_set_ex2 command displays the following information:

show rpl community-set attachpoints

To display all the policies used at an attach point that reference the named community set, use the show rpl community-set attachpoints command in EXEC mode.

showrplcommunity-setnameattachpoints

Syntax Description

name

Name of a community set.

Command Default

No default behavior or values

Command Modes

EXEC

Command History

Release

Modification

Release 3.2

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Use the show rpl community-set attachpoints command to display all the policies used at an attach point that reference the named community set either directly or indirectly.

Displays all the policies used at an attach point that reference the named policy.

show rpl community-set references

To list all the policies that reference the named community set, use the show rpl community-set references command in EXEC mode.

showrplcommunity-setnamereferences [brief]

Syntax Description

name

Name of a community set.

brief

(Optional) Limits the output to just the summary table and not the detailed information for the community set.

Command Default

No default behavior or values

Command Modes

EXEC

Command History

Release

Modification

Release 3.2

This command was introduced.

The summary keyword was replaced with brief.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Use the show rpl community-set references command to display all the policies that reference the named community set.

Use the optional brief keyword to limit the output to just a summary table and not the detailed information for the community set.

(Optional) Limits the display to a list of the names of all extended community sets without their configurations.

states

(Optional) Displays all unused, inactive, and active states.

Command Default

If an attachpoint or reference is not specified, all configured extended community sets are displayed

If a cost, RT, or SoO sets is not specified, all configured extended community sets are displayed

Command Modes

EXEC

Command History

Release

Modification

Release 3.2

This command was introduced.

The summary keyword was replaced with brief. The * keyword was removed and the states keyword was added.

Release 3.3.0

The following keywords were added:

attachpoints

references

cost

rt

soo

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Use the optional brief keyword to limit the display to a list of the names of extended community sets without their configurations.

Task ID

Task ID

Operations

route-policy

read

Examples

In the following example, the configuration of an extended community is displayed for the RT community set named ext_comm_set_rt_ex1:

show rpl inactive as-path-set

To display the AS path sets that are referenced by a policy but not in any policy that is used at an attach point, use the show rpl inactive as-path-set command in EXEC mode.

showrplinactiveas-path-set [detail]

Syntax Description

detail

(Optional) Displays the content of the object and all referenced objects for inactive AS path sets.

Command Default

No default behavior or values

Command Modes

EXEC

Command History

Release

Modification

Release 3.2

This command was introduced.

Release 3.3.0

Added the detail keyword.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Use the show rpl inactive as-path-set command to display all AS path sets that are not in use at an attach point either directly or indirectly but are referenced by at least one policy in the system.

Given this sample configuration, the show rpl inactive as-path-set command displays the following information:

RP/0/0/CPU0:router# show rpl inactive as-path-set
ACTIVE -- Referenced by at least one policy which is attached
INACTIVE -- Only referenced by policies which are not attached
UNUSED -- Not attached (directly or indirectly) and not referenced
The following as-path-sets are INACTIVE
---------------------------------------
as_path_set_ex2

Displays the route policies that are referenced by a policy but not in any policy that is used at an attach point.

show rpl inactive community-set

To display the community sets that are referenced by a policy but not any policy that is used at an attach point, use the show rpl inactive community-set command in EXEC mode.

showrplinactivecommunity-set [detail]

Syntax Description

detail

(Optional) Displays the content of the object and all referenced objects for inactive community sets.

Command Default

No default behavior or values

Command Modes

EXEC

Command History

Release

Modification

Release 3.2

This command was introduced.

Release 3.3.0

The detail keyword was added.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Use the show rpl inactive community-set command to display all community sets that are not in use at an attach point either directly or indirectly but are referenced by at least one policy in the system.

Given this sample configuration, the show rpl inactive community-set command displays the following information:

RP/0/0/CPU0:router# show rpl inactive community-set
ACTIVE -- Referenced by at least one policy which is attached
INACTIVE -- Only referenced by policies which are not attached
UNUSED -- Not attached (directly or indirectly) and not referenced
The following community-sets are INACTIVE
------------------------------------------
comm_set_ex2

Displays the route policies that are referenced by a policy but not in any policy that is used at an attach point.

show rpl inactive extcommunity-set

To display the extended community sets that are referenced by a policy but not in any policy that is used at an attach point, use the show rpl inactive extcommunity-set command in EXEC mode.

showrplinactiveextcommunity-set [detail]

Syntax Description

detail

(Optional) Displays the content of the object and all referenced objects for inactive extended community sets.

Command Default

No default behavior or values

Command Modes

EXEC

Command History

Release

Modification

Release 3.2

This command was introduced.

Release 3.3.0

The detail keyword was added.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Use the show rpl inactive extcommunity-set command to display all extended community sets that are not in use at an attach point either directly or indirectly but are referenced by at least one policy in the system.

Given this sample configuration, the show rpl inactive extcommunity-set command displays the following information:

RP/0/0/CPU0:router# show rpl inactive extcommunity-set
ACTIVE -- Referenced by at least one policy which is attached
INACTIVE -- Only referenced by policies which are not attached
UNUSED -- Not attached (directly or indirectly) and not referenced
The following extcommunity-sets are INACTIVE
--------------------------------------------
ext_comm_set_rt_ex2

Displays the route policies that are referenced by a policy but not in any policy that is used at an attach point.

show rpl inactive prefix-set

To display the prefix sets that are referenced by a policy but not in any policy that is used at an attach point, use the show rpl inactive prefix-set command in EXEC mode.

showrplinactiveprefix-set [detail]

Syntax Description

detail

(Optional) Displays the content of the object and all referenced objects for inactive prefix sets.

Command Default

No default behavior or values

Command Modes

EXEC

Command History

Release

Modification

Release 3.2

This command was introduced.

Release 3.3.0

The detail keyword was added.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Use the show rpl inactive prefix-set command to display all prefix sets that are not in use at an attach point either directly or indirectly but are referenced by at least one policy in the system.

Given this sample configuration, the show rpl inactive prefix-set command displays the following information:

RP/0/0/CPU0:router# show rpl inactive prefix-set
ACTIVE -- Referenced by at least one policy which is attached
INACTIVE -- Only referenced by policies which are not attached
UNUSED -- Not attached (directly or indirectly) and not referenced
The following prefix-sets are INACTIVE
--------------------------------------
sample4
prefix_set_ex2

Displays the RD sets that are referenced by a policy but not in any policy that is used at an attach point.

show rpl inactive rd-set

To display the route distinguisher (RD) sets that are referenced by a policy but not in any policy that is used at an attach point, use the show rpl inactive rd-set command in EXEC mode.

showrplinactiverd-set [detail]

Syntax Description

detail

(Optional) Displays the content of the object and all referenced objects for inactive RD sets.

Command Default

No default behavior or values

Command Modes

EXEC

Command History

Release

Modification

Release 3.4.0

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Use the show rpl inactive rd-set command to display all RD sets that are not in use at an attach point either directly or indirectly but are referenced by at least one policy in the system.

Examples

Given this sample configuration, the show rpl inactive rd-set command displays the following information:

RP/0/0/CPU0:router# show rpl inactive rd-set
ACTIVE -- Referenced by at least one policy which is attached INACTIVE -- Only referenced by policies which are not attached UNUSED -- Not attached (directly or indirectly) and not referenced
The following rd-sets are INACTIVE
------------------------------------------
rdset1
rdset2

Displays the route policies that are referenced by a policy but not in any policy that is used at an attach point.

show rpl inactive route-policy

To display the route policies that are referenced by a policy but not in any policy that is used at an attach point, use the show rpl inactive route-policy command in EXEC mode.

showrplinactiveroute-policy [detail]

Syntax Description

detail

(Optional) Displays the content of the object and all referenced objects for inactive route policies.

Command Default

No default behavior or values

Command Modes

EXEC

Command History

Release

Modification

Release 3.2

This command was introduced.

The policy keyword was changed to route-policy.

Release 3.3.0

The detail keyword was added.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Use the show rpl inactive route-policy command to display all policies that are not in use at an attach point either directly or indirectly but are referenced by at least one other policy in the system.

Given this sample configuration, the show rpl inactive route-policy command displays the following information:

RP/0/0/CPU0:router# show rpl inactive route-policy
ACTIVE -- Referenced by at least one policy which is attached
INACTIVE -- Only referenced by policies which are not attached
UNUSED -- Not attached (directly or indirectly) and not referenced
The following policies are (INACTIVE)
-------------------------------------
sample3
policy_3

Displays the RD sets that are referenced by a policy but not in any policy that is used at an attach point.

show rpl maximum

To display the maximum limits for lines of configuration and number of policies, use the show rpl maximum command in EXEC mode.

showrplmaximum
[ lines | policies ]

Syntax Description

lines

(Optional) Displays the number of lines of configuration limit.

policies

(Optional) Displays the number of policies limit.

Command Default

No default behavior or values

Command Modes

EXEC

Command History

Release

Modification

Release 3.2

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Use the show rpl maximum command to display the current total, current limit, and maximum limit for lines of configuration and policies.

Use the optional lines keyword to limit the display to the number of lines of configuration limits. Use the optional policies keyword to limit the display to the number of policies limits.

Task ID

Task ID

Operations

route-policy

read

Examples

The following example shows sample output from the show rpl maximum command:

Related Commands

Configures the maximum number of lines of configuration and number of policies.

show rpl policy-global references

To display policy-global definitions, use the show rpl policy-global references command in EXEC mode.

showrplpolicy-globalreferences [brief]

Syntax Description

brief

(Optional) Limits the display to a list of the policy names.

Command Default

No default behavior or values

Command Modes

EXEC

Command History

Release

Modification

Release 3.6.0

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

show rpl prefix-set

To display the configuration of prefix sets, use the show rpl prefix-set command in EXEC mode.

showrplprefix-set
[ name | states | brief ]

Syntax Description

name

(Optional) Name of the prefix set.

states

(Optional) Shows all unused, inactive, and active states.

brief

(Optional) Limits the display to a list of the names of all extended community sets without their configurations.

Command Default

No default behavior or values

Command Modes

EXEC

Command History

Release

Modification

Release 3.2

This command was introduced.

The summary keyword was replaced with brief.

The * keyword was removed and the states keyword was added.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Because sets cannot hierarchically reference other sets or policies, no detail keyword exists as with the show rpl policy command.

Task ID

Task ID

Operations

route-policy

read

Examples

In the following example, the configuration of prefix set pset1 is displayed:

show rpl prefix-set attachpoints

To display all the policies used at an attach point that reference the named prefix set, use the show rpl prefix-set attachpoints command in EXEC mode.

showrplprefix-setnameattachpoints

Syntax Description

name

Name of a prefix set.

Command Default

No default behavior or values

Command Modes

EXEC

Command History

Release

Modification

Release 3.2

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Use the show rpl prefix-set attachpoints command to display all the policies used at an attach point that reference the named prefix set either directly or indirectly.

Displays all the policies used at an attach point that reference the named policy.

show rpl prefix-set references

To list all the policies that reference the named prefix set, use the show rpl prefix-set references command in EXEC mode.

showrplprefix-setnamereferences [brief]

Syntax Description

name

Name of the prefix set.

brief

(Optional) Limits the output to just a summary table and not the detailed information for the named prefix set.

Command Default

No default behavior or values

Command Modes

EXEC

Command History

Release

Modification

Release 3.2

This command was introduced.

The summary keyword was replaced with brief.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Use the show rpl prefix-set references command to list all the policies that reference the named prefix set.

Use the optional brief keyword to limit the output to just a summary table and not the detailed information for the named prefix set.

The following example displays information showing the usage and status of each policy that references the prefix set ten-net. The brief keyword limits the display to just a summary table and not the detailed information for the prefix set.

show rpl rd-set

To display the configuration of route distinguisher (RD) sets, use the show rpl rd-set command in EXEC mode.

showrplrd-set
[ name | states | brief ]

Syntax Description

name

(Optional) Name of the RD set.

states

(Optional) Shows all unused, inactive, and active states.

brief

(Optional) Limits the display to a list of the names of all RD sets without their configurations.

Command Default

No default behavior or values

Command Modes

EXEC

Command History

Release

Modification

Release 3.4.0

This command was introduced.

Usage Guidelines

To use this command, you must be in a user group associated with a task group that includes appropriate task IDs. If the user group assignment is preventing you from using a command, contact your AAA administrator for assistance.

Because sets cannot hierarchically reference other sets or policies, no detail keyword exists as with the show rpl policy command.

Task ID

Task ID

Operations

route-policy

read

Examples

In the following example, the configuration of RD set rdset1 is displayed: