… | |
… | |
127 | .\} |
127 | .\} |
128 | .rm #[ #] #H #V #F C |
128 | .rm #[ #] #H #V #F C |
129 | .\" ======================================================================== |
129 | .\" ======================================================================== |
130 | .\" |
130 | .\" |
131 | .IX Title "GVPE.CONF 5" |
131 | .IX Title "GVPE.CONF 5" |
132 | .TH GVPE.CONF 5 "2005-03-23" "1.8" "GNU Virtual Private Ethernet" |
132 | .TH GVPE.CONF 5 "2005-03-26" "1.9" "GNU Virtual Private Ethernet" |
133 | .SH "NAME" |
133 | .SH "NAME" |
134 | gvpe.conf \- configuration file for the GNU VPE daemon |
134 | gvpe.conf \- configuration file for the GNU VPE daemon |
135 | .SH "SYNOPSIS" |
135 | .SH "SYNOPSIS" |
136 | .IX Header "SYNOPSIS" |
136 | .IX Header "SYNOPSIS" |
137 | .Vb 3 |
137 | .Vb 3 |
… | |
… | |
158 | .SH "DESCRIPTION" |
158 | .SH "DESCRIPTION" |
159 | .IX Header "DESCRIPTION" |
159 | .IX Header "DESCRIPTION" |
160 | The gvpe config file consists of a series of lines that contain \f(CW\*(C`variable |
160 | The gvpe config file consists of a series of lines that contain \f(CW\*(C`variable |
161 | = value\*(C'\fR pairs. Empty lines are ignored. Comments start with a \f(CW\*(C`#\*(C'\fR and |
161 | = value\*(C'\fR pairs. Empty lines are ignored. Comments start with a \f(CW\*(C`#\*(C'\fR and |
162 | extend to the end of the line. They can be used on their own lines, or |
162 | extend to the end of the line. They can be used on their own lines, or |
163 | after any directives. Spaces are allowed before or after the \f(CW\*(C`=\*(C'\fR sign or |
163 | after any directives. Whitespace is allowed around the \f(CW\*(C`=\*(C'\fR sign or after |
164 | after values, but not within the variable names or values themselves. |
164 | values, but not within the variable names or values themselves. |
165 | .PP |
165 | .PP |
166 | The only exception to the above is the \*(L"on\*(R" directive that can prefix any |
166 | The only exception to the above is the \*(L"on\*(R" directive that can prefix any |
167 | \&\f(CW\*(C`name = value\*(C'\fR setting and will only \*(L"execute\*(R" it on the named node, or |
167 | \&\f(CW\*(C`name = value\*(C'\fR setting and will only \*(L"execute\*(R" it on the named node, or |
168 | (if the nodename starts with \*(L"!\*(R") on all nodes except the named one. |
168 | (if the nodename starts with \*(L"!\*(R") on all nodes except the named one. |
169 | .PP |
169 | .PP |
… | |
… | |
254 | The default should be working ok for most links. |
254 | The default should be working ok for most links. |
255 | .IP "if-up = relative-or-absolute-path" 4 |
255 | .IP "if-up = relative-or-absolute-path" 4 |
256 | .IX Item "if-up = relative-or-absolute-path" |
256 | .IX Item "if-up = relative-or-absolute-path" |
257 | Sets the path of a script that should be called immediately after the |
257 | Sets the path of a script that should be called immediately after the |
258 | network interface is initialized (but not neccessarily up). The following |
258 | network interface is initialized (but not neccessarily up). The following |
259 | environment variables are passed to it (the values are just examples): |
259 | environment variables are passed to it (the values are just examples). |
|
|
260 | .Sp |
|
|
261 | Variables that have the same value on all nodes: |
260 | .RS 4 |
262 | .RS 4 |
261 | .IP "CONFBASE=/etc/gvpe" 4 |
263 | .IP "CONFBASE=/etc/gvpe" 4 |
262 | .IX Item "CONFBASE=/etc/gvpe" |
264 | .IX Item "CONFBASE=/etc/gvpe" |
263 | The configuration base directory. |
265 | The configuration base directory. |
264 | .IP "IFNAME=vpn0" 4 |
266 | .IP "IFNAME=vpn0" 4 |
265 | .IX Item "IFNAME=vpn0" |
267 | .IX Item "IFNAME=vpn0" |
266 | The interface to initialize. |
268 | The network interface to initialize. |
267 | .IP "MTU=1436" 4 |
|
|
268 | .IX Item "MTU=1436" |
|
|
269 | The \s-1MTU\s0 to set the interface to. You can use lower values (if done |
|
|
270 | consistently on all hosts), but this is usually ineffective. |
|
|
271 | .IP "MAC=fe:fd:80:00:00:01" 4 |
|
|
272 | .IX Item "MAC=fe:fd:80:00:00:01" |
|
|
273 | The \s-1MAC\s0 address to set the interface to. The script *must* set the |
|
|
274 | interface \s-1MAC\s0 to this value. You will most likely use one of these: |
|
|
275 | .Sp |
|
|
276 | .Vb 2 |
|
|
277 | \& ip link set $IFNAME address $MAC mtu $MTU up # GNU/Linux |
|
|
278 | \& ifconfig $IFNAME ether $MAC mtu $MTU up # FreeBSD |
|
|
279 | .Ve |
|
|
280 | .Sp |
|
|
281 | Please see the \f(CW\*(C`gvpe.osdep(5)\*(C'\fR manpage for platform-specific information. |
|
|
282 | .IP "IFTYPE=native # or tincd" 4 |
269 | .IP "IFTYPE=native # or tincd" 4 |
283 | .IX Item "IFTYPE=native # or tincd" |
270 | .IX Item "IFTYPE=native # or tincd" |
284 | .PD 0 |
271 | .PD 0 |
285 | .IP "IFSUBTYPE=linux # or freebsd, darwin etc.." 4 |
272 | .IP "IFSUBTYPE=linux # or freebsd, darwin etc.." 4 |
286 | .IX Item "IFSUBTYPE=linux # or freebsd, darwin etc.." |
273 | .IX Item "IFSUBTYPE=linux # or freebsd, darwin etc.." |
287 | .PD |
274 | .PD |
288 | The interface type (\f(CW\*(C`native\*(C'\fR or \f(CW\*(C`tincd\*(C'\fR) and the subtype (usually the os |
275 | The interface type (\f(CW\*(C`native\*(C'\fR or \f(CW\*(C`tincd\*(C'\fR) and the subtype (usually the |
289 | name in lowercase) that this gvpe was configured for. Can be used to select |
276 | \&\s-1OS\s0 name in lowercase) that this \s-1GVPE\s0 was configured for. Can be used to |
290 | the correct syntax to use for network-related commands. |
277 | select the correct syntax to use for network-related commands. |
|
|
278 | .IP "MTU=1436" 4 |
|
|
279 | .IX Item "MTU=1436" |
|
|
280 | The \s-1MTU\s0 to set the interface to. You can use lower values (if done |
|
|
281 | consistently on all hosts), but this is usually ineffective. |
|
|
282 | .IP "NODES=5" 4 |
|
|
283 | .IX Item "NODES=5" |
|
|
284 | The number of nodes in this \s-1GVPE\s0 network. |
|
|
285 | .RE |
|
|
286 | .RS 4 |
|
|
287 | .Sp |
|
|
288 | Variables that are node-specific and with values pertaining to the node |
|
|
289 | running this \s-1GVPE:\s0 |
|
|
290 | .IP "IFUPDATA=string" 4 |
|
|
291 | .IX Item "IFUPDATA=string" |
|
|
292 | The value of the configuration directive \f(CW\*(C`if\-up\-data\*(C'\fR. |
|
|
293 | .IP "MAC=fe:fd:80:00:00:01" 4 |
|
|
294 | .IX Item "MAC=fe:fd:80:00:00:01" |
|
|
295 | The \s-1MAC\s0 address the network interface has to use. |
|
|
296 | .Sp |
|
|
297 | Might be used to initialize interfaces on platforms where \s-1GVPE\s0 does not |
|
|
298 | do this automatically. Please see the \f(CW\*(C`gvpe.osdep(5)\*(C'\fR manpage for |
|
|
299 | platform-specific information. |
291 | .IP "NODENAME=branch1" 4 |
300 | .IP "NODENAME=branch1" 4 |
292 | .IX Item "NODENAME=branch1" |
301 | .IX Item "NODENAME=branch1" |
293 | The nickname of the current node, as passed to the gvpe daemon. |
302 | The nickname of the node. |
294 | .IP "NODEID=1" 4 |
303 | .IP "NODEID=1" 4 |
295 | .IX Item "NODEID=1" |
304 | .IX Item "NODEID=1" |
296 | The numerical node id of the current node. The first node mentioned in the |
305 | The numerical node \s-1ID\s0 of the node running this instance of \s-1GVPE\s0. The first |
297 | config file gets \s-1ID\s0 1, the second \s-1ID\s0 2 and so on. |
306 | node mentioned in the config file gets \s-1ID\s0 1, the second \s-1ID\s0 2 and so on. |
298 | .RE |
307 | .RE |
299 | .RS 4 |
308 | .RS 4 |
300 | .Sp |
309 | .Sp |
|
|
310 | In addition, all node-specific variables (except \f(CW\*(C`NODEID\*(C'\fR) will be |
|
|
311 | available with a postfix of \f(CW\*(C`_nodeid\*(C'\fR, which contains the value for that |
|
|
312 | node, e.g. the \f(CW\*(C`MAC_1\*(C'\fR variable contains the \s-1MAC\s0 address of node #1, while |
|
|
313 | the \f(CW\*(C`NODENAME_22\*(C'\fR variable contains the name of node #22. |
|
|
314 | .Sp |
301 | Here is a simple if-up script: |
315 | Here is a simple if-up script: |
302 | .Sp |
316 | .Sp |
303 | .Vb 5 |
317 | .Vb 5 |
304 | \& #!/bin/sh |
318 | \& #!/bin/sh |
305 | \& ip link set $IFNAME address $MAC mtu $MTU up |
319 | \& ip link set $IFNAME up |
306 | \& [ $NODENAME = branch1 ] && ip addr add 10.0.0.1 dev $IFNAME |
320 | \& [ $NODENAME = branch1 ] && ip addr add 10.0.0.1 dev $IFNAME |
307 | \& [ $NODENAME = branch2 ] && ip addr add 10.1.0.1 dev $IFNAME |
321 | \& [ $NODENAME = branch2 ] && ip addr add 10.1.0.1 dev $IFNAME |
308 | \& ip route add 10.0.0.0/8 dev $IFNAME |
322 | \& ip route add 10.0.0.0/8 dev $IFNAME |
309 | .Ve |
323 | .Ve |
310 | .Sp |
324 | .Sp |
… | |
… | |
398 | used to select the right configuration section and must be passed as an |
412 | used to select the right configuration section and must be passed as an |
399 | argument to the gvpe daemon. |
413 | argument to the gvpe daemon. |
400 | .IP "node-up = relative-or-absolute-path" 4 |
414 | .IP "node-up = relative-or-absolute-path" 4 |
401 | .IX Item "node-up = relative-or-absolute-path" |
415 | .IX Item "node-up = relative-or-absolute-path" |
402 | Sets a command (default: no script) that should be called whenever a |
416 | Sets a command (default: no script) that should be called whenever a |
403 | connection is established (even on rekeying operations). In addition |
417 | connection is established (even on rekeying operations). In addition to |
404 | to the variables passed to \f(CW\*(C`if\-up\*(C'\fR scripts, the following environment |
418 | all the variables passed to \f(CW\*(C`if\-up\*(C'\fR scripts, the following environment |
405 | variables will be set: |
419 | variables will be set: |
406 | .RS 4 |
420 | .RS 4 |
407 | .IP "DESTNODE=branch2" 4 |
421 | .IP "DESTNODE=branch2" 4 |
408 | .IX Item "DESTNODE=branch2" |
422 | .IX Item "DESTNODE=branch2" |
409 | The name of the remote node. |
423 | The name of the remote node. |
… | |
… | |
547 | via the \s-1ICMP\s0 transport. |
561 | via the \s-1ICMP\s0 transport. |
548 | .Sp |
562 | .Sp |
549 | The default is \f(CW0\fR (which is \f(CW\*(C`echo\-reply\*(C'\fR, also known as |
563 | The default is \f(CW0\fR (which is \f(CW\*(C`echo\-reply\*(C'\fR, also known as |
550 | \&\*(L"ping\-replies\*(R"). Other useful values include \f(CW8\fR (\f(CW\*(C`echo\-request\*(C'\fR, a.k.a. |
564 | \&\*(L"ping\-replies\*(R"). Other useful values include \f(CW8\fR (\f(CW\*(C`echo\-request\*(C'\fR, a.k.a. |
551 | \&\*(L"ping\*(R") and \f(CW11\fR (\f(CW\*(C`time\-exceeded\*(C'\fR), but any 8\-bit value can be used. |
565 | \&\*(L"ping\*(R") and \f(CW11\fR (\f(CW\*(C`time\-exceeded\*(C'\fR), but any 8\-bit value can be used. |
|
|
566 | .IP "if-up-data = value" 4 |
|
|
567 | .IX Item "if-up-data = value" |
|
|
568 | The value specified using this directive will be passed to the \f(CW\*(C`if\-up\*(C'\fR |
|
|
569 | script in the environment variable \f(CW\*(C`IFUPDATA\*(C'\fR. |
552 | .IP "inherit-tos = yes|true|on | no|false|off" 4 |
570 | .IP "inherit-tos = yes|true|on | no|false|off" 4 |
553 | .IX Item "inherit-tos = yes|true|on | no|false|off" |
571 | .IX Item "inherit-tos = yes|true|on | no|false|off" |
554 | Wether to inherit the \s-1TOS\s0 settings of packets sent to the tunnel when |
572 | Wether to inherit the \s-1TOS\s0 settings of packets sent to the tunnel when |
555 | sending packets to this node (default: \f(CW\*(C`yes\*(C'\fR). If set to \f(CW\*(C`yes\*(C'\fR then |
573 | sending packets to this node (default: \f(CW\*(C`yes\*(C'\fR). If set to \f(CW\*(C`yes\*(C'\fR then |
556 | outgoing tunnel packets will have the same \s-1TOS\s0 setting as the packets sent |
574 | outgoing tunnel packets will have the same \s-1TOS\s0 setting as the packets sent |