ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/gvpe/doc/gvpe.conf.5.pod
(Generate patch)

Comparing gvpe/doc/gvpe.conf.5.pod (file contents):
Revision 1.12 by pcg, Wed Mar 23 17:03:58 2005 UTC vs.
Revision 1.13 by pcg, Sat Mar 26 03:16:23 2005 UTC

… …
21=head1 DESCRIPTION 21=head1 DESCRIPTION
22 22
23The gvpe config file consists of a series of lines that contain C<variable 23The gvpe config file consists of a series of lines that contain C<variable
24= value> pairs. Empty lines are ignored. Comments start with a C<#> and 24= value> pairs. Empty lines are ignored. Comments start with a C<#> and
25extend to the end of the line. They can be used on their own lines, or 25extend to the end of the line. They can be used on their own lines, or
26after any directives. Spaces are allowed before or after the C<=> sign or 26after any directives. Whitespace is allowed around the C<=> sign or after
27after values, but not within the variable names or values themselves. 27values, but not within the variable names or values themselves.
28 28
29The only exception to the above is the "on" directive that can prefix any 29The only exception to the above is the "on" directive that can prefix any
30C<name = value> setting and will only "execute" it on the named node, or 30C<name = value> setting and will only "execute" it on the named node, or
31(if the nodename starts with "!") on all nodes except the named one. 31(if the nodename starts with "!") on all nodes except the named one.
32 32
… …
126 126
127=item if-up = relative-or-absolute-path 127=item if-up = relative-or-absolute-path
128 128
129Sets the path of a script that should be called immediately after the 129Sets the path of a script that should be called immediately after the
130network interface is initialized (but not neccessarily up). The following 130network interface is initialized (but not neccessarily up). The following
131environment variables are passed to it (the values are just examples): 131environment variables are passed to it (the values are just examples).
132
133Variables that have the same value on all nodes:
132 134
133=over 4 135=over 4
134 136
135=item CONFBASE=/etc/gvpe 137=item CONFBASE=/etc/gvpe
136 138
137The configuration base directory. 139The configuration base directory.
138 140
139=item IFNAME=vpn0 141=item IFNAME=vpn0
140 142
141The interface to initialize. 143The network interface to initialize.
144
145=item IFTYPE=native # or tincd
146
147=item IFSUBTYPE=linux # or freebsd, darwin etc..
148
149The interface type (C<native> or C<tincd>) and the subtype (usually the
150OS name in lowercase) that this GVPE was configured for. Can be used to
151select the correct syntax to use for network-related commands.
142 152
143=item MTU=1436 153=item MTU=1436
144 154
145The MTU to set the interface to. You can use lower values (if done 155The MTU to set the interface to. You can use lower values (if done
146consistently on all hosts), but this is usually ineffective. 156consistently on all hosts), but this is usually ineffective.
147 157
158=item NODES=5
159
160The number of nodes in this GVPE network.
161
162=back
163
164Variables that are node-specific and with values pertaining to the node
165running this GVPE:
166
167=over 4
168
169=item IFUPDATA=string
170
171The value of the configuration directive C<if-up-data>.
172
148=item MAC=fe:fd:80:00:00:01 173=item MAC=fe:fd:80:00:00:01
149 174
150The MAC address to set the interface to. The script *must* set the 175The MAC address the network interface has to use.
151interface MAC to this value. You will most likely use one of these:
152 176
153 ip link set $IFNAME address $MAC mtu $MTU up # GNU/Linux 177Might be used to initialize interfaces on platforms where GVPE does not
154 ifconfig $IFNAME ether $MAC mtu $MTU up # FreeBSD 178do this automatically. Please see the C<gvpe.osdep(5)> manpage for
155 179platform-specific information.
156Please see the C<gvpe.osdep(5)> manpage for platform-specific information.
157
158=item IFTYPE=native # or tincd
159
160=item IFSUBTYPE=linux # or freebsd, darwin etc..
161
162The interface type (C<native> or C<tincd>) and the subtype (usually the os
163name in lowercase) that this gvpe was configured for. Can be used to select
164the correct syntax to use for network-related commands.
165 180
166=item NODENAME=branch1 181=item NODENAME=branch1
167 182
168The nickname of the current node, as passed to the gvpe daemon. 183The nickname of the node.
169 184
170=item NODEID=1 185=item NODEID=1
171 186
172The numerical node id of the current node. The first node mentioned in the 187The numerical node ID of the node running this instance of GVPE. The first
173config file gets ID 1, the second ID 2 and so on. 188node mentioned in the config file gets ID 1, the second ID 2 and so on.
174 189
175=back 190=back
176 191
192In addition, all node-specific variables (except C<NODEID>) will be
193available with a postfix of C<_nodeid>, which contains the value for that
194node, e.g. the C<MAC_1> variable contains the MAC address of node #1, while
195the C<NODENAME_22> variable contains the name of node #22.
196
177Here is a simple if-up script: 197Here is a simple if-up script:
178 198
179 #!/bin/sh 199 #!/bin/sh
180 ip link set $IFNAME address $MAC mtu $MTU up 200 ip link set $IFNAME up
181 [ $NODENAME = branch1 ] && ip addr add 10.0.0.1 dev $IFNAME 201 [ $NODENAME = branch1 ] && ip addr add 10.0.0.1 dev $IFNAME
182 [ $NODENAME = branch2 ] && ip addr add 10.1.0.1 dev $IFNAME 202 [ $NODENAME = branch2 ] && ip addr add 10.1.0.1 dev $IFNAME
183 ip route add 10.0.0.0/8 dev $IFNAME 203 ip route add 10.0.0.0/8 dev $IFNAME
184 204
185More complicated examples (using routing to reduce arp traffic) can be 205More complicated examples (using routing to reduce arp traffic) can be
… …
280argument to the gvpe daemon. 300argument to the gvpe daemon.
281 301
282=item node-up = relative-or-absolute-path 302=item node-up = relative-or-absolute-path
283 303
284Sets a command (default: no script) that should be called whenever a 304Sets a command (default: no script) that should be called whenever a
285connection is established (even on rekeying operations). In addition 305connection is established (even on rekeying operations). In addition to
286to the variables passed to C<if-up> scripts, the following environment 306all the variables passed to C<if-up> scripts, the following environment
287variables will be set: 307variables will be set:
288 308
289=over 4 309=over 4
290 310
291=item DESTNODE=branch2 311=item DESTNODE=branch2
… …
448via the ICMP transport. 468via the ICMP transport.
449 469
450The default is C<0> (which is C<echo-reply>, also known as 470The default is C<0> (which is C<echo-reply>, also known as
451"ping-replies"). Other useful values include C<8> (C<echo-request>, a.k.a. 471"ping-replies"). Other useful values include C<8> (C<echo-request>, a.k.a.
452"ping") and C<11> (C<time-exceeded>), but any 8-bit value can be used. 472"ping") and C<11> (C<time-exceeded>), but any 8-bit value can be used.
473
474=item if-up-data = value
475
476The value specified using this directive will be passed to the C<if-up>
477script in the environment variable C<IFUPDATA>.
453 478
454=item inherit-tos = yes|true|on | no|false|off 479=item inherit-tos = yes|true|on | no|false|off
455 480
456Wether to inherit the TOS settings of packets sent to the tunnel when 481Wether to inherit the TOS settings of packets sent to the tunnel when
457sending packets to this node (default: C<yes>). If set to C<yes> then 482sending packets to this node (default: C<yes>). If set to C<yes> then

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines