From 9667c597e919119d01a65160eac74f3b75725bef Mon Sep 17 00:00:00 2001 From: Wesley Coakley Date: Fri, 22 May 2020 09:07:00 -0400 Subject: [PATCH] doc: document `show pbr interface` directive Signed-off-by: Wesley Coakley --- doc/user/pbr.rst | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/doc/user/pbr.rst b/doc/user/pbr.rst index 2815b040f2..b07cc259d7 100644 --- a/doc/user/pbr.rst +++ b/doc/user/pbr.rst @@ -144,6 +144,24 @@ causes the policy to be installed into the kernel. even if one is on the master. Each must have the PBR map explicitly added to the interface. +.. clicmd:: show pbr interface [NAME] [json] + + Enumerates all interfaces which ``pbrd`` is keeping track of. Passing + ``json`` will return an array of interfaces; each returned interface will + adhere to the JSON schema below: + + +---------+----------------------------+---------+ + | Key | Description | Type | + +=========+============================+=========+ + | name | Interface name | String | + +---------+----------------------------+---------+ + | index | Device Index | Integer | + +---------+----------------------------+---------+ + | policy | PBR map for this interface | String | + +---------+----------------------------+---------+ + | isValid | Is the map well-formed? | Boolean | + +---------+----------------------------+---------+ + .. _pbr-details: PBR Details -- 2.39.5