]> git.proxmox.com Git - mirror_frr.git/blame - snapcraft/README.usage.md
Rename: FreeRangeRouting FRRouting
[mirror_frr.git] / snapcraft / README.usage.md
CommitLineData
447a8fe9 1Using the FRRouting Snap
3ab11ecc
MW
2===============================
3
4After installing the Snap, the priviledged plug need to be connected:
5
6 snap connect frr:network-control ubuntu-core:network-control
7
447a8fe9 8Enabling/Disabling FRRouting Daemons
3ab11ecc
MW
9-------------------------------------------
10
447a8fe9 11By default (at this time), all FRRouting daemons will be enabled
3ab11ecc
MW
12on installation. If you want to disable a specific daemon, then use
13the systemctl commands
14
15ie for `ospf6d` (OSPFv3):
16
17 systemctl disable snap.frr.ospf6d.service
18 systemctl enable snap.frr.ospf6d.service
19
20The daemons are: `ripd`, `ripngd`, `ospfd`, `ospf6d`, `isisd`, `bgpd`,
21`pimd`, `zebra`
22
23Commands defined by this snap
24-----------------------------
25
26- `frr.vtysh`:
447a8fe9 27 FRRouting VTY Shell (configuration tool)
3ab11ecc
MW
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
34and for debugging defined at this time (May get removed later - do not
35depend 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
56FAQ
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
62Sourcecode available
63====================
64
447a8fe9 65The source for this SNAP is available as part of the FRRouting
3ab11ecc
MW
66Source Code Distribution.
67
68 https://github.com/freerangerouting/frr.git
69
70Instructions for rebuilding the snap are in `README.snap_build.md`
71
72Feedback welcome
73================
74
75Please send Feedback about this snap to Martin Winter at
76`mwinter@opensourcerouting.org`
77