1 Using the FRRouting Snap
2 ===============================
4 After installing the Snap, the priviledged plug need to be connected:
6 snap connect frr:network-control core:network-control
8 Enabling/Disabling FRRouting Daemons
9 -------------------------------------------
11 By default (at this time), all FRRouting daemons will be enabled
12 on installation. If you want to disable a specific daemon, then use
13 the systemctl commands
15 ie for `ospf6d` (OSPFv3):
17 systemctl disable snap.frr.ospf6d.service
18 systemctl enable snap.frr.ospf6d.service
20 The daemons are: `ripd`, `ripngd`, `ospfd`, `ospf6d`, `isisd`, `bgpd`,
23 Commands defined by this snap
24 -----------------------------
27 FRRouting VTY Shell (configuration tool)
29 Returns output of `zebra --version` to display version and configured
32 Returns this document `cat README_usage.md`
34 Allows to enable `FPM` module. See FPM section below
36 and for debugging defined at this time (May get removed later - do not
37 depend on them). These are mainly intended to debug the Snap
40 Starts zebra daemon in foreground
42 Starts ripd daemon in foreground
44 Starts ripng daemon in foreground
46 Starts ospfd daemon in foreground
48 Starts ospf6d daemon in foreground
50 Starts isisd daemon in foreground
52 Starts bgpd daemon in foreground
54 Starts pimd daemon in foreground
56 Starts ldpd daemon in foreground
60 The MPLS forwarding requires a Linux Kernel version 4.5 or newer and
61 specific MPLS kernel modules loaded. It will be auto-detected by
62 FRR. You can check the detected setup with the `show mpls status`
63 command from within `frr.vtysh`
65 The following kernel modules `mpls-router` and `mpls-iptunnel`
66 need to be loaded. On Ubuntu 16.04, this can be done by editing
67 '/etc/modules-load.d/modules.conf' and add the following lines:
69 # Load MPLS Kernel Modules
73 For other distributions, please check the documentation on loading
74 modules. You need to either reboot or use `modprobe` to manually load
75 the modules as well before MPLS will be available.
77 In addition to this, the MPLS Label-Processing needs to be enabled
78 with `sysctl` on the required interfaces. Assuming the interfaces
79 are named `eth0`, `eth1` and `eth2`, then the additional lines in
80 `/etc/sysctl.conf` will enable it on a Ubuntu 16.04 system:
82 # Enable MPLS Label processing on all interfaces
83 net.mpls.conf.eth0.input=1
84 net.mpls.conf.eth1.input=1
85 net.mpls.conf.eth2.input=1
86 net.mpls.platform_labels=100000
88 These settings require either a reboot or a manual configuration with
93 The `frr.set` allows to turn FPM module on or off.
95 frr.set fpm {disable|protobuf|netlink}
97 Disables FPM or enables FPM with selected mode
99 By default, the FPM module is disabled, but installed with netlink and
100 protobuf support. To enable the FPM module, use the `frr.set fpm protobuf`
101 or `frr.set fpm netlink` command. The command will only enable the mode
102 for the next restart of zebra. Please reboot or restart zebra after
103 changing the mode to become effective.
107 - frr.vtysh displays `--MORE--` on long output. How to suppress this?
108 - Define `VTYSH_PAGER` to `cat` (default is `more`). (Ie add
109 `export VTYSH_PAGER=cat` to the end of your `.profile`)
111 - ospfd / ospf6d are not running after installation
112 - Installing a new snap starts the daemons, but at this time they
113 may not have the required priviledged access. Make sure you
114 issue the `snap connect` command as given above (can be verified
115 with `snap interfaces`) and **THEN** restart the daemons (or
117 This is a limitation of any snap package at this time which
118 requires priviledged interfaces (ie to manipulate routing tables)
123 The source for this SNAP is available as part of the FRRouting
124 Source Code Distribution under `GPLv2 or later`
126 <https://github.com/frrouting/frr.git>
128 Instructions for rebuilding the snap are in `snapcraft/README.snap_build.md`
130 *Please checkout the desired branch before following the instructions
131 as they may have changed between versions of FRR*
133 Official Webpage for FRR
134 ========================
136 Official webpage for FRR is at <https://www.frrouting.org/>
141 Please send Feedback about this snap to Martin Winter at
142 `mwinter@opensourcerouting.org`