File: ramond.conf.5

package info (click to toggle)
ramond 0.5-4
  • links: PTS, VCS
  • area: main
  • in suites: buster, jessie, jessie-kfreebsd, stretch, wheezy
  • size: 248 kB
  • ctags: 174
  • sloc: ansic: 1,418; sh: 82; makefile: 26; perl: 10
file content (150 lines) | stat: -rw-r--r-- 3,805 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
.TH ramond\&.conf 5
.SH NAME
.RB "ramond.conf \- Configuration file for " ramond (8)
.SH DESCRIPTION
.PP
.RB "This manual page documents briefly the " ramond\&.conf " configuration file\&."
.PP
.BR ramond\&.conf " is an XML file containing the rules for Router Advertisement processing by " ramond "(8)\&."
.PP
The rules are processed in the order they are defined in the file.
.SH SYNTAX
.PP
.RB "One may refer to the DTD given in " /usr/share/doc/ramond/examples/ramond.conf.dtd "\&."
.PP
.RB "The root element, " <ramond> ", contains one optional attribute, " logfile ", giving the path to the logfile for the daemon\&."
.PP
.RB "This element may contain one or more " <mac\-list> "s, and one or more " <rule> "s\&."
.PP
.RB "The " <mac\-list> " must have a " name " attribute, and contains one or more " <entry> "elements\&."
.PP
.RB "The " <rule> " may contain a few attributes :"
.TP
.B prefix
An IPv6 prefix used for matching RA packets
.TP
.B mac
.RB "A " <mac\-list> " name used for matching source MAC addresses of the RA packets"
.TP
.B lifetime
.RB "This attribute, when having a " \(lq0\(rq " value, is used for matching routes that are being cleared"
.TP
.B interface
The interface which the RA packet came from
.PP
.RB "The " <rule> " may contain :"
.RS 2
.RB "\(bu one or more " <execute> " elements containing the path of the scripts to run when a packet is matched"
.br
.RB "\(bu a " <clear/> " element, so that the matched route will be cleared by " ramond "(8)"
.br
.RB "\(bu or no element, indicating an \(lqignore\(rq rule\&."
.RE
.SH ENVIRONMENT
.RB "The environment variables the configured scripts are run with are listed in the " ramond "(8) manpage\&."
.SH EXAMPLE CONFIGURATION FILE
.PP
.RB "Set the logfile to be " /var/log/ramond.log "\&."
.PP
.RS 1
<ramond logfile="/var/log/ramond.log">
.PP
.RS 1
.RB "Define a " router " mac\-list\&."
.RE
.PP
.RS 2
<mac\-list name="router">
.RS 2
<entry>00:11:22:33:44:55</entry>
.br
<entry>00:22:44:66:88:00</entry>
.RE
</mac\-list>
.RE
.PP
.RS 1
.RB "Define a rule checking if the " router " routes are being cleared\&."
.RE
.PP
.RS 2
<rule mac="router" lifetime="0">
.RS 2
<execute>/usr/local/sbin/routenotify route\-cleared</execute>
.RE
</rule>
.RE
.PP
.RS 1
.RB "Define a rule ignoring our " router " announcing routes for prefix " 2001:dead:cafe:babe::/52 "\&."
.RE
.PP
.RS 2
<rule mac="router" prefix="2001:dead:cafe:babe::/52">
.RS 2
<!-- do nothing -->
.RE
</rule>
.RE
.PP
.RS 1
.RB "Clear the 6to4 routes coming on interface " eth0 "\&."
.RE
.PP
.RS 2
<rule prefix="2002::/16" interface="eth0">
.RS 2
<execute>/usr/local/sbin/routenotify 6to4\-advertised</execute>
.br
<clear/>
.RE
</rule>
.RE
.PP
.RS 1
Match on all advertised prefixes
.RE
.PP
.RS 2
<rule prefix="::/0">
.RS 2
<execute>/usr/local/sbin/routenotify route\-advertised</execute>
.RE
</rule>
.RE
.PP
.RS 1
Match on all RA packets (even those not advertising a prefix)
.RE
.PP
.RS 2
<rule>
.RS 2
<execute>/usr/local/sbin/routenotify route\-advertised</execute>
.RE
</rule>
.RE
.PP
</ramond>
.RE
.SH SEE ALSO
.PP
.BR ramond "(8), " /usr/share/doc/ramond/examples " for a sample " ramond\&.conf " and a sample processing script"
.SH AUTHORS
.TP
.BR "James Morse" " <\&morse_@users\&.sourceforge\&.net\&>"
.RB "Wrote the " ramond " software\&."
.TP
.BR "Nicolas Dandrimont" " <\&nicolas\&.dandrimont@crans\&.org\&>"
Wrote this manpage for the Debian system\&.
.SH COPYRIGHT
.br
Copyright \(co 2010 Nicolas Dandrimont
.br
.PP
This manual page was written for the Debian system (and may be used by others)\&.
.PP
Permission is granted to copy, distribute and/or modify this document under the terms of the usual 3\-clause BSD license\&.
.PP
On Debian systems, the complete text of the 3\-clause BSD license License can be found in /usr/share/doc/ramond/copyright\&.
.sp