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.23 by pcg, Wed Sep 3 04:58:46 2008 UTC vs.
Revision 1.25 by pcg, Sat Jul 18 05:59:16 2009 UTC

… …
130.\} 130.\}
131.rm #[ #] #H #V #F C 131.rm #[ #] #H #V #F C
132.\" ======================================================================== 132.\" ========================================================================
133.\" 133.\"
134.IX Title "GVPE.CONF 5" 134.IX Title "GVPE.CONF 5"
135.TH GVPE.CONF 5 "2008-09-01" "2.2" "GNU Virtual Private Ethernet" 135.TH GVPE.CONF 5 "2009-06-01" "2.22" "GNU Virtual Private Ethernet"
136.\" For nroff, turn off justification. Always turn off hyphenation; it makes 136.\" For nroff, turn off justification. Always turn off hyphenation; it makes
137.\" way too many mistakes in technical documents. 137.\" way too many mistakes in technical documents.
138.if n .ad l 138.if n .ad l
139.nh 139.nh
140.SH "NAME" 140.SH "NAME"
… …
427is established (even on rekeying operations). Note that node\-up/down 427is established (even on rekeying operations). Note that node\-up/down
428scripts will be run asynchronously, but execution is serialised, so there 428scripts will be run asynchronously, but execution is serialised, so there
429will only ever be one such script running. 429will only ever be one such script running.
430.Sp 430.Sp
431In addition to all the variables passed to \f(CW\*(C`if\-up\*(C'\fR scripts, the following 431In addition to all the variables passed to \f(CW\*(C`if\-up\*(C'\fR scripts, the following
432environment variables will be set: 432environment variables will be set (values are just examples):
433.RS 4 433.RS 4
434.IP "DESTNODE=branch2" 4 434.IP "DESTNODE=branch2" 4
435.IX Item "DESTNODE=branch2" 435.IX Item "DESTNODE=branch2"
436The name of the remote node. 436The name of the remote node.
437.IP "DESTID=2" 4 437.IP "DESTID=2" 4
438.IX Item "DESTID=2" 438.IX Item "DESTID=2"
439The node id of the remote node. 439The node id of the remote node.
440.IP "DESTSI=rawip/88.99.77.55:0" 4
441.IX Item "DESTSI=rawip/88.99.77.55:0"
442The \*(L"socket info\*(R" of the target node, protocol dependent but usually in
443the format protocol/ip:port.
440.IP "DESTIP=188.13.66.8" 4 444.IP "DESTIP=188.13.66.8" 4
441.IX Item "DESTIP=188.13.66.8" 445.IX Item "DESTIP=188.13.66.8"
442The numerical \s-1IP\s0 address of the remote node (gvpe accepts connections from 446The numerical \s-1IP\s0 address of the remote node (gvpe accepts connections from
443everywhere, as long as the other node can authenticate itself). 447everywhere, as long as the other node can authenticate itself).
444.IP "DESTPORT=655 # deprecated" 4 448.IP "DESTPORT=655 # deprecated" 4
445.IX Item "DESTPORT=655 # deprecated" 449.IX Item "DESTPORT=655 # deprecated"
446The \s-1UDP\s0 port used by the other side. 450The protocol port used by the other side, if applicable.
447.IP "STATE=UP" 4 451.IP "STATE=up" 4
448.IX Item "STATE=UP" 452.IX Item "STATE=up"
449Node-up scripts get called with STATE=UP, node-down scripts get called 453Node-up scripts get called with STATE=up, node-change scripts get called
450with STATE=DOWN. 454with STATE=change and node-down scripts get called with STATE=down.
451.RE 455.RE
452.RS 4 456.RS 4
453.Sp 457.Sp
454Here is a nontrivial example that uses nsupdate to update the name => ip 458Here is a nontrivial example that uses nsupdate to update the name => ip
455mapping in some \s-1DNS\s0 zone: 459mapping in some \s-1DNS\s0 zone:
… …
461\& echo update add $DESTNODE.lowttl.example.net. 1 in a $DESTIP 465\& echo update add $DESTNODE.lowttl.example.net. 1 in a $DESTIP
462\& echo 466\& echo
463\& } | nsupdate \-d \-k $CONFBASE:key.example.net. 467\& } | nsupdate \-d \-k $CONFBASE:key.example.net.
464.Ve 468.Ve
465.RE 469.RE
470.IP "node-change = relative-or-absolute-path" 4
471.IX Item "node-change = relative-or-absolute-path"
472Same as \f(CW\*(C`node\-change\*(C'\fR, but gets called whenever something about a
473connection changes (such as the source \s-1IP\s0 address).
466.IP "node-down = relative-or-absolute-path" 4 474.IP "node-down = relative-or-absolute-path" 4
467.IX Item "node-down = relative-or-absolute-path" 475.IX Item "node-down = relative-or-absolute-path"
468Same as \f(CW\*(C`node\-up\*(C'\fR, but gets called whenever a connection is lost. 476Same as \f(CW\*(C`node\-up\*(C'\fR, but gets called whenever a connection is lost.
469.IP "pid-file = path" 4 477.IP "pid-file = path" 4
470.IX Item "pid-file = path" 478.IX Item "pid-file = path"
… …
484.IP "rekey = seconds" 4 492.IP "rekey = seconds" 4
485.IX Item "rekey = seconds" 493.IX Item "rekey = seconds"
486Sets the rekeying interval in seconds (default: \f(CW3600\fR). Connections are 494Sets the rekeying interval in seconds (default: \f(CW3600\fR). Connections are
487reestablished every \f(CW\*(C`rekey\*(C'\fR seconds, making them use a new encryption 495reestablished every \f(CW\*(C`rekey\*(C'\fR seconds, making them use a new encryption
488key. 496key.
497.IP "nfmark = integer" 4
498.IX Item "nfmark = integer"
499This advanced option, when set to a nonzero value (default: \f(CW0\fR), tries
500to set the netfilter mark (or fwmark) value on all sockets gvpe uses to
501send packets.
502.Sp
503This can be used to make gvpe use a different set of routing rules. For
504example, on GNU/Linux, the \f(CW\*(C`if\-up\*(C'\fR could set \f(CW\*(C`nfmark\*(C'\fR to 1000 and then
505put all routing rules into table \f(CW99\fR and then use an ip rule to make
506gvpe traffic avoid that routing table, in effect routing normal traffic
507via gvpe and gvpe traffic via the normal system routing tables:
508.Sp
509.Vb 1
510\& ip rule add not fwmark 1000 lookup 99
511.Ve
489.Sh "\s-1NODE\s0 \s-1SPECIFIC\s0 \s-1SETTINGS\s0" 512.Sh "\s-1NODE\s0 \s-1SPECIFIC\s0 \s-1SETTINGS\s0"
490.IX Subsection "NODE SPECIFIC SETTINGS" 513.IX Subsection "NODE SPECIFIC SETTINGS"
491The following settings are node-specific, that is, every node can have 514The following settings are node-specific, that is, every node can have
492different settings, even within the same gvpe instance. Settings that are 515different settings, even within the same gvpe instance. Settings that are
493set before the first node section set the defaults, settings that are 516set before the first node section set the defaults, settings that are

Diff Legend

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