summaryrefslogtreecommitdiff
path: root/doc/user
diff options
context:
space:
mode:
authorQuentin Young <qlyoung@cumulusnetworks.com>2018-01-26 12:38:08 -0500
committerQuentin Young <qlyoung@cumulusnetworks.com>2018-01-26 12:38:08 -0500
commitfce2ac600e8397474f7a5f5e0ed91c8a26a295f7 (patch)
tree2be6e0094bdc42213f5d780bf7b4636fbb21a273 /doc/user
parentc2caa2970b19ee07ac3e7a8f3718c57f458fd063 (diff)
doc: remove @group / @end group
Don't need these in RST Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
Diffstat (limited to 'doc/user')
-rw-r--r--doc/user/appendix.rst1
-rw-r--r--doc/user/eigrpd.rst6
-rw-r--r--doc/user/isisd.rst6
-rw-r--r--doc/user/nhrpd.rst10
-rw-r--r--doc/user/ospf6d.rst2
-rw-r--r--doc/user/ospf_fundamentals.rst6
-rw-r--r--doc/user/ospfd.rst20
-rw-r--r--doc/user/ripd.rst8
-rw-r--r--doc/user/routemap.rst2
-rw-r--r--doc/user/zebra.rst4
10 files changed, 0 insertions, 65 deletions
diff --git a/doc/user/appendix.rst b/doc/user/appendix.rst
index 334d162c91..e2948312a3 100644
--- a/doc/user/appendix.rst
+++ b/doc/user/appendix.rst
@@ -210,7 +210,6 @@ The file specified in "File Name" contains all routing entries,
which are in the format of ``subtype == BGP4MP_ENTRY``.
@example
-@group
Constants:::
/* type value */
diff --git a/doc/user/eigrpd.rst b/doc/user/eigrpd.rst
index 7686ef099d..d4f7e301b3 100644
--- a/doc/user/eigrpd.rst
+++ b/doc/user/eigrpd.rst
@@ -31,10 +31,8 @@ EIGRP is like below:
::
- @group
# zebra -d
# eigrpd -d
- @end group
Please note that *zebra* must be invoked before *eigrpd*.
@@ -99,12 +97,10 @@ Command {no router eigrp (1-65535)} {}
::
- @group
!
router eigrp 1
network 10.0.0.0/8
!
- @end group
Passive interface
@@ -214,7 +210,6 @@ Command {show ip eigrp topology} {}
::
- @group
eigrpd> **show ip eigrp topology**
# show ip eigrp topo
@@ -225,7 +220,6 @@ Command {show ip eigrp topology} {}
P 10.0.2.0/24, 1 successors, FD is 256256, serno: 0
via Connected, enp0s3
- @end group
EIGRP Debug Commands
diff --git a/doc/user/isisd.rst b/doc/user/isisd.rst
index 667af96057..d1c1336b4e 100644
--- a/doc/user/isisd.rst
+++ b/doc/user/isisd.rst
@@ -553,7 +553,6 @@ A simple example, with MD5 authentication enabled:
::
- @group
!
interface eth0
ip router isis FOO
@@ -564,7 +563,6 @@ A simple example, with MD5 authentication enabled:
net 47.0023.0000.0000.0000.0000.0000.0000.1900.0004.00
metric-style wide
is-type level-2-only
- @end group
A Traffic Engineering configuration, with Inter-ASv2 support.
@@ -573,7 +571,6 @@ A Traffic Engineering configuration, with Inter-ASv2 support.
::
- @group
hostname HOSTNAME
password PASSWORD
log file /var/log/zebra.log
@@ -610,14 +607,12 @@ A Traffic Engineering configuration, with Inter-ASv2 support.
mpls-te link unrsv-bw 7 1.25e+06
mpls-te link rsc-clsclr 0xab
mpls-te neighbor 10.1.1.2 as 65000
- @end group
- Then the 'isisd.conf' itself:
::
- @group
hostname HOSTNAME
password PASSWORD
log file /var/log/isisd.log
@@ -636,6 +631,5 @@ A Traffic Engineering configuration, with Inter-ASv2 support.
mpls-te router-address 10.1.1.1
!
line vty
- @end group
diff --git a/doc/user/nhrpd.rst b/doc/user/nhrpd.rst
index a16730a3cc..ae8a986192 100644
--- a/doc/user/nhrpd.rst
+++ b/doc/user/nhrpd.rst
@@ -35,11 +35,9 @@ To create NBMA GRE tunnel you might use the following (linux terminal
commands):
::
- @group
ip tunnel add gre1 mode gre key 42 ttl 64
ip addr add 10.255.255.2/32 dev gre1
ip link set gre1 up
- @end group
Note that the IP-address is assigned as host prefix to gre1. nhrpd will
@@ -59,13 +57,11 @@ This can be achieved in hubs with the following bgp configuration (network
command defines the GRE subnet):
::
- @group
router bgp 65555
address-family ipv4 unicast
network 172.16.0.0/16
redistribute nhrp
exit-address-family
- @end group
.. _Configuring_NHRP:
@@ -91,12 +87,10 @@ This can be achieved with the following iptables rule.
::
- @group
iptables -A FORWARD -i gre1 -o gre1 \\
-m hashlimit --hashlimit-upto 4/minute --hashlimit-burst 1 \\
--hashlimit-mode srcip,dstip --hashlimit-srcmask 24 --hashlimit-dstmask 24 \\
--hashlimit-name loglimit-0 -j NFLOG --nflog-group 1 --nflog-range 128
- @end group
You can fine tune the src/dstmask according to the prefix lengths you
@@ -107,19 +101,15 @@ This kernel NFLOG target's nflog-group is configured in global nhrp config
with:
::
- @group
nhrp nflog-group 1
- @end group
To start sending these traffic notices out from hubs, use the nhrp
per-interface directive:
::
- @group
interface gre1
ip nhrp redirect
- @end group
.. _Integration_with_IKE:
diff --git a/doc/user/ospf6d.rst b/doc/user/ospf6d.rst
index 3644631c59..4fbf5c0dd1 100644
--- a/doc/user/ospf6d.rst
+++ b/doc/user/ospf6d.rst
@@ -54,10 +54,8 @@ OSPF6 router
::
- @group
router ospf6
timers throttle spf 200 400 10000
- @end group
In this example, the `delay` is set to 200ms, the @var{initial
diff --git a/doc/user/ospf_fundamentals.rst b/doc/user/ospf_fundamentals.rst
index c11c212da8..dc3321ff5e 100644
--- a/doc/user/ospf_fundamentals.rst
+++ b/doc/user/ospf_fundamentals.rst
@@ -439,7 +439,6 @@ From just the above two @acronym{LSA}s, one can already see the
following partial topology:
::
- @group
--------------------- Network: ......
| Designated Router IP: 192.168.1.3
@@ -461,7 +460,6 @@ following partial topology:
| Router ID: 192.168.0.53
|
Router ID: 192.168.0.52
- @end group
Note the Router IDs, though they look like IP addresses and often are
@@ -534,7 +532,6 @@ selected.
::
- @group
# show ip ospf database external 192.168.165.0
LS age: 995
Options: 0x2 : *|-|-|-|-|-|E|*
@@ -551,14 +548,12 @@ selected.
Metric: 20
Forward Address: 0.0.0.0
External Route Tag: 0
- @end group
We can add this to our partial topology from above, which now looks
like:
::
- @group
--------------------- Network: ......
| Designated Router IP: 192.168.1.3
|
@@ -579,7 +574,6 @@ like:
| Router ID: 192.168.0.53
|
Router ID: 192.168.0.52
- @end group
Summary LSAs
diff --git a/doc/user/ospfd.rst b/doc/user/ospfd.rst
index 65a5959447..23aae50ecc 100644
--- a/doc/user/ospfd.rst
+++ b/doc/user/ospfd.rst
@@ -172,10 +172,8 @@ Command {no router ospf} {}
::
- @group
router ospf
timers throttle spf 200 400 10000
- @end group
In this example, the `delay` is set to 200ms, the @var{initial
@@ -266,10 +264,8 @@ Command {no router ospf} {}
::
- @group
router ospf
network 192.168.1.0/24 area 0.0.0.0
- @end group
Prefix length in interface must be equal or bigger (ie. smaller network) than
@@ -313,12 +309,10 @@ OSPF area
::
- @group
router ospf
network 192.168.1.0/24 area 0.0.0.0
network 10.0.0.0/8 area 0.0.0.10
area 0.0.0.10 range 10.0.0.0/8
- @end group
With configuration above one Type-3 Summary-LSA with routing info 10.0.0.0/8 is
@@ -345,12 +339,10 @@ OSPF area
::
- @group
router ospf
network 192.168.1.0/24 area 0.0.0.0
network 10.0.0.0/8 area 0.0.0.10
area 0.0.0.10 range 10.0.0.0/8 substitute 11.0.0.0/8
- @end group
One Type-3 summary-LSA with routing info 11.0.0.0/8 is announced into backbone area if
@@ -446,7 +438,6 @@ OSPF area
::
- @group
router ospf
network 192.168.1.0/24 area 0.0.0.0
network 10.0.0.0/8 area 0.0.0.10
@@ -454,7 +445,6 @@ OSPF area
!
access-list foo permit 10.10.0.0/16
access-list foo deny any
- @end group
With example above any intra-area paths from area 0.0.0.10 and from range
@@ -1129,7 +1119,6 @@ A simple example, with MD5 authentication enabled:
::
- @group
!
interface bge0
ip ospf authentication message-digest
@@ -1138,7 +1127,6 @@ A simple example, with MD5 authentication enabled:
router ospf
network 192.168.0.0/16 area 0.0.0.1
area 0.0.0.1 authentication message-digest
- @end group
An @acronym{ABR} router, with MD5 authentication and performing summarisation
@@ -1146,7 +1134,6 @@ of networks between the areas:
::
- @group
!
password ABCDEF
log file /var/log/frr/ospfd.log
@@ -1175,7 +1162,6 @@ of networks between the areas:
area 0.0.0.1 authentication message-digest
area 0.0.0.1 range 10.2.0.0/16
!
- @end group
A Traffic Engineering configuration, with Inter-ASv2 support.
@@ -1184,7 +1170,6 @@ A Traffic Engineering configuration, with Inter-ASv2 support.
::
- @group
hostname HOSTNAME
password PASSWORD
log file /var/log/zebra.log
@@ -1221,14 +1206,12 @@ A Traffic Engineering configuration, with Inter-ASv2 support.
mpls-te link unrsv-bw 7 1.25e+06
mpls-te link rsc-clsclr 0xab
mpls-te neighbor 192.168.2.2 as 65000
- @end group
- Then the 'ospfd.conf' itself:
::
- @group
hostname HOSTNAME
password PASSWORD
log file /var/log/ospfd.log
@@ -1252,14 +1235,12 @@ A Traffic Engineering configuration, with Inter-ASv2 support.
mpls-te inter-as area 1
!
line vty
- @end group
A router information example with PCE advsertisement:
::
- @group
!
router ospf
ospf router-id 192.168.1.1
@@ -1275,6 +1256,5 @@ A router information example with PCE advsertisement:
pce neighbor as 65200
pce scope 0x80
!
- @end group
diff --git a/doc/user/ripd.rst b/doc/user/ripd.rst
index 53fca7c57f..201ea7ce19 100644
--- a/doc/user/ripd.rst
+++ b/doc/user/ripd.rst
@@ -35,10 +35,8 @@ RIP is like below:
::
- @group
# zebra -d
# ripd -d
- @end group
Please note that *zebra* must be invoked before *ripd*.
@@ -154,13 +152,11 @@ Command {no router rip} {}
::
- @group
!
router rip
network 10.0.0.0/8
network eth0
!
- @end group
Passive interface
@@ -375,7 +371,6 @@ Command {distribute-list `access_list` `direct` `ifname`} {}
::
- @group
!
router rip
distribute-list private in eth0
@@ -383,7 +378,6 @@ Command {distribute-list `access_list` `direct` `ifname`} {}
access-list private permit 10 10.0.0.0/8
access-list private deny any
!
- @end group
`distribute-list` can be applied to both incoming and outgoing data.
@@ -676,7 +670,6 @@ Command {show ip rip status} {}
::
- @group
ripd> **show ip rip status**
Routing Protocol is "rip"
Sending updates every 30 seconds with +/-50%, next due in 35 seconds
@@ -694,7 +687,6 @@ Command {show ip rip status} {}
203.181.89.241
Routing Information Sources:
Gateway BadPackets BadRoutes Distance Last Update
- @end group
RIP Debug Commands
diff --git a/doc/user/routemap.rst b/doc/user/routemap.rst
index 0be62d4100..7ec3fcaf4f 100644
--- a/doc/user/routemap.rst
+++ b/doc/user/routemap.rst
@@ -295,11 +295,9 @@ A simple example of a route-map:
::
- @group
route-map test permit 10
match ip address 10
set local-preference 200
- @end group
This means that if a route matches ip access-list number 10 it's
diff --git a/doc/user/zebra.rst b/doc/user/zebra.rst
index d42da83a46..922b1691d3 100644
--- a/doc/user/zebra.rst
+++ b/doc/user/zebra.rst
@@ -467,14 +467,12 @@ Command {ip protocol `protocol` route-map `routemap`} {}
that sets the preferred source address, and applies the route-map to all
*rip* routes.
- @group
ip prefix-list ANY permit 0.0.0.0/0 le 32
route-map RM1 permit 10
match ip address prefix-list ANY
set src 10.0.0.1
ip protocol rip route-map RM1
- @end group
.. _zebra_FIB_push_interface:
@@ -560,7 +558,6 @@ Command {show ip route} {}
::
- @group
Router# show ip route
Codes: K - kernel route, C - connected, S - static, R - RIP,
B - BGP * - FIB route.
@@ -569,7 +566,6 @@ Command {show ip route} {}
S 0.0.0.0/0 203.181.89.1
C* 127.0.0.0/8 lo
C* 203.181.89.240/28 eth0
- @end group
.. index:: Command {show ipv6 route} {}