vpncmd命令详解

vpncmd 命令 - SoftEther VPN 命令行管理工具
SoftEther VPN 命令行管理工具 (vpncmd 命令)
版本 4.38 Build 9760 (英文)
编译于 2021/08/17 22:32:49 由 crosswin 构建
版权所有 (c) SoftEther VPN 项目。保留所有权利。

“vpncmd” 命令的帮助

目的：
SoftEther VPN 命令行管理工具

描述：
‘vpncmd’ 程序是一个实用工具，允许您通过使用命令行来管理 SoftEther VPN 软件。通过使用 vpncmd，您可以连接到在本地或远程计算机上运行的 VPN 客户端、VPN 服务器或 VPN 桥，并管理这些服务。此外，通过使用 VPN
工具模式，您可以调用网络流量速度测试工具和证书创建功能。即使未连接到 VPN 服务器或 VPN 客户端，也可以使用这些功能。
当使用 vpncmd 时，如果使用 /IN 和 /OUT 参数指定文件名，则可以根据列举了可执行命令的文件批量执行命令，并将执行结果写入文件。通常情况下，启动 vpncmd 后会出现命令提示符，但是当通过 /IN 参数指定输入文件时，程序将
在执行输入文件中的所有行后自动终止。此外，当通过 /CMD 参数指定要执行的命令时，程序将在该命令执行完成后自动终止。不能同时指定 /IN 参数和 /CMD 参数。vpncmd 程序的终止代码将是最后一个执行的命令的错误代码（在成功执行
的情况下为 0）。
在 Windows 环境下，如果以具有管理员权限的用户身份启动了 vpncmd 一次或多次，则可以简单地在 Windows 命令提示符或 [运行…] 窗口中输入 ‘vpncmd’ 来启动 vpncmd。在 UNIX 系统下，您可以手动设置 PATH 环境变量，以便
适当地启动。

用法：

  vpncmd [host:port] [/CLIENT|/SERVER|/TOOLS] [/HUB:hub] [/ADMINHUB:adminhub] [/PASSWORD:password] [/IN:infile] [/OUT:outfile] [/CMD commands...]

参数：

  host:port    - 通过以 "主机名:端口号" 的格式指定参数，将自动连接到该主机。如果未指定此参数，将出现提示以输入连接目标。当连接到 VPN 客户端时，无法指定端口号。
  /CLIENT      - 这将连接到 VPN 客户端以进行管理。不能与 /SERVER 一起指定。
  /SERVER      - 这将连接到 VPN 服务器或 VPN 桥以进行管理。不能与 /CLIENT 一起指定。
  /TOOLS       - 这将启用 VPN 工具命令的使用。VPN 工具包括简单的证书创建工具（MakeCert 命令）和网络流量速度测试工具（SpeedTest 命令）。
  /HUB         - 当通过 "虚拟 Hub 管理模式" 连接到 VPN 服务器时，会指定虚拟 Hub 名称 'hub'。如果指定了主机名但未指定 /HUB 参数，则将通过 "服务器管理模式" 进行连接。
  /ADMINHUB    - 这将指定在连接到 VPN 服务器后自动选择的虚拟 Hub 'adminhub' 的名称。如果指定了 /HUB 参数，则将自动选择虚拟 Hub，因此不需要此指定。
  /PASSWORD    - 如果连接时需要管理员密码，请指定密码 'password'。当未指定密码时，将显示提示以输入密码。
  /IN          - 这将指定包含在连接完成后自动执行的命令列表的文本文件 'infile'。如果指定了 /IN 参数，vpncmd 程序将在文件中的所有命令执行完成后自动终止。如果文件包含多字节字符，则编码必须为 Unicode（UTF-8）。这不能与 /CMD
                 一起指定（如果指定了 /CMD，则将忽略 /IN）。
  /OUT         - 您可以指定文本文件 'outfile'，以写入所有字符串，如屏幕提示、消息、错误和执行结果。请注意，如果指定的文件已存在，则将覆盖现有文件的内容。输出字符串将使用 Unicode（UTF-8）编码记录。
  /CMD         - 如果在 /CMD 后包含可选命令 'commands...'，则该命令将在连接完成后执行，并且 vpncmd 程序将在执行后终止。这不能与 /IN 一起指定（如果与 /IN 一起指定，将忽略 /IN）。在所有其他 vpncmd 参数之后指定 /CMD 参数。
  /CSV         - 您可以指定此选项以启用 CSV 输出。每个命令的结果将以 CSV 格式打印。这对其他程序处理结果非常有用。
  /PROGRAMMING - 此参数没有说明。