Vpncmd - Утилита управления командной строкой VPN

Vpncmd - Утилита управления командной строкой VPN

HELP:

vpncmd command - SoftEther VPN Command Line Management Utility
SoftEther VPN Command Line Management Utility (vpncmd command)
Version 4.21 Build 9613   (English)
Compiled 2016/04/24 15:39:17 by yagi at pc30
Copyright (c) SoftEther VPN Project. All Rights Reserved.

Help for command "vpncmd" 

Purpose:
 SoftEther VPN Command Line Management Utility

Description:
  The 'vpncmd' program is a utility that allows you to manage SoftEther VPN software by using command lines. By using vpncmd, you can connect to a VPN Client, a VPN
 Server or VPN Bridge that is running on a local or remote computer and manage these services. Moreover, by using VPN Tools mode, you can call the Network 
Traffic Speed
 Test Tool and the certificate creation function. These can be used even when not connected to the VPN Server or VPN Client.
 When using vpncmd, if the file name is specified by using the /IN and /OUT parameter, the command can be executed in a batch according to a file in which the executable
 commands are enumerated and the execution results can be written to a file. Normally a command prompt will appear after vpncmd is launched but when an input file is
 specified by the /IN parameter, the program will automatically terminate after the execution of all lines in the input file is complete. Also, when a command to execute
 is specified by the /CMD parameter, the program will automatically terminate after the execution of that command is complete. You cannot specify the /IN parameter and
 the /CMD parameter at the same time. The termination code of the vpncmd program will be the error code of the last executed command (0 in the case of successful
 execution).
 Under a Windows environment, when vpncmd is launched once or more by a user with administrator privileges, it is possible to simply input 'vpncmd' to a Windows command
 prompt or [Run...] window to launch vpncmd. To achieve the same result under a UNIX system, you can manually set, as appropriate, the PATH environment variable.
Usage:
 vpncmd [host:port] [/CLIENT|/SERVER|/TOOLS] [/HUB:hub] [/ADMINHUB:adminhub] [/PASSWORD:password] [/IN:infile] [/OUT:outfile] [/CMD commands...]

Parameters:
 host:port    - By specifying parameters in the format "host name:port number", a connection will automatically be made to that host. If this is not specified, a prompt
                will appear to input the connection destination. When connecting to a VPN Client, you cannot specify a port number.
 /CLIENT      - This will connect to VPN Client to do management. You cannot specify it together with /SERVER.
 /SERVER      - This will connect to VPN Server or VPN Bridge to do management. You cannot specify it together with /CLIENT.
 /TOOLS       - This will enables use of VPN Tools commands. VPN Tools include the simple certificate creation tool (MakeCert command) and the Network Traffic 
Speed Test
                Tool (SpeedTest command).
 /HUB         - When connecting to the VPN Server by "Virtual Hub Admin Mode", this specifies the Virtual Hub name 'hub'. If you specify the host name but not 
the /HUB
                parameter, connection will be by "Server Admin Mode".
 /ADMINHUB    - This will specify the name of the Virtual Hub 'adminhub' that is automatically selected after connecting to the VPN Server. If the /HUB 
parameter was
                specified, the Virtual Hub will be selected automatically and this specification will not be necessary.
 /PASSWORD    - If the administrator password is required when connecting, specify the password 'password'. When the password is not specified, a prompt to input the
                password will be displayed.
 /IN          - This will specify the text file 'infile' that contains the list of commands that are automatically executed after the connection is completed. 
If the /IN
                parameter is specified, the vpncmd program will terminate automatically after the execution of all commands in the file are finished. If the file
                contains multiple-byte characters, the encoding must be Unicode (UTF-8). This cannot be specified together with /CMD (if /CMD is specified, /IN will be
                ignored).
 /OUT         - You can specify the text file 'outfile' to write all strings such as onscreen prompts, message, error and execution results. Note that if the specified
                file already exists, the contents of the existing file will be overwritten. Output strings will be recorded using Unicode (UTF-8) encoding.
 /CMD         - If the optional command 'commands...' is included after /CMD, that command will be executed after the connection is complete and the vpncmd program will
                terminate after that. This cannot be specified together with /IN (if specified together with /IN, /IN will be ignored). Specify the /CMD parameter after
                all other vpncmd parameters.
 /CSV         - You can specify this option to enable CSV outputs. Results of each command will be printed in the CSV format. It is useful for processing the results by
                other programs.
 /PROGRAMMING - There is no description for this parameter.

---

# docker exec -it name_container ./vpncmd /SERVER /PASSWORD:server_pass1 /ADMINHUB:DEFAULT /CSV /CMD
Specify the host name or IP address of the computer that the destination VPN Server or VPN Bridge is operating on.
By specifying according to the format 'host name:port number', you can also specify the port number.
(When the port number is unspecified, 443 is used.)
If nothing is input and the Enter key is pressed, the connection will be made to the port number 8888 of localhost (this computer).
Hostname of IP Address of Destination:

If connecting to the server by Virtual Hub Admin Mode, please input the Virtual Hub name.
If connecting by server admin mode, please press Enter without inputting anything.
Specify Virtual Hub Name:
VPN Server/DEFAULT>help
You can use the following 205 commands:
About                      - Display the version information
AcAdd                      - Add Rule to Source IP Address Limit List (IPv4)
AcAdd6                     - Add Rule to Source IP Address Limit List (IPv6)
AcDel                      - Delete Rule from Source IP Address Limit List
AcList                     - Get List of Rule Items of Source IP Address Limit List
AccessAdd                  - Add Access List Rules (IPv4)
AccessAdd6                 - Add Access List Rules (IPv6)
AccessAddEx                - Add Extended Access List Rules (IPv4: Delay, Jitter and Packet Loss Generating)
AccessAddEx6               - Add Extended Access List Rules (IPv6: Delay, Jitter and Packet Loss Generating)
AccessDelete               - Delete Rule from Access List
AccessDisable              - Disable Access List Rule
AccessEnable               - Enable Access List Rule
AccessList                 - Get Access List Rule List
AdminOptionList            - Get List of Virtual Hub Administration Options
AdminOptionSet             - Set Values of Virtual Hub Administration Options
BridgeCreate               - Create Local Bridge Connection
BridgeDelete               - Delete Local Bridge Connection
BridgeDeviceList           - Get List of Network Adapters Usable as Local Bridge
BridgeList                 - Get List of Local Bridge Connection
CAAdd                      - Add Trusted CA Certificate
CADelete                   - Delete Trusted CA Certificate
CAGet                      - Get Trusted CA Certificate
CAList                     - Get List of Trusted CA Certificates
Caps                       - Get List of Server Functions/Capability
CascadeAnonymousSet        - Set User Authentication Type of Cascade Connection to Anonymous Authentication
CascadeCertGet             - Get Client Certificate to Use for Cascade Connection
CascadeCertSet             - Set User Authentication Type of Cascade Connection to Client Certificate Authentication
CascadeCompressDisable     - Disable Data Compression when Communicating by Cascade Connection
CascadeCompressEnable      - Enable Data Compression when Communicating by Cascade Connection
CascadeCreate              - Create New Cascade Connection
CascadeDelete              - Delete Cascade Connection Setting
CascadeDetailSet           - Set Advanced Settings for Cascade Connection
CascadeEncryptDisable      - Disable Encryption when Communicating by Cascade Connection
CascadeEncryptEnable       - Enable Encryption when Communicating by Cascade Connection
CascadeGet                 - Get the Cascade Connection Setting
CascadeList                - Get List of Cascade Connections
CascadeOffline             - Switch Cascade Connection to Offline Status
CascadeOnline              - Switch Cascade Connection to Online Status
CascadePasswordSet         - Set User Authentication Type of Cascade Connection to Password Authentication
CascadePolicySet           - Set Cascade Connection Session Security Policy
CascadeProxyHttp           - Set Connection Method of Cascade Connection to be via an HTTP Proxy Server
CascadeProxyNone           - Specify Direct TCP/IP Connection as the Connection Method of Cascade Connection
CascadeProxySocks          - Set Connection Method of Cascade Connection to be via an SOCKS Proxy Server
CascadeRename              - Change Name of Cascade Connection
CascadeServerCertDelete    - Delete the Server Individual Certificate for Cascade Connection
CascadeServerCertDisable   - Disable Cascade Connection Server Certificate Verification Option
CascadeServerCertEnable    - Enable Cascade Connection Server Certificate Verification Option
CascadeServerCertGet       - Get the Server Individual Certificate for Cascade Connection
CascadeServerCertSet       - Set the Server Individual Certificate for Cascade Connection
CascadeSet                 - Set the Destination for Cascade Connection
CascadeStatusGet           - Get Current Cascade Connection Status
CascadeUsernameSet         - Set User Name to Use Connection of Cascade Connection
Check                      - Check whether SoftEther VPN Operation is Possible
ClusterConnectionStatusGet - Get Connection Status to Cluster Controller
ClusterMemberCertGet       - Get Cluster Member Certificate
ClusterMemberInfoGet       - Get Cluster Member Information
ClusterMemberList          - Get List of Cluster Members
ClusterSettingController   - Set VPN Server Type as Cluster Controller
ClusterSettingGet          - Get Clustering Configuration of Current VPN Server
ClusterSettingMember       - Set VPN Server Type as Cluster Member
ClusterSettingStandalone   - Set VPN Server Type as Standalone
ConfigGet                  - Get the current configuration of the VPN Server
ConfigSet                  - Write Configuration File to VPN Server
ConnectionDisconnect       - Disconnect TCP Connections Connecting to the VPN Server
ConnectionGet              - Get Information of TCP Connections Connecting to the VPN Server
ConnectionList             - Get List of TCP Connections Connecting to the VPN Server
Crash                      - Raise a error on the VPN Server / Bridge to terminate the process forcefully.
CrlAdd                     - Add a Revoked Certificate
CrlDel                     - Delete a Revoked Certificate
CrlGet                     - Get a Revoked Certificate
CrlList                    - Get List of Certificates Revocation List
Debug                      - Execute a Debug Command
DhcpDisable                - Disable Virtual DHCP Server Function of SecureNAT Function
DhcpEnable                 - Enable Virtual DHCP Server Function of SecureNAT Function
DhcpGet                    - Get Virtual DHCP Server Function Setting of SecureNAT Function
DhcpSet                    - Change Virtual DHCP Server Function Setting of SecureNAT Function
DhcpTable                  - Get Virtual DHCP Server Function Lease Table of SecureNAT Function
DynamicDnsGetStatus        - Show the Current Status of Dynamic DNS Function
DynamicDnsSetHostname      - Set the Dynamic DNS Hostname
EtherIpClientAdd           - Add New EtherIP / L2TPv3 over IPsec Client Setting to Accept EthreIP / L2TPv3 Client Devices
EtherIpClientDelete        - Delete an EtherIP / L2TPv3 over IPsec Client Setting
EtherIpClientList          - Get the Current List of EtherIP / L2TPv3 Client Device Entry Definitions
ExtOptionList              - Get List of Virtual Hub Extended Options
ExtOptionSet               - Set a Value of Virtual Hub Extended Options
Flush                      - Save All Volatile Data of VPN Server / Bridge to the Configuration File
GroupCreate                - Create Group
GroupDelete                - Delete Group
GroupGet                   - Get Group Information and List of Assigned Users
GroupJoin                  - Add User to Group
GroupList                  - Get List of Groups
GroupPolicyRemove          - Delete Group Security Policy
GroupPolicySet             - Set Group Security Policy
GroupSet                   - Set Group Information
GroupUnjoin                - Delete User from Group
Hub                        - Select Virtual Hub to Manage
HubCreate                  - Create New Virtual Hub
HubCreateDynamic           - Create New Dynamic Virtual Hub (For Clustering)
HubCreateStatic            - Create New Static Virtual Hub (For Clustering)
HubDelete                  - Delete Virtual Hub
HubList                    - Get List of Virtual Hubs
HubSetDynamic              - Change Virtual Hub Type to Dynamic Virtual Hub
HubSetStatic               - Change Virtual Hub Type to Static Virtual Hub
IPsecEnable                - Enable or Disable IPsec VPN Server Function
IPsecGet                   - Get the Current IPsec VPN Server Settings
IpDelete                   - Delete IP Address Table Entry
IpTable                    - Get the IP Address Table Database
KeepDisable                - Disable the Keep Alive Internet Connection Function
KeepEnable                 - Enable the Keep Alive Internet Connection Function
KeepGet                    - Get the Keep Alive Internet Connection Function
KeepSet                    - Set the Keep Alive Internet Connection Function
LicenseAdd                 - Add License Key Registration
LicenseDel                 - Delete Registered License
LicenseList                - Get List of Registered Licenses
LicenseStatus              - Get License Status of Current VPN Server
ListenerCreate             - Create New TCP Listener
ListenerDelete             - Delete TCP Listener
ListenerDisable            - Stop TCP Listener Operation
ListenerEnable             - Begin TCP Listener Operation
ListenerList               - Get List of TCP Listeners
LogDisable                 - Disable Security Log or Packet Log
LogEnable                  - Enable Security Log or Packet Log
LogFileGet                 - Download Log file
LogFileList                - Get List of Log Files
LogGet                     - Get Log Save Setting of Virtual Hub
LogPacketSaveType          - Set Save Contents and Type of Packet to Save to Packet Log
LogSwitchSet               - Set Log File Switch Cycle
MacDelete                  - Delete MAC Address Table Entry
MacTable                   - Get the MAC Address Table Database
MakeCert                   - Create New X.509 Certificate and Private Key (1024 bit)
MakeCert2048               - Create New X.509 Certificate and Private Key (2048 bit)
NatDisable                 - Disable Virtual NAT Function of SecureNAT Function
NatEnable                  - Enable Virtual NAT Function of SecureNAT Function
NatGet                     - Get Virtual NAT Function Setting of SecureNAT Function
NatSet                     - Change Virtual NAT Function Setting of SecureNAT Function
NatTable                   - Get Virtual NAT Function Session Table of SecureNAT Function
Offline                    - Switch Virtual Hub to Offline
Online                     - Switch Virtual Hub to Online
OpenVpnEnable              - Enable / Disable OpenVPN Clone Server Function
OpenVpnGet                 - Get the Current Settings of OpenVPN Clone Server Function
OpenVpnMakeConfig          - Generate a Sample Setting File for OpenVPN Client
OptionsGet                 - Get Options Setting of Virtual Hubs
PolicyList                 - Display List of Security Policy Types and Settable Values
RadiusServerDelete         - Delete Setting to Use RADIUS Server for User Authentication
RadiusServerGet            - Get Setting of RADIUS Server Used for User Authentication
RadiusServerSet            - Set RADIUS Server to use for User Authentication
Reboot                     - Reboot VPN Server Service
RouterAdd                  - Define New Virtual Layer 3 Switch
RouterDelete               - Delete Virtual Layer 3 Switch
RouterIfAdd                - Add Virtual Interface to Virtual Layer 3 Switch
RouterIfDel                - Delete Virtual Interface of Virtual Layer 3 Switch
RouterIfList               - Get List of Interfaces Registered on the Virtual Layer 3 Switch
RouterList                 - Get List of Virtual Layer 3 Switches
RouterStart                - Start Virtual Layer 3 Switch Operation
RouterStop                 - Stop Virtual Layer 3 Switch Operation
RouterTableAdd             - Add Routing Table Entry for Virtual Layer 3 Switch
RouterTableDel             - Delete Routing Table Entry of Virtual Layer 3 Switch
RouterTableList            - Get List of Routing Tables of Virtual Layer 3 Switch
SecureNatDisable           - Disable the Virtual NAT and DHCP Server Function (SecureNat Function)
SecureNatEnable            - Enable the Virtual NAT and DHCP Server Function (SecureNat Function)
SecureNatHostGet           - Get Network Interface Setting of Virtual Host of SecureNAT Function
SecureNatHostSet           - Change Network Interface Setting of Virtual Host of SecureNAT Function
SecureNatStatusGet         - Get the Operating Status of the Virtual NAT and DHCP Server Function (SecureNat Function)
ServerCertGet              - Get SSL Certificate of VPN Server
ServerCertRegenerate       - Generate New Self-Signed Certificate with Specified CN (Common Name) and Register on VPN Server
ServerCertSet              - Set SSL Certificate and Private Key of VPN Server
ServerCipherGet            - Get the Encrypted Algorithm Used for VPN Communication.
ServerCipherSet            - Set the Encrypted Algorithm Used for VPN Communication.
ServerInfoGet              - Get server information
ServerKeyGet               - Get SSL Certificate Private Key of VPN Server
ServerPasswordSet          - Set VPN Server Administrator Password
ServerStatusGet            - Get Current Server Status
SessionDisconnect          - Disconnect Session
SessionGet                 - Get Session Information
SessionList                - Get List of Connected Sessions
SetEnumAllow               - Allow Enumeration by Virtual Hub Anonymous Users
SetEnumDeny                - Deny Enumeration by Virtual Hub Anonymous Users
SetHubPassword             - Set Virtual Hub Administrator Password
SetMaxSession              - Set the Max Number of Concurrently Connected Sessions for Virtual Hub
SstpEnable                 - Enable / Disable Microsoft SSTP VPN Clone Server Function
SstpGet                    - Get the Current Settings of Microsoft SSTP VPN Clone Server Function
StatusGet                  - Get Current Status of Virtual Hub
SyslogDisable              - Disable syslog Send Function
SyslogEnable               - Set syslog Send Function
SyslogGet                  - Get syslog Send Function
TrafficClient              - Run Network Traffic Speed Test Tool in Client Mode
TrafficServer              - Run Network Traffic Speed Test Tool in Server Mode
UserAnonymousSet           - Set Anonymous Authentication for User Auth Type
UserCertGet                - Get Certificate Registered for Individual Certificate Authentication User
UserCertSet                - Set Individual Certificate Authentication for User Auth Type and Set Certificate
UserCreate                 - Create User
UserDelete                 - Delete User
UserExpiresSet             - Set User's Expiration Date
UserGet                    - Get User Information
UserList                   - Get List of Users
UserNTLMSet                - Set NT Domain Authentication for User Auth Type
UserPasswordSet            - Set Password Authentication for User Auth Type and Set Password
UserPolicyRemove           - Delete User Security Policy
UserPolicySet              - Set User Security Policy
UserRadiusSet              - Set RADIUS Authentication for User Auth Type
UserSet                    - Change User Information
UserSignedSet              - Set Signed Certificate Authentication for User Auth Type
VpnAzureGetStatus          - Show the current status of VPN Azure function
VpnAzureSetEnable          - Enable / Disable VPN Azure Function
VpnOverIcmpDnsEnable       - Enable / Disable the VPN over ICMP / VPN over DNS Server Function
VpnOverIcmpDnsGet          - Get Current Setting of the VPN over ICMP / VPN over DNS Function
To reference the usage for each command, input "command name ?" to view a help.

https://www.softether.org/4-docs/1-manual/2._SoftEther_VPN_Essential_Architecture/2.6_VPN_Command_Line_Management_Utility_(vpncmd)