doc/user/sharp.rst

   1 .. _sharp:
   2
   3 *****
   4 SHARP
   5 *****
   6
   7 :abbr:`SHARP (Super Happy Advanced Routing Process)` is a daemon that provides
   8 miscellaneous functionality used for testing FRR and creating proof-of-concept
   9 labs.
  10
  11 .. _starting-sharp:
  12
  13 Starting SHARP
  14 ==============
  15
  16 Default configuration file for *sharpd* is :file:`sharpd.conf`.  The typical
  17 location of :file:`sharpd.conf` is |INSTALL_PREFIX_ETC|/sharpd.conf.
  18
  19 If the user is using integrated config, then :file:`sharpd.conf` need not be
  20 present and the :file:`frr.conf` is read instead.
  21
  22 .. program:: sharpd
  23
  24 :abbr:`SHARP` supports all the common FRR daemon start options which are
  25 documented elsewhere.
  26
  27 .. _using-sharp:
  28
  29 Using SHARP
  30 ===========
  31
  32 All sharp commands are under the enable node and preceeded by the ``sharp``
  33 keyword. At present, no sharp commands will be preserved in the config.
  34
  35 .. index:: sharp install
  36 .. clicmd:: sharp install routes A.B.C.D nexthop <E.F.G.H|X:X::X:X> (1-1000000)
  37
  38    Install up to 1,000,000 (one million) /32 routes starting at ``A.B.C.D``
  39    with specified nexthop ``E.F.G.H`` or ``X:X::X:X``. The nexthop is
  40    a ``NEXTHOP_TYPE_IPV4`` or ``NEXTHOP_TYPE_IPV6`` and must be reachable
  41    to be installed into the kernel. The routes are installed into zebra as
  42    ``ZEBRA_ROUTE_SHARP`` and can be used as part of a normal route
  43    redistribution. Route installation time is noted in the debug
  44    log. When zebra successfully installs a route into the kernel and SHARP
  45    receives success notifications for all routes this is logged as well.
  46
  47 .. index:: sharp remove
  48 .. clicmd:: sharp remove routes A.B.C.D (1-1000000)
  49
  50    Remove up to 1,000,000 (one million) /32 routes starting at ``A.B.C.D``. The
  51    routes are removed from zebra. Route deletion start is noted in the debug
  52    log and when all routes have been successfully deleted the debug log will be
  53    updated with this information as well.
  54
  55 .. index:: sharp label
  56 .. clicmd:: sharp label <ipv4|ipv6> vrf NAME label (0-1000000)
  57
  58    Install a label into the kernel that causes the specified vrf NAME table to
  59    be used for pop and forward operations when the specified label is seen.
  60
  61 .. index:: sharp watch
  62 .. clicmd:: sharp watch nexthop <A.B.C.D|X:X::X:X>
  63
  64    Instruct zebra to monitor and notify sharp when the specified nexthop is
  65    changed. The notification from zebra is written into the debug log.