1. SoftEther VPN Project
  2. Documents
  3. SoftEther VPN Manual
  4. 6. Command Line Management Utility Manual
  5. 6.1 Overview of vpncmd

6.1 Overview of vpncmd

    This section provides an overview of the vpncmd utility.

     

    6.1.1 vpncmd

    Overview of vpncmd

    vpncmd is formally known as "SoftEther VPN Command Line Management Utility". This software is operated exclusively from the command line and without the use of window-based GUI processing, and it can be used on all operating systems that support SoftEther VPN, including Windows, Linux, FreeBSD, Solaris, and Mac OS X.

    vpncmd on Different Operating Systems

    vpncmd is provided in each SoftEther VPN package file.

    When the Windows version of VPN Server, VPN Client, or VPN Bridge is installed, [SoftEther VPN Command Line Management Utility (vpncmd)] is registered to the Start menu of Windows. Once vpncmd has been started in Windows, it can be started the next time simply by entering [vpncmd] at the command prompt.

    vpncmd is also provided in the Unix operating system versions of VPN Server, VPN Client, and VPN Bridge. When these software products are installed, vpncmd is automatically created and placed in the same directory as the vpnserver, vpnclient, or vpnbridge executable file.

    The vpncmd software provided with all operating system versions of SoftEther VPN is a command line interface program that has the same functions and performs the same operations. Therefore, you can use vpncmd to manage VPN Server, VPN Client, and VPN Bridge from both Windows and non-Windows operating systems.

    vpncmd Startup Environment

    vpncmd may display the output result using multiple lines on the command line interface. In this case, use a terminal emulator or SSH client software with a scroll function. In addition, as an option of vpncmd, you can specify the output file name and write the output result to a text file. For more information about using vpncmd, please refer to 6.2 General Usage of vpncmd.

    6.1.2 vpncmd Management Mode

    You can operate vpncmd using any of the following three modes.

    1. VPN Server / VPN Bridge Management Mode
      This mode enables management by establishing a management connection to SoftEther VPN Server or SoftEther VPN Bridge running on the same or a remote computer.
    2. VPN Client Management Mode
      This mode enables control by connecting to SoftEther VPN Client running on the same or a remote computer.
    3. Use VPN Tools Command (Create Certificate or Measure Communication Throughput) Mode
      This mode enables the use of only the test command and create certificate command only on the computer running vpncmd, without connecting to VPN Server, VPN Client, or other services.

    When vpncmd is started, a dialog box is displayed asking you to select one of these three management modes. Select 1, 2, or 3 to start vpncmd in that management mode. You can also specify the management mode as the command line argument for starting vpncmd.

    vpncmd command - SoftEther VPN Command Line Management Utility
SoftEther VPN Command Line Management Utility (vpncmd command)
Version 1.00 Build 8971 Release Candidate 1 (English)
Compiled 2013/02/14 21:42:00 by yagi at pc26
Copyright (c) SoftEther Project. All Rights Reserved.

By using vpncmd program, the following can be achieved.

1. Management of VPN Server or VPN Bridge
2. Management of VPN Client
3. Use of VPN Tools (certificate creation and Network Traffic Speed Test Tool)

Select 1, 2 or 3: