proxmox-mirrors/mirror_frr
1
0
Fork 0
mirror of https://git.proxmox.com/git/mirror_frr synced 2025-08-16 10:38:05 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

doc: document json for remaining show pbr cmds

Browse Source 
Signed-off-by: Wesley Coakley <wcoakley@cumulusnetworks.com>
This commit is contained in:
Wesley Coakley 2020-05-22 11:36:52 -04:00
parent 9667c597e9
commit 144fd50f64
1 changed files with 84 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

88
doc/user/pbr.rst
View File

@ -59,8 +59,33 @@ Showing Nexthop Group Information
.. clicmd:: show pbr nexthop-groups [NAME] [json] .. clicmd:: show pbr nexthop-groups [NAME] [json]
Display information on a PBR nexthop-group. If ``NAME`` is omitted, all Display information on a PBR nexthop-group. If ``NAME`` is omitted, all
nexthop groups are shown. Setting ``json`` will provide the same information nexthop groups are shown. Setting ``json`` will provide the same
in a predictable and parsable format. information in an array of objects which obey the schema below:
+-------------+----------------------------+---------+
| Key | Description | Type |
+=============+============================+=========+
| id | Unique ID | Integer |
+-------------+----------------------------+---------+
| name | Name of this group | String |
+-------------+----------------------------+---------+
| isValud | Is this group well-formed? | Boolean |
+-------------+----------------------------+---------+
| isInstalled | ... and is it installed? | Boolean |
+-------------+----------------------------+---------+
| nexthops | Nexthops within this group | Array |
+-------------+----------------------------+---------+
Each element within ``nexthops`` describes a single target within this
group, and its structure is described by the JSON below:
+---------+------------------------------+---------+
| Key | Description | Type |
+=========+==============================+=========+
| target | Name of this nexthop | String |
+---------+------------------------------+---------+
| isValid | Is this nexthop well-formed? | Boolean |
+---------+------------------------------+---------+
.. _pbr-maps: .. _pbr-maps:
@ -121,8 +146,63 @@ end destination.
Display pbr maps either all or by ``NAME``. If ``detail`` is set, it will Display pbr maps either all or by ``NAME``. If ``detail`` is set, it will
give information about the rules unique ID used internally and some extra give information about the rules unique ID used internally and some extra
debugging information about install state for the nexthop/nexthop group. debugging information about install state for the nexthop/nexthop group.
Setting ``json`` will provide the same information in a predictable and Setting ``json`` will provide the same information in an array of objects
parsable format. which obey the schema below:
+--------------+--------------------------------+---------+
| Key | Description | Type |
+==============+================================+=========+
| name | Map name | String |
+--------------+--------------------------------+---------+
| isValid | Is the map well-formed? | Boolean |
+--------------+--------------------------------+---------+
| sequences | Rules to match packets against | Array |
+--------------+--------------------------------+---------+
Each element of the ``sequences`` array is composed of a handful of objects
representing the policies associated with this map. Each policy is
described as below (not all fields are required):
+-----------------+-------------------------------------------+---------+
| Key | Description | Type |
+=================+===========================================+=========+
| id | Unique ID | Integer |
+-----------------+-------------------------------------------+---------+
| sequenceNumber | Order of this policy within the map | Integer |
+-----------------+-------------------------------------------+---------+
| ruleNumber | Rule number to install into | Integer |
+-----------------+-------------------------------------------+---------+
| vrfUnchanged | Use interface's VRF | Boolean |
+-----------------+-------------------------------------------+---------+
| isInstalled | Is this policy installed? | Boolean |
+-----------------+-------------------------------------------+---------+
| installedReason | Why (or why not?) | String |
+-----------------+-------------------------------------------+---------+
| matchSrc | Match packets with this source address | String |
+-----------------+-------------------------------------------+---------+
| matchDst | ... or with this destination address | String |
+-----------------+-------------------------------------------+---------+
| matchMark | ... or with this marker | Integer |
+-----------------+-------------------------------------------+---------+
| vrfName | Associated VRF (if relevant) | String |
+-----------------+-------------------------------------------+---------+
| nexthopGroup | This policy's nexthop group (if relevant) | Object |
+-----------------+-------------------------------------------+---------+
Finally, the ``nexthopGroup`` object above cotains information we know
about the configured nexthop for this policy:
+-----------------------+--------------------------------------+---------+
| Key | Description | Type |
+=======================+======================================+=========+
| id | Nexthop table ID | Integer |
+-----------------------+--------------------------------------+---------+
| name | Name of the nexthop group | String |
+-----------------------+--------------------------------------+---------+
| isInstalled | Is this nexthop group installed? | Boolean |
+-----------------------+--------------------------------------+---------+
| isInstalledInternally | Do we think this group is installed? | Integer |
+-----------------------+--------------------------------------+---------+
.. _pbr-policy: .. _pbr-policy: