]> git.puffer.fish Git - mirror/frr.git/commitdiff
doc: Update documentation to new functionality 3562/head
authorDonald Sharp <sharpd@cumulusnetworks.com>
Thu, 3 Jan 2019 14:57:06 +0000 (09:57 -0500)
committerDonald Sharp <sharpd@cumulusnetworks.com>
Thu, 3 Jan 2019 14:57:06 +0000 (09:57 -0500)
Update sharp.rst to reflect new functionality in the `sharp install ..`
command.

Signed-off-by: Donald Sharp <sharpd@cumulusnetworks.com>
doc/user/sharp.rst

index 8831c0159b1395ee6112aa8144f0059c7f40dc59..c2d32a718e59dd6329332b68987498c7db3dc8fe 100644 (file)
@@ -33,16 +33,20 @@ All sharp commands are under the enable node and preceeded by the ``sharp``
 keyword. At present, no sharp commands will be preserved in the config.
 
 .. index:: sharp install
-.. clicmd:: sharp install routes A.B.C.D nexthop <E.F.G.H|X:X::X:X> (1-1000000)
+.. clicmd:: sharp install routes A.B.C.D <nexthop <E.F.G.H|X:X::X:X>|nexthop-group NAME> (1-1000000) [instance (0-255)] [repeat (2-1000)]
 
    Install up to 1,000,000 (one million) /32 routes starting at ``A.B.C.D``
    with specified nexthop ``E.F.G.H`` or ``X:X::X:X``. The nexthop is
    a ``NEXTHOP_TYPE_IPV4`` or ``NEXTHOP_TYPE_IPV6`` and must be reachable
-   to be installed into the kernel. The routes are installed into zebra as
-   ``ZEBRA_ROUTE_SHARP`` and can be used as part of a normal route
+   to be installed into the kernel. Alternatively a nexthop-group NAME
+   can be specified and used as the nexthops.  The routes are installed into
+   zebra as ``ZEBRA_ROUTE_SHARP`` and can be used as part of a normal route
    redistribution. Route installation time is noted in the debug
    log. When zebra successfully installs a route into the kernel and SHARP
    receives success notifications for all routes this is logged as well.
+   Instance (0-255) if specified causes the routes to be installed in a different
+   instance. If repeat is used then we will install/uninstall the routes the
+   number of times specified.
 
 .. index:: sharp remove
 .. clicmd:: sharp remove routes A.B.C.D (1-1000000)