Browse code

Document IPv6-related environment variables.

(ifconfig_ipv6_local, ifconfig_ipv6_netbits, ifconfig_ipv6_remote,
route_ipv6_network_{n}, route_ipv6_gateway_{n})

Signed-off-by: Gert Doering <gert@greenie.muc.de>
Acked-by: David Sommerseth <davids@redhat.com>
Signed-off-by: David Sommerseth <davids@redhat.com>

Gert Doering authored on 2012/02/05 02:18:45
Showing 1 changed files
... ...
@@ -5358,6 +5358,49 @@ normally occurs prior to
5358 5358
 script execution.
5359 5359
 .\"*********************************************************
5360 5360
 .TP
5361
+.B ifconfig_ipv6_local
5362
+The local VPN endpoint IPv6 address specified in the
5363
+.B \-\-ifconfig-ipv6
5364
+option (first parameter).
5365
+Set prior to OpenVPN calling the
5366
+.I ifconfig
5367
+or
5368
+.I netsh
5369
+(windows version of ifconfig) commands which
5370
+normally occurs prior to
5371
+.B \-\-up
5372
+script execution.
5373
+.\"*********************************************************
5374
+.TP
5375
+.B ifconfig_ipv6_netbits
5376
+The prefix length of the IPv6 network on the VPN interface.  Derived from
5377
+the /nnn parameter of the IPv6 address in the
5378
+.B \-\-ifconfig-ipv6
5379
+option (first parameter).
5380
+Set prior to OpenVPN calling the
5381
+.I ifconfig
5382
+or
5383
+.I netsh
5384
+(windows version of ifconfig) commands which
5385
+normally occurs prior to
5386
+.B \-\-up
5387
+script execution.
5388
+.\"*********************************************************
5389
+.TP
5390
+.B ifconfig_ipv6_remote
5391
+The remote VPN endpoint IPv6 address specified in the
5392
+.B \-\-ifconfig-ipv6
5393
+option (second parameter).
5394
+Set prior to OpenVPN calling the
5395
+.I ifconfig
5396
+or
5397
+.I netsh
5398
+(windows version of ifconfig) commands which
5399
+normally occurs prior to
5400
+.B \-\-up
5401
+script execution.
5402
+.\"*********************************************************
5403
+.TP
5361 5404
 .B ifconfig_local
5362 5405
 The local VPN endpoint IP address specified in the
5363 5406
 .B \-\-ifconfig
... ...
@@ -5557,6 +5600,26 @@ than their names as denoted on the command line
5557 5557
 or configuration file.
5558 5558
 .\"*********************************************************
5559 5559
 .TP
5560
+.B route_ipv6_{parm}_{n}
5561
+A set of variables which define each IPv6 route to be added, and
5562
+are set prior to
5563
+.B \-\-up
5564
+script execution.
5565
+
5566
+.B parm
5567
+will be one of "network" or "gateway" ("netmask" is contained as "/nnn"
5568
+in the route_ipv6_network_{n}, unlike IPv4 where it is passed in a separate
5569
+environment variable).
5570
+
5571
+.B n
5572
+is the OpenVPN route number, starting from 1.
5573
+
5574
+If the network or gateway are resolvable DNS names,
5575
+their IP address translations will be recorded rather
5576
+than their names as denoted on the command line
5577
+or configuration file.
5578
+.\"*********************************************************
5579
+.TP
5560 5580
 .B peer_cert
5561 5581
 Temporary file name containing the client certificate upon
5562 5582
 connection.  Useful in conjunction with --tls-verify