applications/luci-openvpn/root/lib/uci/schema/default/openvpn

   1 mode m
   2 Set OpenVPN major mode
   3
   4 local host
   5 Local host name or IP address for bind
   6
   7 remote host [port]
   8 Remote host name or IP address
   9
  10 remote-random
  11 When multiple --remote address/ports are specified, initially randomize the order of the list as a kind of basic load-balancing measure
  12
  13 proto p
  14 Use protocol p for communicating with remote host
  15
  16 connect-retry n
  17 For --proto tcp-client, take n as the number of seconds to wait between connection retries (default=5)
  18
  19 connect-retry-max n
  20 For --proto tcp-client, take n as the number of retries of connection attempt (default=infinite)
  21
  22 auto-proxy
  23 Try to sense HTTP or SOCKS proxy settings automatically
  24
  25 http-proxy server port [authfile|'auto'] [auth-method]
  26 Connect to remote host through an HTTP proxy at address server and port port
  27
  28 http-proxy-retry
  29 Retry indefinitely on HTTP proxy errors
  30
  31 http-proxy-timeout n
  32 Set proxy timeout to n seconds, default=5
  33
  34 http-proxy-option type [parm]
  35 Set extended HTTP proxy options
  36
  37 socks-proxy server [port]
  38 Connect to remote host through a Socks5 proxy at address server and port port (default=1080)
  39
  40 socks-proxy-retry
  41 Retry indefinitely on Socks proxy errors
  42
  43 resolv-retry n
  44 If hostname resolve fails for --remote, retry resolve for n seconds before failing
  45
  46 float
  47 Allow remote peer to change its IP address and/or port number, such as due to DHCP (this is the default if --remote is not used)
  48
  49 ipchange cmd
  50 Execute shell command cmd when our remote ip-address is initially authenticated or changes
  51
  52 port port
  53 TCP/UDP port number for both local and remote
  54
  55 lport port
  56 TCP/UDP port number for bind
  57
  58 rport port
  59 TCP/UDP port number for remote
  60
  61 bind
  62 Bind to local address and port
  63
  64 nobind
  65 Do not bind to local address and port
  66
  67 dev tunX | tapX | null
  68 TUN/TAP virtual network device ( X can be omitted for a dynamic device
  69
  70 dev-type device-type
  71 Which device type are we using? device-type should be tun or tap
  72
  73 topology mode
  74 Configure virtual addressing topology when running in --dev tun mode
  75
  76 tun-ipv6
  77 Build a tun link capable of forwarding IPv6 traffic
  78
  79 dev-node node
  80 Explicitly set the device node rather than using /dev/net/tun, /dev/tun, /dev/tap, etc
  81
  82 lladdr address
  83 Specify the link layer address, more commonly known as the MAC address
  84
  85 iproute cmd
  86 Set alternate command to execute instead of default iproute2 command
  87
  88 ifconfig l rn
  89 Set TUN/TAP adapter parameters
  90
  91 ifconfig-noexec
  92 Don't actually execute ifconfig/netsh commands, instead pass --ifconfig parameters to scripts using environmental variables
  93
  94 ifconfig-nowarn
  95 Don't output an options consistency check warning if the --ifconfig option on this side of the connection doesn't match the remote side
  96
  97 route network/IP [netmask] [gateway] [metric]
  98 Add route to routing table after connection is established
  99
 100 route-gateway gw
 101 Specify a default gateway gw for use with --route
 102
 103 route-metric m
 104 Specify a default metric m for use with --route
 105
 106 route-delay [n] [w]
 107 Delay n seconds (default=0) after connection establishment, before adding routes
 108
 109 route-up cmd
 110 Execute shell command cmd after routes are added, subject to --route-delay
 111
 112 route-noexec
 113 Don't add or remove routes automatically
 114
 115 route-nopull
 116 When used with --client or --pull, accept options pushed by server EXCEPT for routes
 117
 118 redirect-gateway flags...
 119 (Experimental) Automatically execute routing commands to cause all outgoing IP traffic to be redirected over the VPN
 120
 121 link-mtu n
 122 Sets an upper bound on the size of UDP packets which are sent between OpenVPN peers
 123
 124 tun-mtu n
 125 Take the TUN device MTU to be n and derive the link MTU from it (default=1500)
 126
 127 tun-mtu-extra n
 128 Assume that the TUN/TAP device might return as many as n bytes more than the --tun-mtu size on read
 129
 130 mtu-disc type
 131 Should we do Path MTU discovery on TCP/UDP channel? Only supported on OSes such as Linux that supports the necessary system call to set
 132
 133 mtu-test
 134 To empirically measure MTU on connection startup, add the --mtu-test option to your configuration
 135
 136 fragment max
 137 Enable internal datagram fragmentation so that no UDP datagrams are sent which are larger than max bytes
 138
 139 mssfix max
 140 Announce to TCP sessions running over the tunnel that they should limit their send packet sizes such that after OpenVPN has encapsulated them, the resulting UDP packet size that OpenVPN sends to its peer will not exceed max bytes
 141
 142 sndbuf size
 143 Set the TCP/UDP socket send buffer size
 144
 145 rcvbuf size
 146 Set the TCP/UDP socket receive buffer size
 147
 148 socket-flags flags...
 149 Apply the given flags to the OpenVPN transport socket
 150
 151 txqueuelen n
 152 (Linux only) Set the TX queue length on the TUN/TAP interface
 153
 154 shaper n
 155 Limit bandwidth of outgoing tunnel data to n bytes per second on the TCP/UDP port
 156
 157 inactive n [bytes]
 158 Causes OpenVPN to exit after n seconds of inactivity on the TUN/TAP device
 159
 160 ping n
 161 Ping remote over the TCP/UDP control channel if no packets have been sent for at least n seconds (specify --ping on both peers to cause ping packets to be sent in both directions since OpenVPN ping packets are not echoed like IP ping packets)
 162
 163 ping-exit n
 164 Causes OpenVPN to exit after n seconds pass without reception of a ping or other packet from remote
 165
 166 ping-restart n
 167 Similar to --ping-exit, but trigger a SIGUSR1 restart after n seconds pass without reception of a ping or other packet from remote
 168
 169 keepalive n m
 170 A helper directive designed to simplify the expression of --ping and --ping-restart in server mode configurations
 171
 172 ping-timer-rem
 173 Run the --ping-exit / --ping-restart timer only if we have a remote address
 174
 175 persist-tun
 176 Don't close and reopen TUN/TAP device or run up/down scripts across SIGUSR1 or --ping-restart restarts
 177
 178 persist-key
 179 Don't re-read key files across SIGUSR1 or --ping-restart
 180
 181 persist-local-ip
 182 Preserve initially resolved local IP address and port number across SIGUSR1 or --ping-restart restarts
 183
 184 persist-remote-ip
 185 Preserve most recently authenticated remote IP address and port number across SIGUSR1 or --ping-restart restarts
 186
 187 mlock
 188 Disable paging by calling the POSIX mlockall function
 189
 190 up cmd
 191 Shell command to run after successful TUN/TAP device open (pre --user UID change)
 192
 193 up-delay
 194 Delay TUN/TAP open and possible --up script execution until after TCP/UDP connection establishment with peer
 195
 196 down cmd
 197 Shell command to run after TUN/TAP device close (post --user UID change and/or --chroot )
 198
 199 down-pre
 200 Call --down cmd/script before, rather than after, TUN/TAP close
 201
 202 up-restart
 203 Enable the --up and --down scripts to be called for restarts as well as initial program start
 204
 205 setenv name value
 206 Set a custom environmental variable name=value to pass to script
 207
 208 setenv-safe name value
 209 Set a custom environmental variable OPENVPN_name=value to pass to script
 210
 211 disable-occ
 212 Don't output a warning message if option inconsistencies are detected between peers
 213
 214 user user
 215 Change the user ID of the OpenVPN process to user after initialization, dropping privileges in the process
 216
 217 group group
 218 Similar to the --user option, this option changes the group ID of the OpenVPN process to group after initialization
 219
 220 cd dir
 221 Change directory to dir prior to reading any files such as configuration files, key files, scripts, etc
 222
 223 chroot dir
 224 Chroot to dir after initialization
 225
 226 #daemon [progname]
 227 #Become a daemon after all initialization functions are completed
 228
 229 #syslog [progname]
 230 #Direct log output to system logger, but do not become a daemon
 231
 232 passtos
 233 Set the TOS field of the tunnel packet to what the payload's TOS is
 234
 235 inetd [wait|nowait] [progname]
 236 Use this option when OpenVPN is being run from the inetd or xinetd(8) server
 237
 238 log file
 239 Output logging messages to file, including output to stdout/stderr which is generated by called scripts
 240
 241 log-append file
 242 Append logging messages to file
 243
 244 suppress-timestamps
 245 Avoid writing timestamps to log messages, even when they otherwise would be prepended
 246
 247 writepid file
 248 Write OpenVPN's main process ID to file
 249
 250 nice n
 251 Change process priority after initialization ( n greater than 0 is lower priority, n less than zero is higher priority)
 252
 253 fast-io
 254 (Experimental) Optimize TUN/TAP/UDP I/O writes by avoiding a call to poll/epoll/select prior to the write operation
 255
 256 echo [parms...]
 257 Echo parms to log output
 258
 259 remap-usr1 signal
 260 Control whether internally or externally generated SIGUSR1 signals are remapped to SIGHUP (restart without persisting state) or SIGTERM (exit)
 261
 262 verb n
 263 Set output verbosity to n (default=1)
 264
 265 status file [n]
 266 Write operational status to file every n seconds
 267
 268 status-version [n]
 269 Choose the status file format version number
 270
 271 mute n
 272 Log at most n consecutive messages in the same category
 273
 274 comp-lzo [mode]
 275 Use fast LZO compression -- may add up to 1 byte per packet for incompressible data
 276
 277 comp-noadapt
 278 When used in conjunction with --comp-lzo, this option will disable OpenVPN's adaptive compression algorithm
 279
 280 management IP port [pw-file]
 281 Enable management interface on <IP> <port> to handle daemon management functions
 282
 283 management-query-passwords
 284 Query management channel for private key password and --auth-user-pass username/password
 285
 286 management-forget-disconnect
 287 Make OpenVPN forget passwords when management session disconnects
 288
 289 management-hold
 290 Start OpenVPN in a hibernating state, until a client of the management interface explicitly starts it with the hold release command
 291
 292 management-signal
 293 Send SIGUSR1 signal to OpenVPN if management session disconnects
 294
 295 management-log-cache n
 296 Cache the most recent n lines of log file history for usage by the management channel
 297
 298 plugin module-pathname [init-string]
 299 Load plug-in module from the file module-pathname, passing init-string as an argument to the module initialization function