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.23 by pcg, Mon Mar 23 15:22:00 2009 UTC vs.
Revision 1.24 by pcg, Sat Jul 18 05:59:16 2009 UTC

… …
314is established (even on rekeying operations). Note that node-up/down 314is established (even on rekeying operations). Note that node-up/down
315scripts will be run asynchronously, but execution is serialised, so there 315scripts will be run asynchronously, but execution is serialised, so there
316will only ever be one such script running. 316will only ever be one such script running.
317 317
318In addition to all the variables passed to C<if-up> scripts, the following 318In addition to all the variables passed to C<if-up> scripts, the following
319environment variables will be set: 319environment variables will be set (values are just examples):
320 320
321=over 4 321=over 4
322 322
323=item DESTNODE=branch2 323=item DESTNODE=branch2
324 324
325The name of the remote node. 325The name of the remote node.
326 326
327=item DESTID=2 327=item DESTID=2
328 328
329The node id of the remote node. 329The node id of the remote node.
330
331=item DESTSI=rawip/88.99.77.55:0
332
333The "socket info" of the target node, protocol dependent but usually in
334the format protocol/ip:port.
330 335
331=item DESTIP=188.13.66.8 336=item DESTIP=188.13.66.8
332 337
333The numerical IP address of the remote node (gvpe accepts connections from 338The numerical IP address of the remote node (gvpe accepts connections from
334everywhere, as long as the other node can authenticate itself). 339everywhere, as long as the other node can authenticate itself).
335 340
336=item DESTPORT=655 # deprecated 341=item DESTPORT=655 # deprecated
337 342
338The UDP port used by the other side. 343The protocol port used by the other side, if applicable.
339 344
340=item STATE=UP 345=item STATE=up
341 346
342Node-up scripts get called with STATE=UP, node-down scripts get called 347Node-up scripts get called with STATE=up, node-change scripts get called
343with STATE=DOWN. 348with STATE=change and node-down scripts get called with STATE=down.
344 349
345=back 350=back
346 351
347Here is a nontrivial example that uses nsupdate to update the name => ip 352Here is a nontrivial example that uses nsupdate to update the name => ip
348mapping in some DNS zone: 353mapping in some DNS zone:
… …
352 echo update delete $DESTNODE.lowttl.example.net. a 357 echo update delete $DESTNODE.lowttl.example.net. a
353 echo update add $DESTNODE.lowttl.example.net. 1 in a $DESTIP 358 echo update add $DESTNODE.lowttl.example.net. 1 in a $DESTIP
354 echo 359 echo
355 } | nsupdate -d -k $CONFBASE:key.example.net. 360 } | nsupdate -d -k $CONFBASE:key.example.net.
356 361
362=item node-change = relative-or-absolute-path
363
364Same as C<node-change>, but gets called whenever something about a
365connection changes (such as the source IP address).
366
357=item node-down = relative-or-absolute-path 367=item node-down = relative-or-absolute-path
358 368
359Same as C<node-up>, but gets called whenever a connection is lost. 369Same as C<node-up>, but gets called whenever a connection is lost.
360 370
361=item pid-file = path 371=item pid-file = path

Diff Legend

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