Table of contents
You are currently comparing two old versions - only when you are comparing against the latest version can you revert. Return to version archive.
Figure 6-2-1 Users Registered After Executing the batch.txt File
Combined revision comparison
...
| vpncmd Command Reference | |
| Command Name | vpncmd |
| Outline of Command | SoftEther VPN Command Line Management Utility |
| Explanation | 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 speed measurement function, 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 manually set, as appropriate, the PATH environment variable. |
| Commandline format | vpncmd [host:port] [/CLIENT|/SERVER|/TOOLS] [/Hub:hub] [/ADMINHUB:adminhub] [/PASSWORD:password] [/IN:infile] [/OUT:outfile] [/CMD commands...] |
| List of parameter argument that can be specified by vpncmd command. | |
| 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 to do this together with /SERVER. |
| /SERVER | This will connect to VPN Server or VPN Bridge to do management. You cannot specify to do this together with /CLIENT. |
| /TOOLS | This will enables use of VPN Tools commands. VPN Tools include a simple certificate creation tool (MakeCert command) and a communication speed measurement 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 'command_line...' 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. |
...
| C:\>vpncmd /server localhost /adminhub:VPN /cmd UserCreate ABC /GROUP:none /REAL NAME:none /NOTE:none vpncmd command - SoftEther VPN Command Line Management Utility SoftEther VPN Command Line Management Utility (vpncmd command) Connection was established with VPN Server "localhost" (port 5555 You have administrator privileges for the entire VPN Server. The Virtual Hub "VPN" was selected. VPN Server/VPN>UserCreate ABC /GROUP:none /REALNAME:none /NOTE:none UserCreate command - Create User The command terminated normally. C:\> |
...
...
Version from 17:48, 2 Mar 2013
...
| vpncmd Command Reference | |
| Command Name | vpncmd |
| Outline of Command | SoftEther VPN |
| Explanation | 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 speed measurement function, 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 manually set, as appropriate, the PATH environment variable. |
| Commandline format | vpncmd [host:port] [/CLIENT|/SERVER|/TOOLS] [/Hub:hub] [/ADMINHUB:adminhub] [/PASSWORD:password] [/IN:infile] [/OUT:outfile] [/CMD commands...] |
| List of parameter argument that can be specified by vpncmd command. | |
| 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 to do this together with /SERVER. |
| /SERVER | This will connect to VPN Server or VPN Bridge to do management. You cannot specify to do this together with /CLIENT. |
| /TOOLS | This will enables use of VPN Tools commands. VPN Tools include a simple certificate creation tool (MakeCert command) and a communication speed measurement 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 'command_line...' 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. |
...
| C:\>vpncmd /server localhost /adminhub:VPN /cmd UserCreate ABC /GROUP:none /REAL NAME:none /NOTE:none vpncmd command - SoftEther VPN Command Line Management Utility SoftEther VPN Command Line Management Utility (vpncmd command) Connection was established with VPN Server "localhost" (port You have administrator privileges for the entire VPN Server. The Virtual Hub "VPN" was selected. VPN Server/VPN>UserCreate ABC /GROUP:none /REALNAME:none /NOTE:none UserCreate command - Create User The command terminated normally. C:\> |
...
/html/images/6-2-1.gif)
|
...
Current version
...
| vpncmd Command Reference | |
| Command Name | vpncmd |
| Outline of Command | SoftEther VPN Command Line Management Utility |
| Explanation | 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 speed measurement function, 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 manually set, as appropriate, the PATH environment variable. |
| Commandline format | vpncmd [host:port] [/CLIENT|/SERVER|/TOOLS] [/Hub:hub] [/ADMINHUB:adminhub] [/PASSWORD:password] [/IN:infile] [/OUT:outfile] [/CMD commands...] |
| List of parameter argument that can be specified by vpncmd command. | |
| 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 to do this together with /SERVER. |
| /SERVER | This will connect to VPN Server or VPN Bridge to do management. You cannot specify to do this together with /CLIENT. |
| /TOOLS | This will enables use of VPN Tools commands. VPN Tools include a simple certificate creation tool (MakeCert command) and a communication speed measurement 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 'command_line...' 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. |
...
| C:\>vpncmd /server localhost /adminhub:VPN /cmd UserCreate ABC /GROUP:none /REAL NAME:none /NOTE:none vpncmd command - SoftEther VPN Command Line Management Utility SoftEther VPN Command Line Management Utility (vpncmd command) Connection was established with VPN Server "localhost" (port 5555). You have administrator privileges for the entire VPN Server. The Virtual Hub "VPN" was selected. VPN Server/VPN>UserCreate ABC /GROUP:none /REALNAME:none /NOTE:none UserCreate command - Create User The command terminated normally. C:\> |
...
