Browse code

script-options.rst: Update ifconfig_* variables

- Remove obsolete ifconfig_broadcast. Since this was
removed in 2.5.0, do not add a removal note but just
completely remove it.
- Add missing documentation of IPv6 variants for
ifconfig_pool_* variables.

Github: fixes Openvpn/openvpn#527
Change-Id: Ia8c8de6799f0291fc900628fbd06c8a414e741ca
Signed-off-by: Frank Lichtenheld <frank@lichtenheld.com>
Acked-by: Gert Doering <gert@greenie.muc.de>
Message-Id: <20240321161623.2794161-1-frank@lichtenheld.com>
URL: https://www.mail-archive.com/openvpn-devel@lists.sourceforge.net/msg28438.html
Signed-off-by: Gert Doering <gert@greenie.muc.de>
(cherry picked from commit a94226cdc8ed037a6763675aa47e6c821983f174)

Frank Lichtenheld authored on 2024/03/22 01:16:23
Showing 1 changed files
... ...
@@ -682,13 +682,6 @@ instances.
682 682
     recorded to this environmental variable sequence prior to ``--up``
683 683
     script execution.
684 684
 
685
-:code:`ifconfig_broadcast`
686
-    The broadcast address for the virtual ethernet segment which is derived
687
-    from the ``--ifconfig`` option when ``--dev tap`` is used. Set prior to
688
-    OpenVPN calling the :code:`ifconfig` or :code:`netsh` (windows version
689
-    of ifconfig) commands which normally occurs prior to ``--up`` script
690
-    execution.
691
-
692 685
 :code:`ifconfig_ipv6_local`
693 686
     The local VPN endpoint IPv6 address specified in the
694 687
     ``--ifconfig-ipv6`` option (first parameter). Set prior to OpenVPN
... ...
@@ -731,30 +724,53 @@ instances.
731 731
     occurs prior to ``--up`` script execution.
732 732
 
733 733
 :code:`ifconfig_pool_local_ip`
734
-    The local virtual IP address for the TUN/TAP tunnel taken from an
734
+    The local virtual IPv4 address for the TUN/TAP tunnel taken from an
735 735
     ``--ifconfig-push`` directive if specified, or otherwise from the
736 736
     ifconfig pool (controlled by the ``--ifconfig-pool`` config file
737 737
     directive). Only set for ``--dev tun`` tunnels. This option is set on
738 738
     the server prior to execution of the ``--client-connect`` and
739 739
     ``--client-disconnect`` scripts.
740 740
 
741
+:code:`ifconfig_pool_local_ip6`
742
+    The local virtual IPv6 address for the TUN/TAP tunnel taken from an
743
+    ``--ifconfig-ipv6-push`` directive if specified, or otherwise from the
744
+    ifconfig pool (controlled by the ``--ifconfig-ipv6-pool`` config file
745
+    directive). Only set for ``--dev tun`` tunnels. This option is set on
746
+    the server prior to execution of the ``--client-connect`` and
747
+    ``--client-disconnect`` scripts.
748
+
741 749
 :code:`ifconfig_pool_netmask`
742
-    The virtual IP netmask for the TUN/TAP tunnel taken from an
750
+    The virtual IPv4 netmask for the TUN/TAP tunnel taken from an
743 751
     ``--ifconfig-push`` directive if specified, or otherwise from the
744 752
     ifconfig pool (controlled by the ``--ifconfig-pool`` config file
745 753
     directive). Only set for ``--dev tap`` tunnels. This option is set on
746 754
     the server prior to execution of the ``--client-connect`` and
747 755
     ``--client-disconnect`` scripts.
748 756
 
757
+:code:`ifconfig_pool_ip6_netbits`
758
+    The virtual IPv6 prefix length for the TUN/TAP tunnel taken from an
759
+    ``--ifconfig-ipv6-push`` directive if specified, or otherwise from the
760
+    ifconfig pool (controlled by the ``--ifconfig-ipv6-pool`` config file
761
+    directive). Only set for ``--dev tap`` tunnels. This option is set on
762
+    the server prior to execution of the ``--client-connect`` and
763
+    ``--client-disconnect`` scripts.
764
+
749 765
 :code:`ifconfig_pool_remote_ip`
750
-    The remote virtual IP address for the TUN/TAP tunnel taken from an
766
+    The remote virtual IPv4 address for the TUN/TAP tunnel taken from an
751 767
     ``--ifconfig-push`` directive if specified, or otherwise from the
752 768
     ifconfig pool (controlled by the ``--ifconfig-pool`` config file
753 769
     directive). This option is set on the server prior to execution of the
754 770
     ``--client-connect`` and ``--client-disconnect`` scripts.
755 771
 
772
+:code:`ifconfig_pool_remote_ip6`
773
+    The remote virtual IPv6 address for the TUN/TAP tunnel taken from an
774
+    ``--ifconfig-ipv6-push`` directive if specified, or otherwise from the
775
+    ifconfig pool (controlled by the ``--ifconfig-ipv6-pool`` config file
776
+    directive). This option is set on the server prior to execution of the
777
+    ``--client-connect`` and ``--client-disconnect`` scripts.
778
+
756 779
 :code:`link_mtu`
757
-    No longer passed to scripts since OpenVPN 2.6.0.  Used to be the
780
+    *REMOVED* No longer passed to scripts since OpenVPN 2.6.0.  Used to be the
758 781
     maximum packet size (not including the IP header) of tunnel data in
759 782
     UDP tunnel transport mode.
760 783