6.6. Route Policy Command Reference

6.6.1. Command Hierarchies

6.6.1.1. Route Policy Configuration Commands

config
[no] router
[no] weighted-ecmp
abort
as-path (policy options) name expression regular-expression
[no] entry entry-id expression reg-exp
begin [exclusive]
commit
community name members comm-id [comm-id]
community name expression expression [exact]
— no community name [members comm-id]
[no] damping name
half-life minutes
— no half-life
max-suppress minutes
reuse integer
— no reuse
suppress integer
— no suppress
[no] exclusive-lock-time seconds
name name-string value value-string
name name-string address ip-address
name name-string number value-number
— no name name-string
[no] policy-statement name
default-action {accept | next-entry | next-policy | drop | reject}
add-paths-send-limit send-limit
admin-tag-policy policy-name
advertise-label {per-prefix | pop}
aigp-metric metric
aigp-metric add
aigp-metric ipg
as-path {add | replace} name
— no as-path
as-path-prepend as-path [repeat]
as-path-prepend most-recent [repeat]
— no bgp-leak
community add name [name]
community remove name [name]
community replace name [name]
— no community
damping {name | none}
— no damping
local-preference local-preference
metric {add | subtract} metric
metric set [igp | metric-value]
— no metric
multicast-redirection [fwd-service service-id] ip-int-name
next-hop ip-address
— no next-hop
[no] next-hop-self
origin {igp | egp | incomplete | param-name}
— no origin
origin-validation-state {state | param-name}
preference preference
— no preference
[no] resolve-static
source-class [value]
[no] sticky-ecmp
tag tag
— no tag
type {type | param-name}
— no type
description description-string
[no] entry entry-id
action {accept | next-entry | next-policy | drop | reject}
— no action
add-paths-send-limit send-limit
admin-tag-policy policy-name
advertise-label {per-prefix | pop}
aigp-metric metric
aigp-metric metric add
aigp-metric ipg
as-path {add | replace} name
— no as-path
as-path-prepend as-number [repeat]
as-path-prepend most-recent [repeat]
— no bgp-leak
community add name [name]
community remove name [name]
community replace name [name]
— no community
damping {name | none}
— no damping
fc fc [priority {low | high}]
— no fc
local-preference local-preference
metric {add | subtract} metric
metric set {igp | metric-value}
— no metric
next-hop ip-address
multicast-redirection [fwd-service service-id] ip-int-name
— no next-hop
[no] next-hop-self
origin {igp | egp | incomplete | param-name}
— no origin
origin-validation-state {state | param-name}
policy name
preference preference
— no preference
[no] resolve-static
[no] sticky-ecmp
tag {no-tag | tag}
— no tag
type type
— no type
— conditional-expression
route-exists expression
— no route-exists
description description-string
[no] from
area area-id
— no area
as-path name
— no as-path
as-path-group name
as-path-length length [equal | or-higher | or-lower] [unique]
cluster-id ip-address/mask [ip-address/mask]
cluster-id none
— no cluster-id
community comm-name
community expression expression
— no community
community-count count [equal | or-higher | or-lower] [standard | extended | large]
[no] external
family [ipv4] [label-ipv4] [vpn-ipv4] [ipv6] [label-ipv6] [vpn-ipv6] [mcast-ipv4] [l2-vpn] [mvpn-ipv4] [mvpn-ipv6] [mdt-safi] [ms-pw] [flow-ipv4] [flow-ipv6] [route-target] [mcast-vpn-ipv4] [evpn] [bgp-ls] [mcast-ipv6] [mcast-vpn-ipv6] [sr-policy-ipv4]
— no family
flow-spec-dest prefix-list-name
flow-spec-source prefix-list-name
group-address prefix-list-name
host-ip prefix-list-name
— no host-ip
interface interface-name
— no interface
level {1 | 2}
— no level
local-preference preference [equal | or-higher | or-lower]
metric metric [equal | or-higher | or-lower]
— no metric
mvpn-type {1 | 2 | 3 | 4 | 5 | 6 | 7 }
— no mvpn-type
neighbor {ip-address | prefix-list name}
— no neighbor
next-hop ip-address
next-hop prefix-list name
— no next-hop
origin {igp | egp | incomplete | any | aaa | dynamic | static | bonding}
— no origin
path-type {ibgp | ebgp}
— no path-type
policy plcy-or-long-expr
— no policy
name name-string value value-string
name name-string address ip-address
name name-string number value-number
— no name name-string
— no policy name name-string
prefix-list name [name]
protocol protocol [all | instance instance]
protocol bgp bgp-label
— no protocol
source-address ip-address
source-address prefix-list prefix-list-name
state state
— no state
tag {no-tag | tag}
— no tag
type type
— no type
[no] to
level {1 | 2}
— no level
neighbor {ip-address | prefix-list name}
— no neighbor
[no] prefix-list name [name]
protocol protocol [all | {instance instance}]
protocol bgp bgp-label
— no protocol
config
[no] router
[no] prefix-list name
prefix ip-prefix/prefix-length [exact | longer | through length | prefix-length-range length1-length2]
no prefix [ipv-prefix/prefix-length] [exact | longer | through length | prefix-length-range length1-length2]

6.6.1.2. Segment Routing Commands

config
[no] router
[no] shutdown
[no] shutdown
static-policy name [create]
— no static-policy name
binding-sid number
— no binding-sid
color color
— no color
endpoint ipv4-address
— no endpoint
head-end local
head-end ipv4-address
— no head-end
preference preference
segment-list [1..32] [create]
— no segment-list [1..32]
segment [1..11] [create]
— no segment [1..11]
mpls-label value
— no mpls-label
[no] shutdown
weight weight
— no weight
[no] shutdown

6.6.2. Command Descriptions

6.6.2.1. Generic Commands

abort

Syntax 
abort
Context 
config>router>policy-options
Description 

This command is required to discard changes made to a route policy.

begin

Syntax 
begin {exclusive}
Context 
config>router>policy-options
Description 

This command is required in order to enter the mode to create or edit route policies.

Parameters 
exclusive —
Specifies an exclusive lock on the policy configuration. Other CLI and SNMP users will be unable to edit the policy configuration until the lock is removed (via commit, abort, a timeout occurring, or a forced override).

commit

Syntax 
commit
Context 
config>router>policy-options
Description 

This command is required to save changes made to a route policy.

description

Syntax 
description string
no description
Context 
config>router>policy-options>policy-statement
config>router>policy-options>policy-statement>entry
Description 

This command creates a text description which is stored in the configuration file to help identify the content of the entity.

The no form of the command removes the string from the configuration.

Parameters 
string—
The description character string. Allowed values are any string up to 80 characters long composed of printable, 7-bit ASCII characters. If the string contains special characters (#, $, spaces, etc.), the entire string must be enclosed within double quotes.

6.6.2.2. Segment Routing

segment-routing

Syntax 
segment-routing
Context 
config>router>
Description 

This command creates a context to configure protocol-independent parameters relating to segment routing.

sr-policies

Syntax 
sr-policies
Context 
config>router>segment-routing
Description 

This command creates the context to configure segment routing policies. A segment routing policy specifies traffic to be matched by the policy and actions to take on the matched traffic by applying the instructions encoded in one or more segment lists.

ingress-statistics

Syntax 
[no] ingress-statistics
Context 
config>router>segment-routing>sr-policies
Description 

This command administratively enables the collection of ingress traffic statistics for all segment routing policies. The statistics provide counts for the number of incoming packets and bytes corresponding to each (color, endpoint) combination.

If there are any SR-MPLS interfaces on an FP2 or older line-cards, an attempt to enable this command will fail.

The no form of the command disables ingress stats collection for all segment routing policies.

Default 

no ingress-statistics

shutdown

Syntax 
[no] shutdown
Context 
config>router>segment-routing>sr-policies>ingress-statistics
Description 

This command administratively disables the collection of ingress statistics for all segment routing policies.

The no form of the command administratively enables the collection of ingress statistics for all segment routing policies.

reserved-label-block

Syntax 
reserved-label-block name
no reserved-label-block
Context 
config>router>segment-routing>sr-policies
Description 

This command associates a reserved label block with segment routing policies. The reserved-label-block must already exist. Reserved label blocks are configured under the config>router>mpls-labels hierarchy.

A locally-targeted segment routing policy (statically configured or BGP signaled) cannot be activated if its binding SID (BSID) is not an available label between the start-label and end-label of the referenced reserved label block.

The no form of the command removes any association of segment routing policies with a reserved label block.

Default 

no reserved-label-block

Parameters 
name—
Specifies the name of a reserved-label-block that has already been configured, up to 64 characters.

shutdown

Syntax 
[no] shutdown
Context 
config>router>segment-routing>sr-policies
Description 

This command deactivates all segment routing policies and removes the associated entries from the forwarding plane of the router.

It is necessary to execute this shutdown if you want to make a change to the reserved-label-block reference.

The no form of the command enables all segment routing policies so that they can be revalidated and reinstalled as necessary.

static-policy

Syntax 
static-policy name [create]
no static-policy name
Context 
config>router>segment-routing>sr-policies
Description 

This command creates a context to configure a segment routing policy. The resulting segment routing policy is targeted for local installation or propagation by BGP to another router.

The no form of the command deletes the statically defined segment routing policy.

Default 

no static-policy

Parameters 
name—
Specifies the name assigned to the statically defined segment routing policy, up to 64 characters.
create
Keyword used to create the policy.

binding-sid

Syntax 
binding-sid number
no binding-sid
Context 
config>router>segment-routing>sr-policies>static-policy
Description 

This command associates a binding SID with a statically defined segment routing policy. This is a mandatory parameter in order to enable the segment routing policy. The BSID label should be an available label in the reserved-label-block range.

The no form of the command removes the BSID association.

Default 

no binding-sid

Parameters 
number—
Specifies the binding SID label value.
Values—
32 to 1048575

 

color

Syntax 
color color
no color
Context 
config>router>segment-routing>sr-policies>static-policy
Description 

This command associates a color value with a statically defined segment routing policy. This is a mandatory parameter in order to enable the segment routing policy.

The no form of the command removes the color association.

Default 

no color

Parameters 
color—
Specifies the color ID.
Values—
0 to 4294967295

 

distinguisher

Syntax 
distinguisher id
no distinguisher
Context 
config>router>segment-routing>sr-policies>static-policy
Description 

This command associates a distinguisher value with a statically defined segment routing policy. This is a mandatory parameter for non-local segment routing policies (for which head-end is not local). Every non-local segment routing policy must have a unique distinguisher value. When a non-local static segment routing policy is imported into BGP and originated as a BGP route, the configured distinguisher value is copied into the NLRI of the route.

The no form of the command removes the distinguisher association.

Default 

no distinguisher

Parameters 
id—
Specifies the distinguisher ID.
Values—
1 to 4294967295

 

endpoint

Syntax 
endpoint ipv4-address
no endpoint
Context 
config>router>segment-routing>sr-policies>static-policy
Description 

This command associates an IPv4 endpoint address with a statically-defined segment routing policy. This is a mandatory parameter in order to enable the segment routing policy.

An endpoint address of 0.0.0.0 is a special value that matches all BGP next-hops, however in order to use this policy the BGP route must have a color extended community with the color-only bits set to '01' or '10'.

The no form of the command removes the endpoint association.

Default 

no endpoint

Parameters 
ipv4-address—
Specifies the endpoint address of the segment routing policy.
Values—
a.b.c.d

 

head-end

Syntax 
head-end local
head-end ipv4-address
no head-end
Context 
config>router>segment-routing>sr-policies>static-policy
Description 

This command associates a head-end location with a statically-defined segment routing policy. The head-end is an identification of the router which is the target to install the policy. This is a mandatory parameter for enabling the segment routing policy.

In order to associate a static policy with the local router as head-end, the keyword local must be specified. The static policy is associated with another (non-local) router if the head-end parameter is set to any IPv4 address. When a non-local static segment routing policy is imported into BGP and originated as a BGP route, the configured head-end address is converted into an IPv4-address specific route-target extended community that is automatically added to the route.

The no form of the command removes the head-end association.

Default 

no head-end

Parameters 
local
Keyword indicating that the policy is intended to be used by the local router and not advertised to other BGP routers.
ipv4-address—
Specifies the head-end address of the (non-local) segment routing policy.
Values—
a.b.c.d

 

preference

Syntax 
preference preference
Context 
config>router>segment-routing>sr-policies>static-policy
Description 

This command associates a preference value with a statically defined-segment routing policy. This is an optional parameter.

When there are multiple policies for the same (color, endpoint) combination that are targeted for local installation, only one is selected as the active path for the (color, endpoint). In this selection process (which considers both static local policies and BGP signaled policies), the policy with the highest preference value is preferred over all policies with a lower preference value.

The no form of the command removes the explicitly configured preference value and restores the default value of 100.

Default 

no preference

Parameters 
preference—
Specifies the preference ID.
Values—
0 to 4294967295

 

segment-list

Syntax 
segment-list [1..32] [create]
no segment-list list
Context 
config>router>segment-routing>sr-policies
Description 

This command creates the context to configure a segment list for the statically-defined segment routing policy.

Up to 32 segment lists are supported per policy.

The no form of the command deletes the segment list.

Parameters 
create
Keyword used to create the segment list.

segment

Syntax 
segment [1..11] [create]
no segment
Context 
config>router>segment-routing>sr-policies>static-policy>segment-list
Description 

This command creates the context to configure a segment inside a segment-list of a statically-defined segment routing policy.

Each segment list can have up to 11 segments.

The no form of the command deletes the segment context.

Default 

no segment

Parameters 
create
Keyword used to create the list.

mpls-label

Syntax 
mpls-label value
no mpls-label
Context 
config>router>segment-routing>sr-policies>static-policy>segment-list>segment
Description 

This command configures the MPLS label value this is associated with a segment.

The no form of the command removes the label value.

Default 

no mpls-label

Parameters 
value—
Specifies the MPLS label value.
Values—
0 to 1048575

 

shutdown

Syntax 
[no] shutdown
Context 
config>router>segment-routing>sr-policies>static-policy>segment-list
Description 

This command deactivates a segment-list. If this is done on an active policy with more than one segment list, then traffic forwarded by the policy will be diverted to the remaining segment-lists.

The no form of the command enables the segment list so that it can be validated and installed as necessary.

Default 

shutdown

weight

Syntax 
weight weight
no weight
Context 
config>router>segment-routing>sr-policies>static-policy>segment-list
Description 

This command associates a weight value with a segment list of a statically-defined segment routing policy in order to achieve weighted ECMP behavior. Weight is an optional parameter.

When any segment-list in the active policy has a weight greater than 1, traffic matching the policy will be load-balanced across the segment lists according to their relative weight values.

The no form of the command removes the explicitly configured weight value and restores the default value of 1.

Default 

no weight

Parameters 
weight—
Specifies the weight value.
Values—
1 to 4294967295

 

shutdown

Syntax 
[no] shutdown
Context 
config>router>segment-routing>sr-policies>static-policy
Description 

This command deactivates the associated static policy and causes another policy for the same (color, endpoint) combination to be promoted as the active path, assuming there is another valid policy.

It is necessary to execute this shutdown if you want to make critical configuration changes to the static policy.

The no form of the command enables the static policy so that it can be validated and installed as necessary.

6.6.2.3. Route Policy Options

as-path (policy options)

Syntax 
as-path name expression regular-expression
no as-path name
Context 
config>router>policy-options
Description 

This command creates a route policy AS path regular expression statement to use in route policy entries.

The no form of the command deletes the AS path regular expression statement.

Default 

no as-path

Parameters 
name—
The AS path regular expression name. Allowed values are any string up to 32 characters long composed of printable, 7-bit ASCII characters. If the string contains special characters (#, $, spaces, etc.), the entire string must be enclosed within double quotes.
reg-exp—
The AS path regular expression. Allowed values are any string up to 256 characters long composed of printable, 7-bit ASCII characters. If the string contains special characters (#, $, spaces, etc.), the entire string must be enclosed within double quotes. Policy parameters must start and end with at-signs (@); for example, “@variable@”.
null
The AS path expressed as an empty regular expression string.

as-path-group (policy options)

Syntax 
as-path-group name
no as-path-group name
Context 
config>router>policy-options
Description 

This command creates a route policy AS path regular expression statement to use in route policy entries.

The no form of the command deletes the AS path regular expression statement.

Default 

no as-path-group

Parameters 
name—
The AS path regular expression name. Allowed values are any string up to 32 characters long composed of printable, 7-bit ASCII characters. If the string contains special characters (#, $, spaces, etc.), the entire string must be enclosed within double quotes. Policy parameters must start and end with at-signs (@); for example, “@variable@”.

entry

Syntax 
entry entry-id expression reg-exp
no entry
Context 
config>router>policy-options>as-path-group
Description 

This command creates the context to edit route policy entries within an autonomous system path group.

Multiple entries can be created using unique entries. The router exits the filter when the first match is found and executes the action specified. For this reason, entries must be sequenced correctly from most to least explicit.

An entry does not require matching criteria defined (in which case, everything matches) but must have at least define an action in order to be considered complete. Entries without an action are considered incomplete and will be rendered inactive.

The no form of the command removes the specified entry from the autonomous system path group.

Parameters 
entry-id—
The entry ID expressed as a decimal integer. An entry-id uniquely identifies match criteria and the corresponding action. It is recommended that multiple entries be given entry-ids in staggered increments. This allows users to insert a new entry in an existing policy without requiring renumbering of all the existing entries.
Values—
1 to 4294967295

 

reg-exp—
The AS path group regular expression. Allowed values are any string up to 256 characters long composed of printable, 7-bit ASCII characters. If the string contains special characters (#, $, spaces, etc.), the entire string must be enclosed within double quotes.

community

Syntax 
community name members comm-id [comm-id]
community name expression expression [exact]
no community name [members comm-id]
Context 
config>router>policy-options
Description 

This command creates a route policy community list to use in route policy entries.

The no form of the command deletes the community list or the provided community ID.

Default 

no community

Parameters 
name—
The community list name. Allowed values are any string up to 64 characters, composed of printable, 7-bit ASCII characters. If the string contains special characters (#, $, spaces, and so on). The entire string must be enclosed within double quotes.
comm-id—
Specifies a BGP community value, up to 72 characters. A community ID can be specified in different forms.
Values—
[as-num:comm-val | reg-ex | ext-comm | well-known-comm | large-comm]
where:
  1. as-num — 0 to 65535
  2. comm-val — 0 to 65535
  3. reg-ex — A regular expression string. Allowed values are any string up to 72 characters, composed of printable, 7-bit ASCII characters. If the string contains special characters (such as “#”, “$”, or spaces), the entire string must be enclosed within double quotes.
  4. ext-comm — The extended community, defined as one of the following:
    1. {target | origin}:ip-address:comm-val
    2. {target | origin}:reg-ex1&reg-ex2
    3. {target | origin}:ip-address:reg-ex2
    4. {target | origin}:asnum:ext-comm-val
    5. {target | origin}:ext-asnum:comm-val
    6. bandwidth:asnum:val-in-mbps
    7. ext:4300:ovstate
    8. ext:value1:value2
    9. flowspec-set:ext-asnum:group-id
    10. flowspec-set-trans:ext-asnum:group-id
    11. color:co-bits:color-value
    where:
    1. target — route target
    2. origin — route origin
    3. ip-address — a.b.c.d
    4. ext-comm-val — 0 to 4294967295
    5. ext-asnum — 0 to 4294967295
    6. reg-ex1, reg-ex2 — A regular expression string. Allowed values are any string up to 63 characters, composed of printable, 7-bit ASCII characters. If the string contains special characters (#, $, spaces, and so on), the entire string must be enclosed within double quotes.
    7. bandwidth — bandwidth
    8. val-in-mbps — 0 to 16777215
    9. ext:4300 — origin verification
    10. ovstate — 0, 1, or 2 (0 for valid, 1 for not found, 2 for invalid)
    11. ext — extended
    12. value1 — 0000 to FFFF
    13. value2 — 0 to FFFFFFFFFFFF
    14. flowspec-set — flow-spec set
    15. flowspec-set-trans — flow-spec set transitive
    16. group-id — 0 to 16383
    17. co-bits — 00, 01, 10 or 11
    18. color-value — 0 to 4294967295
  5. well-known-commnull, no-export, no-export-subconfed, no-advertise, llgr-stale, no-llgr, blackhole
  6. large-comm — large community, defined as one of the following:
    1. ext-asnum:ext-comm-val:ext-comm-val
    2. reg-ex3&reg-ex3&reg-ex3
    where:
    1. reg-ex3 — A regular expression string. Allowed values are any string up to 68 characters, composed of printable, 7-bit ASCII characters. If the string contains special characters (#, $, spaces, and so on), the entire string must be enclosed within double quotes.

 

expression expression
Specifies a logical expression containing terms and operators. It can contain sub-expressions enclosed in round brackets.
Values—
up to 900 characters
<expression> is one of the following: <expression> {AND|OR} <expression> [NOT] ( <expression> ) [NOT] <comm-id>

 

For example:

from community expression "[community list A] OR ([community list B] AND [community list C])"

exact—
All the communities indicated by the expression must be present in the route in order for a match to occur.

exclusive-lock-time

Syntax 
exclusive-lock-time seconds
no exclusive-lock
Context 
config>router>policy-options
Description 

This command specifies the inactivity timer for the exclusive lock time for policy editing. When a session is idle for greater than this time, the lock is removed and the configuration changes is aborted.

Default 

exclusive-lock-time 300

Parameters 
seconds—
Specifies the duration the session with exclusive lock may be inactive.
Values—
Values: 1 to 3600

 

global-variables

Syntax 
global-variables
no global-variables
Context 
config>router>policy-options
Description 

This command enables the global-variables configuration context.

The no form of the command removes all global variables.

name

Syntax 
name name-string value value-string
name name-string address ip-address
name name-string number value-number
no name name-string
Context 
config>router>policy-options>global-variables
config>router>policy-options>policy-statement>from>policy-variables
Description 

This command allows operators to configure routing policies that are often reused across BGP peers of a common type (transit, peer, customer, and so on). Using global variables allows an operator to have a single variable that is consistent across all peers of a type, while retaining the flexibility to reference different policy functions (prefixes, prefix-lists, community lists, and so on) with unique names.

Depending on the parameter referenced, the correct type should be specified as follows:

  1. value-string: as-path, as-path-group, community, prefix-list, damping
  2. ip-address: next-hop
  3. value-number: aigp-metric, as-path-prepend, local-preference, metric, origin, origin-validation, preference, tag, type

The no form of the command removes the global variable.

Parameters 
name-string—
The name of the global variable, with the variable delimited by at-signs (@) at the beginning and the end of the name. Allowed values are any string up to 32 characters, composed of printable, 7-bit ASCII characters. If the string contains special characters (#, $, spaces, and so on), the entire string must be enclosed within double quotes.
value-string—
The value of the policy variable. Allowed values are any string up to 32 characters long composed of printable, 7-bit ASCII characters. If the string contains special characters (#, $, spaces, and so on), the entire string must be enclosed within double quotes.
value-number—
The numerical value of the policy variable.
Values—
0 to 4294967295

 

ip-address—
The IP address of the policy variable.
Values—
ipv4-address:
  1. a.b.c.d
ipv6-address:
  1. x:x:x:x:x:x:x:x [-interface]
  2. x:x:x:x:x:x:d.d.d.d [-interface]
  3. x: [0 to FFFF]H
  4. d: [0 to 255]D

 

policy-options

Syntax 
[no] policy-options
Context 
config>router
Description 

This command enables the context to configure route policies. Route policies are applied to the routing protocol.

The no form of the command deletes the route policy configuration.

triggered-policy

Syntax 
[no] triggered-policy
Context 
config>router
Description 

This command triggers route policy re-evaluation.

By default, when a change is made to a policy in the config router policy options context and then committed, the change is effective immediately. There may be circumstances when the changes should or must be delayed; for example, if a policy change is implemented that would affect every BGP peer on a router, the consequences could be dramatic. It is more effective to control changes on a peer by peer basis.

If the triggered-policy command is enabled, and a given peer is established, and you want the peer to remain up, then, in order for a change to a route policy to take effect, a clear command with the soft or soft-inbound option must be used. In other words, when a triggered-policy is enabled, any routine policy change or policy assignment change within the protocol will not take effect until the protocol is reset or a clear command is issued to re-evaluate route policies; for example, clear router bgp neighbor x.x.x.x soft. This keeps the peer up and the change made to a route policy is applied only to that peer, or group of peers.

Default 

no triggered-policy

weighted-ecmp

Syntax 
[no] weighted-ecmp
Context 
config>router
Description 

This command enables weighted load balancing in the base router instance for certain types of OSPF, IS-IS, and static routes with equal-cost multipath (ECMP) next hops.

For OSPF and static routes, this command only applies to IPv4 routes where all the next hops are tunnel next hops corresponding to MPLS LSPs with configured load-balancing weights. Weighted load balancing over MPLS LSPs is supported in the following cases:

  1. an IGP prefix resolved to IGP shortcuts in the RTM (igp-shortcut or advertise-tunnel-link enabled in the IGP instance)
  2. a BGP prefix with the BGP next hop resolved to IGP shortcuts in RTM (igp-shortcut or advertise-tunnel-link enabled in the IGP instance)
  3. a static route prefix resolved to an indirect next hop, which is resolved to a set of equal- metric MPLS LSPs in the TTM. The user can allow automatic selection or specify the names of the equal-metric MPLS LSPs in TTM to be used in the ECMP set.
  4. a static route prefix resolved to an indirect next-hop, which is resolved to IGP shortcuts in the RTM
  5. a BGP prefix with a BGP next hop resolved to a static route, which resolves to a set of tunnel next hops towards an indirect next hop in the RTM or TTM
  6. a BGP prefix resolved to another BGP prefix whose next hop is resolved to a set of ECMP tunnel next hops with a static route in the RTM or TTM or to IGP shortcuts in the RTM

For IS-IS routes, in addition to enabling the behavior described for OSPF and static routes, this command also allows weighted load balancing when all the ECMP next hops are interfaces with configured load-balancing weights. The interface-level weighted ECMP support for IS-IS applies to both IPv4 and IPv6.

If one or more LSPs or interfaces in the ECMP set of a prefix do not have a load-balancing weight configured, the regular ECMP spraying for the prefix will be performed.

The no form of the command restores regular ECMP spraying of packets to static and IGP route destinations.

Default 

no weighted-ecmp

6.6.2.4. Route Policy Damping Commands

damping

Syntax 
[no] damping name
Context 
config>router>policy-options
Description 

This command creates a context to configure a route damping profile to use in route policy entries.

The no form of the command deletes the named route damping profile.

Default 

no damping

Parameters 
name—
The damping profile name. Allowed values are any string up to 32 characters long composed of printable, 7-bit ASCII characters. If the string contains special characters (#, $, spaces, etc.), the entire string must be enclosed within double quotes.

half-life

Syntax 
half-life minutes
no half-life
Context 
config>router>policy-options>damping
Description 

This command configures the half-life parameter for the route damping profile.

The half life value is the time, expressed in minutes, required for a route to remain stable in order for the Figure of Merit (FoM) value to be reduced by one half; for example, if the half life value is 6 (minutes) and the route remains stable for 6 minutes, then the new FoM value is 3 (minutes). After another 3 minutes pass and the route remains stable, the new FoM value is 1.5 (minutes).

When the FoM value falls below the reuse threshold, the route is once again considered valid and can be reused or included in route advertisements.

The no form of the command removes the half life parameter from the damping profile.

Default 

no half-life

Parameters 
minutes—
The half life in minutes expressed as a decimal integer.
Values—
1 to 45

 

max-suppress

Syntax 
max-suppress minutes
no max-suppress
Context 
config>router>policy-options>damping
Description 

This command configures the maximum suppression parameter for the route damping profile.

This value indicates the maximum time, expressed in minutes, that a route can remain suppressed.

The no form of the command removes the maximum suppression parameter from the damping profile.

Default 

no max-suppress

Parameters 
minutes—
The maximum suppression time, in minutes, expressed as a decimal integer.
Values—
1 to 720

 

reuse

Syntax 
reuse integer
no reuse
Context 
config>router>policy-options>damping
Description 

This command configures the reuse parameter for the route damping profile.

When the Figure of Merit (FoM) value falls below the reuse threshold, the route is once again considered valid and can be reused or included in route advertisements.

The no form of the command removes the reuse parameter from the damping profile.

Default 

no reuse

Parameters 
integer—
The reuse value expressed as a decimal integer.
Values—
1 to 20000

 

suppress

Syntax 
suppress integer
no suppress
Context 
config>router>policy-options>damping
Description 

This command configures the suppression parameter for the route policy damping profile.

A route is suppressed when it has flapped frequently enough to increase the Figure of Merit (FoM) value to exceed the suppress threshold limit. When the FoM value exceeds the suppress threshold limit, the route is removed from the route table or inclusion in advertisements.

The no form of the command removes the suppress parameter from the damping profile.

Default 

no suppress

Parameters 
integer—
The suppress value expressed as a decimal integer.
Values—
1 to 20000

 

6.6.2.5. Route Policy Prefix Commands

prefix-list

Syntax 
[no] prefix-list name
Context 
config>router>policy-options
Description 

This command creates a context to configure a prefix list to use in route policy entries.

The no form of the command deletes the named prefix list.

Parameters 
name—
The prefix list name. Allowed values are any string up to 32 characters long composed of printable, 7-bit ASCII characters. If the string contains special characters (#, $, spaces, etc.), the entire string must be enclosed within double quotes. Policy parameters must be enclosed by at-signs (@) and may be midstring; for example, "@variable@," "start@variable@end"," @variable@end", or "start@variable@".

An empty prefix list can be configured for pre-provisioning. This empty prefix list will not find a match when referred to by a policy. When removing member prefixes from a prefix list, the prefix list will not be automatically removed when the last member is removed. If required, an empty prefix list must be explicitly removed using the no form of the command.

prefix

Syntax 
[no] prefix ip-prefix/prefix-length { [exact | longer | through length] | [prefix-length-range length1-length2]}
no prefix [ipv-prefix/prefix-length] [exact | longer | through length | prefix-length-range length1-length2]
Context 
config>router>policy-options>prefix-list
Description 

This command creates a prefix entry in the route policy prefix list.

The no form of the command deletes the prefix entry from the prefix list.

Parameters 
ip-prefix—
The IP prefix for prefix list entry in dotted decimal notation.
Values—
ipv4-prefix:
  1. a.b.c.d (host bits must be 0)
ipv4-prefix-length: [0 to 32]
ipv6-prefix:
  1. x:x:x:x:x:x:x:x (eight 16-bit pieces)
  2. x:x:x:x:x:x:d.d.d.d
  3. x: [0 to FFFF]H
  4. d: [0 to 255]D
ipv6-prefix-length: [0 to 128]

 

exact—
Specifies the prefix list entry only matches the route with the specified ip-prefix and prefix mask (length) values.
longer—
Specifies the prefix list entry matches any route that matches the specified ip-prefix and prefix mask length values equal to or greater than the specified mask.
through length
Specifies the prefix list entry matches any route that matches the specified ip-prefix and has a prefix length between the specified length values inclusive.
Values—
0 to 32

 

prefix-length-range length1 - length2
Specifies a route must match the most significant bits and have a prefix length with the given range. The range is inclusive of start and end values.
Values—
0 to 32, length2 > length1

 

6.6.2.6. Route Policy Entry Match Commands

entry

Syntax 
entry entry-id
no entry
Context 
config>router>policy-options>policy-statement
Description 

This command creates the context to edit route policy entries within the route policy statement.

Multiple entries can be created using unique entries. The router exits the filter when the first match is found and executes the action specified. For this reason, entries must be sequenced correctly from most to least explicit.

An entry does not require matching criteria defined (in which case, everything matches) but must have at least define an action in order to be considered complete. Entries without an action are considered incomplete and will be rendered inactive.

The no form of the command removes the specified entry from the route policy statement.

Parameters 
entry-id—
The entry ID expressed as a decimal integer. An entry-id uniquely identifies match criteria and the corresponding action. It is recommended that multiple entries be given entry-ids in staggered increments. This allows users to insert a new entry in an existing policy without requiring renumbering of all the existing entries.
Values—
1 to 4294967295

 

from

Syntax 
[no] from
Context 
config>router>policy-options>policy-statement>entry
Description 

This command creates the context to configure policy match criteria based on a route’s source or the protocol from which the route is received.

If no condition is specified, all route sources are considered to match.

The no form of the command deletes the source match criteria for the route policy statement entry.

area

Syntax 
area area-id
no area
Context 
config>router>policy-options>policy-statement>entry>from
Description 

This command configures an OSPF area as a route policy match criterion.

This match criterion is only used in export policies.

All OSPF routes (internal and external) are matched using this criterion if the best path for the route is by the specified area.

The no form of the command removes the OSPF area match criterion.

Default 

no area

Parameters 
area-id—
The OSPF area ID expressed in dotted decimal notation or as a 32-bit decimal integer.
Values—
0.0.0.0 to 255.255.255.255 (dotted decimal), 0 to 4294967295 (decimal)

 

as-path

Syntax 
as-path name
no as-path
Context 
config>router>policy-options>policy-statement>entry>from
Description 

This command configures an AS path regular expression statement as a match criterion for the route policy entry.

If no AS path criterion is specified, any AS path is considered to match.

AS path regular expression statements are configured at the global route policy level (config>router>policy-options>as-path name).

The no form of the command removes the AS path regular expression statement as a match criterion.

Default 

no as-path

Parameters 
name—
The AS path regular expression name. Allowed values are any string up to 32 characters long composed of printable, 7-bit ASCII characters. If the string contains special characters (#, $, spaces, etc.), the entire string must be enclosed within double quotes. Policy parameters must be enclosed by at-signs (@) and may be midstring; for example, "@variable@," "start@variable@end"," @variable@end", or "start@variable@".

as-path-group

Syntax 
as-path-group name
no as-path-group name
Context 
config>router>policy-options>policy-statement>entry>from
Description 

This command creates a route policy AS path regular expression statement to use in route policy entries.

The no form of the command deletes the AS path regular expression statement.

Default 

no as-path-group

Parameters 
name—
The AS path regular expression name. Allowed values are any string up to 32 characters long composed of printable, 7-bit ASCII characters. If the string contains special characters (#, $, spaces, etc.), the entire string must be enclosed within double quotes. Policy parameters must be enclosed by at-signs (@) and may be midstring; for example, "@variable@," "start@variable@end"," @variable@end", or "start@variable@".

as-path-length

Syntax 
as-path-length length [equal | or-higher | or-lower] [unique]
no as-path-length
Context 
config>router>policy-options>policy-statement>entry>from
Description 

This command matches BGP routes based on their AS path length (the number of AS numbers in the AS_PATH).

If no comparison qualifiers are present (equal, or-higher, or-lower), then equal is the implied default.

Confederation member AS numbers in the AS_PATH do not count towards the total. An AS_SET element is considered to have a length of 1.

The unique option counts .

A non-BGP route does not match a policy entry if it contains the as-path-length command.

Default 

no as-path-length

Parameters 
length—
The length of the AS path.
Values—
0 to 255, or a parameter name delimited by starting and ending at-sign (@) characters

 

equal—
Specifies that matched routes should have the same number of AS path elements as the value specified.
or-higher—
Specifies that matched routes should have the same or a greater number of AS path elements as the value specified.
or-lower—
Specifies that matched routes should have the same or a lower number of AS path elements as the value specified.
unique —
Specifies that only the unique AS numbers should be counted (that is, multiple occurrences of the same AS number in the sequence count as one).

cluster-id

Syntax 
cluster-id ip-address/mask [ip-address/mask]
cluster-id none
no cluster-id
Context 
config>router>policy-options>policy-statement>entry>from
Description 

This command enables BGP routes to be matched based on the IP addresses encoded in the CLUSTER_LIST attribute.

The first ip-address/mask pair is matched against the most recently added cluster ID. Each subsequent ip-address/mask pair is tested against the next most recent cluster ID.

For example, to match all routes reflected by the RR with cluster ID 1.1.1.1 and then any other RR before reaching the router where the policy is applied, use the command cluster-id 0.0.0.0/0 1.1.1.1/32.

Note:

The command matches routes with two or more cluster IDs; the third and older cluster IDs are not evaluated and are automatically considered matching.

The cluster-id none form of the command only matches BGP routes without any CLUSTER_LIST attribute.

A non-BGP route does not match a policy entry if it contains the cluster-id command.

Default 

no cluster-id

Parameters 
ip-address—
A 32-bit cluster ID in dotted decimal notation.
Values—
a.b.c.d

 

mask
Specifies a bit mask to apply to the ip-address parameter.
Values—
0 to 32 (0 is only allowed if the ip-address is 0.0.0.0)

 

none—
Specifies that only BGP routes without a CLUSTER_LIST attribute should be matched.

community-count

Syntax 
community-count count [equal | or-higher | or-lower] [standard | extended | large]
no community-count
Context 
config>router>policy-options>policy-statement>entry>from
Description 

This command matches BGP routes based on community length (that is, the number of community members in the COMMUNITY, EXTENDED_COMMUNITY, or LARGE_COMMUNITY the attributes).

If no comparison qualifiers are present (equal, or-higher, or-lower), then equal is the implied default.

Without the optional standard, extended, or large keyword, the community length applies to the total number of communities, of all types. If some keywords are present, then only the types specified are counted against the limit.

A non-BGP route does not match a policy entry if it contains the community-count command.

Default 

no community-count

Parameters 
count—
Specifies the number of community members.
Values—
0 to 1024, or a parameter, up to 32 characters, name delimited by a starting and ending at-sign (@) character

 

equal—
Specifies that matched routes should have the same number of AS path elements as the value specified.
or-higher—
Specifies that matched routes should have the same or a greater number of community members as the value specified.
or-lower—
Specifies that matched routes should have the same or a lower number of community members as the value specified.
standard—
Specifies that only communities in the COMMUNITY attribute should be counted.
extended—
Specifies that only communities in the EXTENDED_COMMUNITY attribute should be counted.
large—
Specifies that only communities in the LARGE_COMMUNITY attribute should be counted.

local-preference

Syntax 
local-preference preference [equal | or-higher | or-lower]
no local-preference
Context 
config>router>policy-options>policy-statement>entry>from
Description 

This command matches BGP routes based on local preference (the value in the LOCAL_PREF attribute).

If no comparison qualifiers are present (equal, or-higher, or-lower), then equal is the implied default.

A non-BGP route does not match a policy entry if it contains the local-preference command.

Default 

no local-preference

Parameters 
preference—
Specifies the local preference value.
Values—
0 to 4294967295, or a parameter name delimited by starting and ending at-sign (@) characters

 

equal—
Specifies that matched routes should have the same local preference as the value specified.
or-higher—
Specifies that matched routes should have the same or a greater local preference as the value specified.
or-lower—
Specifies that matched routes should have the same or a lower local preference as the value specified.

metric

Syntax 
metric metric [equal | or-higher | or-lower]
no metric
Context 
config>router>policy-options>policy-statement>entry>from
Description 

This command matches BGP routes based on local preference (the value in the MULTI_EXIT_DISC attribute).

If no comparison qualifiers are present (equal, or-higher, or-lower), then equal is the implied default.

A non-BGP route does not match a policy entry if it contains the metric command. In addition, a BGP route without a MED attribute also does not match a policy entry if it contains a metric command.

Default 

no metric

Parameters 
metric—
Specifies the MED value.
Values—
0 to 4294967295, or a parameter name delimited by starting and ending at-sign (@) characters

 

equal—
Specifies that matched routes should have the same MED as the value specified.
or-higher—
Specifies that matched routes should have the same or a greater MED as the value specified.
or-lower—
Specifies that matched routes should have the same or a lower MED as the value specified.

next-hop

Syntax 
next-hop ip-address
next-hop prefix-list name
no next-hop
Context 
config>router>policy-options>policy-statement>entry>from
Description 

This command enables BGP routes to be matched based on the BGP next-hop address. The match condition is evaluated against the IPv4 or IPv6 address in the NEXT_HOP or MP_REACH_NLRI attribute.

When the next-hop match is applied to VPN-IP routes, the Route Distinguisher (RD) is ignored.

A non-BGP route does not match a policy entry if it contains the next-hop command.

Default 

no next-hop

Parameters 
ip-address—
An IPv4 or IPv6 address.
Values—
a.b.c.d or x:x:x:x:x:x:x:x or x:x:x:x:x:x:d.d.d.d

 

name
Specifies the name of a prefix-list (up to 32 characters).
prefix-list—
Specifies that the BGP next-hop should be matched against a prefix-list instead of an individual IP address.

path-type

Syntax 
path-type {ibgp | ebgp}
no path-type
Context 
config>router>policy-options>policy-statement>entry>from
Description 

This command matches BGP routes based on their path type (EBGP or IBGP). A route learned from an EBGP peer has path-type ebgp. A route learned from an IBGP or confed-EBGP peer has path-type ibgp.

A non-BGP route does not match a policy entry if it contains the path-type command.

Default 

no path-type

Parameters 
ip-address—
An IPv4 or IPv6 address.
Values—
a.b.c.d or x:x:x:x:x:x:x:x or x:x:x:x:x:x:d.d.d.d

 

ibgp—
Matches routes from internal BGP peers.
ebgp—
Matches routes from external BGP peers.

external

Syntax 
[no] external
Context 
config>router>policy-options>policy-statement>entry>from
Description 

This command specifies the external route matching criteria for the entry.

Default 

no external

family

Syntax 
family [ipv4] [label-ipv4] [vpn-ipv4] [ipv6] [label-ipv6] [vpn-ipv6] [mcast-ipv4] [l2-vpn] [mvpn-ipv4] [mvpn-ipv6] [mdt-safi] [ms-pw] [flow-ipv4] [flow-ipv6] [route-target] [mcast-vpn-ipv4] [evpn] [bgp-ls] [mcast-ipv6] [mcast-vpn-ipv6] [sr-policy-ipv4]
no family
Context 
config>router>policy-options>policy-statement>entry>from
Description 

This command specifies address families as matching conditions.

Default 

no family

Parameters 
ipv4—
Matches routes belonging to the IPv4 unicast (unlabeled) address family.
label-ipv4—
Matches routes belonging to the IPv4 unicast (labeled) address family.
vpn-ipv4—
Matches routes belonging to the IPv4 VPN (SAFI 128) address family.
ipv6—
Matches routes belonging to the IPv6 unicast (unlabeled) address family.
label-ipv6—
Matches routes belonging to the IPv6 unicast (labeled) address family.
vpn-ipv6—
Matches routes belonging to the IPv6 VPN (SAFI 128) address family.
mcast-ipv4—
Matches routes belonging to the IPv4 multicast SAFI address family.
l2-vpn—
Matches routes belonging to the L2 VPN address family.
mvpn-ipv4—
Matches routes belonging to the IPv4 multicast VPN address family.
mvpn-ipv6—
Matches routes belonging to the IPv6 multicast VPN address family.
mdt-safi—
Matches routes belonging to the MDT SAFI address family.
ms-pw —
Matches routes belonging to the multi-segment pseudowire address family.
flow-ipv4—
Matches routes belonging to the IPv4 flowspec address family.
flow-ipv6—
Matches routes belonging to the IPv6 flowspec address family.
route-target—
Matches routes belonging to the address family for RT constrain routes.
mcast-vpn-ipv4—
Matches routes belonging to the IPv4 VPN multicast (SAFI 129) address family.
evpn—
Matches routes belonging to the EVPN address family.
bgp-ls—
Enables the advertisement of BGP-LS address family to the associated BGP neighbors.
mcast-ipv6—
Matches routes belonging to the IPv6 multicast SAFI address family.
mcast-vpn-ipv6—
Matches routes belonging to the IPv6 multicast routes from a VPRN over the provider network. This family is only applicable in the base BGP routing context.
sr-policy-ipv4—
Matches routes belonging to the segment routing policy address family (AFI1/SAFI73).

flow-spec-dest

Syntax 
flow-spec-dest prefix-list-name
no flow-spec-dest
Context 
config>router>policy-options>policy-statement>entry>from
Description 

This command is used to match BGP flow-spec routes on the basis of the destination IP prefix in the flow specification. An IPv4 flow-spec route is matched by this command if its NLRI contains a type 1 subcomponent encoding a prefix and prefix-length that is covered by an entry in the referenced prefix-list. An IPv6 flow-spec route is matched by this command if its NLRI contains a type 1 component encoding prefix-offset=0 and a prefix & prefix-length that is covered by an entry in the referenced prefix-list.

The flow-spec-dest command has no effect when the policy is not applied as a BGP import or export policy.

Default 

no flow-spec-dest

Parameters 
prefix-list-name—
The name of a prefix-list containing IPv4 and/or IPv6 prefix entries [up to 32 characters].

flow-spec-source

Syntax 
flow-spec-source prefix-list-name
no flow-spec-source
Context 
config>router>policy-options>policy-statement>entry>from
Description 

This command is used to match BGP flow-spec routes on the basis of the source IP prefix in the flow specification. An IPv4 flow-spec route is matched by this command if its NLRI contains a type 2 subcomponent encoding a prefix and prefix-length that is covered by an entry in the referenced prefix-list. An IPv6 flow-spec route is matched by this command if its NLRI contains a type 2 component encoding prefix-offset=0 and a prefix & prefix-length that is covered by an entry in the referenced prefix-list.

The flow-spec-source command has no effect when the policy is not applied as a BGP import or export policy.

Default 

no flow-spec-source

Parameters 
prefix-list-name—
The name of a prefix-list containing IPv4 and/or IPv6 prefix entries [up to 32 characters].

group-address

Syntax 
group-address prefix-list-name
no group-address
Context 
config>router>policy-options>policy-statement>entry>from
Description 

This command specifies the multicast group-address prefix list containing multicast group-addresses that are embedded in the join or prune packet as a filter criterion. The prefix list must be configured prior to entering this command. Prefix lists are configured in the config>router>policy-options>prefix-list context.

The no form of the command removes the criterion from the configuration.

Default 

no group-address

Parameters 
prefix-list-name—
The prefix-list name. Allowed values are any string up to 32 characters long composed of printable, 7-bit ASCII characters. If the string contains special characters (#, $, spaces, etc.), the entire string must be enclosed within double quotes.

The prefix-list-name is defined in the config>router>policy-options>prefix-list context.

host-ip

Syntax 
host-ip prefix-list-name
Context 
config>router>policy-options>policy-statement>entry>from
Description 

This command specifies a prefix list host IP address as a match criterion for the route policy-statement entry.

Default 

no host-ip

Parameters 
prefix-list-name—
The prefix-list name. Allowed values are any string up to 32 characters long composed of printable, 7-bit ASCII characters. If the string contains special characters (#, $, spaces, etc.), the entire string must be enclosed within double quotes.

The prefix-list-name is defined in the config>router>policy-options>prefix-list context.

interface

Syntax 
interface interface-name
no interface
Context 
config>router>policy-options>policy-statement>entry>from
Description 

This command specifies the router interface, specified either by name or address, as a filter criterion.

The no form of the command removes the criterion from the configuration.

Default 

no interface

Parameters 
ip-int-name—
Specify the name of the interface as a match criterion for this entry. If the string contains special characters (#, $, spaces, etc.), the entire string must be enclosed within double quotes.

level

Syntax 
level {1 | 2}
no level
Context 
config>router>policy-options>policy-statement>entry>from
config>router>policy-options>policy-statement>entry>to
Description 

This command specifies the ISIS route level as a match criterion for the entry.

Default 

no level

Parameters 
1 | 2—
Matches the IS-IS route learned from level 1 or level 2.

mvpn-type

Syntax 
mvpn-type {1 | 2 | 3 | 4 | 5 | 6 | 7}
no mvpn-type
Context 
config>router>policy-options>polic-statement>entry>from
Description 

This command allows match on ng-MVPN BGP route type when the policy is used for VRF-import/VRF-export/BGP global export policy. The policy will only be applied to multicast routes.

The no form of the command disables mvpn-type in the policy evaluation.

Default 

no mvpn-type

Parameters 
1 | 2 | 3 | 4 | 5 | 6 | 7 —
BGP MVPN route-type as per RFC 6514.

neighbor

Syntax 
neighbor {ip-address | prefix-list name}
no neighbor
Context 
config>router>policy-options>policy-statement>entry>to
config>router>policy-options>policy-statement>entry>from
Description 

This command specifies the neighbor address as found in the source address of the actual join and prune message as a filter criterion. If no neighbor is specified, any neighbor is considered a match.

The no form of the of the command removes the neighbor IP match criterion from the configuration.

Default 

no neighbor

Parameters 
ip-addr—
The neighbor IP address in dotted decimal notation.
Values—
ipv4-address:
  1. a.b.c.d
ipv6-address:
  1. x:x:x:x:x:x:x:x [-interface]
  2. x:x:x:x:x:x:d.d.d.d [-interface]
  3. x: [0 to FFFF]H
  4. d: [0 to 255]D
  5. interface: 32 characters maximum, mandatory for link local addresses

 

prefix-list name
The prefix-list name. Allowed values are any string up to 32 characters long composed of printable, 7-bit ASCII characters. If the string contains special characters (#, $, spaces, etc.), the entire string must be enclosed within double quotes.

The name specified must already be defined.

origin

Syntax 
origin {igp | egp | incomplete | any | aaa | dynamic | static | bonding}
no origin
Context 
config>router>policy-options>policy-statement>entry>from
Description 

This command configures a match criteria for the origin attribute. Originally, the origin attribute was applicable only to BGP as a mandatory well-known BGP attribute.

The functionality of the origin attribute has expanded to subscriber-management routes (/32 IPv4 host and IPv6 PD WAN host routes). By default, each subscriber-management route will internally (local to the node) carry the origin attribute with one of three values (aaa, dynamic, and static). The value of the attribute depends on the origin of the subscriber-management route. The aaa, dynamic or static values are never carried in BGP updates as part of the BGP origin attribute and are visible within the BGP process.

The values for the origin attribute in the subscriber-management routes allows customized advertisement of the subscriber-management routes by the routing policy.

Default 

no origin

Parameters 
igp—
Configures matching path information originating within the local AS.
egp—
Configures matching path information originating in another AS.
incomplete—
Configures matching path information learned by another method.
any—
Specifies to ignore this criteria.
aaa—
Specifies to use the subscriber host address originated from AAA.
Values—
IPv4 — subscriber-management /32 host routes that are originated from the RADIUS framed-ip-address VSA other than 255.255.255.254. The 255.255.255.254 returned by the RADIUS indicates that the BNG (NAS) should assign an IP address from its own pool.
IPv6 — subscriber-management routes that are originated through framed-ipv6-prefix (SLAAC), delegated-ipv6-prefix (IA_PD) or alc-ipv6-address (IA_NA) RADIUS attributes. It is also applicable to VSA Alc-IPv6-Sub-If-Prefix, where the subscriber interface prefix can be originated from RADIUS. This is valid for IPoE and PPPoE type hosts.

 

dynamic—
Specifies to use the subscriber host address originated from DHCP, DHCPv6, or the local address server.
Values—
IPv4 — subscriber-management /32 host routes that originate from the DHCP server (local or remote) or RADIUS framed-ip-address=255.255.255.254 (RFC 2865).
IPv6 — subscriber-management routes that are assigned via local DHCPv6 server pools whose name is obtained through the Alc-Delegated-IPv6-Pool (PD pool) and Framed-IPv6-Pool (NA pool) RADIUS attributes, or the local address server whose name is obtained through the Alc-SLAAC-IPv6-Pool (SLAAC pool) RADIUS attribute. This is valid for IPoE and PPPoE type hosts.
In addition, for IPoEv6 only, the pool name can also be obtained from ipv6-delegated-prefix-pool (PD pool) and ipv6-wan-address-pool (NA pool) from the LUDB.

 

static—
Specifies to use the subscriber host address originated from the local user database.
Values—
IPv4 — subscriber-management /32 host routes that are originated from the LUDB. This should also cover the RADIUS fallback category (RADIUS falls back to system defaults or to the LUDB).
IPv6 — subscriber-management routes obtained from the LUDB from ipv6-address (IA_NA) or ipv6-prefix (IA_PD), or ipv6-slaac-prefix (SLAAC).

 

origin-validation-state

Syntax 
origin-validation-state state
no origin-validation-state
Context 
config>router>policy-options>policy-statement>entry>from
Description 

This command is used to match BGP routes on the basis of origin validation state:

  1. Valid (0)
  2. Not-Found (1)
  3. Invalid (2)
Default 

no origin-validation-state

Parameters 
valid —
Marks the route as having an origin validation state of valid.
notFound—
Marks the route as having an origin validation state of Not Found.
invalid —
Marks the route as having an origin validation state of invalid.

policy-statement

Syntax 
[no] policy-statement name
Context 
config>router>policy-options
Description 

This command creates the context to configure a route policy statement.

Route policy statements control the flow of routing information to and from a specific protocol, set of protocols, or to a specific BGP neighbor.

The policy-statement is a logical grouping of match and action criteria. A single policy-statement can affect routing in one or more protocols and/or one or more protocols peers/neighbors. A single policy-statement can also affect both the import and export of routing information.

The no form of the command deletes the policy statement.

Default 

no policy-statement

Parameters 
name—
The route policy statement name. Allowed values are any string up to 64 characters long composed of printable, 7-bit ASCII characters. If the string contains special characters (#, $, spaces, etc.), the entire string must be enclosed within double quotes.

policy

Syntax 
policy plcy-or-long-expr
no policy
Context 
config>router>policy-options>policy-statement>entry>from
Description 

This command is used to call another policy by name and evaluate it as a subroutine, or to evaluate a logical expression of subroutine policies.

If the result of the subroutine evaluation is an 'accept', then the route is considered to match the entry in the parent policy that called the subroutine. If the result of the subroutine evaluation is a 'reject’, then the route is considered a non-match of the entry in the parent policy that called the subroutine.

Up to 3 levels of subroutine calls are supported. If a subroutine at maximum depth has this command, it is automatically considered a non-match of all routes.

The no form of the command removes the policy statement as a match criterion.

Default 

no policy

Parameters 
plcy-or-long-expr—
The name of a single policy-statement (up to 64 characters in length) or a policy logical expression (up to 255 characters in length) consisting of policy-statement names (enclosed in square brackets), logical operations (‘and’, ‘or’, ‘not’), and parentheses for grouping.

policy

Syntax 
policy plcy-or-long-expr
no policy
Context 
config>router>policy-options>policy-statement>entry>action
Description 

This command configures a nested policy statement as a match criterion for the route policy entry.

Policy statements are configured at the global route policy level (config>router>policy-options policy-statement).

The command is used to call another policy by name and evaluate it as a subroutine. If the result of the subroutine evaluation is an 'accept', then the route is considered to match the entry in the parent policy that called the subroutine. If the result of the subroutine evaluation is a 'reject’, then the route is considered a non-match of the entry in the parent policy that called the subroutine. Up to 3 levels of subroutine calls are supported. If a subroutine at maximum depth has this command, it is automatically considered a non-match of all routes.

The no form of the command removes the policy statement as a match criterion.

Default 

no policy

Parameters 
plcy-or-long-expr—
The route policy name (up to 64 characters long) or a policy logical expression (up to 255 characters long). Allowed values are any string up to 255 characters long composed of printable, 7-bit ASCII characters. If the string contains special characters (#, $, spaces, etc.), the entire string must be enclosed within double quotes.

policy-variables

Syntax 
policy-variables
Context 
config>router>policy-options>policy-statement>from
Description 

This command enables the policy-variables configuration context.

The no form of the command removes all policy variables.

prefix-list

Syntax 
prefix-list name [name]
no prefix-list
Context 
config>router>policy-options>policy-statement>entry>from
config>router>policy-options>policy-statement>entry>to
Description 

This command configures a prefix list as a match criterion for a route policy statement entry.

If no prefix list is specified, any network prefix is considered a match.

An empty prefix list will evaluate as if 'no match' was found.

The prefix lists specify the network prefix (this includes the prefix and length) a specific policy entry applies.

A maximum of five prefix names can be specified.

The no form of the command removes the prefix list match criterion.

Default 

no prefix-list

Parameters 
name—
The prefix list name. Allowed values are any string up to 32 characters long composed of printable, 7-bit ASCII characters. If the string contains special characters (#, $, spaces, etc.), the entire string must be enclosed within double quotes. Policy parameters must be enclosed by at-signs (@) and may be midstring; for example, "@variable@," "start@variable@end"," @variable@end", or "start@variable@".

protocol

Syntax 
protocol protocol [all | instance instance]
protocol bgp bgp-label
no protocol
Context 
config>router>policy-options>policy-statement>entry>from
Description 

This command configures a routing protocol as a match criterion for a route policy statement entry. This command is used for both import and export policies depending how it is used.

If no protocol parameter is specified, any protocol is considered a match.

The no form of the command removes the protocol match criterion.

Default 

no protocol

Parameters 
protocol
Specifies the protocol name to match on.
Values—
direct, static, bgp, isis, ospf, rip, aggregate, bgp-vpn, igmp, pim, ospf3, ldp, sub-mgmt, mld, managed, vpn-leak, nat, periodic, ipsec, dhcpv6-pd, dhcpv6-na, dhcpv6-ta, dhcpv6-pd-excl, ripng, bgp-label, direct-interface, arp-nd

 

instance
Specifies the OSPF, OSPF3, or IS-IS instance.
Values—
isis-inst — 0 to 31
ospf-inst — 0 to 31
ospf3-inst — 0 to 31, 64 to 95

 

all—
Keyword used only with OSPF or IS-IS that specifies all instances.

protocol

Syntax 
protocol protocol [all | instance instance]
protocol bgp bgp-label
no protocol
Context 
config>router>policy-options>policy-statement>entry>to
Description 

This command configures a routing protocol as a match criterion for a route policy statement entry. This command is used for both import and export policies depending how it is used.

If no protocol parameter is specified, any protocol is considered a match.

The no form of the command removes the protocol match criterion.

Default 

no protocol

Parameters 
protocol
Specifies the protocol name to match on.
Values—
bgp, isis, ospf, rip, bgp-vpn, ospf3, vpn-leak, ldp, ripng, bgp-label

 

instance
Specifies the OSPF, OSPF3, or IS-IS instance.
Values—
isis-inst — 0 to 31
ospf-inst — 0 to 31
ospf3-inst — 0 to 31, 64 to 95

 

all—
Keyword used only with OSPF or IS-IS that specifies all instances.

source-address

Syntax 
source-address ip-address
source-address prefix-list prefix-list-name
no source-address
Context 
config>router>policy-options>policy-statement>entry>from
Description 

This command specifies the source address that is embedded in the join or prune packet as a filter criterion.

The no form of the command removes the criterion from the configuration.

This command specifies a multicast data source address as a match criterion for this entry.

Default 

no source-address

Parameters 
ip-address —
The IP prefix for the IP match criterion in dotted decimal notation.
Values—
ipv4-address:
  1. a.b.c.d
ipv6-address:
  1. x:x:x:x:x:x:x:x
  2. x:x:x:x:x:x:d.d.d.d
  3. x: [0 to FFFF]H
  4. d: [0 to 255]D

 

prefix-list-name—
The prefix list name. Allowed values are any string up to 32 characters long composed of printable, 7-bit ASCII characters. If the string contains special characters (#, $, spaces, and so on), the entire string must be enclosed within double quotes.

state

Syntax 
state state
no state
Context 
config>router>policy-options>policy-statement>entry>from
Description 

This command will configure a match criteria on the state attribute. The state attribute carries the state of an SRRP instance and it can be applied to:

  1. subscriber-interface routes
  2. subscriber-management routes (/32 IPv4 and IPv6 PD wan-host)
  3. managed-routes (applicable only to IPv4).

Based on the state attribute of the route we can manipulate the route advertisement into the network.

We can enable or disable (in case there is no SRRP running) tracking of SRRP state by routes.

This is done on a per subscriber-interface route basis, where a subscriber-interface route is tracking a single SRRP instance state (SRRP instance might be in a Fate Sharing Group).

For subscriber-management and managed-routes, tracking is enabled per group interface under which SRRP is enabled.

This command specifies a multicast data source address as a match criterion for this entry.

Default 

no state

Parameters 
srrp-master—
Track routes with the state attribute carrying srrp-master state.
srrp-non-master—
Track routes with the state attribute carrying srrp-non-master state.
ipsec-master-with-peer —
Track routes with the state attribute carrying ipsec-master-with-peer state.
ipsec-non-master—
Track routes with the state attribute carrying ipsec-non-master state.
ipsec-master-without-peer—
Track routes with the state attribute carrying ipsec-master-without-peer state.

tag

Syntax 
tag {no-tag | tag}
no tag
Context 
config>router>policy-options>policy-statement>entry>from
Description 

This command matches the tag value in static or IGP routes. A decimal or hexadecimal value of 4 octets can be entered. For IS-IS, OSPF, and static routes, all four octets can be used. For RIP and RIPng, only the two most significant octets are used if more than two octets are configured.

The no form of the command removes the tag field match criterion.

Default 

no tag

Parameters 
tag—
Matches the configured tag value.
Values—
Accepts decimal or hexadecimal formats:
  1. IS-IS, OSPF and static routes: 0x0 – 0xFFFFFFFF or 1 – 4294967295
  2. RIP and RIPng: 0x0 – 0xFFFF or 1 – 65535

 

no-tag—
Specifies that no tag value is set.

to

Syntax 
[no] to
Context 
config>router>policy-options>policy-statement>entry
Description 

This command creates the context to configure export policy match criteria based on a route’s destination or the protocol into which the route is being advertised.

If no condition is specified, all route destinations are considered to match.

The to command context only applies to export policies. If it is used for an import policy, match criteria is ignored.

The no form of the command deletes export match criteria for the route policy statement entry.

type

Syntax 
type {1 | 2}
no type
Context 
config>router>policy-options>policy-statement>entry>from
Description 

This command configures an OSPF type metric as a match criterion in the route policy statement entry.

If no type is specified, any OSPF type is considered a match.

The no form of the command removes the OSPF type match criterion.

Default 

no type

Parameters 
1—
Matches OSPF routes with type 1 LSAs.
2—
Matches OSPF routes with type 2 LSAs.

6.6.2.7. Route Policy Action Commands

action

Syntax 
action {accept | next-entry | next-policy | drop | reject}
no action
Context 
config>router>policy-options>policy-statement>entry
Description 

This command creates the context to configure actions to take for routes matching a route policy statement entry.

This command is required and must be entered for the entry to be active.

Any route policy entry without the action command will be considered incomplete and will be inactive.

The no form of the command deletes the action context from the entry.

Default 

no action

Parameters 
accept—
Specifies that routes matching the entry match criteria will be accepted and propagated.
next-entry—
Specifies that the actions specified would be made to the route attributes and then policy evaluation would continue with next policy entry (if any others are specified).
next-policy—
Specifies that the actions specified would be made to the route attributes and then policy evaluation would continue with next route policy (if any others are specified).
drop—
Specifies that routes matching the entry match criteria should be rejected. This parameter provides a context for modifying route properties.
reject—
Specifies that routes matching the entry match criteria should be rejected. This parameter does not provide a context for modifying route properties.

add-paths-send-limit

Syntax 
add-paths-send-limit send-limit
no add-paths-send-limit
Context 
config>router>policy-options>policy-statement>entry
config>router>policy-options>policy-statement>default-action
Description 

This command sets the Add-Paths send-limit to a specific value for all routes matched by the policy entry or default action. Add-Paths allows a BGP router to send multiple paths for the same NLRI/prefix to a peer advertising the Add-Paths receive capability. The send-limit dictates the maximum number of paths that can be advertised.

The default send-limit is controlled by the instance, group or neighbor level configuration and applies to all prefixes in a particular address family. Using route policies allows the default send-limit to be overridden to use a larger or smaller maximum value on a per-prefix basis. For example if, for most prefixes advertised to a peer, at most 1 path should be advertised but for a few exceptional prefixes up to 4 paths should be advertised then the neighbor-level send-limit can be set to a value of 1 and the add-paths-send-limit in the policy entry that matches the exceptional routes can be set to a value of 4.

Default 

no add-paths-send-limit

Parameters 
send-limit—
Specify the maximum number of paths to advertise for matched routes to an Add-Paths peer.
Values—
1to16

 

admin-tag-policy

Syntax 
admin-tag-policy policy-name
no admin-tag-policy
Context 
config>router>policy-options>policy-statement>default-action
config>router>policy-options>policy-statement>entry>action
Description 

This command assigns a route admin tag policy as an action in a route policy.

The admin tag policy must exist under config>router>admin-tags.

The no form of the command removes the admin tag policy.

Parameters 
policy-name—
Specifies the name of the admin tag policy, up to 64 characters.

advertise-label

Syntax 
advertise-label {per-prefix | pop}
no advertise-label
Context 
config>router>policy-options>policy-statement>default-action
config>router>policy-options>policy-statement>entry>action
Description 

The effect of the advertise-label command depends on the context where the associated policy is applied.

When the per-prefix option is used and the command is configured as the default action or entry-specific action of a VRF export policy, every qualifying matched route is advertised with a per-prefix label in the resulting VPN-IP routes. In this situation, non-qualifying routes include local interface routes and BGP-VPN routes. The command overrides, for specific routes, the configured label-mode of the exporting VPRN service.

When configured with the per-prefix option, the command also affects BGP import policies applied to a base router BGP peer. When a label-IPv4 route is matched and accepted by a BGP import policy entry or default action with this command, and it is the best path for the prefix in the label-IPv4 RIB, a per-prefix label is used in the advertised route if there is a BGP next-hop change. A label-IPv4 route advertised with a pre-prefix label supports ECMP forwarding across multiple BGP next-hops.

When configured with the pop option, the command also serves a purpose in route-table-import policies. When a /32 IPv4 static, OSPF, or IS-IS route is matched and accepted by a label-IPv4 RIB route-table-import policy entry or default-action with this command, and the route is a candidate to be advertised as a label-IPv4 route (due to a BGP export policy), the advertised BGP label is programmed for a Pop operation. When a /32 static, OSPF, or IS-IS route is imported into the label-IPv4 RIB and then exported as a BGP route, the default behavior is to program a “swap” operation in the datapath, which swaps the BGP label with the tunnel label that takes traffic to the destination of the /32 route.

Default 

no advertise-label

Parameters 
per-prefix—
Requests per-prefix label allocation for matched routes. This takes effect only in VRF export policies and BGP import policies, and only for certain types of routes.
pop—
Requests Pop label allocation for matched routes. This takes effect only in label-IPv4 route-table-import policies and only applies to /32 IPv4 routes that were learned through static configuration, OSPF, or IS-IS.

aigp-metric

Syntax 
aigp-metric metric
aigp-metric add
aigp-metric igp
no aigp-metric
Context 
config>router>policy-options>policy-statement>entry>action
config>router>policy-options>policy-statement>default-action
Description 

This command assigns a BGP AIGP metric to routes matching the entry. The effect of this command on a route matched and accepted by a route policy entry depends on how the policy is applied (BGP import policy vs. BGP export policy), the type of route and the specific form of the command.

In a BGP import policy this command is used to:

  1. Associate an AIGP metric with an IBGP route received with an empty AS path and no AIGP attribute.
  2. Associate an AIGP metric with an EBGP route received without an AIGP attribute that has an AS path containing only AS numbers belonging to the local AIGP administrative domain.
  3. Modify the received AIGP metric value prior to BGP path selection

In a BGP export policy this command is used to:

  1. Add the AIGP attribute and set the AIGP metric value in a BGP route originated by exporting a direct, static or IGP route from the routing table
  2. Remove the AIGP attribute from a route advertisement to a particular peer
  3. Modify the AIGP metric value in a route advertisement to a particular peer
Default 

no aigp-metric

Parameters 
metric—
Administratively defined metric.
Values—
0 to 4294967295

 

Default—
none
name — The AIGP metric parameter variable name. Allowed values are any string up to 32 characters long composed of printable, 7-bit ASCII characters. If the string contains special characters (#, $, spaces, etc.), the entire string must be enclosed within double quotes. Policy parameters must start and end with at-signs (@); for example, “@variable@”.
add—
Adds the AIGP attribute.
igp—
Sets the AIGP metric to the IGP metric.

as-path

Syntax 
as-path {add | replace} name
no as-path
Context 
config>router>policy-options>policy-statement>default-action
config>router>policy-options>policy-statement>entry>action
Description 

This command assigns a BGP AS path list to routes matching the route policy statement entry.

If no AS path list is specified, the AS path attribute is not changed.

The no form of the command disables the AS path list editing action from the route policy entry.

Default 

no as-path

Parameters 
add—
Specifies that the AS path list is to be prepended to an existing AS list.
replace—
Specifies AS path list replaces any existing as path attribute.
name—
Specifies the AS path list name. Allowed values are any string up to 32 characters long composed of printable, 7-bit ASCII characters. If the string contains special characters (#, $, spaces, and so on), the entire string must be enclosed within double quotes. Policy parameters must be enclosed by at-signs (@) and may be midstring; for example, "@variable@," "start@variable@end"," @variable@end", or "start@variable@".

The name specified must already be defined.

as-path-prepend

Syntax 
as-path-prepend as-path [repeat]
as-path-prepend most-recent [repeat]
no as-path-prepend
Context 
config>router>policy-options>policy-statement>default-action
config>router>policy-options>policy-statement>entry>action
Description 

The command prepends a BGP AS number once or numerous times to the AS path attribute of routes matching the route policy statement entry.

If an AS number is not configured, the AS path is not changed.

If the optional number is specified, then the AS number is prepended as many times as indicated by the number.

The no form of the command disables the AS path prepend action from the route policy entry.

Default 

no as-path-prepend

Parameters 
as-path—
Specifies the AS number to prepend expressed as a decimal integer.
Values—
1 to 4294967295
param-name — Specifies the AS path parameter variable name. Allowed values are any string up to 32 characters composed of printable, 7-bit ASCII characters. If the string contains special characters (#, $, spaces, and so on), the entire string must be enclosed within double quotes. Policy parameters must start and end with at-signs (@); for example, “@variable@”.

 

repeat—
Specifies the number of times to prepend the specified AS number expressed as a decimal integer.
Values—
1 to 50
param-name — Specifies the AS path parameter variable name. Allowed values are any string up to 32 characters composed of printable, 7-bit ASCII characters. If the string contains special characters (#, $, spaces, and so on), the entire string must be enclosed within double quotes. Policy parameters must start and end with at-signs (@); for example, “@variable@”.

 

most-recent—
Specifies that the most recent AS number must be prepended to the AS-Path attribute of the route.

bgp-leak

Syntax 
bgp-leak
no bgp-leak
Context 
config>router>policy-options>policy-statement>default-action
config>router>policy-options>policy-statement>entry>action
Description 

This command causes qualifying matched BGP routes to be marked as leakable, meaning they are candidates to be leaked into other routing instances (copied with their complete set of path attributes). A BGP route is a qualifying route if the NLRI has an IPv4 or IPv6 prefix without a label.

Note:

A leakable BGP route is not actually leaked into another routing instance unless it is accepted by a leak-import policy of that other routing instance.

The bgp-leak command has an effect only when the policy is applied as a BGP import policy in the base router or a VPRN context.

Default 

no bgp-leak

community

Syntax 
community add name [name]
community remove name [name]
community replace name [name]
no community
Context 
config>router>policy-options>policy-statement>default-action
config>router>policy-options>policy-statement>entry>action
Description 

This command adds or removes a BGP community list to or from routes matching the route policy statement entry.

If no community list is specified, the community path attribute is not changed.

The community list changes the community path attribute according to the add and remove keywords.

The no form of the command disables the action to edit the community path attribute for the route policy entry.

Default 

no community

Parameters 
name—
Specifies up to 28 names.
add—
The specified community list is added to any existing list of communities.
remove—
The specified community list is removed from the existing list of communities.
replace—
The specified community list replaces any existing community attribute. name — The community list name. Allowed values are any string up to 64 characters, composed of printable, 7-bit ASCII characters. If the string contains special characters (#, $, spaces, and so on), the entire string must be enclosed within double quotes. Policy parameters must be enclosed by at-signs (@) and may be midstring; for example, "@variable@," "start@variable@end"," @variable@end", or "start@variable@".

community

Syntax 
community comm-name
community expression expression
no community
Context 
config>router>policy-options>policy-statement>entry>from
Description 

This command adds or removes a BGP community list to or from routes matching the route policy statement entry.

If no community list is specified, the community path attribute is not changed.

The community list changes the community path attribute according to the add and remove keywords.

The no form of the command disables the action to edit the community path attribute for the route policy entry.

Default 

no community

Parameters 
comm-name—
Specifies up to 28 names.
expression—
Applies parameters to routes matching the entry.
Values—
expression is one of the following up to 900 characters:
<expression> {AND|OR} <expression>
[NOT] ( <expression> )
[NOT] "["<comm-name>"]

 

damping

Syntax 
damping {name | none}
no damping
Context 
config>router>policy-options>policy-statement>default-action
config>router>policy-options>policy-statement>entry>action
Description 

This command configures a damping profile used for routes matching the route policy statement entry.

If no damping criteria is specified, the default damping profile is used.

The no form of the command removes the damping profile associated with the route policy entry.

Default 

no damping

Parameters 
name—
The damping profile name. Allowed values are any string up to 32 characters long composed of printable, 7-bit ASCII characters. If the string contains special characters (#, $, spaces, etc.), the entire string must be enclosed within double quotes. Policy parameters must be enclosed by at-signs (@) and may be midstring; for example, "@variable@," "start@variable@end"," @variable@end", or "start@variable@".

The name specified must already be defined.

none—
Disables route damping for the route policy.

create-udp-tunnel

Syntax 
create-udp-tunnel
no create-udp-tunnel
Context 
config>router>policy-options>policy-statement >default-action
config>router>policy-options>policy-statement>entry>action
Description 

This command instructs the router to create an MPLS-over-UDP tunnel upon receiving BGP routes that match the import policy.

Default 

no create-udp-tunnel

fc

Syntax 
fc fc [priority {low | high}]
no fc
Context 
config>router>policy-options>policy-statement>entry>action$
Description 

This command associates a forwarding-class and optionally priority with the routes matched by a route policy entry. The command takes effect when the action of the route policy entry is accept, next-entry or next-policy. It has no effect except in route policies applied as VRF import policies, BGP import policies or RIP import policies.

The no form of the command removes the QoS association of the routes matched by the route policy entry.

Default 

no fc

Parameters 
fc —
Specify the name of one of the predefined forwarding classes in the system.
Values—
be, l2, af, l1, h2, ef, h1, nc

 

Default—
none (no QoS information is associated with matched routes)
priority {low | high}
This parameter associates an enqueuing priority with routes matched by the policy entry. Specifying a priority is optional.
Values—
high — Setting the enqueuing parameter to high for a packet increases the likelihood of enqueuing the packet when the ingress queue is congested. Ingress enqueuing priority only affects ingress SAP queuing. Once the packet is placed in a buffer on the ingress queue, the significance of the enqueuing priority is lost.
low — Setting the enqueuing parameter to low for a packet decreases the likelihood of enqueuing the packet when the ingress queue is congested. Ingress enqueuing priority only affects ingress SAP queuing, once the packet is placed in a buffer on the ingress queue, the significance of the enqueuing priority is lost.

 

Default—
low

default-action

Syntax 
default-action {accept | next-entry | next-policy | drop | reject}
no default-action
Context 
config>router>policy-options>policy-statement
Description 

This command enables the context to configure actions to apply to routes that do not match any entries of a route policy statement.

The no form of the command deletes the default-action context for the policy statement.

Default 

no default-action

Parameters 
accept—
Specifies that routes not matched by any entry should be allowed or accepted. This parameter provides a context for modifying route properties.
next-entry—
Specifies that routes not matched by any entry should be evaluated by the next sequential entry in the policy chain, after route properties are possibly modified by the default action of the current policy.
next-policy—
Specifies that routes not matched by any entry should be evaluated by the next sequential policy in the policy chain, after route properties are possibly modified by the default action of the current policy.
drop—
Specifies that routes not matched by any entry should be disallowed or rejected. This parameter provides a context for modifying route properties.
reject—
Specifies that routes not matched by any entry should be disallowed or rejected. This parameter does not provide a context for modifying route properties.

install-backup-path

Syntax 
install-backup-path
no install-backup-path
Context 
config>router>policy-options>policy-statement>entry>action
config>router>policy-options>policy-statement>default-action
Description 

When the best BGP route for an IPv4 or IPv6 prefix is matched by a policy entry or policy default action with this command, BGP attempts to find and install a pre-programmed backup path for the prefix in order to provide BGP fast reroute protection.

The install-backup-path command overrides and has no dependency on commands such as the BGP instance backup-path command or the VPRN-level enable-bgp-vpn-backup command, which enable BGP fast reroute for an entire address family. The install-backup-path command provides more precise control over which IP prefixes are supported with pre-programmed backup paths.

If, within a VPRN, the best path for an IP prefix is provided by a VPRN BGP route, the backup path can be provided by another VPRN BGP route or an imported VPN-IP route. If, within a VPRN, the best path for an IP prefix is provided by an imported VPN-IP route, the backup path can be provided by another VPN-IP route.

The install-backup-path command is supported only in BGP import policies and VRF import policies and has no effect on policy types other than BGP import policies and VRF import policies. The install-backup-path command applies only to the following types of matched routes: IPv4, IPv6, label-IPv4, label-IPv6, VPN-IPv4, and VPN-IPv6.

Default 

no install-backup-path

local-preference

Syntax 
local-preference preference
no local-preference
Context 
config>router>policy-options>policy-statement>default-action
config>router>policy-options>policy-statement>entry
Description 

This command assigns a BGP local preference to routes matching a route policy statement entry.

If no local preference is specified, the BGP configured local preference is used.

The no form of the command disables assigning a local preference in the route policy entry.

Default 

no local-preference

Parameters 
preference—
The local preference expressed as a decimal integer.
Values—
0 to 4294967295 name — The local preference parameter variable name. Allowed values are any string up to 32 characters long composed of printable, 7-bit ASCII characters. If the string contains special characters (#, $, spaces, etc.), the entire string must be enclosed within double quotes. Policy parameters must start and end with at-signs (@); for example, “@variable@”.

 

metric

Syntax 
metric {add | subtract} metric
metric set {[gp | metric-value]
no metric
Context 
config>router>policy-options>policy-statement>default-action
config>router>policy-options>policy-statement>entry>action
Description 

In a BGP import or export policy, this command assigns a MED value to routes matched by the policy statement entry. The MED value may be set to a fixed value (overriding the received value), set to the routing table cost of the route used to resolve the NEXT_HOP of the BGP route (igp option), or modified by adding or subtracting a fixed value offset.

The no form of the command removes the MED attribute from the matched routes.

Default 

no metric

Parameters 
add —
Specifies that an integer is added to any existing metric. If the result of the addition results in a number greater than 4294967295, the value 4294967295 is used.
subtract—
Specified integer is subtracted from any existing metric. If the result of the subtraction results in a number less than 0, the value of 0 is used.
set—
Specified integer replaces any existing metric.
igp—
Sets the MED value to the routing table cost of the route used to resolve the NEXT_HOP of the BGP route.
metric—
The metric modifier expressed as a decimal integer.
Values—
0 to 4294967295
name —The metric parameter variable name. Allowed values are any string up to 32 characters long composed of printable, 7-bit ASCII characters. If the string contains special characters (#, $, spaces, and so on), the entire string must be enclosed within double quotes. Policy parameters must start and end with at-signs (@); for example, “@variable@”

 

multicast-redirection

Syntax 
multicast-redirection [fwd-service service-id] ip-int-name
no multicast-redirection
Context 
config>router>policy-options>policy-statement>default-action
Description 

This command enables a redirection under a filtering policy. The filtering policy in this case becomes a redirection policy and it is defined under the router>policy-option hierarchy.

After the redirection policy is applied to the subscriber, all IGMP messages will be processed per subscriber host before they get redirected to the referenced interface (and possibly service). However, multicast traffic will not be replicated directly per subscriber host but instead it will be forwarded on the interface that is referenced in the redirection policy. The redirected interface must have IGMP enabled.

Currently all traffic is redirected and there is no ability to selectively redirect multicast traffic based on match conditions (multicast-groups, source IP address of IGMP messages, etc). Multicast redirection is supported between VPRN services and also between interfaces within the Global Routing Context. Multicast redirection is not supported between the VPRN services and the Global Routing Context. Multicast redirection is supported in the wholesale/retail VPRN context.

Note:

Redirecting from a VPRN instance to the GRT is not supported. Redirecting from a VPRN to a different VPRN is supported and redirecting from an IES to another IES is also supported.

Default 

no multicast-redirection

Parameters 
fwd-service service-id
Specifies the service to which traffic should be redirected. This option is applied only in the VPRN context. It is possible to redirect the multicast group into another service instance routing interface.
ip-int-name—
specifies the alternate interface to which IGMP messages are redirected.

next-hop

Syntax 
next-hop ip-address
no next-hop
Context 
config>router>policy-options>policy-statement>default-action
config>router>policy-options>policy-statement>entry>action
Description 

This command assigns the specified next hop IP address to routes matching the policy statement entry.

If a next-hop IP address is not specified, the next-hop attribute is not changed.

The no form of the command disables assigning a next hop address in the route policy entry.

Default 

no next-hop

Parameters 
ip-address—
The next hop IP address in dotted decimal notation.
Values—
ipv4-prefix:
  1. a.b.c.d (host bits must be 0)
ipv4-prefix-length: [0 to 32]
ipv6-prefix:
  1. x:x:x:x:x:x:x:x (eight 16-bit pieces)
  2. x:x:x:x:x:x:d.d.d.d
  3. x: [0 to FFFF]H
  4. d: [0 to 255]D
name — The next-hop parameter variable name. Allowed values are any string up to 32 characters long composed of printable, 7-bit ASCII characters. If the string contains special characters (#, $, spaces, etc.), the entire string must be enclosed within double quotes. Policy parameters must start and end with at-signs (@); for example, “@variable@”.

 

next-hop-self

Syntax 
[no] next-hop-self
Context 
config>router>policy-options>policy-statement>entry>action
config>router>policy-options>policy-statement>default-action
Description 

This command configures BGP to advertise routes that match a policy entry (or that match no other policy entry and, therefore, to which the default action applies) using a local address of the BGP instance as the BGP next-hop address. The command applies to IPv4, IPv6, label-IPv4, and label-IPv6 routes. It also applies to VPN-IPv4 and VPN-IPv6 routes, but only when used in conjunction with the enable-rr-vpn-forwarding command.

This command affects how routes are advertised to IBGP peers, regardless of whether or not they were learned from an IBGP or EBGP peer

The no form of the command uses protocol standard behavior to decide whether or not to set next-hop-self in advertised routes.

Default 

no next-hop-self

origin

Syntax 
origin {igp | egp | incomplete | param-name}
no origin
Context 
config>router>policy-options>policy-statement>default-action
config>router>policy-options>policy-statement>entry>action
Description 

This command sets the BGP origin assigned to routes exported into BGP.

If the routes are exported into protocols other than BGP, this option is ignored.

The no form of the command disables setting the BGP origin for the route policy entry.

Default 

no origin

Parameters 
igp—
Sets the path information as originating within the local AS.
egp—
Sets the path information as originating in another AS.
incomplete—
Sets the path information as learned by some other means.
param-name—
The origin parameter variable name. Allowed values are any string up to 32 characters long composed of printable, 7-bit ASCII characters. If the string contains special characters (#, $, spaces, etc.), the entire string must be enclosed within double quotes. Policy parameters must start and end with at-signs (@); for example, “@variable@”.

origin-validation-state

Syntax 
origin-validation-state {state | param-name}
no origin-validation-state
Context 
config>router>policy-options>policy-statement>default-action
config>router>policy-options>policy-statement>entry>action
Description 

This command is used to mark BGP IPv4 and IPv6 routes matching the default-action or a specific entry of a route policy with one of the 3 following origin validation states:

  1. Valid (0)
  2. Not-Found (1)
  3. Invalid (2)
Default 

no origin-validation-state

Parameters 
state—
Specifies the default operational origin validation state for this policy statement.
Values—
valid — Marks the route as having an origin validation state of valid.
notFound — Marks the route as having an origin validation state of Not Found.
invalid — Marks the route as having an origin validation state of invalid.

 

preference

Syntax 
preference preference
no preference
Context 
config>router>policy-options>policy-statement name>default-action
config>router>policy-options>policy-statement>entry>action
Description 

This command assigns a route preference to routes matching the route policy statement entry.

If no preference is specified, the default Route Table Manager (RTM) preference for the protocol is used.

The no form of the command disables setting an RTM preference in the route policy entry.

Note:

This command is supported with the following protocols: RIP import, BGP import, VPRN VRF import (vrf-import), and VPRN GRT lookup export (export-grt).

Default 

no preference

Parameters 
preference—
The route preference expressed as a decimal integer.
Values—
1 to 255 (0 represents unset - MIB only)
name — The preference parameter variable name. Allowed values are any string up to 32 characters long composed of printable, 7-bit ASCII characters. If the string contains special characters (#, $, spaces, etc.), the entire string must be enclosed within double quotes. Policy parameters must start and end with at-signs (@); for example, “@variable@”.

 

resolve-static

Syntax 
[no] resolve-static
Context 
config>router>policy-options>policy-statement>default-action
config>router>policy-options>policy-statement>entry>action
Description 

This command has an affect only in BGP route-table-import policies and applies only to BGP IPv4 and IPv6 routes created by importing static routes with indirect next-hops. When such a route matches a policy entry with this action, the BGP next-hop is the resolved next-hop of the static route.

The no form of the command reverts to the default behavior, which copies the indirect next-hop of the static route into the BGP next-hop without resolving it further.

Default 

no resolve-static

source-class

Syntax 
source-class [value]
no source-class
Context 
config>router>policy-options>policy-statement>entry>action
config>router>policy-options>policy-statement>default-action
Description 

This command configures the default source-class for this policy-statement.

Parameters 
value—
Specifies the default operational source-class for this policy statement.
Values—
1 to 255

 

sticky-ecmp

Syntax 
sticky-ecmp
no sticky-ecmp
Context 
config>router>policy-options>policy-statement>entry>action
config>router>policy-options>policy-statement>default-action
Description 

This command specifies that BGP routes matching an entry or default-action of a route policy should be tagged internally as requiring sticky ECMP behavior. When a BGP route with multiple equal-cost BGP next-hops is programmed for sticky ECMP the failure of one or more of its BGP next-hops causes only the affected traffic flows to be re-distributed to the remaining next-hops; by default (without sticky-ECMP) all flows are potentially affected, even those using a next-hop that did not fail.

Default 

no sticky-ecmp

tag

Syntax 
tag {no-tag | tag}
no tag
Context 
config>router>policy-options>policy-statement>default-action
config>router>policy-options>policy-statement>entry>action
Description 

This command assigns a tag to routes matching the entry, which is then applied to IGP routes. A decimal or hexadecimal value of 4 octets can be entered.

For IS-IS and OSPF, all four octets can be used.

For RIP and RIPng, only the two most significant octets are used if more than two octets are configured.

The no form of the command removes the tag.

Default 

no tag

Parameters 
tag
Assigns an IS-IS, OSPF, RIP or RIPng tag to routes matching the entry.
Values—
Accepts decimal or hexadecimal formats:
IS-IS and OSPF: 0x0–0xFFFFFFFF or 1–4294967295
RIP and RIPng: 0x0–0xFFFF or 1–65535
name — The tag parameter variable name. Allowed values are any string up to 32 characters long composed of printable, 7-bit ASCII characters. If the string contains special characters (#, $, spaces, and so on), the entire string must be enclosed within double quotes. Policy parameters must start and end with at-signs (@); for example, “@variable@”.

 

type

Syntax 
type type
no type
Context 
config>router>policy-options>policy-statement>default-action
config>router>policy-options>policy-statement>entry>action
Description 

This command sets the subtype for the Type 5 LSA (external LSA).

The no form of the command disables assigning a type in the route policy entry.

Default 

type 2

Parameters 
type—
Specifies the type metric.
Values—
Subtype 1 — The external metric in the external LSA is comparable with the internal metric, and thus one can sum up all the metrics along the path (both internal and external) to get the total cost to the destination.
Subtype 2 — The metric in the external LSA is much more important than the internal metric, so the internal metrics should only be considered when comparing two external routes that have the same external metric.

 

route-exists

Syntax 
route-exists expression
no route-exists
Context 
config>router>policy-options>policy-statement>entry>cond-expr
Description 

This command is used to specify a route existence expression to control evaluation of the policy entry. If the route existence expression evaluates to ‘true’ the matching and action commands of the policy entry are applied as normal. If the route existence expression evaluates to ‘false’ the entire policy entry is skipped and processing continues with the next entry; however, conditional expressions are only parsed when the route policy is used as a BGP export policy or VRF export policy.

Default 

no route-exists

Parameters 
expression —
“[“<prefix-list-name>”]” [all | none]

If neither the all nor the none keyword are used the match logic is ‘any’ – that is, the route expression evaluates as ‘true’ if any exact match entry in the referenced prefix-list has an active route in the route table associated with the policy.

all – the route expression evaluates as ‘true’ only if all the exact match entries in the referenced prefix-list have an active route in the route table associated with the policy.

none – the route expression evaluates as ‘true’ only if none of the exact match entries in the referenced prefix-list have an active route in the route table associated with the policy.