Access Server command line interface tools

Upgrade to Latest Version

Introduction to the command line tools

Pretty much every aspect of the configuration of the OpenVPN Access Server program can be configured through the command line interface. There are programs available in the directory /usr/local/openvpn_as/scripts/ that can be used to configure the Access Server from scratch, or to make adjustment to server settings, or to change properties set for users and groups. Certain tasks can only be done from the command line and are not implemented in the Graphical User Interface (GUI).

It is assumed that people that are going to use the CLI are familiar with at least some basics of Linux administration, namely the ability to log on to the server (console or SSH), to obtain root privileges, and to change directories in the Linux operating system.

Most of the command line parameters are executed as root user in the /usr/local/openvpn_as/scripts/ directory.

We recommend you use copy and paste to execute the commands where possible as manually typing it may result in a slight difference, and the command prompt is not a forgiving environment.

Authentication before using the CLI

Much of the functionality for managing users and user permissions, as well as server configuration and other tasks, is contained in the sacli program. This program requires that you have root privileges. Therefore all commands used in the documentation here assume that you are on the console of the server or logged on via an SSH session to the server, and that you have either the ability to run commands with "sudo" or that you are logged on as "root" user.

Overview