summaryrefslogtreecommitdiff
path: root/docs/configuration/policy/route-map.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/configuration/policy/route-map.rst')
-rw-r--r--docs/configuration/policy/route-map.rst144
1 files changed, 113 insertions, 31 deletions
diff --git a/docs/configuration/policy/route-map.rst b/docs/configuration/policy/route-map.rst
index 792014bc..cc65d50c 100644
--- a/docs/configuration/policy/route-map.rst
+++ b/docs/configuration/policy/route-map.rst
@@ -69,16 +69,39 @@ Route Map
IP address of route to match, based on prefix-list.
+.. cfgcmd:: set policy route-map <text> rule <1-65535> match ip address
+ prefix-len <0-32>
+
+ IP address of route to match, based on specified prefix-length.
+ Note that this can be used for kernel routes only.
+ Do not apply to the routes of dynamic routing protocols (e.g. BGP,
+ RIP, OSFP), as this can lead to unexpected results..
+
.. cfgcmd:: set policy route-map <text> rule <1-65535> match ip nexthop
access-list <1-2699>
IP next-hop of route to match, based on access-list.
.. cfgcmd:: set policy route-map <text> rule <1-65535> match ip nexthop
+ address <x.x.x.x>
+
+ IP next-hop of route to match, based on ip address.
+
+.. cfgcmd:: set policy route-map <text> rule <1-65535> match ip nexthop
+ prefix-len <0-32>
+
+ IP next-hop of route to match, based on prefix length.
+
+.. cfgcmd:: set policy route-map <text> rule <1-65535> match ip nexthop
prefix-list <text>
IP next-hop of route to match, based on prefix-list.
+.. cfgcmd:: set policy route-map <text> rule <1-65535> match ip nexthop
+ type <blackhole>
+
+ IP next-hop of route to match, based on type.
+
.. cfgcmd:: set policy route-map <text> rule <1-65535> match ip route-source
access-list <1-2699>
@@ -99,6 +122,14 @@ Route Map
IPv6 address of route to match, based on IPv6 prefix-list.
+.. cfgcmd:: set policy route-map <text> rule <1-65535> match ipv6 address
+ prefix-len <0-128>
+
+ IPv6 address of route to match, based on specified prefix-length.
+ Note that this can be used for kernel routes only.
+ Do not apply to the routes of dynamic routing protocols (e.g. BGP,
+ RIP, OSFP), as this can lead to unexpected results..
+
.. cfgcmd:: set policy route-map <text> rule <1-65535> match ipv6 nexthop
<h:h:h:h:h:h:h:h>
@@ -149,52 +180,82 @@ Route Map
BGP aggregator attribute: AS number or IP address of an aggregation.
-.. cfgcmd:: set policy route-map <text> rule <1-65535> set as-path-exclude
+.. cfgcmd:: set policy route-map <text> rule <1-65535> set as-path exclude
<text>
- Remove ASN(s) from a BGP AS-path attribute. For example "456 64500 45001".
+ Drop AS-NUMBER from the BGP AS path.
-.. cfgcmd:: set policy route-map <text> rule <1-65535> set as-path-prepend
+.. cfgcmd:: set policy route-map <text> rule <1-65535> set as-path prepend
<text>
- Prepend string for a BGP AS-path attribute. For example "64501 64501".
+ Prepend the given string of AS numbers to the AS_PATH of the BGP path's NLRI.
+
+.. cfgcmd:: set policy route-map <text> rule <1-65535> set as-path
+ prepend-last-as <n>
+
+ Prepend the existing last AS number (the leftmost ASN) to the AS_PATH.
.. cfgcmd:: set policy route-map <text> rule <1-65535> set atomic-aggregate
BGP atomic aggregate attribute.
-.. cfgcmd:: set policy route-map <text> rule <1-65535> set bgp-extcommunity-rt
- <aa:nn>
+.. cfgcmd:: set policy route-map <text> rule <1-65535> set community
+ <add|replace> <community>
- Set route target value. ExtCommunity in format: asn:value.
+ Add or replace BGP community attribute in format ``<0-65535:0-65535>``
+ or from well-known community list
-.. cfgcmd:: set policy route-map <text> rule <1-65535> set comm-list comm-list
- <text>
+.. cfgcmd:: set policy route-map <text> rule <1-65535> set community none
- BGP communities with a community-list.
+ Delete all BGP communities
-.. cfgcmd:: set policy route-map <text> rule <1-65535> set comm-list delete
+.. cfgcmd:: set policy route-map <text> rule <1-65535> set community delete
+ <text>
Delete BGP communities matching the community-list.
-.. cfgcmd:: set policy route-map <text> rule <1-65535> set community
- <aa:bb|local-AS|no-advertise|no-export|internet|additive|none>
+.. cfgcmd:: set policy route-map <text> rule <1-65535> set large-community
+ <add|replace> <GA:LDP1:LDP2>
- Set BGP community attribute.
+ Add or replace BGP large-community attribute in format
+ ``<0-4294967295:0-4294967295:0-4294967295>``
-.. cfgcmd:: set policy route-map <text> rule <1-65535> set distance <0-255>
+.. cfgcmd:: set policy route-map <text> rule <1-65535> set large-community none
+
+ Delete all BGP large-communities
- Locally significant administrative distance.
+.. cfgcmd:: set policy route-map <text> rule <1-65535> set large-community delete
+ <text>
+
+ Delete BGP communities matching the large-community-list.
+
+.. cfgcmd:: set policy route-map <text> rule <1-65535> set extcommunity bandwidth
+ <1-25600|cumulative|num-multipaths>
-.. cfgcmd:: set policy route-map <text> rule <1-65535> set extcommunity-rt
+ Set extcommunity bandwidth
+
+.. cfgcmd:: set policy route-map <text> rule <1-65535> set extcommunity bandwidth-non-transitive
+
+ The link bandwidth extended community is encoded as non-transitive
+
+.. cfgcmd:: set policy route-map <text> rule <1-65535> set extcommunity rt
<text>
- Set route target value.
+ Set route target value in format ``<0-65535:0-4294967295>`` or ``<IP:0-65535>``.
-.. cfgcmd:: set policy route-map <text> rule <1-65535> set extcommunity-soo
+.. cfgcmd:: set policy route-map <text> rule <1-65535> set extcommunity soo
<text>
- Set site of origin value.
+ Set site of origin value in format ``<0-65535:0-4294967295>`` or ``<IP:0-65535>``.
+
+.. cfgcmd:: set policy route-map <text> rule <1-65535> set extcommunity none
+
+ Clear all BGP extcommunities.
+
+.. cfgcmd:: set policy route-map <text> rule <1-65535> set distance <0-255>
+
+ Locally significant administrative distance.
+
.. cfgcmd:: set policy route-map <text> rule <1-65535> set ip-next-hop
<x.x.x.x>
@@ -211,8 +272,8 @@ Route Map
peer-address
Set the BGP nexthop address to the address of the peer. For an incoming
- route-map this means the ip address of our peer is used. For an
- outgoing route-map this means the ip address of our self is used to
+ route-map this means the ip address of our peer is used. For an
+ outgoing route-map this means the ip address of our self is used to
establish the peering with our neighbor.
.. cfgcmd:: set policy route-map <text> rule <1-65535> set ipv6-next-hop
@@ -224,21 +285,16 @@ Route Map
peer-address
Set the BGP nexthop address to the address of the peer. For an incoming
- route-map this means the ip address of our peer is used. For an
- outgoing route-map this means the ip address of our self is used to
+ route-map this means the ip address of our peer is used. For an
+ outgoing route-map this means the ip address of our self is used to
establish the peering with our neighbor.
-
+
.. cfgcmd:: set policy route-map <text> rule <1-65535> set ipv6-next-hop
prefer-global
-
+
For Incoming and Import Route-maps if we receive a v6 global and v6 LL
address for the route, then prefer to use the global address as the
nexthop.
-
-.. cfgcmd:: set policy route-map <text> rule <1-65535> set large-community
- <text>
-
- Set BGP large community value.
.. cfgcmd:: set policy route-map <text> rule <1-65535> set local-preference
<0-4294967295>
@@ -283,3 +339,29 @@ Route Map
<0-4294967295>
Set BGP weight attribute
+
+List of well-known communities
+==============================
+ * ``local-as`` - Well-known communities value NO_EXPORT_SUBCONFED 0xFFFFFF03
+ * ``no-advertise`` - Well-known communities value NO_ADVERTISE 0xFFFFFF02
+ * ``no-export`` - Well-known communities value NO_EXPORT 0xFFFFFF01
+ * ``internet`` - Well-known communities value 0
+ * ``graceful-shutdown`` - Well-known communities value GRACEFUL_SHUTDOWN 0xFFFF0000
+ * ``accept-own`` - Well-known communities value ACCEPT_OWN 0xFFFF0001
+ * ``route-filter-translated-v4`` - Well-known communities value ROUTE_FILTER_TRANSLATED_v4 0xFFFF0002
+ * ``route-filter-v4`` - Well-known communities value ROUTE_FILTER_v4 0xFFFF0003
+ * ``route-filter-translated-v6`` - Well-known communities value ROUTE_FILTER_TRANSLATED_v6 0xFFFF0004
+ * ``route-filter-v6`` - Well-known communities value ROUTE_FILTER_v6 0xFFFF0005
+ * ``llgr-stale`` - Well-known communities value LLGR_STALE 0xFFFF0006
+ * ``no-llgr`` - Well-known communities value NO_LLGR 0xFFFF0007
+ * ``accept-own-nexthop`` - Well-known communities value accept-own-nexthop 0xFFFF0008
+ * ``blackhole`` - Well-known communities value BLACKHOLE 0xFFFF029A
+ * ``no-peer`` - Well-known communities value NOPEER 0xFFFFFF04
+
+
+
+
+
+
+
+