mirror/openvpn
0
0
Fork 0
mirror of https://github.com/OpenVPN/openvpn.git synced 2024-09-20 03:52:28 +02:00
Code

script-options.rst: Update ifconfig_* variables

Browse Source 
- 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>
This commit is contained in:
Frank Lichtenheld 2024-03-21 17:16:23 +01:00 committed by Gert Doering
parent 4b95656536
commit a94226cdc8
1 changed files with 27 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

38
doc/man-sections/script-options.rst
View File

@ -682,13 +682,6 @@ instances.
recorded to this environmental variable sequence prior to ``--up`` recorded to this environmental variable sequence prior to ``--up``
script execution. script execution.
:code:`ifconfig_broadcast`
The broadcast address for the virtual ethernet segment which is derived
from the ``--ifconfig`` option when ``--dev tap`` is used. Set prior to
OpenVPN calling the :code:`ifconfig` or :code:`netsh` (windows version
of ifconfig) commands which normally occurs prior to ``--up`` script
execution.
:code:`ifconfig_ipv6_local` :code:`ifconfig_ipv6_local`
The local VPN endpoint IPv6 address specified in the The local VPN endpoint IPv6 address specified in the
``--ifconfig-ipv6`` option (first parameter). Set prior to OpenVPN ``--ifconfig-ipv6`` option (first parameter). Set prior to OpenVPN
@ -731,30 +724,53 @@ instances.
occurs prior to ``--up`` script execution. occurs prior to ``--up`` script execution.
:code:`ifconfig_pool_local_ip` :code:`ifconfig_pool_local_ip`
The local virtual IP address for the TUN/TAP tunnel taken from an The local virtual IPv4 address for the TUN/TAP tunnel taken from an
``--ifconfig-push`` directive if specified, or otherwise from the ``--ifconfig-push`` directive if specified, or otherwise from the
ifconfig pool (controlled by the ``--ifconfig-pool`` config file ifconfig pool (controlled by the ``--ifconfig-pool`` config file
directive). Only set for ``--dev tun`` tunnels. This option is set on directive). Only set for ``--dev tun`` tunnels. This option is set on
the server prior to execution of the ``--client-connect`` and the server prior to execution of the ``--client-connect`` and
``--client-disconnect`` scripts. ``--client-disconnect`` scripts.
:code:`ifconfig_pool_local_ip6`
The local virtual IPv6 address for the TUN/TAP tunnel taken from an
``--ifconfig-ipv6-push`` directive if specified, or otherwise from the
ifconfig pool (controlled by the ``--ifconfig-ipv6-pool`` config file
directive). Only set for ``--dev tun`` tunnels. This option is set on
the server prior to execution of the ``--client-connect`` and
``--client-disconnect`` scripts.
:code:`ifconfig_pool_netmask` :code:`ifconfig_pool_netmask`
The virtual IP netmask for the TUN/TAP tunnel taken from an The virtual IPv4 netmask for the TUN/TAP tunnel taken from an
``--ifconfig-push`` directive if specified, or otherwise from the ``--ifconfig-push`` directive if specified, or otherwise from the
ifconfig pool (controlled by the ``--ifconfig-pool`` config file ifconfig pool (controlled by the ``--ifconfig-pool`` config file
directive). Only set for ``--dev tap`` tunnels. This option is set on directive). Only set for ``--dev tap`` tunnels. This option is set on
the server prior to execution of the ``--client-connect`` and the server prior to execution of the ``--client-connect`` and
``--client-disconnect`` scripts. ``--client-disconnect`` scripts.
:code:`ifconfig_pool_ip6_netbits`
The virtual IPv6 prefix length for the TUN/TAP tunnel taken from an
``--ifconfig-ipv6-push`` directive if specified, or otherwise from the
ifconfig pool (controlled by the ``--ifconfig-ipv6-pool`` config file
directive). Only set for ``--dev tap`` tunnels. This option is set on
the server prior to execution of the ``--client-connect`` and
``--client-disconnect`` scripts.
:code:`ifconfig_pool_remote_ip` :code:`ifconfig_pool_remote_ip`
The remote virtual IP address for the TUN/TAP tunnel taken from an The remote virtual IPv4 address for the TUN/TAP tunnel taken from an
``--ifconfig-push`` directive if specified, or otherwise from the ``--ifconfig-push`` directive if specified, or otherwise from the
ifconfig pool (controlled by the ``--ifconfig-pool`` config file ifconfig pool (controlled by the ``--ifconfig-pool`` config file
directive). This option is set on the server prior to execution of the directive). This option is set on the server prior to execution of the
``--client-connect`` and ``--client-disconnect`` scripts. ``--client-connect`` and ``--client-disconnect`` scripts.
:code:`ifconfig_pool_remote_ip6`
The remote virtual IPv6 address for the TUN/TAP tunnel taken from an
``--ifconfig-ipv6-push`` directive if specified, or otherwise from the
ifconfig pool (controlled by the ``--ifconfig-ipv6-pool`` config file
directive). This option is set on the server prior to execution of the
``--client-connect`` and ``--client-disconnect`` scripts.
:code:`link_mtu` :code:`link_mtu`
No longer passed to scripts since OpenVPN 2.6.0. Used to be the *REMOVED* No longer passed to scripts since OpenVPN 2.6.0. Used to be the
maximum packet size (not including the IP header) of tunnel data in maximum packet size (not including the IP header) of tunnel data in
UDP tunnel transport mode. UDP tunnel transport mode.