2.6 VPN コマンドライン管理ユーティリティ (vpncmd) - SoftEther VPN プロジェクト

2.6 VPN コマンドライン管理ユーティリティ (vpncmd)

    「SoftEther VPN コマンドライン管理ユーティリティ (vpncmd)」は、SoftEther VPN Server、SoftEther VPN Client および SoftEther VPN Bridge の 3 種類のソフトウェアに、ローカルまたはリモートで接続し、通常 GUI で行う設定や操作などの制御を、コマンドラインまたは入力ファイルからの入力によって行うことができる優れたコマンドラインユーティリティです。

    2.6.1 vpncmd とは

    VPN コマンドライン管理ユーティリティ (vpncmd) について

    「SoftEther VPN コマンドライン管理ユーティリティ (vpncmd)」は、「2.4 VPN サーバー管理マネージャ」 および 「2.5 VPN クライアント接続マネージャ」 で解説した「SoftEther VPN サーバー管理ユーティリティ」および「SoftEther VPN クライアント接続マネージャ」の、2 種類の Windows 用制御ツールをコマンドラインインターフェイス (CUI) 化したソフトウェアです。

    vpncmd は SoftEther VPN Server をサポートしているオペレーティングシステム上であれば動作します。 Linux / FreeBSD / Solaris / Mac OS X でも使用できます。したがって、SoftEther VPN Server などをインストールしたコンピュータの SSH コンソール上で、そのまま vpncmd を呼び出して localhost に接続することにより、SoftEther VPN Server の管理を行うことができます。

    外部のプログラムからの vpncmd の呼び出し

    vpncmd プログラムを起動する際に、コマンドライン引数として「入力ファイル (/IN)」を指定することによって、複数のコマンドを書いたコマンドファイルを入力し、それらを自動的に実行させることが可能です。さらに、実行結果を「出力ファイル (/OUT)」に書き出すことができます。これらの機能により、外部のプログラムから vpncmd を呼び出して、VPN Server / VPN Client / VPN Bridge を自動制御することも簡単に行えます。

    大量のユーザー登録などの繰り返し処理での vpncmd の使用

    vpncmd プログラムを活用すると、たとえば大量のユーザー (数千人~数万人) を、一度に SoftEther VPN Server の仮想 HUB に登録するといった、GUI を使用した場合には非常に時間のかかる処理を、半自動的に実行させることができます。

    vpncmd と GUI ツールの使い分け

    vpncmd プログラムのコマンドラインインターフェイスには、大量のコマンドが搭載されており、これらのコマンドすべてを使いこなすためには、「6. コマンドライン管理ユーティリティマニュアル」 またはコマンドヘルプを熟読する必要があります。「SoftEther VPN サーバー管理マネージャ」や「SoftEther VPN クライアント接続マネージャ」は、SoftEther VPN の初心者でもすべての機能を簡単に使いこなすことができますが、vpncmd プログラムを使いこなすには時間がかかります。

    したがって、日常的な操作や管理および設定についてはSoftEther VPN サーバー管理マネージャや SoftEther VPN クライアント接続マネージャをできる限り使用し、大量のユーザーを登録したり別のプログラムから自動的に制御を行ったりするために vpncmd プログラムを使用するのが最適でしょう。

    vpncmd の具体的な使用方法

    vpncmd プログラムにおけるコマンドの具体的な使用方法については、「6. コマンドライン管理ユーティリティマニュアル」 を参照してください。

    2-6-1.png

    VPN コマンドライン管理ユーティリティ (vpncmd)

    2.6.2 コマンドヘルプの表示

    vpncmd プログラムのコマンドラインコンソールにおいて、使用方法が分からないコマンドがあった場合は、そのコマンド名の後ろに「--help」または「/help」と付けることによって、コマンドヘルプが表示されます。

    また、コマンド名を忘れてしまった場合は、「help」と入力することによって、すべてのコマンド名が表示されます。

    vpncmd のコマンド名は、原則として操作対象の「オブジェクトの種類の名前」が先頭に付きます。たとえば、新しいユーザーを作成するコマンドは UserCreate コマンドです。このような場合、「User?」と入力することで "User" で始まるコマンドの一覧が表示されます。

    vpncmd プログラムのコマンドラインコンソールにおけるコマンドの入力方法や入力規則および自動補完機能の詳細については 「6. コマンドライン管理ユーティリティマニュアル」 を参照してください。