openvpn
-------
.. osdx:cfgcmd:: vpn openvpn
.. raw:: html
AresC640
Atlas840
M10-Smart
M2
RS420
RXL15000
SDE
OpenVPN profiles
.. osdx:cfgcmd:: vpn openvpn client-profile
.. raw:: html
AresC640
Atlas840
M10-Smart
M2
RS420
RXL15000
SDE
:arg id:
Client options
:instances: Multiple
.. osdx:cfgcmd:: vpn openvpn client-profile allow-pull-fqdn
.. raw:: html
AresC640
Atlas840
M10-Smart
M2
RS420
RXL15000
SDE
Allow client to pull DNS names from server
.. osdx:cfgcmd:: vpn openvpn client-profile authentication
.. raw:: html
AresC640
Atlas840
M10-Smart
M2
RS420
RXL15000
SDE
Client authentication
:ref Required:
:ref Required:
.. osdx:cfgcmd:: vpn openvpn client-profile authentication encrypted-password
.. raw:: html
AresC640
Atlas840
M10-Smart
M2
RS420
RXL15000
SDE
:arg password:
VPN encrypted password
.. osdx:cfgcmd:: vpn openvpn client-profile authentication password
.. raw:: html
AresC640
Atlas840
M10-Smart
M2
RS420
RXL15000
SDE
:arg txt:
VPN password
.. osdx:cfgcmd:: vpn openvpn client-profile authentication username
.. raw:: html
AresC640
Atlas840
M10-Smart
M2
RS420
RXL15000
SDE
:arg id:
VPN username
.. osdx:cfgcmd:: vpn openvpn client-profile pull
.. raw:: html
AresC640
Atlas840
M10-Smart
M2
RS420
RXL15000
SDE
Option pulling parameters
.. osdx:cfgcmd:: vpn openvpn client-profile pull filter
.. raw:: html
AresC640
Atlas840
M10-Smart
M2
RS420
RXL15000
SDE
Option filter parameters
:arg u32:
Filter index
:instances: Multiple
:ref Required:
:ref Required:
.. osdx:cfgcmd:: vpn openvpn client-profile pull filter policy
.. raw:: html
AresC640
Atlas840
M10-Smart
M2
RS420
RXL15000
SDE
Filter policy
:arg accept:
Allow option
:arg ignore:
Remove option
:arg reject:
Flag option as error and restart tunnel
.. osdx:cfgcmd:: vpn openvpn client-profile pull filter text
.. raw:: html
AresC640
Atlas840
M10-Smart
M2
RS420
RXL15000
SDE
:arg txt:
Filter rules that start with this text
.. osdx:cfgcmd:: vpn openvpn encryption-profile
.. raw:: html
AresC640
Atlas840
M10-Smart
M2
RS420
RXL15000
SDE
:arg id:
Data channel encryption options
:instances: Multiple
.. osdx:cfgcmd:: vpn openvpn encryption-profile auth
.. raw:: html
AresC640
Atlas840
M10-Smart
M2
RS420
RXL15000
SDE
Digest algorithms to authenticate data channel packets with
:arg u32:
Digest index
:instances: Multiple
:ref Required:
.. osdx:cfgcmd:: vpn openvpn encryption-profile auth algorithm
.. raw:: html
AresC640
Atlas840
M10-Smart
M2
RS420
RXL15000
SDE
Digest algorithm
:arg none:
Disable data channel authentication
.. osdx:cfgcmd:: vpn openvpn encryption-profile cipher
.. raw:: html
AresC640
Atlas840
M10-Smart
M2
RS420
RXL15000
SDE
Cipher algorithms to encrypt data channel packets with
:arg u32:
Cipher index
:instances: Multiple
:ref Required:
.. osdx:cfgcmd:: vpn openvpn encryption-profile cipher algorithm
.. raw:: html
AresC640
Atlas840
M10-Smart
M2
RS420
RXL15000
SDE
Cipher algorithm
:arg none:
Disable data channel encryption
.. osdx:cfgcmd:: vpn openvpn encryption-profile ncp
.. raw:: html
AresC640
Atlas840
M10-Smart
M2
RS420
RXL15000
SDE
Negotiable Crypto Parameters (client/server mode)
.. osdx:cfgcmd:: vpn openvpn encryption-profile ncp cipher
.. raw:: html
AresC640
Atlas840
M10-Smart
M2
RS420
RXL15000
SDE
Cipher negotiation proposals
:arg u32:
Cipher index
:instances: Multiple
:ref Required:
.. osdx:cfgcmd:: vpn openvpn encryption-profile ncp cipher algorithm
.. raw:: html
AresC640
Atlas840
M10-Smart
M2
RS420
RXL15000
SDE
:arg id:
Cipher algorithm
.. osdx:cfgcmd:: vpn openvpn encryption-profile ncp disable
.. raw:: html
AresC640
Atlas840
M10-Smart
M2
RS420
RXL15000
SDE
Disable cipher negotiation
.. osdx:cfgcmd:: vpn openvpn encryption-profile secret
.. raw:: html
AresC640
Atlas840
M10-Smart
M2
RS420
RXL15000
SDE
Static key encryption mode (p2p mode)
:ref Required:
.. osdx:cfgcmd:: vpn openvpn encryption-profile secret direction
.. raw:: html
AresC640
Atlas840
M10-Smart
M2
RS420
RXL15000
SDE
:arg u32:
Data flow direction
.. osdx:cfgcmd:: vpn openvpn encryption-profile secret static-key
.. raw:: html
AresC640
Atlas840
M10-Smart
M2
RS420
RXL15000
SDE
:arg file:
Static key file
.. osdx:cfgcmd:: vpn openvpn server-profile
.. raw:: html
AresC640
Atlas840
M10-Smart
M2
RS420
RXL15000
SDE
:arg id:
Server options
:instances: Multiple
.. osdx:cfgcmd:: vpn openvpn server-profile authentication
.. raw:: html
AresC640
Atlas840
M10-Smart
M2
RS420
RXL15000
SDE
Authentication list
:ref Reference: system aaa list *
.. osdx:cfgcmd:: vpn openvpn server-profile client
.. raw:: html
AresC640
Atlas840
M10-Smart
M2
RS420
RXL15000
SDE
:arg id:
Client parameters
Client Common Name
:instances: Multiple
.. osdx:cfgcmd:: vpn openvpn server-profile client address
.. raw:: html
AresC640
Atlas840
M10-Smart
M2
RS420
RXL15000
SDE
:arg ipv4:
Static IP address
:arg fqdn:
Static IP address
.. osdx:cfgcmd:: vpn openvpn server-profile client disable
.. raw:: html
AresC640
Atlas840
M10-Smart
M2
RS420
RXL15000
SDE
Disable client
.. osdx:cfgcmd:: vpn openvpn server-profile client push
.. raw:: html
AresC640
Atlas840
M10-Smart
M2
RS420
RXL15000
SDE
Option pushing parameters
.. osdx:cfgcmd:: vpn openvpn server-profile client push reset
.. raw:: html
AresC640
Atlas840
M10-Smart
M2
RS420
RXL15000
SDE
Ignore global push list for client
.. osdx:cfgcmd:: vpn openvpn server-profile client push route
.. raw:: html
AresC640
Atlas840
M10-Smart
M2
RS420
RXL15000
SDE
Routing parameters
.. osdx:cfgcmd:: vpn openvpn server-profile client push route delay
.. raw:: html
AresC640
Atlas840
M10-Smart
M2
RS420
RXL15000
SDE
:arg u32:
Delay after connection establishment before adding routes
.. osdx:cfgcmd:: vpn openvpn server-profile client push route destination
.. raw:: html
AresC640
Atlas840
M10-Smart
M2
RS420
RXL15000
SDE
Route destination
:arg ipv4cidr:
IPv4 address
:arg ipv4net:
IPv4 network
:arg vpn_gateway:
Remote VPN endpoint address
:arg net_gateway:
Pre-existing IP default gateway
:arg remote_host:
Remote host
:instances: Multiple
.. osdx:cfgcmd:: vpn openvpn server-profile client push route destination gateway
.. raw:: html
AresC640
Atlas840
M10-Smart
M2
RS420
RXL15000
SDE
Route gateway
:arg vpn_gateway:
Remote VPN endpoint address
:arg net_gateway:
Pre-existing IP default gateway
:arg remote_host:
Remote host
.. osdx:cfgcmd:: vpn openvpn server-profile client push route destination metric
.. raw:: html
AresC640
Atlas840
M10-Smart
M2
RS420
RXL15000
SDE
:arg u32:
Route metric
.. osdx:cfgcmd:: vpn openvpn server-profile client push route gateway
.. raw:: html
AresC640
Atlas840
M10-Smart
M2
RS420
RXL15000
SDE
Default gateway to use with pushed routes
:arg ipv4:
IPv4 address
:arg dhcp:
Extract the gateway address from a DHCP negotiation
.. osdx:cfgcmd:: vpn openvpn server-profile client-to-client
.. raw:: html
AresC640
Atlas840
M10-Smart
M2
RS420
RXL15000
SDE
Allow connected clients to reach each other
.. osdx:cfgcmd:: vpn openvpn server-profile duplicate-cn
.. raw:: html
AresC640
Atlas840
M10-Smart
M2
RS420
RXL15000
SDE
Allow multiple clients with the same common name to concurrently connect
.. osdx:cfgcmd:: vpn openvpn server-profile push
.. raw:: html
AresC640
Atlas840
M10-Smart
M2
RS420
RXL15000
SDE
Push configuration options to the clients
.. osdx:cfgcmd:: vpn openvpn server-profile push route
.. raw:: html
AresC640
Atlas840
M10-Smart
M2
RS420
RXL15000
SDE
Routing parameters
.. osdx:cfgcmd:: vpn openvpn server-profile push route delay
.. raw:: html
AresC640
Atlas840
M10-Smart
M2
RS420
RXL15000
SDE
:arg u32:
Delay after connection establishment before adding routes
.. osdx:cfgcmd:: vpn openvpn server-profile push route destination
.. raw:: html
AresC640
Atlas840
M10-Smart
M2
RS420
RXL15000
SDE
Route destination
:arg ipv4net:
IPv4 network
:arg vpn_gateway:
Remote VPN endpoint address
:arg net_gateway:
Pre-existing IP default gateway
:arg remote_host:
Remote host
:instances: Multiple
.. osdx:cfgcmd:: vpn openvpn server-profile push route destination gateway
.. raw:: html
AresC640
Atlas840
M10-Smart
M2
RS420
RXL15000
SDE
Route gateway
:arg vpn_gateway:
Remote VPN endpoint address
:arg net_gateway:
Pre-existing IP default gateway
:arg remote_host:
Remote host
.. osdx:cfgcmd:: vpn openvpn server-profile push route destination metric
.. raw:: html
AresC640
Atlas840
M10-Smart
M2
RS420
RXL15000
SDE
:arg u32:
Route metric
.. osdx:cfgcmd:: vpn openvpn server-profile push route gateway
.. raw:: html
AresC640
Atlas840
M10-Smart
M2
RS420
RXL15000
SDE
Default gateway to use with pushed routes
:arg ipv4:
IPv4 address
:arg dhcp:
Extract the gateway address from a DHCP negotiation
.. osdx:cfgcmd:: vpn openvpn tls-profile
.. raw:: html
AresC640
Atlas840
M10-Smart
M2
RS420
RXL15000
SDE
:arg id:
TLS options
:instances: Multiple
.. osdx:cfgcmd:: vpn openvpn tls-profile auth
.. raw:: html
AresC640
Atlas840
M10-Smart
M2
RS420
RXL15000
SDE
Additional layer of HMAC authentication on top of the TLS control channel
:ref Required:
.. osdx:cfgcmd:: vpn openvpn tls-profile auth direction
.. raw:: html
AresC640
Atlas840
M10-Smart
M2
RS420
RXL15000
SDE
:arg u32:
Data flow direction
.. osdx:cfgcmd:: vpn openvpn tls-profile auth static-key
.. raw:: html
AresC640
Atlas840
M10-Smart
M2
RS420
RXL15000
SDE
:arg file:
Static key to use for HMAC authentication
.. osdx:cfgcmd:: vpn openvpn tls-profile ca
.. raw:: html
AresC640
Atlas840
M10-Smart
M2
RS420
RXL15000
SDE
:arg file:
Certificate Authority certificate in PEM format
.. osdx:cfgcmd:: vpn openvpn tls-profile certificate
.. raw:: html
AresC640
Atlas840
M10-Smart
M2
RS420
RXL15000
SDE
:arg file:
Local certificate in PEM format
.. osdx:cfgcmd:: vpn openvpn tls-profile crl
.. raw:: html
AresC640
Atlas840
M10-Smart
M2
RS420
RXL15000
SDE
:arg file:
Certificate Revocation List in PEM format
.. osdx:cfgcmd:: vpn openvpn tls-profile crypt
.. raw:: html
AresC640
Atlas840
M10-Smart
M2
RS420
RXL15000
SDE
Encrypt and authenticate all control channel packets
:ref Required:
.. osdx:cfgcmd:: vpn openvpn tls-profile crypt static-key
.. raw:: html
AresC640
Atlas840
M10-Smart
M2
RS420
RXL15000
SDE
:arg file:
Static key to use for HMAC authentication
.. osdx:cfgcmd:: vpn openvpn tls-profile csr
.. raw:: html
AresC640
Atlas840
M10-Smart
M2
RS420
RXL15000
SDE
Certificate Signing Request instance (SCEP)
:ref Reference: system certificate scep csr *
.. osdx:cfgcmd:: vpn openvpn tls-profile dhparam
.. raw:: html
AresC640
Atlas840
M10-Smart
M2
RS420
RXL15000
SDE
Diffie-Hellman parameters in PEM format (server mode)
:arg none:
Do not use dhparam file
.. osdx:cfgcmd:: vpn openvpn tls-profile private-key
.. raw:: html
AresC640
Atlas840
M10-Smart
M2
RS420
RXL15000
SDE
:arg file:
Local certificate's private key in PEM format
.. osdx:cfgcmd:: vpn openvpn tunnel-profile
.. raw:: html
AresC640
Atlas840
M10-Smart
M2
RS420
RXL15000
SDE
:arg id:
Tunnel options
:instances: Multiple
.. osdx:cfgcmd:: vpn openvpn tunnel-profile compression
.. raw:: html
AresC640
Atlas840
M10-Smart
M2
RS420
RXL15000
SDE
Compression algorithm to use
:arg lzo:
Better compatibility
:arg lz4:
Better performance
.. osdx:cfgcmd:: vpn openvpn tunnel-profile float
.. raw:: html
AresC640
Atlas840
M10-Smart
M2
RS420
RXL15000
SDE
Allow remote peer to change its IP address and/or port number
.. osdx:cfgcmd:: vpn openvpn tunnel-profile keepalive
.. raw:: html
AresC640
Atlas840
M10-Smart
M2
RS420
RXL15000
SDE
Keepalive parameters
:ref Required:
:ref Required:
.. osdx:cfgcmd:: vpn openvpn tunnel-profile keepalive interval
.. raw:: html
AresC640
Atlas840
M10-Smart
M2
RS420
RXL15000
SDE
:arg u32:
Ping interval
.. osdx:cfgcmd:: vpn openvpn tunnel-profile keepalive timeout
.. raw:: html
AresC640
Atlas840
M10-Smart
M2
RS420
RXL15000
SDE
:arg u32:
Ping timeout to restart
.. osdx:cfgcmd:: vpn openvpn tunnel-profile log-level
.. raw:: html
AresC640
Atlas840
M10-Smart
M2
RS420
RXL15000
SDE
OpenVPN log level
:arg u32:
Disable all logging except fatal errors (0)
:arg u32:
Normal usage range (1-4)
:arg u32:
Output R and W for each packet read and write (5)
:arg u32:
Debug info range (6-11)