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

Comparing gvpe/doc/gvpe.conf.5 (file contents):
Revision 1.7 by pcg, Sun Mar 6 18:34:46 2005 UTC vs.
Revision 1.19 by pcg, Thu Mar 29 17:35:20 2007 UTC

1.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.14 1.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32
2.\" 2.\"
3.\" Standard preamble: 3.\" Standard preamble:
4.\" ======================================================================== 4.\" ========================================================================
5.de Sh \" Subsection heading 5.de Sh \" Subsection heading
6.br 6.br
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-06" "1.8" "GNU Virtual Private Ethernet" 132.TH GVPE.CONF 5 "2007-01-31" "2.01" "GNU Virtual Private Ethernet"
133.SH "NAME" 133.SH "NAME"
134gvpe.conf \- configuration file for the GNU VPE daemon 134gvpe.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"
160The gvpe config file consists of a series of lines that contain \f(CW\*(C`variable 160The 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
162extend to the end of the line. They can be used on their own lines, or 162extend to the end of the line. They can be used on their own lines, or
163after any directives. Spaces are allowed before or after the \f(CW\*(C`=\*(C'\fR sign or 163after any directives. Whitespace is allowed around the \f(CW\*(C`=\*(C'\fR sign or after
164after values, but not within the variable names or values themselves. 164values, but not within the variable names or values themselves.
165.PP 165.PP
166The only exception to the above is the \*(L"on\*(R" directive that can prefix any 166The 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
202(default: \f(CW127.0.0.1\fR, changing it is highly recommended). 202(default: \f(CW127.0.0.1\fR, changing it is highly recommended).
203.IP "dns-forw-port = port-number" 4 203.IP "dns-forw-port = port-number" 4
204.IX Item "dns-forw-port = port-number" 204.IX Item "dns-forw-port = port-number"
205The port where the \f(CW\*(C`dns\-forw\-host\*(C'\fR is to be contacted (default: \f(CW53\fR, 205The port where the \f(CW\*(C`dns\-forw\-host\*(C'\fR is to be contacted (default: \f(CW53\fR,
206which is fine in most cases). 206which is fine in most cases).
207.IP "dns-max-outstanding = integer-number-of-requests" 4
208.IX Item "dns-max-outstanding = integer-number-of-requests"
209The maximum number of outstanding \s-1DNS\s0 transport requests
210(default: \f(CW100\fR). \s-1GVPE\s0 will never issue more requests then the given
211limit without receiving replies. In heavily overloaded situations it might
212help to set this to a low number (e.g. \f(CW3\fR or even \f(CW1\fR) to limit the
213number of parallel requests.
214.Sp
215The default should be working ok for most links.
216.IP "dns-overlap-factor = float" 4
217.IX Item "dns-overlap-factor = float"
218The \s-1DNS\s0 transport uses the minimum request latency (\fBmin_latency\fR) seen
219during a connection as it's timing base. This factor (default: \f(CW0.5\fR,
220must be > 0) is multiplied by \fBmin_latency\fR to get the maximum sending
221rate (= minimum send interval), i.e. a factor of \f(CW1\fR means that a new
222request might be generated every \fBmin_latency\fR seconds, which means on
223average there should only ever be one outstanding request. A factor of
224\&\f(CW0.5\fR means that \s-1GVPE\s0 will send requests twice as often as the minimum
225latency measured.
226.Sp
227For congested or picky dns forwarders you could use a value nearer to or
228exceeding \f(CW1\fR.
229.Sp
230The default should be working ok for most links.
231.IP "dns-send-interval = send-interval-in-seconds" 4
232.IX Item "dns-send-interval = send-interval-in-seconds"
233The minimum send interval (= maximum rate) that the \s-1DNS\s0 transport will
234use to send new \s-1DNS\s0 requests. \s-1GVPE\s0 will not exceed this rate even when
235the latency is very low. The default is \f(CW0.01\fR, which means \s-1GVPE\s0 will
236not send more than 100 \s-1DNS\s0 requests per connection per second. For
237high-bandwidth links you could go lower, e.g. to \f(CW0.001\fR or so. For
238congested or rate-limited links, you might want to go higher, say \f(CW0.1\fR,
239\&\f(CW0.2\fR or even higher.
240.Sp
241The default should be working ok for most links.
242.IP "dns-timeout-factor = float" 4
243.IX Item "dns-timeout-factor = float"
244Factor to multiply the \f(CW\*(C`min_latency\*(C'\fR (see \f(CW\*(C`dns\-overlap\-factor\*(C'\fR) by to
245get request timeouts. The default of \f(CW8\fR means that the \s-1DNS\s0 transport
246will resend the request when no reply has been received for longer than
247eight times the minimum (= expected) latency, assuming the request or
248reply has been lost.
249.Sp
250For congested links a higher value might be necessary (e.g. \f(CW30\fR). If
251the link is very stable lower values (e.g. \f(CW2\fR) might work
252nicely. Values near or below \f(CW1\fR makes no sense whatsoever.
253.Sp
254The default should be working ok for most links but will result in low
255throughput if packet loss is high.
207.IP "if-up = relative-or-absolute-path" 4 256.IP "if-up = relative-or-absolute-path" 4
208.IX Item "if-up = relative-or-absolute-path" 257.IX Item "if-up = relative-or-absolute-path"
209Sets the path of a script that should be called immediately after the 258Sets the path of a script that should be called immediately after the
210network interface is initialized (but not neccessarily up). The following 259network interface is initialized (but not neccessarily up). The following
211environment variables are passed to it (the values are just examples): 260environment variables are passed to it (the values are just examples).
261.Sp
262Variables that have the same value on all nodes:
212.RS 4 263.RS 4
213.IP "CONFBASE=/etc/gvpe" 4 264.IP "CONFBASE=/etc/gvpe" 4
214.IX Item "CONFBASE=/etc/gvpe" 265.IX Item "CONFBASE=/etc/gvpe"
215The configuration base directory. 266The configuration base directory.
216.IP "IFNAME=vpn0" 4 267.IP "IFNAME=vpn0" 4
217.IX Item "IFNAME=vpn0" 268.IX Item "IFNAME=vpn0"
218The interface to initialize. 269The network interface to initialize.
219.IP "MTU=1436" 4
220.IX Item "MTU=1436"
221The \s-1MTU\s0 to set the interface to. You can use lower values (if done
222consistently on all hosts), but this is usually ineffective.
223.IP "MAC=fe:fd:80:00:00:01" 4
224.IX Item "MAC=fe:fd:80:00:00:01"
225The \s-1MAC\s0 address to set the interface to. The script *must* set the
226interface \s-1MAC\s0 to this value. You will most likely use one of these:
227.Sp
228.Vb 2
229\& ip link set $IFNAME address $MAC mtu $MTU up # GNU/Linux
230\& ifconfig $IFNAME ether $MAC mtu $MTU up # FreeBSD
231.Ve
232.Sp
233Please see the \f(CW\*(C`gvpe.osdep(5)\*(C'\fR manpage for platform-specific information.
234.IP "IFTYPE=native # or tincd" 4 270.IP "IFTYPE=native # or tincd" 4
235.IX Item "IFTYPE=native # or tincd" 271.IX Item "IFTYPE=native # or tincd"
236.PD 0 272.PD 0
237.IP "IFSUBTYPE=linux # or freebsd, darwin etc.." 4 273.IP "IFSUBTYPE=linux # or freebsd, darwin etc.." 4
238.IX Item "IFSUBTYPE=linux # or freebsd, darwin etc.." 274.IX Item "IFSUBTYPE=linux # or freebsd, darwin etc.."
239.PD 275.PD
240The interface type (\f(CW\*(C`native\*(C'\fR or \f(CW\*(C`tincd\*(C'\fR) and the subtype (usually the os 276The interface type (\f(CW\*(C`native\*(C'\fR or \f(CW\*(C`tincd\*(C'\fR) and the subtype (usually the
241name in lowercase) that this gvpe was configured for. Can be used to select 277\&\s-1OS\s0 name in lowercase) that this \s-1GVPE\s0 was configured for. Can be used to
242the correct syntax to use for network-related commands. 278select the correct syntax to use for network-related commands.
279.IP "MTU=1436" 4
280.IX Item "MTU=1436"
281The \s-1MTU\s0 to set the interface to. You can use lower values (if done
282consistently on all hosts), but this is usually ineffective.
283.IP "NODES=5" 4
284.IX Item "NODES=5"
285The number of nodes in this \s-1GVPE\s0 network.
286.RE
287.RS 4
288.Sp
289Variables that are node-specific and with values pertaining to the node
290running this \s-1GVPE:\s0
291.IP "IFUPDATA=string" 4
292.IX Item "IFUPDATA=string"
293The value of the configuration directive \f(CW\*(C`if\-up\-data\*(C'\fR.
294.IP "MAC=fe:fd:80:00:00:01" 4
295.IX Item "MAC=fe:fd:80:00:00:01"
296The \s-1MAC\s0 address the network interface has to use.
297.Sp
298Might be used to initialize interfaces on platforms where \s-1GVPE\s0 does not
299do this automatically. Please see the \f(CW\*(C`gvpe.osdep(5)\*(C'\fR manpage for
300platform-specific information.
243.IP "NODENAME=branch1" 4 301.IP "NODENAME=branch1" 4
244.IX Item "NODENAME=branch1" 302.IX Item "NODENAME=branch1"
245The nickname of the current node, as passed to the gvpe daemon. 303The nickname of the node.
246.IP "NODEID=1" 4 304.IP "NODEID=1" 4
247.IX Item "NODEID=1" 305.IX Item "NODEID=1"
248The numerical node id of the current node. The first node mentioned in the 306The numerical node \s-1ID\s0 of the node running this instance of \s-1GVPE\s0. The first
249config file gets \s-1ID\s0 1, the second \s-1ID\s0 2 and so on. 307node mentioned in the config file gets \s-1ID\s0 1, the second \s-1ID\s0 2 and so on.
250.RE 308.RE
251.RS 4 309.RS 4
252.Sp 310.Sp
311In addition, all node-specific variables (except \f(CW\*(C`NODEID\*(C'\fR) will be
312available with a postfix of \f(CW\*(C`_nodeid\*(C'\fR, which contains the value for that
313node, e.g. the \f(CW\*(C`MAC_1\*(C'\fR variable contains the \s-1MAC\s0 address of node #1, while
314the \f(CW\*(C`NODENAME_22\*(C'\fR variable contains the name of node #22.
315.Sp
253Here is a simple if-up script: 316Here is a simple if-up script:
254.Sp 317.Sp
255.Vb 5 318.Vb 5
256\& #!/bin/sh 319\& #!/bin/sh
257\& ip link set $IFNAME address $MAC mtu $MTU up 320\& ip link set $IFNAME up
258\& [ $NODENAME = branch1 ] && ip addr add 10.0.0.1 dev $IFNAME 321\& [ $NODENAME = branch1 ] && ip addr add 10.0.0.1 dev $IFNAME
259\& [ $NODENAME = branch2 ] && ip addr add 10.1.0.1 dev $IFNAME 322\& [ $NODENAME = branch2 ] && ip addr add 10.1.0.1 dev $IFNAME
260\& ip route add 10.0.0.0/8 dev $IFNAME 323\& ip route add 10.0.0.0/8 dev $IFNAME
261.Ve 324.Ve
262.Sp 325.Sp
350used to select the right configuration section and must be passed as an 413used to select the right configuration section and must be passed as an
351argument to the gvpe daemon. 414argument to the gvpe daemon.
352.IP "node-up = relative-or-absolute-path" 4 415.IP "node-up = relative-or-absolute-path" 4
353.IX Item "node-up = relative-or-absolute-path" 416.IX Item "node-up = relative-or-absolute-path"
354Sets a command (default: no script) that should be called whenever a 417Sets a command (default: no script) that should be called whenever a
355connection is established (even on rekeying operations). In addition 418connection is established (even on rekeying operations). In addition to
356to the variables passed to \f(CW\*(C`if\-up\*(C'\fR scripts, the following environment 419all the variables passed to \f(CW\*(C`if\-up\*(C'\fR scripts, the following environment
357variables will be set: 420variables will be set:
358.RS 4 421.RS 4
359.IP "DESTNODE=branch2" 4 422.IP "DESTNODE=branch2" 4
360.IX Item "DESTNODE=branch2" 423.IX Item "DESTNODE=branch2"
361The name of the remote node. 424The name of the remote node.
412reestablished every \f(CW\*(C`rekey\*(C'\fR seconds. 475reestablished every \f(CW\*(C`rekey\*(C'\fR seconds.
413.Sh "\s-1NODE\s0 \s-1SPECIFIC\s0 \s-1SETTINGS\s0" 476.Sh "\s-1NODE\s0 \s-1SPECIFIC\s0 \s-1SETTINGS\s0"
414.IX Subsection "NODE SPECIFIC SETTINGS" 477.IX Subsection "NODE SPECIFIC SETTINGS"
415The following settings are node\-specific, that is, every node can have 478The following settings are node\-specific, that is, every node can have
416different settings, even within the same gvpe instance. Settings that are 479different settings, even within the same gvpe instance. Settings that are
417executed before the first node section set the defaults, settings that are 480set before the first node section set the defaults, settings that are
418executed within a node section only apply to the given node. 481set within a node section only apply to the given node.
482.IP "allow-direct = nodename" 4
483.IX Item "allow-direct = nodename"
484Allow direct connections to this node. See \f(CW\*(C`deny\-direct\*(C'\fR for more info.
419.IP "compress = yes|true|on | no|false|off" 4 485.IP "compress = yes|true|on | no|false|off" 4
420.IX Item "compress = yes|true|on | no|false|off" 486.IX Item "compress = yes|true|on | no|false|off"
421Wether to compress data packets sent to this host (default: \f(CW\*(C`yes\*(C'\fR). 487Wether to compress data packets sent to this host (default: \f(CW\*(C`yes\*(C'\fR).
422Compression is really cheap even on slow computers and has no size 488Compression is really cheap even on slow computers and has no size
423overhead at all, so enabling this is a good idea. 489overhead at all, so enabling this is a good idea.
427try to establish and keep a connection to the given host), \f(CW\*(C`never\*(C'\fR 493try to establish and keep a connection to the given host), \f(CW\*(C`never\*(C'\fR
428(never initiate a connection to the given host, but accept connections), 494(never initiate a connection to the given host, but accept connections),
429\&\f(CW\*(C`ondemand\*(C'\fR (try to establish a connection on the first packet sent, and 495\&\f(CW\*(C`ondemand\*(C'\fR (try to establish a connection on the first packet sent, and
430take it down after the keepalive interval) or \f(CW\*(C`disabled\*(C'\fR (node is bad, 496take it down after the keepalive interval) or \f(CW\*(C`disabled\*(C'\fR (node is bad,
431don't talk to it). 497don't talk to it).
498.IP "deny-direct = nodename | *" 4
499.IX Item "deny-direct = nodename | *"
500Deny direct connections to the specified node (or all nodes when \f(CW\*(C`*\*(C'\fR
501is given). Only one node can be specified, but you can use multiple
502\&\f(CW\*(C`allow\-direct\*(C'\fR and \f(CW\*(C`deny\-direct\*(C'\fR statements. This only makes sense in
503networks with routers, as routers are required for indirect connections.
504.Sp
505Sometimes, a node cannot reach some other nodes for reasons of network
506connectivity. For example, a node behind a firewall that only allows
507conenctions to/from a single other node in the network. In this case one
508should specify \f(CW\*(C`deny\-direct = *\*(C'\fR and \f(CW\*(C`allow\-direct = othernodename\*(C'\fR (the other
509node \fImust\fR be a router for this to work).
510.Sp
511The algorithm to check wether a connection may be direct is as follows:
512.Sp
5131. Other node mentioned in a \f(CW\*(C`allow\-direct\*(C'\fR? If yes, allow the connection.
514.Sp
5152. Other node mentioned in a \f(CW\*(C`deny\-direct\*(C'\fR? If yes, deny direct connections.
516.Sp
5173. Allow the connection.
518.Sp
519That is, \f(CW\*(C`allow\-direct\*(C'\fR takes precedence over \f(CW\*(C`deny\-direct\*(C'\fR.
520.Sp
521The check is done in both directions, i.e. both nodes must allow a direct
522connection before one is attempted, so you only need to specify connect
523limitations on one node.
432.IP "dns-domain = domain-suffix" 4 524.IP "dns-domain = domain-suffix" 4
433.IX Item "dns-domain = domain-suffix" 525.IX Item "dns-domain = domain-suffix"
434The \s-1DNS\s0 domain suffix that points to the \s-1DNS\s0 tunnel server. Needs to be 526The \s-1DNS\s0 domain suffix that points to the \s-1DNS\s0 tunnel server for this node.
435set on both client and server.
436.Sp 527.Sp
437The domain must point to a \s-1NS\s0 record that points to the \fIdns-hostname\fR, 528The domain must point to a \s-1NS\s0 record that points to the \fIdns-hostname\fR,
438i.e. 529i.e.
439.Sp 530.Sp
440.Vb 2 531.Vb 2
453The address to bind the \s-1DNS\s0 tunnel socket to, similar to the \f(CW\*(C`hostname\*(C'\fR, 544The address to bind the \s-1DNS\s0 tunnel socket to, similar to the \f(CW\*(C`hostname\*(C'\fR,
454but for the \s-1DNS\s0 tunnel protocol only. Default: \f(CW0.0.0.0\fR, but that might 545but for the \s-1DNS\s0 tunnel protocol only. Default: \f(CW0.0.0.0\fR, but that might
455change. 546change.
456.IP "dns-port = port-number" 4 547.IP "dns-port = port-number" 4
457.IX Item "dns-port = port-number" 548.IX Item "dns-port = port-number"
458The port to bind the \s-1DNS\s0 tunnel socket to. Must be \f(CW0\fR on all \s-1DNS\s0 tunnel 549The port to bind the \s-1DNS\s0 tunnel socket to. Must be \f(CW53\fR on \s-1DNS\s0 tunnel servers.
459clients and \f(CW53\fR on the server. 550.IP "enable-dns = yes|true|on | no|false|off" 4
551.IX Item "enable-dns = yes|true|on | no|false|off"
552See \fIgvpe.protocol\fR\|(7) for a description of the \s-1DNS\s0 transport
553protocol. Avoid this protocol if you can.
554.Sp
555Enable the \s-1DNS\s0 tunneling protocol on this node, either as server or as
556client. Support for this transport protocol is only available when gvpe
557was compiled using the \f(CW\*(C`\-\-enable\-dns\*(C'\fR option.
558.IP "enable-icmp = yes|true|on | no|false|off" 4
559.IX Item "enable-icmp = yes|true|on | no|false|off"
560See \fIgvpe.protocol\fR\|(7) for a description of the \s-1ICMP\s0 transport protocol.
561.Sp
562Enable the \s-1ICMP\s0 transport using icmp packets of type \f(CW\*(C`icmp\-type\*(C'\fR on this
563node.
460.IP "enable-rawip = yes|true|on | no|false|off" 4 564.IP "enable-rawip = yes|true|on | no|false|off" 4
461.IX Item "enable-rawip = yes|true|on | no|false|off" 565.IX Item "enable-rawip = yes|true|on | no|false|off"
566See \fIgvpe.protocol\fR\|(7) for a description of the \s-1RAW\s0 \s-1IP\s0 transport protocol.
567.Sp
462Enable the \s-1RAW\s0 IPv4 transport using the \f(CW\*(C`ip\-proto\*(C'\fR protocol 568Enable the \s-1RAW\s0 IPv4 transport using the \f(CW\*(C`ip\-proto\*(C'\fR protocol
463(default: \f(CW\*(C`no\*(C'\fR). This is the best choice, since the overhead per packet 569(default: \f(CW\*(C`no\*(C'\fR).
464is only 38 bytes, as opposed to \s-1UDP\s0's 58 (or \s-1TCP\s0's 60+).
465.IP "enable-tcp = yes|true|on | no|false|off" 4 570.IP "enable-tcp = yes|true|on | no|false|off" 4
466.IX Item "enable-tcp = yes|true|on | no|false|off" 571.IX Item "enable-tcp = yes|true|on | no|false|off"
572See \fIgvpe.protocol\fR\|(7) for a description of the \s-1TCP\s0 transport protocol.
573.Sp
467Enable the TCPv4 transport using the \f(CW\*(C`tcp\-port\*(C'\fR port 574Enable the TCPv4 transport using the \f(CW\*(C`tcp\-port\*(C'\fR port
468(default: \f(CW\*(C`no\*(C'\fR). Support for this horribly unsuitable protocol is only 575(default: \f(CW\*(C`no\*(C'\fR). Support for this transport protocol is only available
469available when gvpe was compiled using the \f(CW\*(C`\-\-enable\-tcp\*(C'\fR option. Never 576when gvpe was compiled using the \f(CW\*(C`\-\-enable\-tcp\*(C'\fR option.
470use this transport unless you really must, it is horribly ineffiecent and
471resource-intensive compared to the other transports.
472.IP "enable-udp = yes|true|on | no|false|off" 4 577.IP "enable-udp = yes|true|on | no|false|off" 4
473.IX Item "enable-udp = yes|true|on | no|false|off" 578.IX Item "enable-udp = yes|true|on | no|false|off"
579See \fIgvpe.protocol\fR\|(7) for a description of the \s-1UDP\s0 transport protocol.
580.Sp
474Enable the UDPv4 transport using the \f(CW\*(C`udp\-port\*(C'\fR port (default: \f(CW\*(C`no\*(C'\fR, 581Enable the UDPv4 transport using the \f(CW\*(C`udp\-port\*(C'\fR port (default: \f(CW\*(C`no\*(C'\fR,
475unless no other protocol is enabled for a node, in which case this 582unless no other protocol is enabled for a node, in which case this
476protocol is enabled automatically). This is a good general choice since 583protocol is enabled automatically).
477\&\s-1UDP\s0 tunnels well through many firewalls.
478.Sp 584.Sp
479\&\s-1NOTE:\s0 Please specify \f(CW\*(C`enable\-udp = yes\*(C'\fR if you want t use it even though 585\&\s-1NOTE:\s0 Please specify \f(CW\*(C`enable\-udp = yes\*(C'\fR if you want t use it even though
480it might get switched on automatically, as some future version might 586it might get switched on automatically, as some future version might
481default to another default protocol. 587default to another default protocol.
588.IP "hostname = hostname | ip [can not be defaulted]" 4
589.IX Item "hostname = hostname | ip [can not be defaulted]"
590Forces the address of this node to be set to the given dns hostname or ip
591address. It will be resolved before each connect request, so dyndns should
592work fine. If this setting is not specified and a router is available,
593then the router will be queried for the address of this node. Otherwise,
594the connection attempt will fail.
595.IP "icmp-type = integer" 4
596.IX Item "icmp-type = integer"
597Sets the type value to be used for outgoing (and incoming) packets sent
598via the \s-1ICMP\s0 transport.
599.Sp
600The default is \f(CW0\fR (which is \f(CW\*(C`echo\-reply\*(C'\fR, also known as
601\&\*(L"ping\-replies\*(R"). Other useful values include \f(CW8\fR (\f(CW\*(C`echo\-request\*(C'\fR, a.k.a.
602\&\*(L"ping\*(R") and \f(CW11\fR (\f(CW\*(C`time\-exceeded\*(C'\fR), but any 8\-bit value can be used.
603.IP "if-up-data = value" 4
604.IX Item "if-up-data = value"
605The value specified using this directive will be passed to the \f(CW\*(C`if\-up\*(C'\fR
606script in the environment variable \f(CW\*(C`IFUPDATA\*(C'\fR.
482.IP "inherit-tos = yes|true|on | no|false|off" 4 607.IP "inherit-tos = yes|true|on | no|false|off" 4
483.IX Item "inherit-tos = yes|true|on | no|false|off" 608.IX Item "inherit-tos = yes|true|on | no|false|off"
484Wether to inherit the \s-1TOS\s0 settings of packets sent to the tunnel when 609Wether to inherit the \s-1TOS\s0 settings of packets sent to the tunnel when
485sending packets to this node (default: \f(CW\*(C`yes\*(C'\fR). If set to \f(CW\*(C`yes\*(C'\fR then 610sending packets to this node (default: \f(CW\*(C`yes\*(C'\fR). If set to \f(CW\*(C`yes\*(C'\fR then
486outgoing tunnel packets will have the same \s-1TOS\s0 setting as the packets sent 611outgoing tunnel packets will have the same \s-1TOS\s0 setting as the packets sent
487to the tunnel device, which is usually what you want. 612to the tunnel device, which is usually what you want.
488.IP "max-retry = positive-number" 4 613.IP "max-retry = positive-number" 4
489.IX Item "max-retry = positive-number" 614.IX Item "max-retry = positive-number"
490The maximum interval in seconds (default: \f(CW28800\fR, 8 hours) between 615The maximum interval in seconds (default: \f(CW3600\fR, one hour) between
491retries to establish a connection to this node. When a connection cannot 616retries to establish a connection to this node. When a connection cannot
492be established, gvpe uses exponential backoff capped at this value. It's 617be established, gvpe uses exponential backoff capped at this value. It's
493sometimes useful to set this to a much lower value (e.g. \f(CW120\fR) on 618sometimes useful to set this to a much lower value (e.g. \f(CW120\fR) on
494connections to routers that usually are stable but sometimes are down, to 619connections to routers that usually are stable but sometimes are down, to
495assure quick reconnections. 620assure quick reconnections even after longer downtimes.
496.IP "router-priority = 0 | 1 | positive\-number>2" 4 621.IP "router-priority = 0 | 1 | positive\-number>=2" 4
497.IX Item "router-priority = 0 | 1 | positive-number>2" 622.IX Item "router-priority = 0 | 1 | positive-number>=2"
498Sets the router priority of the given host (default: \f(CW0\fR, disabled). If 623Sets the router priority of the given host (default: \f(CW0\fR, disabled). If
499some host tries to connect to another host without a hostname, it asks 624some host tries to connect to another host without a hostname, it asks
500the router host for it's \s-1IP\s0 address. The router host is the one with the 625the router host for it's \s-1IP\s0 address. The router host is the one with the
501highest priority larger than \f(CW1\fR that is currently reachable. 626highest priority larger than \f(CW1\fR that is currently reachable.
502.Sp 627.Sp
538.SH "SEE ALSO" 663.SH "SEE ALSO"
539.IX Header "SEE ALSO" 664.IX Header "SEE ALSO"
540\&\fIgvpe\fR\|(5), \fIgvpe\fR\|(8), \fIgvpectrl\fR\|(8). 665\&\fIgvpe\fR\|(5), \fIgvpe\fR\|(8), \fIgvpectrl\fR\|(8).
541.SH "AUTHOR" 666.SH "AUTHOR"
542.IX Header "AUTHOR" 667.IX Header "AUTHOR"
543Marc Lehmann <gvpe@plan9.de> 668Marc Lehmann <gvpe@schmorp.de>

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines