summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorQuentin Young <qlyoung@cumulusnetworks.com>2018-06-12 22:08:12 +0200
committerQuentin Young <qlyoung@cumulusnetworks.com>2018-06-12 22:27:38 +0200
commit2e7c93acec903af4af775ef6e95c5a09cafe31ac (patch)
tree982679a1bda968481d5dc2ecb173b5abdbff36a9 /doc
parentpbrd: remove json options (diff)
downloadfrr-2e7c93acec903af4af775ef6e95c5a09cafe31ac.tar.xz
frr-2e7c93acec903af4af775ef6e95c5a09cafe31ac.zip
doc: document `pbr table range` & a couple others
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
Diffstat (limited to 'doc')
-rw-r--r--doc/user/pbr.rst27
1 files changed, 20 insertions, 7 deletions
diff --git a/doc/user/pbr.rst b/doc/user/pbr.rst
index aa48a3cd4..638767c55 100644
--- a/doc/user/pbr.rst
+++ b/doc/user/pbr.rst
@@ -33,7 +33,6 @@ Nexthop Groups
Nexthop groups are a way to encapsulate ECMP information together. It's a
listing of ECMP nexthops used to forward packets for when a pbr-map is matched.
-.. index:: nexthop-group
.. clicmd:: nexthop-group NAME
Create a nexthop-group with an associated NAME. This will put you into a
@@ -46,24 +45,38 @@ listing of ECMP nexthops used to forward packets for when a pbr-map is matched.
are used to are allowed here. The syntax was intentionally kept the same as
creating nexthops as you would for static routes.
+.. clicmd:: [no] pbr table range (10000-4294966272) (10000-4294966272)
+
+ Set or unset the range used to assign numeric table ID's to new
+ nexthop-group tables. Existing tables will not be modified to fit in this
+ range, so it is recommended to configure this before adding nexthop groups.
+
+ .. seealso:: :ref:`pbr-details`
+
+Showing Nexthop Group Information
+---------------------------------
+
+.. clicmd:: show pbr nexthop-groups [NAME]
+
+ Display information on a PBR nexthop-group. If ``NAME`` is omitted, all
+ nexthop groups are shown.
+
.. _pbr-maps:
PBR Maps
========
-PBR maps are a way to group policies that we would like to apply
-to individual interfaces. These policies when applied are matched
-against incoming packets. If matched the nexthop-group or nexthop
-is used to forward the packets to the end destination
+PBR maps are a way to group policies that we would like to apply to individual
+interfaces. These policies when applied are matched against incoming packets.
+If matched the nexthop-group or nexthop is used to forward the packets to the
+end destination.
-.. index:: pbr-map
.. clicmd:: pbr-map NAME seq (1-700)
Create a pbr-map with NAME and sequence number specified. This command puts
you into a new submode for pbr-map specification. To exit this mode type
exit or end as per normal conventions for leaving a sub-mode.
-.. index:: match
.. clicmd:: match src-ip PREFIX
When a incoming packet matches the source prefix specified, take the packet