Skip to content

Commit 373055c

Browse files
committed
doc: add description command to static routes
Signed-off-by: drosarius <dustin.rosarius@gmail.com>
1 parent 58e6c5b commit 373055c

File tree

2 files changed

+12
-9
lines changed

2 files changed

+12
-9
lines changed

doc/user/pim.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -305,7 +305,7 @@ addresses but unicast addresses.
305305
This table is fully separate from the default unicast table. However,
306306
RPF lookup can include the unicast table.
307307

308-
.. clicmd:: ip mroute PREFIX NEXTHOP [DISTANCE]
308+
.. clicmd:: ip mroute PREFIX NEXTHOP [DISTANCE] [description DESCRIPTION]
309309

310310
Adds a static route entry to the Multicast RIB. This performs exactly as the
311311
``ip route`` command, except that it inserts the route in the Multicast RIB

doc/user/static.rst

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -27,21 +27,21 @@ Static Route Commands
2727
Static routing is a very fundamental feature of routing technology. It defines
2828
a static prefix and gateway, with several possible forms.
2929

30-
.. clicmd:: ip route NETWORK GATEWAY [DISTANCE] [table TABLENO] [nexthop-vrf VRFNAME] [vrf VRFNAME]
30+
.. clicmd:: ip route NETWORK GATEWAY [DISTANCE] [table TABLENO] [nexthop-vrf VRFNAME] [vrf VRFNAME] [description DESCRIPTION]
3131

32-
.. clicmd:: ip route NETWORK IFNAME [DISTANCE] [table TABLENO] [nexthop-vrf VRFNAME] [vrf VRFNAME]
32+
.. clicmd:: ip route NETWORK IFNAME [DISTANCE] [table TABLENO] [nexthop-vrf VRFNAME] [vrf VRFNAME] [description DESCRIPTION]
3333

34-
.. clicmd:: ip route NETWORK GATEWAY IFNAME [DISTANCE] [onlink] [table TABLENO] [nexthop-vrf VRFNAME] [vrf VRFNAME]
34+
.. clicmd:: ip route NETWORK GATEWAY IFNAME [DISTANCE] [onlink] [table TABLENO] [nexthop-vrf VRFNAME] [vrf VRFNAME] [description DESCRIPTION]
3535

36-
.. clicmd:: ip route NETWORK (Null0|blackhole|reject) [DISTANCE] [table TABLENO] [nexthop-vrf VRFNAME] [vrf VRFNAME]
36+
.. clicmd:: ip route NETWORK (Null0|blackhole|reject) [DISTANCE] [table TABLENO] [nexthop-vrf VRFNAME] [vrf VRFNAME] [description DESCRIPTION]
3737

38-
.. clicmd:: ipv6 route NETWORK [from SRCPREFIX] GATEWAY [DISTANCE] [table TABLENO] [nexthop-vrf VRFNAME] [vrf VRFNAME]
38+
.. clicmd:: ipv6 route NETWORK [from SRCPREFIX] GATEWAY [DISTANCE] [table TABLENO] [nexthop-vrf VRFNAME] [vrf VRFNAME] [description DESCRIPTION]
3939

40-
.. clicmd:: ipv6 route NETWORK [from SRCPREFIX] IFNAME [DISTANCE] [table TABLENO] [nexthop-vrf VRFNAME] [vrf VRFNAME]
40+
.. clicmd:: ipv6 route NETWORK [from SRCPREFIX] IFNAME [DISTANCE] [table TABLENO] [nexthop-vrf VRFNAME] [vrf VRFNAME] [description DESCRIPTION]
4141

42-
.. clicmd:: ipv6 route NETWORK [from SRCPREFIX] GATEWAY IFNAME [DISTANCE] [onlink] [table TABLENO] [nexthop-vrf VRFNAME] [vrf VRFNAME]
42+
.. clicmd:: ipv6 route NETWORK [from SRCPREFIX] GATEWAY IFNAME [DISTANCE] [onlink] [table TABLENO] [nexthop-vrf VRFNAME] [vrf VRFNAME] [description DESCRIPTION]
4343

44-
.. clicmd:: ipv6 route NETWORK [from SRCPREFIX] (Null0|blackhole|reject) [DISTANCE] [table TABLENO] [nexthop-vrf VRFNAME] [vrf VRFNAME]
44+
.. clicmd:: ipv6 route NETWORK [from SRCPREFIX] (Null0|blackhole|reject) [DISTANCE] [table TABLENO] [nexthop-vrf VRFNAME] [vrf VRFNAME] [description DESCRIPTION]
4545

4646
NETWORK is destination prefix with a valid v4 or v6 network based upon
4747
initial form of the command.
@@ -68,6 +68,9 @@ a static prefix and gateway, with several possible forms.
6868

6969
``nexthop-vrf`` VRFNAME allows you to create a leaked route with a nexthop in the
7070
specified VRFNAME. ``nexthop-vrf`` cannot be currently used with namespace based vrfs.
71+
72+
``description`` DESCRIPTION allows you to set a text description (up to 80 characters) for the
73+
route.
7174

7275
The IPv6 variant allows the installation of a static source-specific route
7376
with the SRCPREFIX sub command. These routes are currently supported

0 commit comments

Comments
 (0)