2.6 VPN Command Line Management Utility (vpncmd)

    The SoftEther VPN command line management utility (vpncmd) is a superior command utility that can control settings or operation accomplished by conventional GUI by connect to a local or remote connection to SoftEther VPN Server, SoftEther VPN Client, and SoftEther VPN Bridge by command line or input file.

    2.6.1 What is vpncmd?

    VPN Command Line Management Utility (vpncmd)

    SoftEther VPN command line management utility (vpncmd) is command interface (CUI) software that combines Windows control tools of SoftEther VPN Server administration utility and SoftEther VPN Client Manager described in 2.4 VPN Server Manager and 2.5 VPN Client Manager.

    vpncmd runs on an operating system that supports SoftEther VPN Server. It can also be used by Linux / FreeBSD / Solaris / Mac OS X. You can therefore administer SoftEther VPN Server by invoking vpncmd on the SSH console off a computers installed with SoftEther VPN Server, etc., and connecting to localhost.

    Invoking vpncmd from External Program

    By specifying input file (/IN) as command line argument, you can have it automatically executed by inputting a command file with multiple commands. You can also output the execution results to a file (/OUT). By invoking vpncmd from an external program with these functions, VPN Server / VPN Client / VPN Bridge can be automatically controlled.

    Using vpncmd for Repetitious Processing Such as Registering Large Numbers of Users

    When using the vpncmd program, for example, if GUI is used to register a large number of users (several thousand to several tens of thousands) at once in the Virtual Hub of SoftEther VPN Server, processing that takes a lot of time can be semi-automated.

    Usage of vpncmd and GUI Tool

    The command line interface of vpncmd program contains a large amount of commands. In order to use all of these commands properly, you must thoroughly read 6. Command Line Management Utility Manual or command help. Even beginners can easily use all of the functions of SoftEther VPN Server Manager and SoftEther VPN Client Manager, but it takes time to be able to use the vpncmd program properly.

    Therefore concerning routine operation, administration and settings, use SoftEther VPN Server Manager and SoftEther VPN Client Manager as much as possible; it is best to use the vpncmd program for registering large numbers of users and automatically controlling from another program.

    Specific vpncmd Usage Method

    For specific method of using the vpncmd program, see 6. Command Line Management Utility Manual.

    2-6-1.png

    VPN command line management utility (vpncmd)

    2.6.2 Displaying Command Help

    If there are any commands in the command line console of the vpncmd program that you do not know how to use, you can display help by adding "--help" or "/help" to the end of the command name.

    If you forget the command name, all command names can be displayed by inputting "help".

    As a rule, the target of the operation is placed in the front of the vpncmd command name. For example, the command to create anew user is UserCreate. In this case by inputting "User?" a list of commands beginning with "User" is displayed.

    For details on command input method, input rules and automatic complement function for command console of the vpncmd program, see 6. Command Line Management Utility Manual.