snapcraft/README.usage.md

   1 Using the FreeRangeRouting Snap
   2 ===============================
   3
   4 After installing the Snap, the priviledged plug need to be connected:
   5
   6     snap connect frr:network-control ubuntu-core:network-control
   7
   8 Enabling/Disabling FreeRangeRouting Daemons
   9 -------------------------------------------
  10
  11 By default (at this time), all FreeRangeRouting daemons will be enabled
  12 on installation. If you want to disable a specific daemon, then use
  13 the systemctl commands
  14
  15 ie for `ospf6d` (OSPFv3):
  16
  17     systemctl disable snap.frr.ospf6d.service
  18     systemctl enable snap.frr.ospf6d.service
  19
  20 The daemons are: `ripd`, `ripngd`, `ospfd`, `ospf6d`, `isisd`, `bgpd`,
  21 `pimd`, `zebra`
  22
  23 Commands defined by this snap
  24 -----------------------------
  25
  26 - `frr.vtysh`:
  27         FreeRangeRouting VTY Shell (configuration tool)
  28 - `frr.version`:
  29         Returns output of `zebra --version` to display version and configured
  30         options
  31 - `frr.readme`:
  32         Returns this document `cat README_usage.md`
  33
  34 and for debugging defined at this time (May get removed later - do not
  35 depend on them). These are mainly intended to debug the Snap
  36
  37 - `frr.zebra-debug`:
  38         Starts zebra daemon in foreground
  39 - `frr.ripd-debug`:
  40         Starts ripd daemon in foreground
  41 - `frr.ripngd-debug`:
  42         Starts ripng daemon in foreground
  43 - `frr.ospfd-debug`:
  44         Starts ospfd daemon in foreground
  45 - `frr.ospf6d-debug`:
  46         Starts ospf6d daemon in foreground
  47 - `frr.isisd-debug`:
  48         Starts isisd daemon in foreground
  49 - `frr.bgpd-debug`:
  50         Starts bgpd daemon in foreground
  51 - `frr.pimd-debug`:
  52         Starts pimd daemon in foreground
  53 - `frr.ldpd-debug`:
  54     Starts ldpd daemon in foreground
  55
  56 FAQ
  57 ---
  58 - frr.vtysh displays `--MORE--` on long output. How to suppress this?
  59     - Define `VTYSH_PAGER` to `cat` (default is `more`). (Ie add
  60       `export VTYSH_PAGER=cat` to the end of your `.profile`)
  61
  62 Sourcecode available
  63 ====================
  64
  65 The source for this SNAP is available as part of the FreeRangeRouting
  66 Source Code Distribution.
  67
  68     https://github.com/freerangerouting/frr.git
  69
  70 Instructions for rebuilding the snap are in `README.snap_build.md`
  71
  72 Feedback welcome
  73 ================
  74
  75 Please send Feedback about this snap to Martin Winter at
  76 `mwinter@opensourcerouting.org`
  77