Skip to content

Latest commit

 

History

History
21694 lines (21459 loc) · 933 KB

cisco.iosxr.iosxr_route_maps_module.rst

File metadata and controls

21694 lines (21459 loc) · 933 KB
Raw

cisco.iosxr.iosxr_route_maps

Resource module to configure route maps.

Version added: 10.2.0

Synopsis

  • This module configures and manages the attributes of Route maps on Cisco IOSXR.

Parameters

Parameter Choices/Defaults Comments
config
list / elements=dictionary
A list of configurations for route policy.
else_section
dictionary
A dictionary of configurations that would be considered in the else block
else_section
dictionary
A dictionary of configurations for nested else, does not support if/ elseif
add
dictionary
Add offset to the existing value
eigrp_metric
dictionary
EIGRP metric attribute
bandwidth
integer
<0-4294967295> Bandwidth in Kbits per second
delay
integer
<0-4294967295> Delay metric in 10 microsecond units
effective_bandwith
integer
<0-255> Effective bandwidth metric (Loading) where 255 is 100% loaded
max_transmission
integer
<0-65535> Maximum Transmission Unit metric of the path
reliability
integer
<0-255> Reliability metric where 255 is 100% reliable
rip_metric
integer
<0-16> RIP metric attribute
apply
list / elements=dictionary
Apply a route policy
route_policy
string
Apply a specific route policy
route_policy_input
string
ipv4/ ipv6 / name-string
drop
boolean
    Choices:
  • no
  • yes
Reject this route with no further processing
pass
boolean
    Choices:
  • no
  • yes
Pass this route for further processing
prepend
dictionary
Prepend to BGP AS-path
as_path
integer
<1-4294967295> 32-bit decimal number/ 16-bit decimal number as-path
most_recent
boolean
    Choices:
  • no
  • yes
Most recent Autonomous System Number
number_of_times
integer
number of times to prepend
own_as
boolean
    Choices:
  • no
  • yes
Local Autonomous System Number
remove
dictionary
Remove all private-as entries
entire_aspath
boolean
    Choices:
  • no
  • yes
Remove private-AS from entire aspath
set
boolean
    Choices:
  • no
  • yes
Remove all private-as entries (remove as-path private-as)
set
dictionary
Set a route attribute
administrative_distance
integer
Administrative Distance of the prefix, <1-255> 8 bit decimal numbe
aigp_metric
dictionary
AIGP metric attribute
decrement
boolean
    Choices:
  • no
  • yes
- Decrement the attribute by specified value
icrement
boolean
    Choices:
  • no
  • yes
+ Increment the attribute with specified value
igp_cost
boolean
    Choices:
  • no
  • yes
Internal routing protocol cost
metric_number
integer
<0-4294967295> 32-bit decimal number
attribute_set
string
TE attribute-set name <0-4294967295> 32-bit decimal number
c_multicast_routing
dictionary
Multicast Customer routing type
bgp
boolean
    Choices:
  • no
  • yes
BGP customer-multicast routing
pim
boolean
    Choices:
  • no
  • yes
PIM customer-multicast routing
community
dictionary
BGP community attribute
additive
boolean
    Choices:
  • no
  • yes
Add to the existing community
community_name
string
Community set name
core_tree
dictionary
Multicast Distribution Tree type
ingress_replication
boolean
    Choices:
  • no
  • yes
Ingress Replication core segment
ingress_replication_default
boolean
    Choices:
  • no
  • yes
Ingress Replication Default MDT core
ingress_replication_partitioned
boolean
    Choices:
  • no
  • yes
Ingress Replication Partitioned MDT core
mldp
boolean
    Choices:
  • no
  • yes
MLDP core segment
mldp_default
boolean
    Choices:
  • no
  • yes
MLDP Default MDT core
mldp_inband
boolean
    Choices:
  • no
  • yes
MLDP Inband core
mldp_partitioned_mp2mp
boolean
    Choices:
  • no
  • yes
MLDP Partitioned MP2MP MDT core
mldp_partitioned_p2mp
boolean
    Choices:
  • no
  • yes
MLDP Partitioned P2MP MDT core
p2mp_te
boolean
    Choices:
  • no
  • yes
P2MP TE core segment
p2mp_te_default
boolean
    Choices:
  • no
  • yes
P2MP TE Default MDT core
p2mp_te_partitioned
boolean
    Choices:
  • no
  • yes
P2MP TE Partitioned MDT core
pim_default
boolean
    Choices:
  • no
  • yes
PIM Default MDT core
sr_p2mp
boolean
    Choices:
  • no
  • yes
Segment-Routing P2MP core
dampening
dictionary
BGP route flap dampening parameters
halflife
integer
Dampening penalty half-life, <1-45> Half-life time for penalty, default 15
max_suppress
integer
Maximum dampening penalty, <1-255> Maximum dampening penalty time, default 60
reuse
integer
Penalty before reusing suppressed route, <1-20000> Dampening reuse threshold, default 750
suppress
integer
Dampening penalty to start suppressing a route, <1-20000> Suppress penalty threshold, default 2000
downstream_core_tree
dictionary
BGP I-PMSI/S-PMSI core tree type
ingress_replication
boolean
    Choices:
  • no
  • yes
Ingress Replication core segment
mldp
boolean
    Choices:
  • no
  • yes
MLDP core segment
p2mp_te
boolean
    Choices:
  • no
  • yes
P2MP TE core segment
sr_p2mp
boolean
    Choices:
  • no
  • yes
Segment-Routing P2MP core
eigrp_metric
dictionary
EIGRP metric attribute
bandwidth
integer
<0-4294967295> Bandwidth in Kbits per second
delay
integer
<0-4294967295> Delay metric in 10 microsecond units
effective_bandwith
integer
<0-255> Effective bandwidth metric (Loading) where 255 is 100% loaded
max_transmission
integer
<0-65535> Maximum Transmission Unit metric of the path
reliability
integer
<0-255> Reliability metric where 255 is 100% reliable
fallback_vrf_lookup
boolean
    Choices:
  • no
  • yes
fallback vrf look-up
flow_tag
integer
flow tag value for PBR BGP flow-tag, <1-63> 6 bit decimal number starting from 1
forward_class
integer
Forward class (default value 0), <1-7> 3 bit decimal number starting from 1
ip_precedence
integer
IP Precedence to classify packets, <1-7> 3 bit decimal number starting from 1
isis_metric
integer
IS-IS metric attribute, <0-16777215> 24 bit decimal number
label
integer
Set BGP label value, <0-1048575> 20 bit decimal number
label_index
integer
Set Segment Routing label-index value, <0-1048575> 20 bit decimal number
label_mode
dictionary
Set BGP label-mode value
per_ce
boolean
    Choices:
  • no
  • yes
Set the label mode to per-ce
per_prefix
boolean
    Choices:
  • no
  • yes
Set the label mode to per-prefix
per_vrf
boolean
    Choices:
  • no
  • yes
Set the label mode to per-vrf
large_community
string
BGP large community attribute
level
dictionary
Where to import route
level_1
boolean
    Choices:
  • no
  • yes
IS-IS level-1 routes
level_1_2
boolean
    Choices:
  • no
  • yes
IS-IS level-1 and level-2 routes
level_2
boolean
    Choices:
  • no
  • yes
IS-IS level-2 routes
load_balance
boolean
    Choices:
  • no
  • yes
Load-balance for ECMP ecmp-consistent
local_preference
list / elements=dictionary
List of local preference configurations
decrement
boolean
    Choices:
  • no
  • yes
- Decrement the attribute by specified value
increment
boolean
    Choices:
  • no
  • yes
+ Increment the attribute with specified value
metric_number
integer / required
<0-4294967295> 32-bit decimal number
multiply
boolean
    Choices:
  • no
  • yes
* multiply the attribute by specified value
lsm_root
string
Label Switched Multicast Root address
metric_type
dictionary
Type of metric for destination routing protocol
external
boolean
    Choices:
  • no
  • yes
ISIS external metric-type
internal
boolean
    Choices:
  • no
  • yes
ISIS internal metric-type
rib_metric_as_external
boolean
    Choices:
  • no
  • yes
Use RIB metric and set ISIS external metric-type
rib_metric_as_internal
boolean
    Choices:
  • no
  • yes
Use RIB metric and set ISIS internal metric-type
type_1
boolean
    Choices:
  • no
  • yes
OSPF type-1 route
type_2
boolean
    Choices:
  • no
  • yes
OSPF type-2 route
mpls
string
MPLS traffic-eng attributeset name-string
next_hop
dictionary
Next hop address specified in this route
address
string
next hop address
origin
dictionary
BGP origin code
egp
boolean
    Choices:
  • no
  • yes
ISIS external metric-type
igp
boolean
    Choices:
  • no
  • yes
ISIS internal metric-type
rincomplete
boolean
    Choices:
  • no
  • yes
Use RIB metric and set ISIS external metric-type
ospf_metric
integer
OSPF metric attribute
path_color
boolean
    Choices:
  • no
  • yes
BGP Path Color for RIB (path-color external-reach)
path_selection
dictionary
BGP path selection
all
boolean
    Choices:
  • no
  • yes
BGP all advertise
backup
dictionary
BGP backup
advertise
boolean
    Choices:
  • no
  • yes
Advertise the path
backup_decimal
integer
<1>, decimal number 1
install
boolean
    Choices:
  • no
  • yes
Install the path
best_path
boolean
    Choices:
  • no
  • yes
BGP best path
group_best
boolean
    Choices:
  • no
  • yes
BGP group-best advertise
multiplath
boolean
    Choices:
  • no
  • yes
BGP multipath advertise
qos_group
integer
QoS Group to classify packets
rib_metric
integer
RIB metric for table-policy
rip_metric
integer
RIP metric attribute
rip_tag
integer
RIP Route tag attribute
rt_set
integer
Limit on routes with paths with an RT-set
s_pmsi
boolean
    Choices:
  • no
  • yes
S-PMSI Advertisement type (star-g)
spf_priority
dictionary
OSPF SPF priority
critical
boolean
    Choices:
  • no
  • yes
Critical priority
high
boolean
    Choices:
  • no
  • yes
High priority
medium
boolean
    Choices:
  • no
  • yes
Medium priority
static_p2mp_te
string
Static P2MP-TE tunnel
tag
integer
Route tag attribute
traffic_index
dictionary
Traffic-index for BGP policy accounting
ignore
boolean
    Choices:
  • no
  • yes
Remove any traffic-index setting
index_number
integer
6 bit decimal number starting from 1 <1-63>
upstream_core_tree
dictionary
BGP Leaf AD core tree type
ingress_replication
boolean
    Choices:
  • no
  • yes
Ingress Replication core segment
mldp
boolean
    Choices:
  • no
  • yes
MLDP core segment
p2mp_te
boolean
    Choices:
  • no
  • yes
P2MP TE core segment
sr_p2mp
boolean
    Choices:
  • no
  • yes
Segment-Routing P2MP core
vpn_distinguisher
integer
BGP VPN distinguisher (VD) attribute
weight
integer
Weight attribute for route selection
suppress_route
boolean
    Choices:
  • no
  • yes
Suppress specific routes when aggregating
unsuppress_route
boolean
    Choices:
  • no
  • yes
Unsuppress specific aggregated routes
elseif_section
list / elements=dictionary
A list of elif configurations that would follow along with the top level if
add
dictionary
Add offset to the existing value
eigrp_metric
dictionary
EIGRP metric attribute
bandwidth
integer
<0-4294967295> Bandwidth in Kbits per second
delay
integer
<0-4294967295> Delay metric in 10 microsecond units
effective_bandwith
integer
<0-255> Effective bandwidth metric (Loading) where 255 is 100% loaded
max_transmission
integer
<0-65535> Maximum Transmission Unit metric of the path
reliability
integer
<0-255> Reliability metric where 255 is 100% reliable
rip_metric
integer
<0-16> RIP metric attribute
apply
list / elements=dictionary
Apply a route policy
route_policy
string
Apply a specific route policy
route_policy_input
string
ipv4/ ipv6 / name-string
condition
string
the condition string, eg - aigp-metric eq 23 and as-path in tmp1 and community is-empty and community matches-any test1 (don't add then at end)
drop
boolean
    Choices:
  • no
  • yes
Reject this route with no further processing
pass
boolean
    Choices:
  • no
  • yes
Pass this route for further processing
prepend
dictionary
Prepend to BGP AS-path
as_path
integer
<1-4294967295> 32-bit decimal number/ 16-bit decimal number as-path
most_recent
boolean
    Choices:
  • no
  • yes
Most recent Autonomous System Number
number_of_times
integer
number of times to prepend
own_as
boolean
    Choices:
  • no
  • yes
Local Autonomous System Number
remove
dictionary
Remove all private-as entries
entire_aspath
boolean
    Choices:
  • no
  • yes
Remove private-AS from entire aspath
set
boolean
    Choices:
  • no
  • yes
Remove all private-as entries (remove as-path private-as)
set
dictionary
Set a route attribute
administrative_distance
integer
Administrative Distance of the prefix, <1-255> 8 bit decimal numbe
aigp_metric
dictionary
AIGP metric attribute
decrement
boolean
    Choices:
  • no
  • yes
- Decrement the attribute by specified value
icrement
boolean
    Choices:
  • no
  • yes
+ Increment the attribute with specified value
igp_cost
boolean
    Choices:
  • no
  • yes
Internal routing protocol cost
metric_number
integer
<0-4294967295> 32-bit decimal number
attribute_set
string
TE attribute-set name <0-4294967295> 32-bit decimal number
c_multicast_routing
dictionary
Multicast Customer routing type
bgp
boolean
    Choices:
  • no
  • yes
BGP customer-multicast routing
pim
boolean
    Choices:
  • no
  • yes
PIM customer-multicast routing
community
dictionary
BGP community attribute
additive
boolean
    Choices:
  • no
  • yes
Add to the existing community
community_name
string
Community set name
core_tree
dictionary
Multicast Distribution Tree type
ingress_replication
boolean
    Choices:
  • no
  • yes
Ingress Replication core segment
ingress_replication_default
boolean
    Choices:
  • no
  • yes
Ingress Replication Default MDT core
ingress_replication_partitioned
boolean
    Choices:
  • no
  • yes
Ingress Replication Partitioned MDT core
mldp
boolean
    Choices:
  • no
  • yes
MLDP core segment
mldp_default
boolean
    Choices:
  • no
  • yes
MLDP Default MDT core
mldp_inband
boolean
    Choices:
  • no
  • yes
MLDP Inband core
mldp_partitioned_mp2mp
boolean
    Choices:
  • no
  • yes
MLDP Partitioned MP2MP MDT core
mldp_partitioned_p2mp
boolean
    Choices:
  • no
  • yes
MLDP Partitioned P2MP MDT core
p2mp_te
boolean
    Choices:
  • no
  • yes
P2MP TE core segment
p2mp_te_default
boolean
    Choices:
  • no
  • yes
P2MP TE Default MDT core
p2mp_te_partitioned
boolean
    Choices:
  • no
  • yes
P2MP TE Partitioned MDT core
pim_default
boolean
    Choices:
  • no
  • yes
PIM Default MDT core
sr_p2mp
boolean
    Choices:
  • no
  • yes
Segment-Routing P2MP core
dampening
dictionary
BGP route flap dampening parameters
halflife
integer
Dampening penalty half-life, <1-45> Half-life time for penalty, default 15
max_suppress
integer
Maximum dampening penalty, <1-255> Maximum dampening penalty time, default 60
reuse
integer
Penalty before reusing suppressed route, <1-20000> Dampening reuse threshold, default 750
suppress
integer
Dampening penalty to start suppressing a route, <1-20000> Suppress penalty threshold, default 2000
downstream_core_tree
dictionary
BGP I-PMSI/S-PMSI core tree type
ingress_replication
boolean
    Choices:
  • no
  • yes
Ingress Replication core segment
mldp
boolean
    Choices:
  • no
  • yes
MLDP core segment
p2mp_te
boolean
    Choices:
  • no
  • yes
P2MP TE core segment
sr_p2mp
boolean
    Choices:
  • no
  • yes
Segment-Routing P2MP core
eigrp_metric
dictionary
EIGRP metric attribute
bandwidth
integer
<0-4294967295> Bandwidth in Kbits per second
delay
integer
<0-4294967295> Delay metric in 10 microsecond units
effective_bandwith
integer
<0-255> Effective bandwidth metric (Loading) where 255 is 100% loaded
max_transmission
integer
<0-65535> Maximum Transmission Unit metric of the path
reliability
integer
<0-255> Reliability metric where 255 is 100% reliable
fallback_vrf_lookup
boolean
    Choices:
  • no
  • yes
fallback vrf look-up
flow_tag
integer
flow tag value for PBR BGP flow-tag, <1-63> 6 bit decimal number starting from 1
forward_class
integer
Forward class (default value 0), <1-7> 3 bit decimal number starting from 1
ip_precedence
integer
IP Precedence to classify packets, <1-7> 3 bit decimal number starting from 1
isis_metric
integer
IS-IS metric attribute, <0-16777215> 24 bit decimal number
label
integer
Set BGP label value, <0-1048575> 20 bit decimal number
label_index
integer
Set Segment Routing label-index value, <0-1048575> 20 bit decimal number
label_mode
dictionary
Set BGP label-mode value
per_ce
boolean
    Choices:
  • no
  • yes
Set the label mode to per-ce
per_prefix
boolean
    Choices:
  • no
  • yes
Set the label mode to per-prefix
per_vrf
boolean
    Choices:
  • no
  • yes
Set the label mode to per-vrf
large_community
string
BGP large community attribute
level
dictionary
Where to import route
level_1
boolean
    Choices:
  • no
  • yes
IS-IS level-1 routes
level_1_2
boolean
    Choices:
  • no
  • yes
IS-IS level-1 and level-2 routes
level_2
boolean
    Choices:
  • no
  • yes
IS-IS level-2 routes
load_balance
boolean
    Choices:
  • no
  • yes
Load-balance for ECMP ecmp-consistent
local_preference
list / elements=dictionary
List of local preference configurations
decrement
boolean
    Choices:
  • no
  • yes
- Decrement the attribute by specified value
increment
boolean
    Choices:
  • no
  • yes
+ Increment the attribute with specified value
metric_number
integer / required
<0-4294967295> 32-bit decimal number
multiply
boolean
    Choices:
  • no
  • yes
* multiply the attribute by specified value
lsm_root
string
Label Switched Multicast Root address
metric_type
dictionary
Type of metric for destination routing protocol
external
boolean
    Choices:
  • no
  • yes
ISIS external metric-type
internal
boolean
    Choices:
  • no
  • yes
ISIS internal metric-type
rib_metric_as_external
boolean
    Choices:
  • no
  • yes
Use RIB metric and set ISIS external metric-type
rib_metric_as_internal
boolean
    Choices:
  • no
  • yes
Use RIB metric and set ISIS internal metric-type
type_1
boolean
    Choices:
  • no
  • yes
OSPF type-1 route
type_2
boolean
    Choices:
  • no
  • yes
OSPF type-2 route
mpls
string
MPLS traffic-eng attributeset name-string
next_hop
dictionary
Next hop address specified in this route
address
string
next hop address
origin
dictionary
BGP origin code
egp
boolean
    Choices:
  • no
  • yes
ISIS external metric-type
igp
boolean
    Choices:
  • no
  • yes
ISIS internal metric-type
rincomplete
boolean
    Choices:
  • no
  • yes
Use RIB metric and set ISIS external metric-type
ospf_metric
integer
OSPF metric attribute
path_color
boolean
    Choices:
  • no
  • yes
BGP Path Color for RIB (path-color external-reach)
path_selection
dictionary
BGP path selection
all
boolean
    Choices:
  • no
  • yes
BGP all advertise
backup
dictionary
BGP backup
advertise
boolean
    Choices:
  • no
  • yes
Advertise the path
backup_decimal
integer
<1>, decimal number 1
install
boolean
    Choices:
  • no
  • yes
Install the path
best_path
boolean
    Choices:
  • no
  • yes
BGP best path
group_best
boolean
    Choices:
  • no
  • yes
BGP group-best advertise
multiplath
boolean
    Choices:
  • no
  • yes
BGP multipath advertise
qos_group
integer
QoS Group to classify packets
rib_metric
integer
RIB metric for table-policy
rip_metric
integer
RIP metric attribute
rip_tag
integer
RIP Route tag attribute
rt_set
integer
Limit on routes with paths with an RT-set
s_pmsi
boolean
    Choices:
  • no
  • yes
S-PMSI Advertisement type (star-g)
spf_priority
dictionary
OSPF SPF priority
critical
boolean
    Choices:
  • no
  • yes
Critical priority
high
boolean
    Choices:
  • no
  • yes
High priority
medium
boolean
    Choices:
  • no
  • yes
Medium priority
static_p2mp_te
string
Static P2MP-TE tunnel
tag
integer
Route tag attribute
traffic_index
dictionary
Traffic-index for BGP policy accounting
ignore
boolean
    Choices:
  • no
  • yes
Remove any traffic-index setting
index_number
integer
6 bit decimal number starting from 1 <1-63>
upstream_core_tree
dictionary
BGP Leaf AD core tree type
ingress_replication
boolean
    Choices:
  • no
  • yes
Ingress Replication core segment
mldp
boolean
    Choices:
  • no
  • yes
MLDP core segment
p2mp_te
boolean
    Choices:
  • no
  • yes
P2MP TE core segment
sr_p2mp
boolean
    Choices:
  • no
  • yes
Segment-Routing P2MP core
vpn_distinguisher
integer
BGP VPN distinguisher (VD) attribute
weight
integer
Weight attribute for route selection
suppress_route
boolean
    Choices:
  • no
  • yes
Suppress specific routes when aggregating
unsuppress_route
boolean
    Choices:
  • no
  • yes
Unsuppress specific aggregated routes
global
dictionary
A dictionary of configurations for route policy without any conditions
add
dictionary
Add offset to the existing value
eigrp_metric
dictionary
EIGRP metric attribute
bandwidth
integer
<0-4294967295> Bandwidth in Kbits per second
delay
integer
<0-4294967295> Delay metric in 10 microsecond units
effective_bandwith
integer
<0-255> Effective bandwidth metric (Loading) where 255 is 100% loaded
max_transmission
integer
<0-65535> Maximum Transmission Unit metric of the path
reliability
integer
<0-255> Reliability metric where 255 is 100% reliable
rip_metric
integer
<0-16> RIP metric attribute
apply
list / elements=dictionary
Apply a route policy
route_policy
string
Apply a specific route policy
route_policy_input
string
ipv4/ ipv6 / name-string
drop
boolean
    Choices:
  • no
  • yes
Reject this route with no further processing
pass
boolean
    Choices:
  • no
  • yes
Pass this route for further processing
prepend
dictionary
Prepend to BGP AS-path
as_path
integer
<1-4294967295> 32-bit decimal number/ 16-bit decimal number as-path
most_recent
boolean
    Choices:
  • no
  • yes
Most recent Autonomous System Number
number_of_times
integer
number of times to prepend
own_as
boolean
    Choices:
  • no
  • yes
Local Autonomous System Number
remove
dictionary
Remove all private-as entries
entire_aspath
boolean
    Choices:
  • no
  • yes
Remove private-AS from entire aspath
set
boolean
    Choices:
  • no
  • yes
Remove all private-as entries (remove as-path private-as)
set
dictionary
Set a route attribute
administrative_distance
integer
Administrative Distance of the prefix, <1-255> 8 bit decimal numbe
aigp_metric
dictionary
AIGP metric attribute
decrement
boolean
    Choices:
  • no
  • yes
- Decrement the attribute by specified value
icrement
boolean
    Choices:
  • no
  • yes
+ Increment the attribute with specified value
igp_cost
boolean
    Choices:
  • no
  • yes
Internal routing protocol cost
metric_number
integer
<0-4294967295> 32-bit decimal number
attribute_set
string
TE attribute-set name <0-4294967295> 32-bit decimal number
c_multicast_routing
dictionary
Multicast Customer routing type
bgp
boolean
    Choices:
  • no
  • yes
BGP customer-multicast routing
pim
boolean
    Choices:
  • no
  • yes
PIM customer-multicast routing
community
dictionary
BGP community attribute
additive
boolean
    Choices:
  • no
  • yes
Add to the existing community
community_name
string
Community set name
core_tree
dictionary
Multicast Distribution Tree type
ingress_replication
boolean
    Choices:
  • no
  • yes
Ingress Replication core segment
ingress_replication_default
boolean
    Choices:
  • no
  • yes
Ingress Replication Default MDT core
ingress_replication_partitioned
boolean
    Choices:
  • no
  • yes
Ingress Replication Partitioned MDT core
mldp
boolean
    Choices:
  • no
  • yes
MLDP core segment
mldp_default
boolean
    Choices:
  • no
  • yes
MLDP Default MDT core
mldp_inband
boolean
    Choices:
  • no
  • yes
MLDP Inband core
mldp_partitioned_mp2mp
boolean
    Choices:
  • no
  • yes
MLDP Partitioned MP2MP MDT core
mldp_partitioned_p2mp
boolean
    Choices:
  • no
  • yes
MLDP Partitioned P2MP MDT core
p2mp_te
boolean
    Choices:
  • no
  • yes
P2MP TE core segment
p2mp_te_default
boolean
    Choices:
  • no
  • yes
P2MP TE Default MDT core
p2mp_te_partitioned
boolean
    Choices:
  • no
  • yes
P2MP TE Partitioned MDT core
pim_default
boolean
    Choices:
  • no
  • yes
PIM Default MDT core
sr_p2mp
boolean
    Choices:
  • no
  • yes
Segment-Routing P2MP core
dampening
dictionary
BGP route flap dampening parameters
halflife
integer
Dampening penalty half-life, <1-45> Half-life time for penalty, default 15
max_suppress
integer
Maximum dampening penalty, <1-255> Maximum dampening penalty time, default 60
reuse
integer
Penalty before reusing suppressed route, <1-20000> Dampening reuse threshold, default 750
suppress
integer
Dampening penalty to start suppressing a route, <1-20000> Suppress penalty threshold, default 2000
downstream_core_tree
dictionary
BGP I-PMSI/S-PMSI core tree type
ingress_replication
boolean
    Choices:
  • no
  • yes
Ingress Replication core segment
mldp
boolean
    Choices:
  • no
  • yes
MLDP core segment
p2mp_te
boolean
    Choices:
  • no
  • yes
P2MP TE core segment
sr_p2mp
boolean
    Choices:
  • no
  • yes
Segment-Routing P2MP core
eigrp_metric
dictionary
EIGRP metric attribute
bandwidth
integer
<0-4294967295> Bandwidth in Kbits per second
delay
integer
<0-4294967295> Delay metric in 10 microsecond units
effective_bandwith
integer
<0-255> Effective bandwidth metric (Loading) where 255 is 100% loaded
max_transmission
integer
<0-65535> Maximum Transmission Unit metric of the path
reliability
integer
<0-255> Reliability metric where 255 is 100% reliable
fallback_vrf_lookup
boolean
    Choices:
  • no
  • yes
fallback vrf look-up
flow_tag
integer
flow tag value for PBR BGP flow-tag, <1-63> 6 bit decimal number starting from 1
forward_class
integer
Forward class (default value 0), <1-7> 3 bit decimal number starting from 1
ip_precedence
integer
IP Precedence to classify packets, <1-7> 3 bit decimal number starting from 1
isis_metric
integer
IS-IS metric attribute, <0-16777215> 24 bit decimal number
label
integer
Set BGP label value, <0-1048575> 20 bit decimal number
label_index
integer
Set Segment Routing label-index value, <0-1048575> 20 bit decimal number
label_mode
dictionary
Set BGP label-mode value
per_ce
boolean
    Choices:
  • no
  • yes
Set the label mode to per-ce
per_prefix
boolean
    Choices:
  • no
  • yes
Set the label mode to per-prefix
per_vrf
boolean
    Choices:
  • no
  • yes
Set the label mode to per-vrf
large_community
string
BGP large community attribute
level
dictionary
Where to import route
level_1
boolean
    Choices:
  • no
  • yes
IS-IS level-1 routes
level_1_2
boolean
    Choices:
  • no
  • yes
IS-IS level-1 and level-2 routes
level_2
boolean
    Choices:
  • no
  • yes
IS-IS level-2 routes
load_balance
boolean
    Choices:
  • no
  • yes
Load-balance for ECMP ecmp-consistent
local_preference
list / elements=dictionary
List of local preference configurations
decrement
boolean
    Choices:
  • no
  • yes
- Decrement the attribute by specified value
increment
boolean
    Choices:
  • no
  • yes
+ Increment the attribute with specified value
metric_number
integer / required
<0-4294967295> 32-bit decimal number
multiply
boolean
    Choices:
  • no
  • yes
* multiply the attribute by specified value
lsm_root
string
Label Switched Multicast Root address
metric_type
dictionary
Type of metric for destination routing protocol
external
boolean
    Choices:
  • no
  • yes
ISIS external metric-type
internal
boolean
    Choices:
  • no
  • yes
ISIS internal metric-type
rib_metric_as_external
boolean
    Choices:
  • no
  • yes
Use RIB metric and set ISIS external metric-type
rib_metric_as_internal
boolean
    Choices:
  • no
  • yes
Use RIB metric and set ISIS internal metric-type
type_1
boolean
    Choices:
  • no
  • yes
OSPF type-1 route
type_2
boolean
    Choices:
  • no
  • yes
OSPF type-2 route
mpls
string
MPLS traffic-eng attributeset name-string
next_hop
dictionary
Next hop address specified in this route
address
string
next hop address
origin
dictionary
BGP origin code
egp
boolean
    Choices:
  • no
  • yes
ISIS external metric-type
igp
boolean
    Choices:
  • no
  • yes
ISIS internal metric-type
rincomplete
boolean
    Choices:
  • no
  • yes
Use RIB metric and set ISIS external metric-type
ospf_metric
integer
OSPF metric attribute
path_color
boolean
    Choices:
  • no
  • yes
BGP Path Color for RIB (path-color external-reach)
path_selection
dictionary
BGP path selection
all
boolean
    Choices:
  • no
  • yes
BGP all advertise
backup
dictionary
BGP backup
advertise
boolean
    Choices:
  • no
  • yes
Advertise the path
backup_decimal
integer
<1>, decimal number 1
install
boolean
    Choices:
  • no
  • yes
Install the path
best_path
boolean
    Choices:
  • no
  • yes
BGP best path
group_best
boolean
    Choices:
  • no
  • yes
BGP group-best advertise
multiplath
boolean
    Choices:
  • no
  • yes
BGP multipath advertise
qos_group
integer
QoS Group to classify packets
rib_metric
integer
RIB metric for table-policy
rip_metric
integer
RIP metric attribute
rip_tag
integer
RIP Route tag attribute
rt_set
integer
Limit on routes with paths with an RT-set
s_pmsi
boolean
    Choices:
  • no
  • yes
S-PMSI Advertisement type (star-g)
spf_priority
dictionary
OSPF SPF priority
critical
boolean
    Choices:
  • no
  • yes
Critical priority
high
boolean
    Choices:
  • no
  • yes
High priority
medium
boolean
    Choices:
  • no
  • yes
Medium priority
static_p2mp_te
string
Static P2MP-TE tunnel
tag
integer
Route tag attribute
traffic_index
dictionary
Traffic-index for BGP policy accounting
ignore
boolean
    Choices:
  • no
  • yes
Remove any traffic-index setting
index_number
integer
6 bit decimal number starting from 1 <1-63>
upstream_core_tree
dictionary
BGP Leaf AD core tree type
ingress_replication
boolean
    Choices:
  • no
  • yes
Ingress Replication core segment
mldp
boolean
    Choices:
  • no
  • yes
MLDP core segment
p2mp_te
boolean
    Choices:
  • no
  • yes
P2MP TE core segment
sr_p2mp
boolean
    Choices:
  • no
  • yes
Segment-Routing P2MP core
vpn_distinguisher
integer
BGP VPN distinguisher (VD) attribute
weight
integer
Weight attribute for route selection
suppress_route
boolean
    Choices:
  • no
  • yes
Suppress specific routes when aggregating
unsuppress_route
boolean
    Choices:
  • no
  • yes
Unsuppress specific aggregated routes
if_section
dictionary
A dictionary of configurations for route policy for the nested if condition, under top level else
add
dictionary
Add offset to the existing value
eigrp_metric
dictionary
EIGRP metric attribute
bandwidth
integer
<0-4294967295> Bandwidth in Kbits per second
delay
integer
<0-4294967295> Delay metric in 10 microsecond units
effective_bandwith
integer
<0-255> Effective bandwidth metric (Loading) where 255 is 100% loaded
max_transmission
integer
<0-65535> Maximum Transmission Unit metric of the path
reliability
integer
<0-255> Reliability metric where 255 is 100% reliable
rip_metric
integer
<0-16> RIP metric attribute
apply
list / elements=dictionary
Apply a route policy
route_policy
string
Apply a specific route policy
route_policy_input
string
ipv4/ ipv6 / name-string
condition
string
the condition string, eg - aigp-metric eq 23 and as-path in tmp1 and community is-empty and community matches-any test1 (don't add then at end)
drop
boolean
    Choices:
  • no
  • yes
Reject this route with no further processing
pass
boolean
    Choices:
  • no
  • yes
Pass this route for further processing
prepend
dictionary
Prepend to BGP AS-path
as_path
integer
<1-4294967295> 32-bit decimal number/ 16-bit decimal number as-path
most_recent
boolean
    Choices:
  • no
  • yes
Most recent Autonomous System Number
number_of_times
integer
number of times to prepend
own_as
boolean
    Choices:
  • no
  • yes
Local Autonomous System Number
remove
dictionary
Remove all private-as entries
entire_aspath
boolean
    Choices:
  • no
  • yes
Remove private-AS from entire aspath
set
boolean
    Choices:
  • no
  • yes
Remove all private-as entries (remove as-path private-as)
set
dictionary
Set a route attribute
administrative_distance
integer
Administrative Distance of the prefix, <1-255> 8 bit decimal numbe
aigp_metric
dictionary
AIGP metric attribute
decrement
boolean
    Choices:
  • no
  • yes
- Decrement the attribute by specified value
icrement
boolean
    Choices:
  • no
  • yes
+ Increment the attribute with specified value
igp_cost
boolean
    Choices:
  • no
  • yes
Internal routing protocol cost
metric_number
integer
<0-4294967295> 32-bit decimal number
attribute_set
string
TE attribute-set name <0-4294967295> 32-bit decimal number
c_multicast_routing
dictionary
Multicast Customer routing type
bgp
boolean
    Choices:
  • no
  • yes
BGP customer-multicast routing
pim
boolean
    Choices:
  • no
  • yes
PIM customer-multicast routing
community
dictionary
BGP community attribute
additive
boolean
    Choices:
  • no
  • yes
Add to the existing community
community_name
string
Community set name
core_tree
dictionary
Multicast Distribution Tree type
ingress_replication
boolean
    Choices:
  • no
  • yes
Ingress Replication core segment
ingress_replication_default
boolean
    Choices:
  • no
  • yes
Ingress Replication Default MDT core
ingress_replication_partitioned
boolean
    Choices:
  • no
  • yes
Ingress Replication Partitioned MDT core
mldp
boolean
    Choices:
  • no
  • yes
MLDP core segment
mldp_default
boolean
    Choices:
  • no
  • yes
MLDP Default MDT core
mldp_inband
boolean
    Choices:
  • no
  • yes
MLDP Inband core
mldp_partitioned_mp2mp
boolean
    Choices:
  • no
  • yes
MLDP Partitioned MP2MP MDT core
mldp_partitioned_p2mp
boolean
    Choices:
  • no
  • yes
MLDP Partitioned P2MP MDT core
p2mp_te
boolean
    Choices:
  • no
  • yes
P2MP TE core segment
p2mp_te_default
boolean
    Choices:
  • no
  • yes
P2MP TE Default MDT core
p2mp_te_partitioned
boolean
    Choices:
  • no
  • yes
P2MP TE Partitioned MDT core
pim_default
boolean
    Choices:
  • no
  • yes
PIM Default MDT core
sr_p2mp
boolean
    Choices:
  • no
  • yes
Segment-Routing P2MP core
dampening
dictionary
BGP route flap dampening parameters
halflife
integer
Dampening penalty half-life, <1-45> Half-life time for penalty, default 15
max_suppress
integer
Maximum dampening penalty, <1-255> Maximum dampening penalty time, default 60
reuse
integer
Penalty before reusing suppressed route, <1-20000> Dampening reuse threshold, default 750
suppress
integer
Dampening penalty to start suppressing a route, <1-20000> Suppress penalty threshold, default 2000
downstream_core_tree
dictionary
BGP I-PMSI/S-PMSI core tree type
ingress_replication
boolean
    Choices:
  • no
  • yes
Ingress Replication core segment
mldp
boolean
    Choices:
  • no
  • yes
MLDP core segment
p2mp_te
boolean
    Choices:
  • no
  • yes
P2MP TE core segment
sr_p2mp
boolean
    Choices:
  • no
  • yes
Segment-Routing P2MP core
eigrp_metric
dictionary
EIGRP metric attribute
bandwidth
integer
<0-4294967295> Bandwidth in Kbits per second
delay
integer
<0-4294967295> Delay metric in 10 microsecond units
effective_bandwith
integer
<0-255> Effective bandwidth metric (Loading) where 255 is 100% loaded
max_transmission
integer
<0-65535> Maximum Transmission Unit metric of the path
reliability
integer
<0-255> Reliability metric where 255 is 100% reliable
fallback_vrf_lookup
boolean
    Choices:
  • no
  • yes
fallback vrf look-up
flow_tag
integer
flow tag value for PBR BGP flow-tag, <1-63> 6 bit decimal number starting from 1
forward_class
integer
Forward class (default value 0), <1-7> 3 bit decimal number starting from 1
ip_precedence
integer
IP Precedence to classify packets, <1-7> 3 bit decimal number starting from 1
isis_metric
integer
IS-IS metric attribute, <0-16777215> 24 bit decimal number
label
integer
Set BGP label value, <0-1048575> 20 bit decimal number
label_index
integer
Set Segment Routing label-index value, <0-1048575> 20 bit decimal number
label_mode
dictionary
Set BGP label-mode value
per_ce
boolean
    Choices:
  • no
  • yes
Set the label mode to per-ce
per_prefix
boolean
    Choices:
  • no
  • yes
Set the label mode to per-prefix
per_vrf
boolean
    Choices:
  • no
  • yes
Set the label mode to per-vrf
large_community
string
BGP large community attribute
level
dictionary
Where to import route
level_1
boolean
    Choices:
  • no
  • yes
IS-IS level-1 routes
level_1_2
boolean
    Choices:
  • no
  • yes
IS-IS level-1 and level-2 routes
level_2
boolean
    Choices:
  • no
  • yes
IS-IS level-2 routes
load_balance
boolean
    Choices:
  • no
  • yes
Load-balance for ECMP ecmp-consistent
local_preference
list / elements=dictionary
List of local preference configurations
decrement
boolean
    Choices:
  • no
  • yes
- Decrement the attribute by specified value
increment
boolean
    Choices:
  • no
  • yes
+ Increment the attribute with specified value
metric_number
integer / required
<0-4294967295> 32-bit decimal number
multiply
boolean
    Choices:
  • no
  • yes
* multiply the attribute by specified value
lsm_root
string
Label Switched Multicast Root address
metric_type
dictionary
Type of metric for destination routing protocol
external
boolean
    Choices:
  • no
  • yes
ISIS external metric-type
internal
boolean
    Choices:
  • no
  • yes
ISIS internal metric-type
rib_metric_as_external
boolean
    Choices:
  • no
  • yes
Use RIB metric and set ISIS external metric-type
rib_metric_as_internal
boolean
    Choices:
  • no
  • yes
Use RIB metric and set ISIS internal metric-type
type_1
boolean
    Choices:
  • no
  • yes
OSPF type-1 route
type_2
boolean
    Choices:
  • no
  • yes
OSPF type-2 route
mpls
string
MPLS traffic-eng attributeset name-string
next_hop
dictionary
Next hop address specified in this route
address
string
next hop address
origin
dictionary
BGP origin code
egp
boolean
    Choices:
  • no
  • yes
ISIS external metric-type
igp
boolean
    Choices:
  • no
  • yes
ISIS internal metric-type
rincomplete
boolean
    Choices:
  • no
  • yes
Use RIB metric and set ISIS external metric-type
ospf_metric
integer
OSPF metric attribute
path_color
boolean
    Choices:
  • no
  • yes
BGP Path Color for RIB (path-color external-reach)
path_selection
dictionary
BGP path selection
all
boolean
    Choices:
  • no
  • yes
BGP all advertise
backup
dictionary
BGP backup
advertise
boolean
    Choices:
  • no
  • yes
Advertise the path
backup_decimal
integer
<1>, decimal number 1
install
boolean
    Choices:
  • no
  • yes
Install the path
best_path
boolean
    Choices:
  • no
  • yes
BGP best path
group_best
boolean
    Choices:
  • no
  • yes
BGP group-best advertise
multiplath
boolean
    Choices:
  • no
  • yes
BGP multipath advertise
qos_group
integer
QoS Group to classify packets
rib_metric
integer
RIB metric for table-policy
rip_metric
integer
RIP metric attribute
rip_tag
integer
RIP Route tag attribute
rt_set
integer
Limit on routes with paths with an RT-set
s_pmsi
boolean
    Choices:
  • no
  • yes
S-PMSI Advertisement type (star-g)
spf_priority
dictionary
OSPF SPF priority
critical
boolean
    Choices:
  • no
  • yes
Critical priority
high
boolean
    Choices:
  • no
  • yes
High priority
medium
boolean
    Choices:
  • no
  • yes
Medium priority
static_p2mp_te
string
Static P2MP-TE tunnel
tag
integer
Route tag attribute
traffic_index
dictionary
Traffic-index for BGP policy accounting
ignore
boolean
    Choices:
  • no
  • yes
Remove any traffic-index setting
index_number
integer
6 bit decimal number starting from 1 <1-63>
upstream_core_tree
dictionary
BGP Leaf AD core tree type
ingress_replication
boolean
    Choices:
  • no
  • yes
Ingress Replication core segment
mldp
boolean
    Choices:
  • no
  • yes
MLDP core segment
p2mp_te
boolean
    Choices:
  • no
  • yes
P2MP TE core segment
sr_p2mp
boolean
    Choices:
  • no
  • yes
Segment-Routing P2MP core
vpn_distinguisher
integer
BGP VPN distinguisher (VD) attribute
weight
integer
Weight attribute for route selection
suppress_route
boolean
    Choices:
  • no
  • yes
Suppress specific routes when aggregating
unsuppress_route
boolean
    Choices:
  • no
  • yes
Unsuppress specific aggregated routes
elseif_section
list / elements=dictionary
A list of elif configurations that would follow along with the top level if
add
dictionary
Add offset to the existing value
eigrp_metric
dictionary
EIGRP metric attribute
bandwidth
integer
<0-4294967295> Bandwidth in Kbits per second
delay
integer
<0-4294967295> Delay metric in 10 microsecond units
effective_bandwith
integer
<0-255> Effective bandwidth metric (Loading) where 255 is 100% loaded
max_transmission
integer
<0-65535> Maximum Transmission Unit metric of the path
reliability
integer
<0-255> Reliability metric where 255 is 100% reliable
rip_metric
integer
<0-16> RIP metric attribute
apply
list / elements=dictionary
Apply a route policy
route_policy
string
Apply a specific route policy
route_policy_input
string
ipv4/ ipv6 / name-string
condition
string
the condition string, eg - aigp-metric eq 23 and as-path in tmp1 and community is-empty and community matches-any test1 (don't add then at end)
drop
boolean
    Choices:
  • no
  • yes
Reject this route with no further processing
pass
boolean
    Choices:
  • no
  • yes
Pass this route for further processing
prepend
dictionary
Prepend to BGP AS-path
as_path
integer
<1-4294967295> 32-bit decimal number/ 16-bit decimal number as-path
most_recent
boolean
    Choices:
  • no
  • yes
Most recent Autonomous System Number
number_of_times
integer
number of times to prepend
own_as
boolean
    Choices:
  • no
  • yes
Local Autonomous System Number
remove
dictionary
Remove all private-as entries
entire_aspath
boolean
    Choices:
  • no
  • yes
Remove private-AS from entire aspath
set
boolean
    Choices:
  • no
  • yes
Remove all private-as entries (remove as-path private-as)
set
dictionary
Set a route attribute
administrative_distance
integer
Administrative Distance of the prefix, <1-255> 8 bit decimal numbe
aigp_metric
dictionary
AIGP metric attribute
decrement
boolean
    Choices:
  • no
  • yes
- Decrement the attribute by specified value
icrement
boolean
    Choices:
  • no
  • yes
+ Increment the attribute with specified value
igp_cost
boolean
    Choices:
  • no
  • yes
Internal routing protocol cost
metric_number
integer
<0-4294967295> 32-bit decimal number
attribute_set
string
TE attribute-set name <0-4294967295> 32-bit decimal number
c_multicast_routing
dictionary
Multicast Customer routing type
bgp
boolean
    Choices:
  • no
  • yes
BGP customer-multicast routing
pim
boolean
    Choices:
  • no
  • yes
PIM customer-multicast routing
community
dictionary
BGP community attribute
additive
boolean
    Choices:
  • no
  • yes
Add to the existing community
community_name
string
Community set name
core_tree
dictionary
Multicast Distribution Tree type
ingress_replication
boolean
    Choices:
  • no
  • yes
Ingress Replication core segment
ingress_replication_default
boolean
    Choices:
  • no
  • yes
Ingress Replication Default MDT core
ingress_replication_partitioned
boolean
    Choices:
  • no
  • yes
Ingress Replication Partitioned MDT core
mldp
boolean
    Choices:
  • no
  • yes
MLDP core segment
mldp_default
boolean
    Choices:
  • no
  • yes
MLDP Default MDT core
mldp_inband
boolean
    Choices:
  • no
  • yes
MLDP Inband core
mldp_partitioned_mp2mp
boolean
    Choices:
  • no
  • yes
MLDP Partitioned MP2MP MDT core
mldp_partitioned_p2mp
boolean
    Choices:
  • no
  • yes
MLDP Partitioned P2MP MDT core
p2mp_te
boolean
    Choices:
  • no
  • yes
P2MP TE core segment
p2mp_te_default
boolean
    Choices:
  • no
  • yes
P2MP TE Default MDT core
p2mp_te_partitioned
boolean
    Choices:
  • no
  • yes
P2MP TE Partitioned MDT core
pim_default
boolean
    Choices:
  • no
  • yes
PIM Default MDT core
sr_p2mp
boolean
    Choices:
  • no
  • yes
Segment-Routing P2MP core
dampening
dictionary
BGP route flap dampening parameters
halflife
integer
Dampening penalty half-life, <1-45> Half-life time for penalty, default 15
max_suppress
integer
Maximum dampening penalty, <1-255> Maximum dampening penalty time, default 60
reuse
integer
Penalty before reusing suppressed route, <1-20000> Dampening reuse threshold, default 750
suppress
integer
Dampening penalty to start suppressing a route, <1-20000> Suppress penalty threshold, default 2000
downstream_core_tree
dictionary
BGP I-PMSI/S-PMSI core tree type
ingress_replication
boolean
    Choices:
  • no
  • yes
Ingress Replication core segment
mldp
boolean
    Choices:
  • no
  • yes
MLDP core segment
p2mp_te
boolean
    Choices:
  • no
  • yes
P2MP TE core segment
sr_p2mp
boolean
    Choices:
  • no
  • yes
Segment-Routing P2MP core
eigrp_metric
dictionary
EIGRP metric attribute
bandwidth
integer
<0-4294967295> Bandwidth in Kbits per second
delay
integer
<0-4294967295> Delay metric in 10 microsecond units
effective_bandwith
integer
<0-255> Effective bandwidth metric (Loading) where 255 is 100% loaded
max_transmission
integer
<0-65535> Maximum Transmission Unit metric of the path
reliability
integer
<0-255> Reliability metric where 255 is 100% reliable
fallback_vrf_lookup
boolean
    Choices:
  • no
  • yes
fallback vrf look-up
flow_tag
integer
flow tag value for PBR BGP flow-tag, <1-63> 6 bit decimal number starting from 1
forward_class
integer
Forward class (default value 0), <1-7> 3 bit decimal number starting from 1
ip_precedence
integer
IP Precedence to classify packets, <1-7> 3 bit decimal number starting from 1
isis_metric
integer
IS-IS metric attribute, <0-16777215> 24 bit decimal number
label
integer
Set BGP label value, <0-1048575> 20 bit decimal number
label_index
integer
Set Segment Routing label-index value, <0-1048575> 20 bit decimal number
label_mode
dictionary
Set BGP label-mode value
per_ce
boolean
    Choices:
  • no
  • yes
Set the label mode to per-ce
per_prefix
boolean
    Choices:
  • no
  • yes
Set the label mode to per-prefix
per_vrf
boolean
    Choices:
  • no
  • yes
Set the label mode to per-vrf
large_community
string
BGP large community attribute
level
dictionary
Where to import route
level_1
boolean
    Choices:
  • no
  • yes
IS-IS level-1 routes
level_1_2
boolean
    Choices:
  • no
  • yes
IS-IS level-1 and level-2 routes
level_2
boolean
    Choices:
  • no
  • yes
IS-IS level-2 routes
load_balance
boolean
    Choices:
  • no
  • yes
Load-balance for ECMP ecmp-consistent
local_preference
list / elements=dictionary
List of local preference configurations
decrement
boolean
    Choices:
  • no
  • yes
- Decrement the attribute by specified value
increment
boolean
    Choices:
  • no
  • yes
+ Increment the attribute with specified value
metric_number
integer / required
<0-4294967295> 32-bit decimal number
multiply
boolean
    Choices:
  • no
  • yes
* multiply the attribute by specified value
lsm_root
string
Label Switched Multicast Root address
metric_type
dictionary
Type of metric for destination routing protocol
external
boolean
    Choices:
  • no
  • yes
ISIS external metric-type
internal
boolean
    Choices:
  • no
  • yes
ISIS internal metric-type
rib_metric_as_external
boolean
    Choices:
  • no
  • yes
Use RIB metric and set ISIS external metric-type
rib_metric_as_internal
boolean
    Choices:
  • no
  • yes
Use RIB metric and set ISIS internal metric-type
type_1
boolean
    Choices:
  • no
  • yes
OSPF type-1 route
type_2
boolean
    Choices:
  • no
  • yes
OSPF type-2 route
mpls
string
MPLS traffic-eng attributeset name-string
next_hop
dictionary
Next hop address specified in this route
address
string
next hop address
origin
dictionary
BGP origin code
egp
boolean
    Choices:
  • no
  • yes
ISIS external metric-type
igp
boolean
    Choices:
  • no
  • yes
ISIS internal metric-type
rincomplete
boolean
    Choices:
  • no
  • yes
Use RIB metric and set ISIS external metric-type
ospf_metric
integer
OSPF metric attribute
path_color
boolean
    Choices:
  • no
  • yes
BGP Path Color for RIB (path-color external-reach)
path_selection
dictionary
BGP path selection
all
boolean
    Choices:
  • no
  • yes
BGP all advertise
backup
dictionary
BGP backup
advertise
boolean
    Choices:
  • no
  • yes
Advertise the path
backup_decimal
integer
<1>, decimal number 1
install
boolean
    Choices:
  • no
  • yes
Install the path
best_path
boolean
    Choices:
  • no
  • yes
BGP best path
group_best
boolean
    Choices:
  • no
  • yes
BGP group-best advertise
multiplath
boolean
    Choices:
  • no
  • yes
BGP multipath advertise
qos_group
integer
QoS Group to classify packets
rib_metric
integer
RIB metric for table-policy
rip_metric
integer
RIP metric attribute
rip_tag
integer
RIP Route tag attribute
rt_set
integer
Limit on routes with paths with an RT-set
s_pmsi
boolean
    Choices:
  • no
  • yes
S-PMSI Advertisement type (star-g)
spf_priority
dictionary
OSPF SPF priority
critical
boolean
    Choices:
  • no
  • yes
Critical priority
high
boolean
    Choices:
  • no
  • yes
High priority
medium
boolean
    Choices:
  • no
  • yes
Medium priority
static_p2mp_te
string
Static P2MP-TE tunnel
tag
integer
Route tag attribute
traffic_index
dictionary
Traffic-index for BGP policy accounting
ignore
boolean
    Choices:
  • no
  • yes
Remove any traffic-index setting
index_number
integer
6 bit decimal number starting from 1 <1-63>
upstream_core_tree
dictionary
BGP Leaf AD core tree type
ingress_replication
boolean
    Choices:
  • no
  • yes
Ingress Replication core segment
mldp
boolean
    Choices:
  • no
  • yes
MLDP core segment
p2mp_te
boolean
    Choices:
  • no
  • yes
P2MP TE core segment
sr_p2mp
boolean
    Choices:
  • no
  • yes
Segment-Routing P2MP core
vpn_distinguisher
integer
BGP VPN distinguisher (VD) attribute
weight
integer
Weight attribute for route selection
suppress_route
boolean
    Choices:
  • no
  • yes
Suppress specific routes when aggregating
unsuppress_route
boolean
    Choices:
  • no
  • yes
Unsuppress specific aggregated routes
global
dictionary
A dictionary of configurations for route policy without any conditions
add
dictionary
Add offset to the existing value
eigrp_metric
dictionary
EIGRP metric attribute
bandwidth
integer
<0-4294967295> Bandwidth in Kbits per second
delay
integer
<0-4294967295> Delay metric in 10 microsecond units
effective_bandwith
integer
<0-255> Effective bandwidth metric (Loading) where 255 is 100% loaded
max_transmission
integer
<0-65535> Maximum Transmission Unit metric of the path
reliability
integer
<0-255> Reliability metric where 255 is 100% reliable
rip_metric
integer
<0-16> RIP metric attribute
apply
list / elements=dictionary
Apply a route policy
route_policy
string
Apply a specific route policy
route_policy_input
string
ipv4/ ipv6 / name-string
drop
boolean
    Choices:
  • no
  • yes
Reject this route with no further processing
pass
boolean
    Choices:
  • no
  • yes
Pass this route for further processing
prepend
dictionary
Prepend to BGP AS-path
as_path
integer
<1-4294967295> 32-bit decimal number/ 16-bit decimal number as-path
most_recent
boolean
    Choices:
  • no
  • yes
Most recent Autonomous System Number
number_of_times
integer
number of times to prepend
own_as
boolean
    Choices:
  • no
  • yes
Local Autonomous System Number
remove
dictionary
Remove all private-as entries
entire_aspath
boolean
    Choices:
  • no
  • yes
Remove private-AS from entire aspath
set
boolean
    Choices:
  • no
  • yes
Remove all private-as entries (remove as-path private-as)
set
dictionary
Set a route attribute
administrative_distance
integer
Administrative Distance of the prefix, <1-255> 8 bit decimal numbe
aigp_metric
dictionary
AIGP metric attribute
decrement
boolean
    Choices:
  • no
  • yes
- Decrement the attribute by specified value
icrement
boolean
    Choices:
  • no
  • yes
+ Increment the attribute with specified value
igp_cost
boolean
    Choices:
  • no
  • yes
Internal routing protocol cost
metric_number
integer
<0-4294967295> 32-bit decimal number
attribute_set
string
TE attribute-set name <0-4294967295> 32-bit decimal number
c_multicast_routing
dictionary
Multicast Customer routing type
bgp
boolean
    Choices:
  • no
  • yes
BGP customer-multicast routing
pim
boolean
    Choices:
  • no
  • yes
PIM customer-multicast routing
community
dictionary
BGP community attribute
additive
boolean
    Choices:
  • no
  • yes
Add to the existing community
community_name
string
Community set name
core_tree
dictionary
Multicast Distribution Tree type
ingress_replication
boolean
    Choices:
  • no
  • yes
Ingress Replication core segment
ingress_replication_default
boolean
    Choices:
  • no
  • yes
Ingress Replication Default MDT core
ingress_replication_partitioned
boolean
    Choices:
  • no
  • yes
Ingress Replication Partitioned MDT core
mldp
boolean
    Choices:
  • no
  • yes
MLDP core segment
mldp_default
boolean
    Choices:
  • no
  • yes
MLDP Default MDT core
mldp_inband
boolean
    Choices:
  • no
  • yes
MLDP Inband core
mldp_partitioned_mp2mp
boolean
    Choices:
  • no
  • yes
MLDP Partitioned MP2MP MDT core
mldp_partitioned_p2mp
boolean
    Choices:
  • no
  • yes
MLDP Partitioned P2MP MDT core
p2mp_te
boolean
    Choices:
  • no
  • yes
P2MP TE core segment
p2mp_te_default
boolean
    Choices:
  • no
  • yes
P2MP TE Default MDT core
p2mp_te_partitioned
boolean
    Choices:
  • no
  • yes
P2MP TE Partitioned MDT core
pim_default
boolean
    Choices:
  • no
  • yes
PIM Default MDT core
sr_p2mp
boolean
    Choices:
  • no
  • yes
Segment-Routing P2MP core
dampening
dictionary
BGP route flap dampening parameters
halflife
integer
Dampening penalty half-life, <1-45> Half-life time for penalty, default 15
max_suppress
integer
Maximum dampening penalty, <1-255> Maximum dampening penalty time, default 60
reuse
integer
Penalty before reusing suppressed route, <1-20000> Dampening reuse threshold, default 750
suppress
integer
Dampening penalty to start suppressing a route, <1-20000> Suppress penalty threshold, default 2000
downstream_core_tree
dictionary
BGP I-PMSI/S-PMSI core tree type
ingress_replication
boolean
    Choices:
  • no
  • yes
Ingress Replication core segment
mldp
boolean
    Choices:
  • no
  • yes
MLDP core segment
p2mp_te
boolean
    Choices:
  • no
  • yes
P2MP TE core segment
sr_p2mp
boolean
    Choices:
  • no
  • yes
Segment-Routing P2MP core
eigrp_metric
dictionary
EIGRP metric attribute
bandwidth
integer
<0-4294967295> Bandwidth in Kbits per second
delay
integer
<0-4294967295> Delay metric in 10 microsecond units
effective_bandwith
integer
<0-255> Effective bandwidth metric (Loading) where 255 is 100% loaded
max_transmission
integer
<0-65535> Maximum Transmission Unit metric of the path
reliability
integer
<0-255> Reliability metric where 255 is 100% reliable
fallback_vrf_lookup
boolean
    Choices:
  • no
  • yes
fallback vrf look-up
flow_tag
integer
flow tag value for PBR BGP flow-tag, <1-63> 6 bit decimal number starting from 1
forward_class
integer
Forward class (default value 0), <1-7> 3 bit decimal number starting from 1
ip_precedence
integer
IP Precedence to classify packets, <1-7> 3 bit decimal number starting from 1
isis_metric
integer
IS-IS metric attribute, <0-16777215> 24 bit decimal number
label
integer
Set BGP label value, <0-1048575> 20 bit decimal number
label_index
integer
Set Segment Routing label-index value, <0-1048575> 20 bit decimal number
label_mode
dictionary
Set BGP label-mode value
per_ce
boolean
    Choices:
  • no
  • yes
Set the label mode to per-ce
per_prefix
boolean
    Choices:
  • no
  • yes
Set the label mode to per-prefix
per_vrf
boolean
    Choices:
  • no
  • yes
Set the label mode to per-vrf
large_community
string
BGP large community attribute
level
dictionary
Where to import route
level_1
boolean
    Choices:
  • no
  • yes
IS-IS level-1 routes
level_1_2
boolean
    Choices:
  • no
  • yes
IS-IS level-1 and level-2 routes
level_2
boolean
    Choices:
  • no
  • yes
IS-IS level-2 routes
load_balance
boolean
    Choices:
  • no
  • yes
Load-balance for ECMP ecmp-consistent
local_preference
list / elements=dictionary
List of local preference configurations
decrement
boolean
    Choices:
  • no
  • yes
- Decrement the attribute by specified value
increment
boolean
    Choices:
  • no
  • yes
+ Increment the attribute with specified value
metric_number
integer / required
<0-4294967295> 32-bit decimal number
multiply
boolean
    Choices:
  • no
  • yes
* multiply the attribute by specified value
lsm_root
string
Label Switched Multicast Root address
metric_type
dictionary
Type of metric for destination routing protocol
external
boolean
    Choices:
  • no
  • yes
ISIS external metric-type
internal
boolean
    Choices:
  • no
  • yes
ISIS internal metric-type
rib_metric_as_external
boolean
    Choices:
  • no
  • yes
Use RIB metric and set ISIS external metric-type
rib_metric_as_internal
boolean
    Choices:
  • no
  • yes
Use RIB metric and set ISIS internal metric-type
type_1
boolean
    Choices:
  • no
  • yes
OSPF type-1 route
type_2
boolean
    Choices:
  • no
  • yes
OSPF type-2 route
mpls
string
MPLS traffic-eng attributeset name-string
next_hop
dictionary
Next hop address specified in this route
address
string
next hop address
origin
dictionary
BGP origin code
egp
boolean
    Choices:
  • no
  • yes
ISIS external metric-type
igp
boolean
    Choices:
  • no
  • yes
ISIS internal metric-type
rincomplete
boolean
    Choices:
  • no
  • yes
Use RIB metric and set ISIS external metric-type
ospf_metric
integer
OSPF metric attribute
path_color
boolean
    Choices:
  • no
  • yes
BGP Path Color for RIB (path-color external-reach)
path_selection
dictionary
BGP path selection
all
boolean
    Choices:
  • no
  • yes
BGP all advertise
backup
dictionary
BGP backup
advertise
boolean
    Choices:
  • no
  • yes
Advertise the path
backup_decimal
integer
<1>, decimal number 1
install
boolean
    Choices:
  • no
  • yes
Install the path
best_path
boolean
    Choices:
  • no
  • yes
BGP best path
group_best
boolean
    Choices:
  • no
  • yes
BGP group-best advertise
multiplath
boolean
    Choices:
  • no
  • yes
BGP multipath advertise
qos_group
integer
QoS Group to classify packets
rib_metric
integer
RIB metric for table-policy
rip_metric
integer
RIP metric attribute
rip_tag
integer
RIP Route tag attribute
rt_set
integer
Limit on routes with paths with an RT-set
s_pmsi
boolean
    Choices:
  • no
  • yes
S-PMSI Advertisement type (star-g)
spf_priority
dictionary
OSPF SPF priority
critical
boolean
    Choices:
  • no
  • yes
Critical priority
high
boolean
    Choices:
  • no
  • yes
High priority
medium
boolean
    Choices:
  • no
  • yes
Medium priority
static_p2mp_te
string
Static P2MP-TE tunnel
tag
integer
Route tag attribute
traffic_index
dictionary
Traffic-index for BGP policy accounting
ignore
boolean
    Choices:
  • no
  • yes
Remove any traffic-index setting
index_number
integer
6 bit decimal number starting from 1 <1-63>
upstream_core_tree
dictionary
BGP Leaf AD core tree type
ingress_replication
boolean
    Choices:
  • no
  • yes
Ingress Replication core segment
mldp
boolean
    Choices:
  • no
  • yes
MLDP core segment
p2mp_te
boolean
    Choices:
  • no
  • yes
P2MP TE core segment
sr_p2mp
boolean
    Choices:
  • no
  • yes
Segment-Routing P2MP core
vpn_distinguisher
integer
BGP VPN distinguisher (VD) attribute
weight
integer
Weight attribute for route selection
suppress_route
boolean
    Choices:
  • no
  • yes
Suppress specific routes when aggregating
unsuppress_route
boolean
    Choices:
  • no
  • yes
Unsuppress specific aggregated routes
if_section
dictionary
A dictionary of configurations for route policy for the top level if condition for the policy
add
dictionary
Add offset to the existing value
eigrp_metric
dictionary
EIGRP metric attribute
bandwidth
integer
<0-4294967295> Bandwidth in Kbits per second
delay
integer
<0-4294967295> Delay metric in 10 microsecond units
effective_bandwith
integer
<0-255> Effective bandwidth metric (Loading) where 255 is 100% loaded
max_transmission
integer
<0-65535> Maximum Transmission Unit metric of the path
reliability
integer
<0-255> Reliability metric where 255 is 100% reliable
rip_metric
integer
<0-16> RIP metric attribute
apply
list / elements=dictionary
Apply a route policy
route_policy
string
Apply a specific route policy
route_policy_input
string
ipv4/ ipv6 / name-string
condition
string
the condition string, eg - aigp-metric eq 23 and as-path in tmp1 and community is-empty and community matches-any test1 (don't add then at end)
drop
boolean
    Choices:
  • no
  • yes
Reject this route with no further processing
pass
boolean
    Choices:
  • no
  • yes
Pass this route for further processing
prepend
dictionary
Prepend to BGP AS-path
as_path
integer
<1-4294967295> 32-bit decimal number/ 16-bit decimal number as-path
most_recent
boolean
    Choices:
  • no
  • yes
Most recent Autonomous System Number
number_of_times
integer
number of times to prepend
own_as
boolean
    Choices:
  • no
  • yes
Local Autonomous System Number
remove
dictionary
Remove all private-as entries
entire_aspath
boolean
    Choices:
  • no
  • yes
Remove private-AS from entire aspath
set
boolean
    Choices:
  • no
  • yes
Remove all private-as entries (remove as-path private-as)
set
dictionary
Set a route attribute
administrative_distance
integer
Administrative Distance of the prefix, <1-255> 8 bit decimal numbe
aigp_metric
dictionary
AIGP metric attribute
decrement
boolean
    Choices:
  • no
  • yes
- Decrement the attribute by specified value
icrement
boolean
    Choices:
  • no
  • yes
+ Increment the attribute with specified value
igp_cost
boolean
    Choices:
  • no
  • yes
Internal routing protocol cost
metric_number
integer
<0-4294967295> 32-bit decimal number
attribute_set
string
TE attribute-set name <0-4294967295> 32-bit decimal number
c_multicast_routing
dictionary
Multicast Customer routing type
bgp
boolean
    Choices:
  • no
  • yes
BGP customer-multicast routing
pim
boolean
    Choices:
  • no
  • yes
PIM customer-multicast routing
community
dictionary
BGP community attribute
additive
boolean
    Choices:
  • no
  • yes
Add to the existing community
community_name
string
Community set name
core_tree
dictionary
Multicast Distribution Tree type
ingress_replication
boolean
    Choices:
  • no
  • yes
Ingress Replication core segment
ingress_replication_default
boolean
    Choices:
  • no
  • yes
Ingress Replication Default MDT core
ingress_replication_partitioned
boolean
    Choices:
  • no
  • yes
Ingress Replication Partitioned MDT core
mldp
boolean
    Choices:
  • no
  • yes
MLDP core segment
mldp_default
boolean
    Choices:
  • no
  • yes
MLDP Default MDT core
mldp_inband
boolean
    Choices:
  • no
  • yes
MLDP Inband core
mldp_partitioned_mp2mp
boolean
    Choices:
  • no
  • yes
MLDP Partitioned MP2MP MDT core
mldp_partitioned_p2mp
boolean
    Choices:
  • no
  • yes
MLDP Partitioned P2MP MDT core
p2mp_te
boolean
    Choices:
  • no
  • yes
P2MP TE core segment
p2mp_te_default
boolean
    Choices:
  • no
  • yes
P2MP TE Default MDT core
p2mp_te_partitioned
boolean
    Choices:
  • no
  • yes
P2MP TE Partitioned MDT core
pim_default
boolean
    Choices:
  • no
  • yes
PIM Default MDT core
sr_p2mp
boolean
    Choices:
  • no
  • yes
Segment-Routing P2MP core
dampening
dictionary
BGP route flap dampening parameters
halflife
integer
Dampening penalty half-life, <1-45> Half-life time for penalty, default 15
max_suppress
integer
Maximum dampening penalty, <1-255> Maximum dampening penalty time, default 60
reuse
integer
Penalty before reusing suppressed route, <1-20000> Dampening reuse threshold, default 750
suppress
integer
Dampening penalty to start suppressing a route, <1-20000> Suppress penalty threshold, default 2000
downstream_core_tree
dictionary
BGP I-PMSI/S-PMSI core tree type
ingress_replication
boolean
    Choices:
  • no
  • yes
Ingress Replication core segment
mldp
boolean
    Choices:
  • no
  • yes
MLDP core segment
p2mp_te
boolean
    Choices:
  • no
  • yes
P2MP TE core segment
sr_p2mp
boolean
    Choices:
  • no
  • yes
Segment-Routing P2MP core
eigrp_metric
dictionary
EIGRP metric attribute
bandwidth
integer
<0-4294967295> Bandwidth in Kbits per second
delay
integer
<0-4294967295> Delay metric in 10 microsecond units
effective_bandwith
integer
<0-255> Effective bandwidth metric (Loading) where 255 is 100% loaded
max_transmission
integer
<0-65535> Maximum Transmission Unit metric of the path
reliability
integer
<0-255> Reliability metric where 255 is 100% reliable
fallback_vrf_lookup
boolean
    Choices:
  • no
  • yes
fallback vrf look-up
flow_tag
integer
flow tag value for PBR BGP flow-tag, <1-63> 6 bit decimal number starting from 1
forward_class
integer
Forward class (default value 0), <1-7> 3 bit decimal number starting from 1
ip_precedence
integer
IP Precedence to classify packets, <1-7> 3 bit decimal number starting from 1
isis_metric
integer
IS-IS metric attribute, <0-16777215> 24 bit decimal number
label
integer
Set BGP label value, <0-1048575> 20 bit decimal number
label_index
integer
Set Segment Routing label-index value, <0-1048575> 20 bit decimal number
label_mode
dictionary
Set BGP label-mode value
per_ce
boolean
    Choices:
  • no
  • yes
Set the label mode to per-ce
per_prefix
boolean
    Choices:
  • no
  • yes
Set the label mode to per-prefix
per_vrf
boolean
    Choices:
  • no
  • yes
Set the label mode to per-vrf
large_community
string
BGP large community attribute
level
dictionary
Where to import route
level_1
boolean
    Choices:
  • no
  • yes
IS-IS level-1 routes
level_1_2
boolean
    Choices:
  • no
  • yes
IS-IS level-1 and level-2 routes
level_2
boolean
    Choices:
  • no
  • yes
IS-IS level-2 routes
load_balance
boolean
    Choices:
  • no
  • yes
Load-balance for ECMP ecmp-consistent
local_preference
list / elements=dictionary
List of local preference configurations
decrement
boolean
    Choices:
  • no
  • yes
- Decrement the attribute by specified value
increment
boolean
    Choices:
  • no
  • yes
+ Increment the attribute with specified value
metric_number
integer / required
<0-4294967295> 32-bit decimal number
multiply
boolean
    Choices:
  • no
  • yes
* multiply the attribute by specified value
lsm_root
string
Label Switched Multicast Root address
metric_type
dictionary
Type of metric for destination routing protocol
external
boolean
    Choices:
  • no
  • yes
ISIS external metric-type
internal
boolean
    Choices:
  • no
  • yes
ISIS internal metric-type
rib_metric_as_external
boolean
    Choices:
  • no
  • yes
Use RIB metric and set ISIS external metric-type
rib_metric_as_internal
boolean
    Choices:
  • no
  • yes
Use RIB metric and set ISIS internal metric-type
type_1
boolean
    Choices:
  • no
  • yes
OSPF type-1 route
type_2
boolean
    Choices:
  • no
  • yes
OSPF type-2 route
mpls
string
MPLS traffic-eng attributeset name-string
next_hop
dictionary
Next hop address specified in this route
address
string
next hop address
origin
dictionary
BGP origin code
egp
boolean
    Choices:
  • no
  • yes
ISIS external metric-type
igp
boolean
    Choices:
  • no
  • yes
ISIS internal metric-type
rincomplete
boolean
    Choices:
  • no
  • yes
Use RIB metric and set ISIS external metric-type
ospf_metric
integer
OSPF metric attribute
path_color
boolean
    Choices:
  • no
  • yes
BGP Path Color for RIB (path-color external-reach)
path_selection
dictionary
BGP path selection
all
boolean
    Choices:
  • no
  • yes
BGP all advertise
backup
dictionary
BGP backup
advertise
boolean
    Choices:
  • no
  • yes
Advertise the path
backup_decimal
integer
<1>, decimal number 1
install
boolean
    Choices:
  • no
  • yes
Install the path
best_path
boolean
    Choices:
  • no
  • yes
BGP best path
group_best
boolean
    Choices:
  • no
  • yes
BGP group-best advertise
multiplath
boolean
    Choices:
  • no
  • yes
BGP multipath advertise
qos_group
integer
QoS Group to classify packets
rib_metric
integer
RIB metric for table-policy
rip_metric
integer
RIP metric attribute
rip_tag
integer
RIP Route tag attribute
rt_set
integer
Limit on routes with paths with an RT-set
s_pmsi
boolean
    Choices:
  • no
  • yes
S-PMSI Advertisement type (star-g)
spf_priority
dictionary
OSPF SPF priority
critical
boolean
    Choices:
  • no
  • yes
Critical priority
high
boolean
    Choices:
  • no
  • yes
High priority
medium
boolean
    Choices:
  • no
  • yes
Medium priority
static_p2mp_te
string
Static P2MP-TE tunnel
tag
integer
Route tag attribute
traffic_index
dictionary
Traffic-index for BGP policy accounting
ignore
boolean
    Choices:
  • no
  • yes
Remove any traffic-index setting
index_number
integer
6 bit decimal number starting from 1 <1-63>
upstream_core_tree
dictionary
BGP Leaf AD core tree type
ingress_replication
boolean
    Choices:
  • no
  • yes
Ingress Replication core segment
mldp
boolean
    Choices:
  • no
  • yes
MLDP core segment
p2mp_te
boolean
    Choices:
  • no
  • yes
P2MP TE core segment
sr_p2mp
boolean
    Choices:
  • no
  • yes
Segment-Routing P2MP core
vpn_distinguisher
integer
BGP VPN distinguisher (VD) attribute
weight
integer
Weight attribute for route selection
suppress_route
boolean
    Choices:
  • no
  • yes
Suppress specific routes when aggregating
unsuppress_route
boolean
    Choices:
  • no
  • yes
Unsuppress specific aggregated routes
name
string
Name of the route policy.
running_config
string
This option is used only with state parsed.
The value of this option should be and aggregate of the output received from the IOS XR device by executing the command show running-config route-policy <policy_name> for per route-policy.
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
state
string
    Choices:
  • merged ←
  • replaced
  • overridden
  • purged
  • rendered
  • gathered
  • parsed
The state the configuration should be left in
The states rendered, gathered and parsed does not perform any change on the device.
The state rendered will transform the configuration in config option to platform specific CLI commands which will be returned in the rendered key within the result. For state rendered active connection to remote host is not required.
The state gathered will fetch the running configuration from device and transform it into structured data in the format as per the resource module argspec and the value is returned in the gathered key within the result.
The state parsed reads the configuration from running_config option and transforms it into JSON format as per the resource module parameters and the value is returned in the parsed key within the result. The value of running_config option should be the aggregate of the output of command show running-config route-policy <policy_name> that gives individual route-policy details and executed on device. For state parsed active connection to remote host is not required.

Notes

Note

  • Tested against Cisco IOS-XR 7.2.2.
  • This module works with connection network_cli.

Examples

# Using merged

# Before state:
# -------------
#
# viosxr#show running-config | include route-policy
#

- name: Merge route-policy configuration
  cisco.iosxr.iosxr_route_maps:
    state: merged
    config:
      - global:
          apply:
            - route_policy: A_NEW_ROUTE_POLICY
          set:
            community:
              additive: true
              community_name: (11011:1001)
            weight: 20000
        name: SIMPLE_GLOBAL_ROUTE_POLICY
      - else_section:
          global:
            drop: true
        if_section:
          condition: destination in SIMPLE_CONDITION_ROUTE_POLICY
          pass: true
        name: SIMPLE_CONDITION_ROUTE_POLICY
      - else_section:
          else_section:
            drop: true
          if_section:
            condition: destination in A_RANDOM_POLICY
            pass: true
            set:
              community:
                additive: true
                community_name: (101010:1)
        if_section:
          condition: as-path in (ios-regex '_3117_', ios-regex '_600_')
          drop: true
        name: COMPLEX_ROUTE_POLICY
      - else_section:
          global:
            pass: true
        if_section:
          condition: community matches-any (9119:1001) or community matches-any (11100:1001)
          drop: true
        name: COMPLEX_CONDITION_ROUTE_POLICY

# Task Output
# -----------
#
# before:
# - {}
# commands:
# - route-policy SIMPLE_GLOBAL_ROUTE_POLICY
# - apply A_NEW_ROUTE_POLICY
# - set community (11011:1001) additive
# - set weight 20000
# - end-policy
# - route-policy SIMPLE_CONDITION_ROUTE_POLICY
# - if destination in SIMPLE_CONDITION_ROUTE_POLICY then
# - pass
# - else
# - drop
# - endif
# - end-policy
# - route-policy COMPLEX_ROUTE_POLICY
# - if as-path in (ios-regex '_3117_', ios-regex '_600_') then
# - drop
# - else
# - if destination in A_RANDOM_POLICY then
# - pass
# - set community (101010:1) additive
# - else
# - drop
# - endif
# - endif
# - end-policy
# - route-policy COMPLEX_CONDITION_ROUTE_POLICY
# - if community matches-any (9119:1001) or community matches-any (11100:1001) then
# - drop
# - else
# - pass
# - endif
# - end-policy
# after:
# - global:
#     apply:
#       - route_policy: A_NEW_ROUTE_POLICY
#     set:
#       community:
#         additive: true
#         community_name: (11011:1001)
#       weight: 20000
#   name: SIMPLE_GLOBAL_ROUTE_POLICY
# - else_section:
#     global:
#       drop: true
#   if_section:
#     condition: destination in SIMPLE_CONDITION_ROUTE_POLICY
#     pass: true
#   name: SIMPLE_CONDITION_ROUTE_POLICY
# - else_section:
#     else_section:
#       drop: true
#     if_section:
#       condition: destination in A_RANDOM_POLICY
#       pass: true
#       set:
#         community:
#           additive: true
#           community_name: (101010:1)
#   if_section:
#     condition: as-path in (ios-regex '_3117_', ios-regex '_600_')
#     drop: true
#   name: COMPLEX_ROUTE_POLICY
# - else_section:
#     global:
#       pass: true
#   if_section:
#     condition: community matches-any (9119:1001) or community matches-any (11100:1001)
#     drop: true
#   name: COMPLEX_CONDITION_ROUTE_POLICY

# After state:
# -------------
#
# viosxr#show running-config | include route-policy
# route-policy SIMPLE_GLOBAL_ROUTE_POLICY
# route-policy SIMPLE_CONDITION_ROUTE_POLICY
# route-policy COMPLEX_ROUTE_POLICY
# route-policy COMPLEX_CONDITION_ROUTE_POLICY
#
# viosxr#show running-config route-policy SIMPLE_GLOBAL_ROUTE_POLICY
# route-policy SIMPLE_GLOBAL_ROUTE_POLICY
#   set weight 20000
#   set local-preference 200
#   set community (11011:1001) additive
#   apply A_NEW_ROUTE_POLICY
# end-policy
# viosxr#show running-config route-policy SIMPLE_CONDITION_ROUTE_POLICY
# route-policy SIMPLE_CONDITION_ROUTE_POLICY
#   if destination in SIMPLE_CONDITION_ROUTE_POLICY then
#     pass
#   else
#     drop
#   endif
# end-policy
# viosxr#show running-config route-policy COMPLEX_ROUTE_POLICY
# route-policy COMPLEX_ROUTE_POLICY
#   if as-path in (ios-regex '_3117_', ios-regex '_600_') then
#     drop
#   else
#     if destination in A_RANDOM_POLICY then
#       pass
#       set community (101010:1) additive
#       set local-preference 200
#     else
#       drop
#     endif
#   endif
# end-policy
# viosxr#show running-config route-policy COMPLEX_CONDITION_ROUTE_POLICY
# route-policy COMPLEX_CONDITION_ROUTE_POLICY
#   if community matches-any (9119:1001) or community matches-any (11100:1001) then
#     drop
#   else
#     pass
#   endif
# end-policy

# Using replaced

# Before state:
# -------------
#
# viosxr#show running-config | include route-policy
# route-policy SIMPLE_GLOBAL_ROUTE_POLICY
# route-policy SIMPLE_CONDITION_ROUTE_POLICY
# route-policy COMPLEX_ROUTE_POLICY
# route-policy COMPLEX_CONDITION_ROUTE_POLICY
#
# viosxr#show running-config route-policy SIMPLE_GLOBAL_ROUTE_POLICY
# route-policy SIMPLE_GLOBAL_ROUTE_POLICY
#   set weight 20000
#   set local-preference 200
#   set community (11011:1001) additive
#   apply A_NEW_ROUTE_POLICY
# end-policy
# viosxr#show running-config route-policy SIMPLE_CONDITION_ROUTE_POLICY
# route-policy SIMPLE_CONDITION_ROUTE_POLICY
#   if destination in SIMPLE_CONDITION_ROUTE_POLICY then
#     pass
#   else
#     drop
#   endif
# end-policy
# viosxr#show running-config route-policy COMPLEX_ROUTE_POLICY
# route-policy COMPLEX_ROUTE_POLICY
#   if as-path in (ios-regex '_3117_', ios-regex '_600_') then
#     drop
#   else
#     if destination in A_RANDOM_POLICY then
#       pass
#       set community (101010:1) additive
#       set local-preference 200
#     else
#       drop
#     endif
#   endif
# end-policy
# viosxr#show running-config route-policy COMPLEX_CONDITION_ROUTE_POLICY
# route-policy COMPLEX_CONDITION_ROUTE_POLICY
#   if community matches-any (9119:1001) or community matches-any (11100:1001) then
#     drop
#   else
#     pass
#   endif
# end-policy

- name: Replace the route-policy configuration
  cisco.iosxr.iosxr_route_maps:
    state: replaced
    config:
      - global:
          apply:
            - route_policy: A_NEW_ROUTE_POLICY
          set:
            community:
              additive: true
              community_name: (11011:1001)
            weight: 20000
        name: SIMPLE_GLOBAL_ROUTE_POLICY
      - else_section:
          global:
            drop: true
        if_section:
          condition: destination in SIMPLE_CONDITION_ROUTE_POLICY
          pass: true
        name: VERY_SIMPLE_CONDITION_ROUTE_POLICY

# Task Output
# -----------
#
# before:
# - global:
#     apply:
#       - route_policy: A_NEW_ROUTE_POLICY
#     set:
#       community:
#         additive: true
#         community_name: (11011:1001)
#       weight: 20000
#   name: SIMPLE_GLOBAL_ROUTE_POLICY
# - else_section:
#     global:
#       drop: true
#   if_section:
#     condition: destination in SIMPLE_CONDITION_ROUTE_POLICY
#     pass: true
#   name: SIMPLE_CONDITION_ROUTE_POLICY
# - else_section:
#     else_section:
#       drop: true
#     if_section:
#       condition: destination in A_RANDOM_POLICY
#       pass: true
#       set:
#         community:
#           additive: true
#           community_name: (101010:1)
#   if_section:
#     condition: as-path in (ios-regex '_3117_', ios-regex '_600_')
#     drop: true
#   name: COMPLEX_ROUTE_POLICY
# - else_section:
#     global:
#       pass: true
#   if_section:
#     condition: community matches-any (9119:1001) or community matches-any (11100:1001)
#     drop: true
#   name: COMPLEX_CONDITION_ROUTE_POLICY
# commands:
# - route-policy VERY_SIMPLE_CONDITION_ROUTE_POLICY
# - if destination in SIMPLE_CONDITION_ROUTE_POLICY then
# - pass
# - else
# - drop
# - endif
# - end-policy
# after:
# - global:
#     apply:
#       - route_policy: A_NEW_ROUTE_POLICY
#     set:
#       community:
#         additive: true
#         community_name: (11011:1001)
#       weight: 20000
#   name: SIMPLE_GLOBAL_ROUTE_POLICY
# - else_section:
#     global:
#       drop: true
#   if_section:
#     condition: destination in SIMPLE_CONDITION_ROUTE_POLICY
#     pass: true
#   name: SIMPLE_CONDITION_ROUTE_POLICY
# - else_section:
#     else_section:
#       drop: true
#     if_section:
#       condition: destination in A_RANDOM_POLICY
#       pass: true
#       set:
#         community:
#           additive: true
#           community_name: (101010:1)
#   if_section:
#     condition: as-path in (ios-regex '_3117_', ios-regex '_600_')
#     drop: true
#   name: COMPLEX_ROUTE_POLICY
# - else_section:
#     global:
#       pass: true
#   if_section:
#     condition: community matches-any (9119:1001) or community matches-any (11100:1001)
#     drop: true
#   name: COMPLEX_CONDITION_ROUTE_POLICY
# - else_section:
#     global:
#       drop: true
#   if_section:
#     condition: destination in SIMPLE_CONDITION_ROUTE_POLICY
#     pass: true
#   name: VERY_SIMPLE_CONDITION_ROUTE_POLICY

# After state:
# -------------
#
# viosxr#show running-config | include route-policy
# route-policy SIMPLE_GLOBAL_ROUTE_POLICY
# route-policy SIMPLE_CONDITION_ROUTE_POLICY
# route-policy COMPLEX_ROUTE_POLICY
# route-policy COMPLEX_CONDITION_ROUTE_POLICY
# route-policy VERY_SIMPLE_CONDITION_ROUTE_POLICY
#
# viosxr#show running-config route-policy SIMPLE_GLOBAL_ROUTE_POLICY
# route-policy SIMPLE_GLOBAL_ROUTE_POLICY
#   set weight 20000
#   set local-preference 200
#   set community (11011:1001) additive
#   apply A_NEW_ROUTE_POLICY
# end-policy
# viosxr#show running-config route-policy SIMPLE_CONDITION_ROUTE_POLICY
# route-policy SIMPLE_CONDITION_ROUTE_POLICY
#   if destination in SIMPLE_CONDITION_ROUTE_POLICY then
#     pass
#   else
#     drop
#   endif
# end-policy
# viosxr#show running-config route-policy COMPLEX_ROUTE_POLICY
# route-policy COMPLEX_ROUTE_POLICY
#   if as-path in (ios-regex '_3117_', ios-regex '_600_') then
#     drop
#   else
#     if destination in A_RANDOM_POLICY then
#       pass
#       set community (101010:1) additive
#       set local-preference 200
#     else
#       drop
#     endif
#   endif
# end-policy
# viosxr#show running-config route-policy COMPLEX_CONDITION_ROUTE_POLICY
# route-policy COMPLEX_CONDITION_ROUTE_POLICY
#   if community matches-any (9119:1001) or community matches-any (11100:1001) then
#     drop
#   else
#     pass
#   endif
# end-policy
# viosxr#show running-config route-policy SIMPLE_CONDITION_ROUTE_POLICY
# route-policy SIMPLE_CONDITION_ROUTE_POLICY
#   if destination in SIMPLE_CONDITION_ROUTE_POLICY then
#     pass
#   else
#     drop
#   endif
# end-policy
# viosxr#show running-config route-policy VERY_SIMPLE_CONDITION_ROUTE_POLICY
# route-policy SIMPLE_CONDITION_ROUTE_POLICY
#   if destination in SIMPLE_CONDITION_ROUTE_POLICY then
#     pass
#   else
#     drop
#   endif
# end-policy

# Using overridden

# Before state:
# -------------
#
# viosxr#show running-config | include route-policy
# route-policy SIMPLE_GLOBAL_ROUTE_POLICY
# route-policy SIMPLE_CONDITION_ROUTE_POLICY
# route-policy COMPLEX_ROUTE_POLICY
# route-policy COMPLEX_CONDITION_ROUTE_POLICY
#
# viosxr#show running-config route-policy SIMPLE_GLOBAL_ROUTE_POLICY
# route-policy SIMPLE_GLOBAL_ROUTE_POLICY
#   set weight 20000
#   set local-preference 200
#   set community (11011:1001) additive
#   apply A_NEW_ROUTE_POLICY
# end-policy
# viosxr#show running-config route-policy SIMPLE_CONDITION_ROUTE_POLICY
# route-policy SIMPLE_CONDITION_ROUTE_POLICY
#   if destination in SIMPLE_CONDITION_ROUTE_POLICY then
#     pass
#   else
#     drop
#   endif
# end-policy
# viosxr#show running-config route-policy COMPLEX_ROUTE_POLICY
# route-policy COMPLEX_ROUTE_POLICY
#   if as-path in (ios-regex '_3117_', ios-regex '_600_') then
#     drop
#   else
#     if destination in A_RANDOM_POLICY then
#       pass
#       set community (101010:1) additive
#       set local-preference 200
#     else
#       drop
#     endif
#   endif
# end-policy
# viosxr#show running-config route-policy COMPLEX_CONDITION_ROUTE_POLICY
# route-policy COMPLEX_CONDITION_ROUTE_POLICY
#   if community matches-any (9119:1001) or community matches-any (11100:1001) then
#     drop
#   else
#     pass
#   endif
# end-policy

- name: Override the route-policy configuration
  cisco.iosxr.iosxr_route_maps:
    state: overridden
    config:
      - global:
          apply:
            - route_policy: A_NEW_ROUTE_POLICY
          set:
            community:
              additive: true
              community_name: (11011:1001)
            weight: 20000
        name: SIMPLE_GLOBAL_ROUTE_POLICY
      - else_section:
          global:
            drop: true
        if_section:
          condition: destination in SIMPLE_CONDITION_ROUTE_POLICY
          pass: true
        name: VERY_SIMPLE_CONDITION_ROUTE_POLICY

# Task Output
# -----------
#
# before:
# - global:
#     apply:
#       - route_policy: A_NEW_ROUTE_POLICY
#     set:
#       community:
#         additive: true
#         community_name: (11011:1001)
#       weight: 20000
#   name: SIMPLE_GLOBAL_ROUTE_POLICY
# - else_section:
#     global:
#       drop: true
#   if_section:
#     condition: destination in SIMPLE_CONDITION_ROUTE_POLICY
#     pass: true
#   name: SIMPLE_CONDITION_ROUTE_POLICY
# - else_section:
#     else_section:
#       drop: true
#     if_section:
#       condition: destination in A_RANDOM_POLICY
#       pass: true
#       set:
#         community:
#           additive: true
#           community_name: (101010:1)
#   if_section:
#     condition: as-path in (ios-regex '_3117_', ios-regex '_600_')
#     drop: true
#   name: COMPLEX_ROUTE_POLICY
# - else_section:
#     global:
#       pass: true
#   if_section:
#     condition: community matches-any (9119:1001) or community matches-any (11100:1001)
#     drop: true
#   name: COMPLEX_CONDITION_ROUTE_POLICY
# commands:
# - route-policy VERY_SIMPLE_CONDITION_ROUTE_POLICY
# - if destination in SIMPLE_CONDITION_ROUTE_POLICY then
# - pass
# - else
# - drop
# - endif
# - end-policy
# - no route-policy SIMPLE_CONDITION_ROUTE_POLICY
# - no route-policy COMPLEX_ROUTE_POLICY
# - no route-policy COMPLEX_CONDITION_ROUTE_POLICY
# after:
# - global:
#     apply:
#       - route_policy: A_NEW_ROUTE_POLICY
#     set:
#       community:
#         additive: true
#         community_name: (11011:1001)
#       weight: 20000
#   name: SIMPLE_GLOBAL_ROUTE_POLICY
# - else_section:
#     global:
#       drop: true
#   if_section:
#     condition: destination in SIMPLE_CONDITION_ROUTE_POLICY
#     pass: true
#   name: VERY_SIMPLE_CONDITION_ROUTE_POLICY

# After state:
# -------------
#
# viosxr#show running-config | include route-policy
# route-policy SIMPLE_GLOBAL_ROUTE_POLICY
# route-policy VERY_SIMPLE_CONDITION_ROUTE_POLICY
#
# viosxr#show running-config route-policy SIMPLE_GLOBAL_ROUTE_POLICY
# route-policy SIMPLE_GLOBAL_ROUTE_POLICY
#   set weight 20000
#   set local-preference 200
#   set community (11011:1001) additive
#   apply A_NEW_ROUTE_POLICY
# end-policy
# viosxr#show running-config route-policy VERY_SIMPLE_CONDITION_ROUTE_POLICY
# route-policy SIMPLE_CONDITION_ROUTE_POLICY
#   if destination in SIMPLE_CONDITION_ROUTE_POLICY then
#     pass
#   else
#     drop
#   endif
# end-policy

# Using purged

# Before state:
# -------------
#
# viosxr#show running-config | include route-policy
# route-policy SIMPLE_GLOBAL_ROUTE_POLICY
# route-policy SIMPLE_CONDITION_ROUTE_POLICY
# route-policy COMPLEX_ROUTE_POLICY
#
# viosxr#show running-config route-policy SIMPLE_GLOBAL_ROUTE_POLICY
# route-policy SIMPLE_GLOBAL_ROUTE_POLICY
#   set weight 20000
#   set local-preference 200
#   set community (11011:1001) additive
#   apply A_NEW_ROUTE_POLICY
# end-policy
# viosxr#show running-config route-policy SIMPLE_CONDITION_ROUTE_POLICY
# route-policy SIMPLE_CONDITION_ROUTE_POLICY
#   if destination in SIMPLE_CONDITION_ROUTE_POLICY then
#     pass
#   else
#     drop
#   endif
# end-policy
# viosxr#show running-config route-policy COMPLEX_ROUTE_POLICY
# route-policy COMPLEX_ROUTE_POLICY
#   if as-path in (ios-regex '_3117_', ios-regex '_600_') then
#     drop
#   else
#     if destination in A_RANDOM_POLICY then
#       pass
#       set community (101010:1) additive
#       set local-preference 200
#     else
#       drop
#     endif
#   endif
# end-policy

- name: Purge or remove route-policy configuration
  cisco.iosxr.iosxr_route_maps:
    state: purged
    config:
      - name: COMPLEX_ROUTE_POLICY_NO_EXIST
      - name: COMPLEX_ROUTE_POLICY

# Task Output
# -----------
#
# before:
# - global:
#     apply:
#       - route_policy: A_NEW_ROUTE_POLICY
#     set:
#       community:
#         additive: true
#         community_name: (11011:1001)
#       weight: 20000
#   name: SIMPLE_GLOBAL_ROUTE_POLICY
# - else_section:
#     global:
#       drop: true
#   if_section:
#     condition: destination in SIMPLE_CONDITION_ROUTE_POLICY
#     pass: true
#   name: SIMPLE_CONDITION_ROUTE_POLICY
# - else_section:
#     else_section:
#       drop: true
#     if_section:
#       condition: destination in A_RANDOM_POLICY
#       pass: true
#       set:
#         community:
#           additive: true
#           community_name: (101010:1)
#   if_section:
#     condition: as-path in (ios-regex '_3117_', ios-regex '_600_')
#     drop: true
#   name: COMPLEX_ROUTE_POLICY
# commands:
# - no route-policy COMPLEX_CONDITION_ROUTE_POLICY
# after:
# - global:
#     apply:
#       - route_policy: A_NEW_ROUTE_POLICY
#     set:
#       community:
#         additive: true
#         community_name: (11011:1001)
#       weight: 20000
#   name: SIMPLE_GLOBAL_ROUTE_POLICY
# - else_section:
#     global:
#       drop: true
#   if_section:
#     condition: destination in SIMPLE_CONDITION_ROUTE_POLICY
#     pass: true
#   name: SIMPLE_CONDITION_ROUTE_POLICY

# After state:
# -------------
#
# viosxr#show running-config | include route-policy
# route-policy SIMPLE_GLOBAL_ROUTE_POLICY
# route-policy SIMPLE_CONDITION_ROUTE_POLICY
#
# viosxr#show running-config route-policy SIMPLE_GLOBAL_ROUTE_POLICY
# route-policy SIMPLE_GLOBAL_ROUTE_POLICY
#   set weight 20000
#   set local-preference 200
#   set community (11011:1001) additive
#   apply A_NEW_ROUTE_POLICY
# end-policy
# viosxr#show running-config route-policy SIMPLE_CONDITION_ROUTE_POLICY
# route-policy SIMPLE_CONDITION_ROUTE_POLICY
#   if destination in SIMPLE_CONDITION_ROUTE_POLICY then
#     pass
#   else
#     drop
#   endif
# end-policy

# Using rendered

- name: Render route-policy configuration
  cisco.iosxr.iosxr_route_maps:
    state: rendered
    config:
      - global:
          apply:
            - route_policy: A_NEW_ROUTE_POLICY
          set:
            community:
              additive: true
              community_name: (11011:1001)
            weight: 20000
        name: SIMPLE_GLOBAL_ROUTE_POLICY
      - else_section:
          global:
            drop: true
        if_section:
          condition: destination in SIMPLE_CONDITION_ROUTE_POLICY
          pass: true
        name: SIMPLE_CONDITION_ROUTE_POLICY
      - else_section:
          else_section:
            drop: true
          if_section:
            condition: destination in A_RANDOM_POLICY
            pass: true
            set:
              community:
                additive: true
                community_name: (101010:1)
        if_section:
          condition: as-path in (ios-regex '_3117_', ios-regex '_600_')
          drop: true
        name: COMPLEX_ROUTE_POLICY
      - else_section:
          global:
            pass: true
        if_section:
          condition: community matches-any (9119:1001) or community matches-any (11100:1001)
          drop: true
        name: COMPLEX_CONDITION_ROUTE_POLICY

# Task Output
# -----------
#
# rendered:
# - route-policy SIMPLE_GLOBAL_ROUTE_POLICY
# - apply A_NEW_ROUTE_POLICY
# - set community (11011:1001) additive
# - set weight 20000
# - end-policy
# - route-policy SIMPLE_CONDITION_ROUTE_POLICY
# - if destination in SIMPLE_CONDITION_ROUTE_POLICY then
# - pass
# - else
# - drop
# - endif
# - end-policy
# - route-policy COMPLEX_ROUTE_POLICY
# - if as-path in (ios-regex '_3117_', ios-regex '_600_') then
# - drop
# - else
# - if destination in A_RANDOM_POLICY then
# - pass
# - set community (101010:1) additive
# - else
# - drop
# - endif
# - endif
# - end-policy
# - route-policy COMPLEX_CONDITION_ROUTE_POLICY
# - if community matches-any (9119:1001) or community matches-any (11100:1001) then
# - drop
# - else
# - pass
# - endif
# - end-policy

# Using parsed

# File: parsed.cfg
# ----------------
#
# route-policy SIMPLE_GLOBAL_ROUTE_POLICY
#   set weight 20000
#   set local-preference 200
#   set community (11011:1001) additive
#   apply A_NEW_ROUTE_POLICY
# end-policy
# !
# route-policy SIMPLE_CONDITION_ROUTE_POLICY
#   if destination in SIMPLE_CONDITION_ROUTE_POLICY then
#     pass
#   else
#     drop
#   endif
# end-policy
# !
# route-policy COMPLEX_ROUTE_POLICY
#   if as-path in (ios-regex '_3117_', ios-regex '_600_') then
#     drop
#   else
#     if destination in A_RANDOM_POLICY then
#       pass
#       set community (101010:1) additive
#       set local-preference 200
#     else
#       drop
#     endif
#   endif
# end-policy
# !
# route-policy COMPLEX_CONDITION_ROUTE_POLICY
#   if community matches-any (9119:1001) or community matches-any (11100:1001) then
#     drop
#   else
#     pass
#   endif
# end-policy

- name: Parse the provided configuration
  cisco.iosxr.iosxr_route_maps:
    running_config: "{{ lookup('file', 'iosxr_route_maps_conf.cfg') }}"
    state: parsed

# Task Output
# -----------
#
# parsed:
# - global:
#     apply:
#     - route_policy: A_NEW_ROUTE_POLICY
#     set:
#       community:
#         additive: true
#         community_name: (11011:1001)
#       weight: 20000
#   name: SIMPLE_GLOBAL_ROUTE_POLICY
# - else_section:
#     global:
#       drop: true
#   if_section:
#     condition: destination in SIMPLE_CONDITION_ROUTE_POLICY
#     pass: true
#   name: SIMPLE_CONDITION_ROUTE_POLICY
# - else_section:
#     else_section:
#       drop: true
#     if_section:
#       condition: destination in A_RANDOM_POLICY
#       pass: true
#       set:
#         community:
#           additive: true
#           community_name: (101010:1)
#   if_section:
#     condition: as-path in (ios-regex '_3117_', ios-regex '_600_')
#     drop: true
#   name: COMPLEX_ROUTE_POLICY
# - else_section:
#     global:
#       pass: true
#   if_section:
#     condition: community matches-any (9119:1001) or community matches-any (11100:1001)
#     drop: true
#   name: COMPLEX_CONDITION_ROUTE_POLICY

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
after
dictionary
when changed
The resulting configuration after module execution.

Sample:
This output will always be in the same format as the module argspec.
before
dictionary
when state is merged, replaced, overridden, purged or purged
The configuration prior to the module execution.

Sample:
This output will always be in the same format as the module argspec.
commands
list
when state is merged, replaced, overridden, purged or purged
The set of commands pushed to the remote device.

Sample:
['route-policy APPLY_TEST_ROUTE_POLICY_COMPLEX', 'if destination in DEFAULT then', 'pass']
gathered
list
when state is gathered
Facts about the network resource gathered from the remote device as structured data.

Sample:
This output will always be in the same format as the module argspec.
parsed
list
when state is parsed
The device native config provided in running_config option parsed into structured data as per module argspec.

Sample:
This output will always be in the same format as the module argspec.
rendered
list
when state is rendered
The provided configuration in the task rendered in device-native format (offline).

Sample:
['route-policy APPLY_TEST_ROUTE_POLICY_COMPLEX', 'if destination in DEFAULT then', 'pass']


Status

Authors

  • Sagar Paul (@KB-perByte)