From 98078b2609a0c8f8f325d7d9363f29facde1b1cd Mon Sep 17 00:00:00 2001 From: Dan Williams Date: Thu, 13 Aug 2009 16:56:44 -0500 Subject: [PATCH] vpn: document VPN Ip4Config key/value pairs --- include/NetworkManagerVPN.h | 35 +++++++++++++++++++++++++++++++++++ 1 file changed, 35 insertions(+) diff --git a/include/NetworkManagerVPN.h b/include/NetworkManagerVPN.h index c33c9b3edb..3d6b0fdee7 100644 --- a/include/NetworkManagerVPN.h +++ b/include/NetworkManagerVPN.h @@ -114,18 +114,53 @@ typedef enum { } NMVPNPluginFailure; +/* uint32: IP address of the public external VPN gateway (network byte order) */ #define NM_VPN_PLUGIN_IP4_CONFIG_EXT_GATEWAY "gateway" + +/* uint32: IP address of the internal gateway of the subnet the VPN interface is + * on (network byte order) + */ #define NM_VPN_PLUGIN_IP4_CONFIG_INT_GATEWAY "internal-gateway" + +/* uint32: IP address of the VPN interface (network byte order) */ #define NM_VPN_PLUGIN_IP4_CONFIG_ADDRESS "address" + +/* uint32: IP address of the other side of Point-to-Point connection if the VPN + * uses Point-to-Point configuration. (network byte order) + */ #define NM_VPN_PLUGIN_IP4_CONFIG_PTP "ptp" + +/* uint32: IP prefix of the VPN interface; 1 - 32 inclusive */ #define NM_VPN_PLUGIN_IP4_CONFIG_PREFIX "prefix" + +/* array of uint32: IP addresses of DNS servers for the VPN (network byte order) */ #define NM_VPN_PLUGIN_IP4_CONFIG_DNS "dns" + +/* array of uint32: IP addresses of NBNS/WINS servers for the VPN (network byte order) */ #define NM_VPN_PLUGIN_IP4_CONFIG_NBNS "nbns" + +/* uint32: Message Segment Size that the VPN interface should use */ #define NM_VPN_PLUGIN_IP4_CONFIG_MSS "mss" + +/* uint32: Maximum Transfer Unit that the VPN interface should use */ #define NM_VPN_PLUGIN_IP4_CONFIG_MTU "mtu" + +/* string: VPN interface name (tun0, tap0, etc) */ #define NM_VPN_PLUGIN_IP4_CONFIG_TUNDEV "tundev" + +/* string: DNS domain name */ #define NM_VPN_PLUGIN_IP4_CONFIG_DOMAIN "domain" + +/* string: Login message */ #define NM_VPN_PLUGIN_IP4_CONFIG_BANNER "banner" + +/* array of (uint32, uint32, uint32, uint32): custom routes the client should + * apply. In the order of: + * 1: destination IP address (network byte order) + * 2: destination prefix (1 - 32 inclusive) + * 3: IP address of next hop (network byte order) + * 4: route metric + */ #define NM_VPN_PLUGIN_IP4_CONFIG_ROUTES "routes" /* Deprecated */