Skip to main content
Version: current

ovpn-client


interface/ovpn-client

Type: Directory

FlagNameDescription
XdisabledWhether an item is disabled.
RrunningWhether the interface is running.
Hhw-cryptoWhether hardware encryption is active.
Tatls-authWhether TLS authentication (tls-auth) is active.
Tctls-cryptWhether tls-crypt authentication is active.
ArgumentTypeDescription
namestringDescriptive name of the interface.
mac-addressmacAddrMAC address of the OVPN interface. Automatically generated if not specified.
max-mtunumMaximum Transmission Unit. Maximum packet size that the OVPN interface can send without packet fragmentation.
connect-to ( mandatory )address (flags=D46v)Remote address of the OVPN server.
portnumPort to connect to.
modeenum (ip | ethernet)Layer3 or Layer2 tunnel mode (alternatively tun, tap).
protocolenum (tcp | udp)Transport protocol to use when connecting to the remote endpoint.
user ( mandatory )stringUser name used for authentication.
passwordstringPassword used for authentication. Must not be longer than 1000 characters.
profileenumSpecifies which PPP profile configuration is used when establishing the tunnel.
certificateenum (none)Client certificate from the certificate store.
verify-server-certificateboolChecks the server certificate's CN or SAN against the connect-to parameter and enables trust-chain validation against the router's certificate store. The IP or hostname must be present in the server's certificate.
tls-versionenum (any | only-1.2)Specifies which TLS versions to allow.
authenum (sha1 | md5 | sha256 | sha384 | sha512 | null)Allowed authentication methods.
cipherenum (blowfish128 | aes128-cbc | aes192-cbc | aes256-cbc | aes128-gcm | aes192-gcm | aes256-gcm | null)Allowed ciphers. To use GCM ciphers, set auth to null, because the GCM cipher also handles authentication.
use-peer-dnsenum (no | yes | exclusively)Whether to add DNS servers provided by the OVPN server to IP/DNS configuration.
add-default-routeboolWhether to add the OVPN remote address as a default route.
route-nopullboolIf enabled, the client does not use routes pushed by the server (including def1).
disconnect-notifybool { }Sends explicit disconnect notification in UDP mode.