PacketiX VPN 2.0 マニュアル 第6章 コマンドライン管理ユーティリティマニュアル 6.3 VPN Server / VPN Bridge の管理コマンドリファレンス (サーバー全体編) |
6.3 VPN Server / VPN Bridge の管理コマンドリファレンス (サーバー全体編)
ここでは、vpncmd を「VPN Server または VPN Bridge
の管理」モードで使用している場合に呼び出すことができるすべてのコマンドのうち、VPN Server
全体を設定・管理するためのコマンドについて解説します。なお、仮想 HUB を Hub コマンドで選択してから仮想 HUB
に対する設定・管理を行うためコマンドについては 「6.4 VPN Server / VPN Bridge の管理コマンドリファレンス (仮想 HUB 編)」 を参照してください。
6.3.1 About - バージョン情報の表示
コマンド名 |
About |
コマンドの概要 |
バージョン情報の表示 |
説明 |
このコマンドライン管理ユーティリティのバージョン情報を表示します。バージョン情報には、vpncmd のバージョン番号、ビルド番号、ビルド情報などが含まれます。 |
コマンドライン書式 |
About |
vpncmd
コマンドで指定することができるパラメータ引数の一覧 |
このコマンドには指定すべきパラメータ引数は 1 つもありません。 |
6.3.2 ServerInfoGet - サーバー情報の取得
コマンド名 |
ServerInfoGet |
コマンドの概要 |
サーバー情報の取得 |
説明 |
現在接続している VPN Server または VPN Bridge のサーバー情報を取得します。サーバーの情報には、バージョン番号、ビルド番号、ビルド情報などが含まれます。また、現在のサーバーの動作モードや動作しているオペレーティングシステムの情報なども取得できます。 |
コマンドライン書式 |
ServerInfoGet |
vpncmd
コマンドで指定することができるパラメータ引数の一覧 |
このコマンドには指定すべきパラメータ引数は 1 つもありません。 |
6.3.3 ServerStatusGet - サーバーの現在の状態の取得
コマンド名 |
ServerStatusGet |
コマンドの概要 |
サーバーの現在の状態の取得 |
説明 |
現在接続している VPN Server または VPN Bridge の現在の状態をリアルタイムに取得します。サーバー上に存在する各種オブジェクトの個数やデータ通信の統計情報などを取得できます。また、OS によっては現在コンピュータで使用されているメモリ量などを取得することもできます。 |
コマンドライン書式 |
ServerStatusGet |
vpncmd
コマンドで指定することができるパラメータ引数の一覧 |
このコマンドには指定すべきパラメータ引数は 1 つもありません。 |
6.3.4 ListenerCreate - TCP リスナーの追加
コマンド名 |
ListenerCreate |
コマンドの概要 |
TCP リスナーの追加 |
説明 |
サーバーに新しい TCP リスナーを追加します。TCP リスナーを追加すると、サーバーは指定した TCP/IP ポート番号でクライアントからの接続の待機を開始します。 一度追加した TCP リスナーは、ListenerDelete コマンドで後から削除することができます。 なお、現在の登録されている TCP リスナーの一覧は、ListenerList コマンドで取得することができます。 このコマンドを実行するには、VPN Server の管理者権限が必要です。 |
コマンドライン書式 |
ListenerCreate [port] |
vpncmd
コマンドで指定することができるパラメータ引数の一覧 |
port |
新しく追加する TCP/IP リスナーのポート番号を整数で指定します。すでに別のプログラムが使用しているポート番号を使用することもできますが、そのプログラムがポートの使用を終了するまで、VPN Server はそのポートを使用できません。ポート番号は 1 以上 65535 以下で指定してください。 |
6.3.5 ListenerDelete - TCP リスナーの削除
コマンド名 |
ListenerDelete |
コマンドの概要 |
TCP リスナーの削除 |
説明 |
サーバーに登録されている TCP リスナーを削除します。TCP リスナーが動作状態にある場合は、自動的に動作を停止してからリスナーが削除されます。 なお、現在の登録されている TCP リスナーの一覧は、ListenerList コマンドで取得することができます。 このコマンドを実行するには、VPN Server の管理者権限が必要です。 |
コマンドライン書式 |
ListenerDelete [port] |
vpncmd
コマンドで指定することができるパラメータ引数の一覧 |
port |
削除したい既に登録されている TCP/IP リスナーのポート番号を整数で指定します。 |
6.3.6 ListenerList - TCP リスナー一覧の取得
コマンド名 |
ListenerList |
コマンドの概要 |
TCP リスナー一覧の取得 |
説明 |
現在サーバーに登録されている TCP リスナーの一覧を取得します。各 TCP リスナーが動作中またはエラー状態であるかどうかの情報も取得します。 このコマンドを実行するには、VPN Server の管理者権限が必要です。 |
コマンドライン書式 |
ListenerList |
vpncmd
コマンドで指定することができるパラメータ引数の一覧 |
このコマンドには指定すべきパラメータ引数は 1 つもありません。 |
6.3.7 ListenerEnable - TCP リスナーの動作開始
コマンド名 |
ListenerEnable |
コマンドの概要 |
TCP リスナーの動作開始 |
説明 |
現在サーバーに登録されている TCP リスナーが停止している場合は、その動作を開始します。 なお、現在の登録されている TCP リスナーの一覧は、ListenerList コマンドで取得することができます。 このコマンドを実行するには、VPN Server の管理者権限が必要です。 |
コマンドライン書式 |
ListenerEnable [port] |
vpncmd
コマンドで指定することができるパラメータ引数の一覧 |
port |
開始する TCP/IP リスナーのポート番号を整数で指定します。 |
6.3.8 ListenerDisable - TCP リスナーの動作停止
コマンド名 |
ListenerDisable |
コマンドの概要 |
TCP リスナーの動作停止 |
説明 |
現在サーバーに登録されている TCP リスナーが動作している場合は、その動作を停止します。 なお、現在の登録されている TCP リスナーの一覧は、ListenerList コマンドで取得することができます。 このコマンドを実行するには、VPN Server の管理者権限が必要です。 |
コマンドライン書式 |
ListenerDisable [port] |
vpncmd
コマンドで指定することができるパラメータ引数の一覧 |
port |
停止する TCP/IP リスナーのポート番号を整数で指定します。 |
6.3.9 ServerPasswordSet - VPN Server の管理者パスワードの設定
コマンド名 |
ServerPasswordSet |
コマンドの概要 |
VPN Server の管理者パスワードの設定 |
説明 |
VPN Server の管理者パスワードを設定します。パラメータとしてパスワードを指定することができます。パラメータを指定しない場合は、パスワードとその確認入力を行なうためのプロンプトが表示されます。パスワードをパラメータに与えた場合、そのパスワードが一時的に画面に表示されるため危険です。できる限り、パラメータを指定せずにパスワードプロンプトを用いてパスワードを入力することを推奨します。 このコマンドを実行するには、VPN Server の管理者権限が必要です。 |
コマンドライン書式 |
ServerPasswordSet [password] |
vpncmd
コマンドで指定することができるパラメータ引数の一覧 |
password |
新しく設定するパスワードを指定します。 |
6.3.10 ClusterSettingGet - 現在の VPN Server のクラスタリング構成の取得
コマンド名 |
ClusterSettingGet |
コマンドの概要 |
現在の VPN Server のクラスタリング構成の取得 |
説明 |
現在の VPN Server のクラスタリング構成を取得します。 このコマンドを実行するには、VPN Server の管理者権限が必要です。 |
コマンドライン書式 |
ClusterSettingGet |
vpncmd
コマンドで指定することができるパラメータ引数の一覧 |
このコマンドには指定すべきパラメータ引数は 1 つもありません。 |
6.3.11 ClusterSettingStandalone - VPN Server の種類をスタンドアロンに設定
コマンド名 |
ClusterSettingStandalone |
コマンドの概要 |
VPN Server の種類をスタンドアロンに設定 |
説明 |
VPN Server の種類を「スタンドアロンサーバー」に設定します。スタンドアロンサーバーとは、いずれのクラスタにも属していない状態の VPN Server を意味します。VPN Server をインストールした状態のデフォルトはスタンドアロンサーバーモードで動作しています。特にクラスタを構成する予定がない場合は、スタンドアロンサーバーモードで動作させることを推奨します。 このコマンドを実行するには、VPN Server の管理者権限が必要です。 また、このコマンドを実行すると、VPN Server は自動的に再起動します。 このコマンドは、VPN Bridge では実行できません。 |
コマンドライン書式 |
ClusterSettingStandalone |
vpncmd
コマンドで指定することができるパラメータ引数の一覧 |
このコマンドには指定すべきパラメータ引数は 1 つもありません。 |
6.3.12 ClusterSettingController - VPN Server の種類をクラスタコントローラに設定
コマンド名 |
ClusterSettingController |
コマンドの概要 |
VPN Server の種類をクラスタコントローラに設定 |
説明 |
VPN Server の種類を「クラスタコントローラ」に設定します。クラスタコントローラとは、複数台の VPN Server でクラスタリングを構築する場合における、各クラスタメンバサーバーの中心となるコンピュータで、クラスタ内に 1 台必要です。同一クラスタを構成する他のクラスタメンバサーバーはクラスタコントローラに接続することによりクラスタメンバとしての動作を開始します。 このコマンドを実行するには、VPN Server の管理者権限が必要です。 また、このコマンドを実行すると、VPN Server は自動的に再起動します。 このコマンドは、VPN Bridge では実行できません。 |
コマンドライン書式 |
ClusterSettingController [/WEIGHT:weight] [/ONLY:yes|no] |
vpncmd
コマンドで指定することができるパラメータ引数の一覧 |
/WEIGHT |
この VPN Server の性能基準比の値を設定します。クラスタ内でロードバランシングを行う際に基準となる値です。通常は 100 です。例えば、他のメンバが 100 の状態で 1 台だけ 200 にすると、他のメンバの 2 倍接続を受け持つようにロードバランシング時に調整されます。値は 1 以上で指定します。このパラメータを指定しない場合は 100 が使用されます。 |
/ONLY |
"yes" を指定すると、VPN Server がクラスタ内でコントローラとしての機能のみを動作させ、一般の VPN Client の接続は自分自身以外のメンバに必ず振り分けるようになります。この機能は、負荷が高い環境で使用します。このパラメータを指定しない場合は "no" が使用されます。 |
6.3.13 ClusterSettingMember - VPN Server の種類をクラスタメンバに設定
コマンド名 |
ClusterSettingMember |
コマンドの概要 |
VPN Server の種類をクラスタメンバに設定 |
説明 |
VPN Server の種類を「クラスタメンバサーバー」に設定します。クラスタメンバサーバーとは、複数台の VPN Server でクラスタリングを構築する場合における、特定の既存のクラスタコントローラが中心となって構成されるクラスタに属する他のメンバコンピュータで、クラスタに必要なだけ複数追加することができます。 クラスタメンバサーバーとして VPN Server を設定するには、事前に参加する予定のクラスタのコントローラの管理者に、コントローラの IP アドレスとポート番号、この VPN Server の公開 IP アドレスおよび公開ポート番号 (必要な場合)、およびパスワードを問い合わせる必要があります。 このコマンドを実行するには、VPN Server の管理者権限が必要です。 また、このコマンドを実行すると、VPN Server は自動的に再起動します。 このコマンドは、VPN Bridge では実行できません。 |
コマンドライン書式 |
ClusterSettingMember [server:port] [/IP:ip] [/PORTS:ports] [/PASSWORD:password] [/WEIGHT:weight] |
vpncmd
コマンドで指定することができるパラメータ引数の一覧 |
server:port |
[ホスト名:ポート番号] の形式のパラメータで接続先のクラスタコントローラのホスト名または IP アドレス、およびポート番号を指定します。 |
/IP |
このサーバーの公開 IP アドレスを指定します。公開 IP アドレスを指定しない場合、"/IP:none" のように指定してください。公開 IP アドレスを指定しなければ、クラスタコントローラへの接続の際に使用されるネットワークインターフェイスの IP アドレスが自動的に使われます。 |
/PORTS |
このサーバーの公開ポート番号の一覧を指定します。公開ポート番号は少なくとも 1 つ以上設定する必要があり、複数個設定することも可能です。その場合は、"/PORTS:443,992,8888" のようにカンマ記号で区切ってください。 |
/PASSWORD |
接続先のコントローラに接続するためのパスワードを指定します。接続先のコントローラの管理パスワードと同一です。 |
/WEIGHT |
この VPN Server の性能基準比の値を設定します。クラスタ内でロードバランシングを行う際に基準となる値です。通常は 100 です。例えば、他のメンバが 100 の状態で 1 台だけ 200 にすると、他のメンバの 2 倍接続を受け持つようにロードバランシング時に調整されます。値は 1 以上で指定します。このパラメータを指定しない場合は 100 が使用されます。 |
6.3.14 ClusterMemberList - クラスタメンバの一覧の取得
コマンド名 |
ClusterMemberList |
コマンドの概要 |
クラスタメンバの一覧の取得 |
説明 |
VPN Server がクラスタコントローラとして動作している場合、そのクラスタ内のクラスタメンバサーバーの一覧をクラスタコントローラ自身を含めて取得します。 各メンバごとに、[種類]、[接続時刻]、[ホスト名]、[ポイント]、[セッション数]、[TCP コネクション数]、[動作仮想 HUB 数]、[消費クライアント接続ライセンス]、[消費ブリッジ接続ライセンス] の一覧も取得します。 このコマンドは、VPN Bridge では実行できません。 |
コマンドライン書式 |
ClusterMemberList |
vpncmd
コマンドで指定することができるパラメータ引数の一覧 |
このコマンドには指定すべきパラメータ引数は 1 つもありません。 |
6.3.15 ClusterMemberInfoGet - クラスタメンバの情報の取得
コマンド名 |
ClusterMemberInfoGet |
コマンドの概要 |
クラスタメンバの情報の取得 |
説明 |
VPN Server がクラスタコントローラとして動作している場合、そのクラスタ内のクラスタメンバサーバーの ID を指定してそのメンバサーバーの情報を取得することができます。 指定されたクラスタメンバサーバーの [サーバーの種類]、[接続確立時刻]、[IP アドレス]、[ホスト名]、[ポイント]、[公開ポートの一覧]、[動作している仮想 HUB 数]、[1 個目の仮想 HUB]、[セッション数]、[TCP コネクション数] が取得できます。 このコマンドは、VPN Bridge では実行できません。 |
コマンドライン書式 |
ClusterMemberInfoGet [id] |
vpncmd
コマンドで指定することができるパラメータ引数の一覧 |
id |
情報を取得するクラスタメンバの ID を指定します。クラスタメンバサーバーの ID は ClusterMemberList コマンドで取得することができます。 |
6.3.16 ClusterMemberCertGet - クラスタメンバの証明書の取得
コマンド名 |
ClusterMemberCertGet |
コマンドの概要 |
クラスタメンバの証明書の取得 |
説明 |
VPN Server がクラスタコントローラとして動作している場合、そのクラスタ内のクラスタメンバサーバーの ID を指定してそのメンバサーバーの公開している X.509 証明書を取得することができます。証明書は、X.509 形式のファイルに保存することができます。 このコマンドは、VPN Bridge では実行できません。 |
コマンドライン書式 |
ClusterMemberCertGet [id] [/SAVECERT:cert] |
vpncmd
コマンドで指定することができるパラメータ引数の一覧 |
id |
証明書を取得するクラスタメンバの ID を指定します。クラスタメンバサーバーの ID は ClusterMemberList コマンドで取得することができます。 |
/SAVECERT |
取得した証明書を保存するファイルのパス名を指定します。証明書は X.509 形式で保存されます。 |
6.3.17 ClusterConnectionStatusGet - クラスタコントローラへの接続状態の取得
コマンド名 |
ClusterConnectionStatusGet |
コマンドの概要 |
クラスタコントローラへの接続状態の取得 |
説明 |
VPN Server がクラスタメンバサーバーとして動作している場合、クラスタコントローラへの接続状態を取得します。 取得できる情報には、[コントローラの IP アドレス]、[ポート番号]、[接続状態]、[接続開始時刻]、[最初の接続確立成功時刻]、[現在の接続成功確立時刻]、[接続試行回数]、[接続に成功した回数]、[接続に失敗した回数] があります。 このコマンドは、VPN Bridge では実行できません。 |
コマンドライン書式 |
ClusterConnectionStatusGet |
vpncmd
コマンドで指定することができるパラメータ引数の一覧 |
このコマンドには指定すべきパラメータ引数は 1 つもありません。 |
6.3.18 ServerCertGet - VPN Server の SSL 証明書の取得
コマンド名 |
ServerCertGet |
コマンドの概要 |
VPN Server の SSL 証明書の取得 |
説明 |
VPN Server が接続したクライアントに対して提示する SSL 証明書を取得します。証明書は、X.509 形式のファイルに保存することができます。 |
コマンドライン書式 |
ServerCertGet [cert] |
vpncmd
コマンドで指定することができるパラメータ引数の一覧 |
cert |
取得した証明書を保存するファイルのパス名を指定します。証明書は X.509 形式で保存されます。 |
6.3.19 ServerKeyGet - VPN Server の SSL 証明書の秘密鍵の取得
コマンド名 |
ServerKeyGet |
コマンドの概要 |
VPN Server の SSL 証明書の秘密鍵の取得 |
説明 |
VPN Server が接続したクライアントに対して提示する SSL 証明書の秘密鍵を取得します。秘密鍵は、Base 64 でエンコードされたファイルに保存することができます。 このコマンドを実行するには、VPN Server の管理者権限が必要です。 |
コマンドライン書式 |
ServerKeyGet [key] |
vpncmd
コマンドで指定することができるパラメータ引数の一覧 |
key |
取得した秘密鍵を保存するファイルのパス名を指定します。秘密鍵は Base 64 エンコードされて保存されます。 |
6.3.20 ServerCertSet - VPN Server の SSL 証明書と秘密鍵の設定
コマンド名 |
ServerCertSet |
コマンドの概要 |
VPN Server の SSL 証明書と秘密鍵の設定 |
説明 |
VPN Server が接続したクライアントに対して提示する SSL 証明書とその証明書に対応する秘密鍵を設定します。証明書は X.509 形式、秘密鍵は Base 64 エンコードされた形式である必要があります。 このコマンドを実行するには、VPN Server の管理者権限が必要です。 |
コマンドライン書式 |
ServerCertSet [/LOADCERT:cert] [/LOADKEY:key] |
vpncmd
コマンドで指定することができるパラメータ引数の一覧 |
/LOADCERT |
使用する X.509 形式の証明書ファイルを指定します。 |
/LOADKEY |
使用する Base 64 エンコードされた、証明書に対応する秘密鍵ファイルを指定します。 |
6.3.21 ServerCipherGet - VPN 通信で使用される暗号化アルゴリズムの取得
コマンド名 |
ServerCipherGet |
コマンドの概要 |
VPN 通信で使用される暗号化アルゴリズムの取得 |
説明 |
VPN Server と接続したクライアントとの間で通信に使用する SSL コネクションにおける暗号化および電子署名に用いられるアルゴリズムの現在の設定と VPN Server 上で使用可能なアルゴリズムの一覧を取得します。 |
コマンドライン書式 |
ServerCipherGet |
vpncmd
コマンドで指定することができるパラメータ引数の一覧 |
このコマンドには指定すべきパラメータ引数は 1 つもありません。 |
6.3.22 ServerCipherSet - VPN 通信で使用される暗号化アルゴリズムの設定
コマンド名 |
ServerCipherSet |
コマンドの概要 |
VPN 通信で使用される暗号化アルゴリズムの設定 |
説明 |
VPN Server と接続したクライアントとの間で通信に使用する SSL コネクションにおける暗号化および電子署名に用いられるアルゴリズムを設定します。 アルゴリズム名を指定すると、以後この VPN Server に接続した VPN Client や VPN Bridge との間で指定したアルゴリズムが使用されデータが暗号化されます。 このコマンドを実行するには、VPN Server の管理者権限が必要です。 |
コマンドライン書式 |
ServerCipherSet [name] |
vpncmd
コマンドで指定することができるパラメータ引数の一覧 |
name |
設定するる暗号化および電子署名アルゴリズムを指定します。使用可能なアルゴリズムの一覧は、ServerCipherGet コマンドで取得することができます。 |
6.3.23 KeepEnable - インターネット接続の維持機能の有効化
コマンド名 |
KeepEnable |
コマンドの概要 |
インターネット接続の維持機能の有効化 |
説明 |
[インターネット接続の維持機能] を有効にします。[インターネット接続の維持機能] を使用すると、一定期間無通信状態が続くと自動的に接続が切断されるようなネットワーク接続環境の場合、インターネット上の任意のサーバーに対して一定間隔ごとにパケットを送信することにより、インターネット接続を維持することができます。 接続先のホスト名などについては、KeepSet コマンドで設定することができます。 VPN Server または VPN Bridge でこのコマンドを実行するには、管理者権限が必要です。 |
コマンドライン書式 |
KeepEnable |
vpncmd
コマンドで指定することができるパラメータ引数の一覧 |
このコマンドには指定すべきパラメータ引数は 1 つもありません。 |
6.3.24 KeepDisable - インターネット接続の維持機能の無効化
コマンド名 |
KeepDisable |
コマンドの概要 |
インターネット接続の維持機能の無効化 |
説明 |
[インターネット接続の維持機能] を無効にします。 VPN Server または VPN Bridge でこのコマンドを実行するには、管理者権限が必要です。 |
コマンドライン書式 |
KeepDisable |
vpncmd
コマンドで指定することができるパラメータ引数の一覧 |
このコマンドには指定すべきパラメータ引数は 1 つもありません。 |
6.3.25 KeepSet - インターネット接続の維持機能の設定
コマンド名 |
KeepSet |
コマンドの概要 |
インターネット接続の維持機能の設定 |
説明 |
[インターネット接続の維持機能] の接続先ホスト名などの設定を行ないます。[インターネット接続の維持機能] を使用すると、一定期間無通信状態が続くと自動的に接続が切断されるようなネットワーク接続環境の場合、インターネット上の任意のサーバーに対して一定間隔ごとにパケットを送信することにより、インターネット接続を維持することができます。 このコマンドでは、通信先の [ホスト名]、[ポート番号]、[パケット送出間隔]、および [プロトコル] を指定することができます。 インターネット接続維持のために送信されるパケットはランダムな内容であり、コンピュータやユーザーを識別する個人情報などが送信されることはありません。 インターネット接続の維持機能は、KeepEnable コマンドまたは KeepDisable コマンドを用いて有効化 / 無効化することができます。KeepSet は有効・無効の状態を変更しません。 VPN Server または VPN Bridge でこのコマンドを実行するには、管理者権限が必要です。 |
コマンドライン書式 |
KeepSet [/HOST:host:port] [/PROTOCOL:tcp|udp] [/INTERVAL:interval] |
vpncmd
コマンドで指定することができるパラメータ引数の一覧 |
/HOST |
[ホスト名:ポート番号] の形式で通信先のホスト名または IP アドレスとポート番号を指定します。 |
/PROTOCOL |
tcp または udp を指定します。 |
/INTERVAL |
パケットを送出する間隔を秒単位で指定します。 |
6.3.26 KeepGet - インターネット接続の維持機能の取得
コマンド名 |
KeepGet |
コマンドの概要 |
インターネット接続の維持機能の取得 |
説明 |
[インターネット接続の維持機能] の現在の設定内容を取得します。通信先の [ホスト名]、[ポート番号]、[パケット送出間隔]、および [プロトコル] に加えて、現在の [インターネット接続の維持機能] の有効状態が取得できます。 |
コマンドライン書式 |
KeepGet |
vpncmd
コマンドで指定することができるパラメータ引数の一覧 |
このコマンドには指定すべきパラメータ引数は 1 つもありません。 |
6.3.27 ConnectionList - VPN Server に接続中の TCP コネクション一覧の取得
コマンド名 |
ConnectionList |
コマンドの概要 |
VPN Server に接続中の TCP コネクション一覧の取得 |
説明 |
現在、VPN Server に接続中の TCP/IP コネクションの一覧を取得します。ただし、VPN セッションとして確立された TCP/IP コネクションは表示されません。VPN セッションとして確立された TCP/IP コネクションの一覧は SessionList コマンドを用いて取得できます。 [コネクション名]、[接続元]、[接続時刻] および [種類] を取得することができます。 このコマンドを実行するには、VPN Server の管理者権限が必要です。 |
コマンドライン書式 |
ConnectionList |
vpncmd
コマンドで指定することができるパラメータ引数の一覧 |
このコマンドには指定すべきパラメータ引数は 1 つもありません。 |
6.3.28 ConnectionGet - VPN Server に接続中の TCP コネクションの情報の取得
コマンド名 |
ConnectionGet |
コマンドの概要 |
VPN Server に接続中の TCP コネクションの情報の取得 |
説明 |
VPN Server に接続中の指定された TCP/IP コネクションに関する詳細な情報を取得します。 [コネクション名]、[コネクションの種類]、[接続元ホスト名]、[接続元 IP アドレス]、[接続元ポート番号 (TCP)]、[接続時刻]、[サーバー製品名]、[サーバー バージョン]、[サーバー ビルド番号]、[クライアント製品名]、[クライアントバージョン]、[クライアントビルド番号] が取得できます。 このコマンドを実行するには、VPN Server の管理者権限が必要です。 |
コマンドライン書式 |
ConnectionGet [name] |
vpncmd
コマンドで指定することができるパラメータ引数の一覧 |
name |
情報を取得するコネクション名を指定します。コネクション名の一覧は ConnectionList コマンドで取得できます。 |
6.3.29 ConnectionDisconnect - VPN Server に接続中の TCP コネクションの切断
コマンド名 |
ConnectionDisconnect |
コマンドの概要 |
VPN Server に接続中の TCP コネクションの切断 |
説明 |
VPN Server に接続中の指定された TCP/IP コネクションを強制的に切断します。 このコマンドを実行するには、VPN Server の管理者権限が必要です。 |
コマンドライン書式 |
ConnectionDisconnect [name] |
vpncmd
コマンドで指定することができるパラメータ引数の一覧 |
name |
切断するコネクション名を指定します。コネクション名の一覧は ConnectionList コマンドで取得できます。 |
6.3.30 BridgeDeviceList - ローカルブリッジに使用できる LAN カード一覧の取得
コマンド名 |
BridgeDeviceList |
コマンドの概要 |
ローカルブリッジに使用できる LAN カード一覧の取得 |
説明 |
ローカルブリッジ接続でブリッジ先のデバイスとして使用できる Ethernet デバイス (LAN カード) の一覧を取得します。 ここで表示されるデバイス名は、BridgeCreate コマンドで使用することができます。 このコマンドを実行するには、VPN Server の管理者権限が必要です。 |
コマンドライン書式 |
BridgeDeviceList |
vpncmd
コマンドで指定することができるパラメータ引数の一覧 |
このコマンドには指定すべきパラメータ引数は 1 つもありません。 |
6.3.31 BridgeList - ローカルブリッジ接続の一覧の取得
コマンド名 |
BridgeList |
コマンドの概要 |
ローカルブリッジ接続の一覧の取得 |
説明 |
現在定義されているローカルブリッジ接続の一覧を取得します。 ローカルブリッジ接続の仮想 HUB 名とブリッジ先の Ethernet デバイス (LAN カード) 名または tap デバイス名および動作状況が取得できます。 |
コマンドライン書式 |
BridgeList |
vpncmd
コマンドで指定することができるパラメータ引数の一覧 |
このコマンドには指定すべきパラメータ引数は 1 つもありません。 |
6.3.32 BridgeCreate - ローカルブリッジ接続の作成
コマンド名 |
BridgeCreate |
コマンドの概要 |
ローカルブリッジ接続の作成 |
説明 |
新しいローカルブリッジ接続を VPN Server 上に作成します。 ローカルブリッジを使用すると、この VPN Server 上で動作する仮想 HUB と物理的な Ethernet デバイス (LAN カード) との間でレイヤ 2 ブリッジ接続を構成することができます。 システムに tap デバイス (仮想のネットワークインターフェイス) を作成し、仮想 HUB との間でブリッジ接続することもできます (tap デバイスは Linux 版のみサポートされています)。 ブリッジ先の Ethernet デバイス (LAN カード) には、稼働中の任意の LAN カードとの間でブリッジできますが、高負荷環境においてはブリッジ専用に LAN カードを用意することをお勧めします。 このコマンドを実行するには、VPN Server の管理者権限が必要です。 |
コマンドライン書式 |
BridgeCreate [hubname] [/DEVICE:device_name] [/TAP:yes|no] |
vpncmd
コマンドで指定することができるパラメータ引数の一覧 |
hubname |
ブリッジする仮想 HUB を指定します。仮想 HUB の一覧は HubList コマンドで取得できます。ただし、必ずしも現在動作している仮想 HUB 名を指定する必要はありません。現在動作していないまたは存在しない仮想 HUB 名を指定すると、その仮想 HUB が実際に動作を開始した際にローカルブリッジ接続が有効になります。 |
/DEVICE |
ブリッジ先の Ethernet デバイス (LAN カード) 名または tap デバイス名を指定します。Ethernet デバイス名の一覧は BridgeDeviceList コマンドで取得することができます。 |
/TAP |
ブリッジ先として LAN カードではなく tap デバイスを使用する場合は yes を指定します (Linux 版のみサポートされます)。省略した場合は no と見なされます。 |
6.3.33 BridgeDelete - ローカルブリッジ接続の削除
コマンド名 |
BridgeDelete |
コマンドの概要 |
ローカルブリッジ接続の削除 |
説明 |
既存のローカルブリッジ接続を削除します。現在のローカルブリッジ接続の一覧は、BridgeDeviceList コマンドで取得できます。 このコマンドを実行するには、VPN Server の管理者権限が必要です。 |
コマンドライン書式 |
BridgeDelete [hubname] [/DEVICE:device_name] |
vpncmd
コマンドで指定することができるパラメータ引数の一覧 |
hubname |
削除するローカルブリッジの仮想 HUB を指定します。 |
/DEVICE |
削除するローカルブリッジのデバイス名 (LAN カード名または tap デバイス名) を指定します。 |
6.3.34 Caps - サーバーの機能・能力一覧の取得
コマンド名 |
Caps |
コマンドの概要 |
サーバーの機能・能力一覧の取得 |
説明 |
現在接続して管理している VPN Server の持つ機能と能力の一覧を取得します。 VPN Server の機能や能力は、動作している VPN Server のエディションやバージョンによって異なります。コマンドライン管理ユーティリティにあるコマンドでも、接続先の VPN Server の機能や能力によっては動作しない場合があります。このコマンドは、接続先の VPN Server の能力を調査して報告します。 VPN Server のバージョンのほうがコマンドライン管理ユーティリティよりも新しく、コマンドライン管理ユーティリティが把握していない機能がある場合は、その内部文字列 (変数名) がそのまま表示されることがあります。 |
コマンドライン書式 |
Caps |
vpncmd
コマンドで指定することができるパラメータ引数の一覧 |
このコマンドには指定すべきパラメータ引数は 1 つもありません。 |
6.3.35 Reboot - VPN Server サービスの再起動
コマンド名 |
Reboot |
コマンドの概要 |
VPN Server サービスの再起動 |
説明 |
VPN Server サービスを再起動します。 VPN Server を再起動すると、現在接続しているセッションや TCP コネクションはすべて切断され、再起動が完了するまで新たな接続は受け付けなくなります。 このコマンドでは、VPN Server サービスプログラムのみが再起動され、VPN Server が動作している物理的なコンピュータが再起動することはありません。この管理セッションも切断されるため、管理を続行するには再接続してください。 また、/RESETCONFIG:yes パラメータを指定すると、現在の VPN Server が持っているコンフィグレーションファイル (.config) の内容を初期化します。 このコマンドを実行するには、VPN Server の管理者権限が必要です。 |
コマンドライン書式 |
Reboot [/RESETCONFIG:yes|no] |
vpncmd
コマンドで指定することができるパラメータ引数の一覧 |
/RESETCONFIG |
yes を指定すると、現在の VPN Server が持っているコンフィグレーションファイル (.config) の内容を初期化します。このパラメータは慎重に設定してください。 |
6.3.36 ConfigGet - VPN Server の現在のコンフィグレーションの取得
コマンド名 |
ConfigGet |
コマンドの概要 |
VPN Server の現在のコンフィグレーションの取得 |
説明 |
VPN Server の現在のコンフィグレーションの内容を構造化したテキストファイル (.config ファイル) として取得します。このコマンドを実行した瞬間の VPN Server 内の状態が取得できます。 コンフィグレーションファイルの内容は、パラメータを指定しない場合は画面上にそのまま表示されます。パラメータで保存するファイル名を指定すると、そのファイル名で内容が保存されます。 コンフィグレーションファイルは通常のテキストエディタ等で編集可能です。編集したコンフィグレーションを VPN Server に書き込むには、ConfigSet コマンドを使用します。 このコマンドを実行するには、VPN Server の管理者権限が必要です。 |
コマンドライン書式 |
ConfigGet [path] |
vpncmd
コマンドで指定することができるパラメータ引数の一覧 |
path |
コンフィグレーションファイルの内容をファイルに保存したい場合は、そのファイル名を指定します。何も指定しない場合は、コンフィグレーションの内容は画面に表示されます。コンフィグレーションファイルにマルチバイト文字が含まれる場合は、Unicode (UTF-8) でエンコードされて保存されます。 |
6.3.37 ConfigSet - VPN Server へのコンフィグレーションの書き込み
コマンド名 |
ConfigSet |
コマンドの概要 |
VPN Server へのコンフィグレーションの書き込み |
説明 |
VPN Server にコンフィグレーションを書き込みます。このコマンドを実行すると、指定したコンフィグレーションファイルの内容が VPN Server に適用され、VPN Server プログラムは自動的に再起動され、新しいコンフィグレーションの内容に従って動作を開始します。 コンフィグレーションファイルはすべての内容を管理者が記述するのは困難であるため、ConfigGet コマンドでまず現在の VPN Server のコンフィグレーションの内容を取得してファイルに保存し、その内容を通常のテキストエディタなどで編集したものを ConfigSet コマンドで VPN Server に書き戻すことを推奨します。 このコマンドは VPN Server に関する詳しい知識をお持ちの方のためのコマンドであり、不正なコンフィグレーションファイルを書き込んだ場合はエラーが発生したり現在の設定内容が失われたりする可能性がありますので、十分注意してください。 このコマンドを実行するには、VPN Server の管理者権限が必要です。 |
コマンドライン書式 |
ConfigSet [path] |
vpncmd
コマンドで指定することができるパラメータ引数の一覧 |
path |
書き込むコンフィグレーションファイルのファイル名を指定します。書き込むファイルにマルチバイト文字が含まれている場合は、Unicode (UTF-8) でエンコードされている必要があります。 |
6.3.38 RouterList - 仮想レイヤ 3 スイッチ一覧の取得
コマンド名 |
RouterList |
コマンドの概要 |
仮想レイヤ 3 スイッチ一覧の取得 |
説明 |
VPN Server 上に定義されている仮想レイヤ 3 スイッチの一覧を取得します。仮想レイヤ 3 スイッチの [スイッチ名]、[動作状況]、[インターフェイス数]、[ルーティングテーブル数] が取得できます。 このコマンドを実行するには、VPN Server の管理者権限が必要です。 また、このコマンドは VPN Bridge では動作しません。 |
コマンドライン書式 |
RouterList |
vpncmd
コマンドで指定することができるパラメータ引数の一覧 |
このコマンドには指定すべきパラメータ引数は 1 つもありません。 |
6.3.39 RouterAdd - 新しい仮想レイヤ 3 スイッチの定義
コマンド名 |
RouterAdd |
コマンドの概要 |
新しい仮想レイヤ 3 スイッチの定義 |
説明 |
VPN Server 上に新しい仮想レイヤ 3 スイッチを定義します。 このコマンドを実行するには、VPN Server の管理者権限が必要です。 また、このコマンドは VPN Bridge では動作しません。
[仮想レイヤ 3 スイッチ機能についての説明] この VPN Server 内で動作している複数の仮想 HUB 間で仮想のレイヤ 3 スイッチを定義し、異なった IP ネットワーク間をルーティングすることができます。
[仮想レイヤ 3 スイッチ機能に関するご注意] 仮想レイヤ 3 スイッチ機能は、ネットワークおよび IP ルーティングに関する詳しい知識をお持ちの方やネットワーク管理者のための機能です。通常の VPN 機能を使用する場合は、仮想レイヤ 3 スイッチ機能を使用する必要はありません。 仮想レイヤ 3 スイッチ機能を使用する場合は、IP ルーティングに関する十分な知識をお持ちの上で、ネットワークに与える影響を十分考慮してから設定してください。 |
コマンドライン書式 |
RouterAdd [name] |
vpncmd
コマンドで指定することができるパラメータ引数の一覧 |
name |
新しく作成する仮想レイヤ 3 スイッチの名前を指定します。既に存在する仮想レイヤ 3 スイッチと同一の名前を付けることはできません。 |
6.3.40 RouterDelete - 仮想レイヤ 3 スイッチの削除
コマンド名 |
RouterDelete |
コマンドの概要 |
仮想レイヤ 3 スイッチの削除 |
説明 |
VPN Server 上に定義されている既存の仮想レイヤ 3 スイッチを削除します。指定した仮想レイヤ 3 スイッチが動作中の場合は自動的に動作を停止してから削除を行ないます。 既存の仮想レイヤ 3 スイッチの一覧を取得するには、RouterList コマンドを使用します。 このコマンドを実行するには、VPN Server の管理者権限が必要です。 また、このコマンドは VPN Bridge では動作しません。 |
コマンドライン書式 |
RouterDelete [name] |
vpncmd
コマンドで指定することができるパラメータ引数の一覧 |
name |
削除する仮想レイヤ 3 スイッチの名前を指定します。 |
6.3.41 RouterStart - 仮想レイヤ 3 スイッチの動作の開始
コマンド名 |
RouterStart |
コマンドの概要 |
仮想レイヤ 3 スイッチの動作の開始 |
説明 |
VPN Server 上に定義されている既存の仮想レイヤ 3 スイッチの動作が停止している場合は、その動作を開始します。 既存の仮想レイヤ 3 スイッチの一覧を取得するには、RouterList コマンドを使用します。 このコマンドを実行するには、VPN Server の管理者権限が必要です。 また、このコマンドは VPN Bridge では動作しません。
[仮想レイヤ 3 スイッチ機能についての説明] この VPN Server 内で動作している複数の仮想 HUB 間で仮想のレイヤ 3 スイッチを定義し、異なった IP ネットワーク間をルーティングすることができます。
[仮想レイヤ 3 スイッチ機能に関するご注意] 仮想レイヤ 3 スイッチ機能は、ネットワークおよび IP ルーティングに関する詳しい知識をお持ちの方やネットワーク管理者のための機能です。通常の VPN 機能を使用する場合は、仮想レイヤ 3 スイッチ機能を使用する必要はありません。 仮想レイヤ 3 スイッチ機能を使用する場合は、IP ルーティングに関する十分な知識をお持ちの上で、ネットワークに与える影響を十分考慮してから設定してください。 |
コマンドライン書式 |
RouterStart [name] |
vpncmd
コマンドで指定することができるパラメータ引数の一覧 |
name |
開始する仮想レイヤ 3 スイッチの名前を指定します。 |
6.3.42 RouterStop - 仮想レイヤ 3 スイッチの動作の停止
コマンド名 |
RouterStop |
コマンドの概要 |
仮想レイヤ 3 スイッチの動作の停止 |
説明 |
VPN Server 上に定義されている既存の仮想レイヤ 3 スイッチの動作が動作している場合は、その動作を停止します。 既存の仮想レイヤ 3 スイッチの一覧を取得するには、RouterList コマンドを使用します。 このコマンドを実行するには、VPN Server の管理者権限が必要です。 |
コマンドライン書式 |
RouterStop [name] |
vpncmd
コマンドで指定することができるパラメータ引数の一覧 |
name |
停止する仮想レイヤ 3 スイッチの名前を指定します。 |
6.3.43 RouterIfList - 仮想レイヤ 3 スイッチに登録されているインターフェイス一覧の取得
コマンド名 |
RouterIfList |
コマンドの概要 |
仮想レイヤ 3 スイッチに登録されているインターフェイス一覧の取得 |
説明 |
指定した仮想レイヤ 3 スイッチに仮想インターフェイスが定義されている場合は、仮想インターフェイスの一覧を取得します。 1 つの仮想レイヤ 3 スイッチには、複数個の仮想インターフェイスとルーティングテーブルを定義することができます。 仮想インターフェイスは仮想 HUB に関連付けられ、仮想 HUB が動作しているときに仮想 HUB 内で 1 台の IP ホストのように動作します。複数の仮想 HUB に対してそれぞれ別々の IP ネットワークに所属する仮想インターフェイスが定義されているとき、それらのインターフェイス間で IP ルーティングが自動的に行われます。 このコマンドを実行するには、VPN Server の管理者権限が必要です。 また、このコマンドは VPN Bridge では動作しません。 |
コマンドライン書式 |
RouterIfList [name] |
vpncmd
コマンドで指定することができるパラメータ引数の一覧 |
name |
仮想レイヤ 3 スイッチの名前を指定します。 |
6.3.44 RouterIfAdd - 仮想レイヤ 3 スイッチへの仮想インターフェイスの追加
コマンド名 |
RouterIfAdd |
コマンドの概要 |
仮想レイヤ 3 スイッチへの仮想インターフェイスの追加 |
説明 |
指定した仮想レイヤ 3 スイッチに、同じ VPN Server 上で動作している仮想 HUB へ接続する仮想インターフェイスを追加します。 1 つの仮想レイヤ 3 スイッチには、複数個の仮想インターフェイスとルーティングテーブルを定義することができます。 仮想インターフェイスは仮想 HUB に関連付けられ、仮想 HUB が動作しているときに仮想 HUB 内で 1 台の IP ホストのように動作します。複数の仮想 HUB に対してそれぞれ別々の IP ネットワークに所属する仮想インターフェイスが定義されているとき、それらのインターフェイス間で IP ルーティングが自動的に行われます。 仮想インターフェイスが所属する IP ネットワーク空間とインターフェイス自身の IP アドレスを定義する必要があります。 また、インターフェイスが接続する先の仮想 HUB 名を指定する必要があります。 仮想 HUB 名は現在存在していない仮想 HUB を指定することもできます。 仮想インターフェイスは、仮想 HUB 内で 1 つの IP アドレスを持つ必要があります。また、その IP アドレスの属する IP ネットワークのサブネットマスクを指定する必要もあります。 複数の仮想 HUB 内の IP 空間同士の仮想レイヤ 3 スイッチを経由したルーティングは、ここで指定した IP アドレスに基づいて動作します。 このコマンドを実行するには、VPN Server の管理者権限が必要です。 また、このコマンドは VPN Bridge では動作しません。 このコマンドを実行するには、操作対象の仮想レイヤ 3 スイッチが停止している必要があります。もし停止していない場合は、RouterStop コマンドで停止させてからこのコマンドを実行してください。 |
コマンドライン書式 |
RouterIfAdd [name] [/HUB:hub] [/IP:ip/mask] |
vpncmd
コマンドで指定することができるパラメータ引数の一覧 |
name |
仮想レイヤ 3 スイッチの名前を指定します。 |
/HUB |
新しく追加する仮想インターフェイスの接続先の仮想 HUB 名を指定します。仮想 HUB の一覧は HubList コマンドで取得できます。ただし、必ずしも現在動作している仮想 HUB 名を指定する必要はありません。現在動作していないまたは存在しない仮想 HUB 名を指定すると、その仮想 HUB が実際に動作を開始した際に仮想レイヤ 3 スイッチが有効になります。 |
/IP |
[IP アドレス/サブネットマスク] の形式で、新しく追加する仮想インターフェイスの持つ IP アドレスとサブネットマスクを指定します。IP アドレスは 192.168.0.1 のように 10 進数をドットで区切って指定します。サブネットマスクは 255.255.255.0 のように 10 進数をドットで区切って指定するか、24 のように先頭からのビット長を 10 進数で指定できます。 |
6.3.45 RouterIfDel - 仮想レイヤ 3 スイッチの仮想インターフェイスの削除
コマンド名 |
RouterIfDel |
コマンドの概要 |
仮想レイヤ 3 スイッチの仮想インターフェイスの削除 |
説明 |
指定した仮想レイヤ 3 スイッチ内にすでに定義されている仮想インターフェイスを削除します。 現在定義されている仮想インターフェイスの一覧は、RouterIfList コマンドで取得することができます。 このコマンドを実行するには、VPN Server の管理者権限が必要です。 また、このコマンドは VPN Bridge では動作しません。 このコマンドを実行するには、操作対象の仮想レイヤ 3 スイッチが停止している必要があります。もし停止していない場合は、RouterStop コマンドで停止させてからこのコマンドを実行してください。 |
コマンドライン書式 |
RouterIfDel [name] [/HUB:hub] |
vpncmd
コマンドで指定することができるパラメータ引数の一覧 |
name |
仮想レイヤ 3 スイッチの名前を指定します。 |
/HUB |
削除する仮想インターフェイスの接続先の仮想 HUB 名を指定します。 |
6.3.46 RouterTableList - 仮想レイヤ 3 スイッチのルーティングテーブル一覧の取得
コマンド名 |
RouterTableList |
コマンドの概要 |
仮想レイヤ 3 スイッチのルーティングテーブル一覧の取得 |
説明 |
指定した仮想レイヤ 3 スイッチにルーティングテーブルが定義されている場合は、ルーティングテーブルの一覧を取得します。 仮想レイヤ 3 スイッチの IP ルーティングエンジンは、IP パケットの宛先 IP アドレスが各仮想インターフェイスの所属する IP ネットワークのいずれにも所属しない場合、ルーティングテーブルを参照してルーティングを行います。 このコマンドを実行するには、VPN Server の管理者権限が必要です。 また、このコマンドは VPN Bridge では動作しません。 |
コマンドライン書式 |
RouterTableList [name] |
vpncmd
コマンドで指定することができるパラメータ引数の一覧 |
name |
仮想レイヤ 3 スイッチの名前を指定します。 |
6.3.47 RouterTableAdd - 仮想レイヤ 3 スイッチへのルーティングテーブルエントリの追加
コマンド名 |
RouterTableAdd |
コマンドの概要 |
仮想レイヤ 3 スイッチへのルーティングテーブルエントリの追加 |
説明 |
指定した仮想レイヤ 3 スイッチのルーティングテーブルに新しいルーティングテーブルエントリを追加します。 仮想レイヤ 3 スイッチの IP ルーティングエンジンは、IP パケットの宛先 IP アドレスが各仮想インターフェイスの所属する IP ネットワークのいずれにも所属しない場合、ルーティングテーブルを参照してルーティングを行います。 仮想レイヤ 3 スイッチに追加するルーティングテーブルのエントリの内容を指定する必要があります。ゲートウェイアドレスは、この仮想 HUB 内で動作する仮想インターフェイスのうちいずれかの IP アドレスとそのサブネットマスクで規定される IP ネットワークに所属している IP アドレスを指定する必要があります。 このコマンドを実行するには、VPN Server の管理者権限が必要です。 また、このコマンドは VPN Bridge では動作しません。 このコマンドを実行するには、操作対象の仮想レイヤ 3 スイッチが停止している必要があります。もし停止していない場合は、RouterStop コマンドで停止させてからこのコマンドを実行してください。 |
コマンドライン書式 |
RouterTableAdd [name] [/NETWORK:ip/mask] [/GATEWAY:gwip] [/METRIC:metric] |
vpncmd
コマンドで指定することができるパラメータ引数の一覧 |
name |
仮想レイヤ 3 スイッチの名前を指定します。 |
/NETWORK |
[IP アドレス/サブネットマスク] の形式で、新しく追加するルーティングテーブルエントリのネットワークアドレスとサブネットマスクを指定します。ネットワークアドレスは 192.168.0.1 のように 10 進数をドットで区切って指定します。サブネットマスクは 255.255.255.0 のように 10 進数をドットで区切って指定するか、24 のように先頭からのビット長を 10 進数で指定できます。0.0.0.0/0.0.0.0 を指定すると、デフォルトルートの意味になります。 |
/GATEWAY |
ゲートウェイの IP アドレスを指定します。 |
/METRIC |
メトリック値を指定します。1 以上の整数で指定してください。 |
6.3.48 RouterTableDel - 仮想レイヤ 3 スイッチのルーティングテーブルエントリの削除
コマンド名 |
RouterTableDel |
コマンドの概要 |
仮想レイヤ 3 スイッチのルーティングテーブルエントリの削除 |
説明 |
指定した仮想レイヤ 3 スイッチ内に定義されているルーティングテーブルのエントリを削除します。 すでに定義されているルーティンクテーブルエントリの一覧は、RouterTableList コマンドで取得できます。 このコマンドを実行するには、VPN Server の管理者権限が必要です。 また、このコマンドは VPN Bridge では動作しません。 このコマンドを実行するには、操作対象の仮想レイヤ 3 スイッチが停止している必要があります。もし停止していない場合は、RouterStop コマンドで停止させてからこのコマンドを実行してください。 |
コマンドライン書式 |
RouterTableDel [name] [/NETWORK:ip/mask] [/GATEWAY:gwip] [/METRIC:metric] |
vpncmd
コマンドで指定することができるパラメータ引数の一覧 |
name |
仮想レイヤ 3 スイッチの名前を指定します。 |
/NETWORK |
[IP アドレス/サブネットマスク] の形式で、削除するルーティングテーブルエントリのネットワークアドレスを指定します。 |
/GATEWAY |
ゲートウェイの IP アドレスを指定します。 |
/METRIC |
メトリック値を指定します。1 以上の整数で指定してください。 |
6.3.49 LogFileList - ログファイル一覧の取得
コマンド名 |
LogFileList |
コマンドの概要 |
ログファイル一覧の取得 |
説明 |
VPN Server のコンピュータ上に保存されている、VPN Server が出力したログファイルの一覧を表示します。ここで表示されるログファイルのファイル名を指定して LogFileGet コマンドを呼び出すことにより、ログファイルの内容をダウンロードすることもできます。 VPN Server にサーバー管理モードで接続している場合は、すべての仮想 HUB のパケットログ、セキュリティログ、および VPN Server のサーバー ログを表示またはダウンロードすることができます。 仮想 HUB 管理モードで接続している場合は、管理対象の仮想 HUB のパケットログとセキュリティログのみを表示またはダウンロードすることができます。 |
コマンドライン書式 |
LogFileList |
vpncmd
コマンドで指定することができるパラメータ引数の一覧 |
このコマンドには指定すべきパラメータ引数は 1 つもありません。 |
6.3.50 LogFileGet - ログファイルのダウンロード
コマンド名 |
LogFileGet |
コマンドの概要 |
ログファイルのダウンロード |
説明 |
VPN Server のコンピュータ上に保存されているログファイルをダウンロードします。ログファイルをダウンロードするには、まず LogFileList コマンドでログファイルの一覧を表示してから、次に LogFileGet コマンドでダウンロードすることができます。VPN Server にサーバー管理モードで接続している場合は、すべての仮想 HUB のパケットログ、セキュリティログ、および VPN Server のサーバー ログを表示またはダウンロードすることができます。仮想 HUB 管理モードで接続している場合は、管理対象の仮想 HUB のパケットログとセキュリティログのみを表示またはダウンロードすることができます。 パラメータとしてファイル名を指定した場合は、ダウンロードしたログファイルはそのファイルに保存されます。ファイル名を指定しなかった場合は、画面上に表示されます。 ログファイルのサイズは巨大である場合がありますので、注意してください。 |
コマンドライン書式 |
LogFileGet [name] [/SERVER:server] [/SAVEPATH:savepath] |
vpncmd
コマンドで指定することができるパラメータ引数の一覧 |
name |
ダウンロードするログファイル名を指定します。LogFileGet コマンドでダウンロードできるログファイル名の一覧を取得できます。 |
/SERVER |
クラスタコントローラに対してダウンロード要求を行う場合は、ログファイルが保存されているサーバー名を指定します。LogFileGet コマンドで表示されるサーバーを指定してください。 |
/SAVEPATH |
ダウンロードしたログファイルを保存する場合はファイル名を指定します。指定しない場合は、画面上に表示されます。 |
6.3.51 HubCreate - 新しい仮想 HUB の作成
コマンド名 |
HubCreate |
コマンドの概要 |
新しい仮想 HUB の作成 |
説明 |
VPN Server 上に新しい仮想 HUB を作成します。 作成した仮想 HUB は直ちに動作を開始します。 VPN Server がクラスタ内で動作している場合は、このコマンドはクラスタコントローラに対してのみ有効です。また、新しい仮想 HUB はダイナミック仮想 HUB として動作します。HubSetStatic コマンドでスタティック仮想 HUB に変更することもできます。すでに VPN Server 上に存在する仮想 HUB の一覧を取得するには、HubList コマンドを使用します。 このコマンドを実行するには、VPN Server の管理者権限が必要です。 また、このコマンドは VPN Bridge およびクラスタメンバサーバーとして動作している VPN Server では動作しません。 |
コマンドライン書式 |
HubCreate [name] [/PASSWORD:password] |
vpncmd
コマンドで指定することができるパラメータ引数の一覧 |
name |
作成する仮想 HUB の名前を指定します。 |
/PASSWORD |
作成する仮想 HUB の管理パスワードを設定する場合は、その管理パスワードを指定します。指定しない場合は、入力するためのプロンプトが表示されます。 |
6.3.52 HubDelete - 仮想 HUB の削除
コマンド名 |
HubDelete |
コマンドの概要 |
仮想 HUB の削除 |
説明 |
VPN Server 上の既存の仮想 HUB を削除します。 仮想 HUB を削除すると、現在仮想 HUB に接続しているセッションがすべて切断され、新たなセッションが仮想 HUB に接続できなくなります。 また、仮想 HUB のすべての設定、ユーザー オブジェクト、グループオブジェクト、証明書、およびカスケード接続が削除されます。 仮想 HUB を削除すると、元に戻すことはできません。 このコマンドを実行するには、VPN Server の管理者権限が必要です。 また、このコマンドは VPN Bridge およびクラスタメンバサーバーとして動作している VPN Server では動作しません。 |
コマンドライン書式 |
HubDelete [name] |
vpncmd
コマンドで指定することができるパラメータ引数の一覧 |
name |
削除する仮想 HUB の名前を指定します。 |
6.3.53 HubSetStatic - 仮想 HUB の種類をスタティック仮想 HUB に変更
コマンド名 |
HubSetStatic |
コマンドの概要 |
仮想 HUB の種類をスタティック仮想 HUB に変更 |
説明 |
VPN Server がクラスタ内で動作している場合、仮想 HUB の種類をスタティック仮想 HUB に設定します。仮想 HUB の種類を変更すると、現在仮想 HUB に接続しているすべてのセッションは一旦切断されます。 スタティック仮想 HUB として動作している仮想 HUB がある場合、すべてのクラスタメンバサーバー上でその名前の仮想 HUB が生成されます。その仮想 HUB に接続しようとしたユーザーは、各サーバーの負荷状況を元にしたアルゴリズムによって、その仮想 HUB をホスティングしているいずれかのクラスタメンバに接続されます。 スタティック仮想 HUB は、一例として、企業におけるインターネットから社内 LAN へのリモートアクセス用途において、同時に数千〜数万単位の大量のユーザーが同時に接続する可能性があるリモートアクセス VPN 用に利用することが可能です。 このコマンドを実行するには、VPN Server の管理者権限が必要です。 また、このコマンドは VPN Bridge およびクラスタメンバサーバーまたはスタンドアロンサーバーとして動作している VPN Server では動作しません。 |
コマンドライン書式 |
HubSetStatic [name] |
vpncmd
コマンドで指定することができるパラメータ引数の一覧 |
name |
スタティック仮想 HUB に設定する仮想 HUB の名前を指定します。 |
6.3.54 HubSetDynamic - 仮想 HUB の種類をダイナミック仮想 HUB に変更
コマンド名 |
HubSetDynamic |
コマンドの概要 |
仮想 HUB の種類をダイナミック仮想 HUB に変更 |
説明 |
VPN Server がクラスタ内で動作している場合、仮想 HUB の種類をダイナミック仮想 HUB に設定します。仮想 HUB の種類を変更すると、現在仮想 HUB に接続しているすべてのセッションは一旦切断されます。 クラスタ内に定義されているダイナミック仮想 HUB にクライアントが 1 台も接続していないとき、その仮想 HUB はどのクラスタメンバ上にも存在しません。ダイナミック仮想 HUB に 1 台目のクライアントが接続しようとすると、クラスタ内で最も負荷の低いサーバーがその仮想 HUB をホスティングします。2 台目以降のクライアントがその仮想 HUB に接続しようとすると、仮想 HUB をホスティングしているサーバーに自動的に接続します。各ダイナミック仮想 HUB は、すべてのクライアントが切断すると、どのサーバーにも実体が存在しない状態に戻ります。 ダイナミック仮想 HUB の応用例は幅広く、たとえば社内において部課ごとに仮想 HUB を定義しておき、各社員が自分が所属している部課の仮想 HUB に接続して作業を行うといったことを、単一のクラスタを設置するだけで、集中管理することができます。 このコマンドを実行するには、VPN Server の管理者権限が必要です。 また、このコマンドは VPN Bridge およびクラスタメンバサーバーまたはスタンドアロンサーバーとして動作している VPN Server では動作しません。 |
コマンドライン書式 |
HubSetDynamic [name] |
vpncmd
コマンドで指定することができるパラメータ引数の一覧 |
name |
ダイナミック仮想 HUB に設定する仮想 HUB の名前を指定します。 |
6.3.55 HubList - 仮想 HUB の一覧の取得
コマンド名 |
HubList |
コマンドの概要 |
仮想 HUB の一覧の取得 |
説明 |
VPN Server 内の既存の仮想 HUB の一覧を取得します。それぞれの仮想 HUB について、[仮想 HUB 名]、[状態]、[種類]、[ユーザー数]、[グループ数]、[セッション数]、[MAC テーブル数]、[IP テーブル数]、[ログイン回数]、[最終ログイン日時]、[最終通信日時] を取得できます。 ただし、仮想 HUB 管理モードで接続している場合は、管理権限の無い仮想 HUB のオプションで匿名ユーザーに対して仮想 HUB を列挙しないオプションが有効になっている場合、その仮想 HUB は列挙されません。サーバー管理モードで接続している場合は、すべての仮想 HUB の一覧が表示されます。 クラスタリング環境におけるクラスタコントローラ以外のクラスタメンバに接続して管理している場合は、その VPN Server が現在ホスティングしている仮想 HUB のみが表示されます。クラスタコントローラに接続して管理している場合は、すべての仮想 HUB が表示されます。 |
コマンドライン書式 |
HubList |
vpncmd
コマンドで指定することができるパラメータ引数の一覧 |
このコマンドには指定すべきパラメータ引数は 1 つもありません。 |
6.3.56 Hub - 管理する仮想 HUB の選択
コマンド名 |
Hub |
コマンドの概要 |
管理する仮想 HUB の選択 |
説明 |
管理対象の仮想 HUB を選択します。VPN Server に接続した状態の管理ユーティリティでは、仮想 HUB に関する設定・管理を行なうコマンドを実行する前に Hub コマンドで管理を行なう仮想 HUB を選択しておく必要があります。 VPN Server に仮想 HUB 管理モードで接続している状態では、管理対象となっている 1 つの仮想 HUB を選択することができ、他の仮想 HUB を選択することはできません。VPN Server にサーバー管理モードで接続している状態では、すべての仮想 HUB の管理を行なうことができます。 現在サーバー上に存在する仮想 HUB の一覧を取得するには、HubList コマンドを使用します。 VPN Bridge では、"BRIDGE" という名前の仮想 HUB 以外を選択することはできません。 |
コマンドライン書式 |
Hub [name] |
vpncmd
コマンドで指定することができるパラメータ引数の一覧 |
name |
管理する仮想 HUB の名前を指定します。パラメータを指定していない場合は、管理対象の仮想 HUB の選択を解除します。 |
6.3.57 LicenseAdd - 新しいライセンスキーの登録
コマンド名 |
LicenseAdd |
コマンドの概要 |
新しいライセンスキーの登録 |
説明 |
PacketiX VPN Server に新しいライセンスキーを登録します。 PacketiX VPN Server を使用するには、有効なライセンスを取得し、ライセンスキーを登録する必要があります。ライセンスキーは、36 桁の英数字およびハイフン ( '-' ) で構成されている、ライセンスの所有を証明するキーコードです。 ライセンスキーは、本ソフトウェアと共にライセンス証書を受け取った場合はライセンス証書に印刷されています。本ソフトウェアのライセンスをオンラインで購入した場合は、購入時の Web サイトの画面やメールなどにライセンスキーが記載されていることがあります。その他の方法でライセンスキーが記載されている場合もあります。不明な場合は、ライセンスの購入元にお問い合わせください。
現在登録されているライセンスの一覧を取得するには、LicenseList コマンドを使用します。 現在の VPN Server のライセンス状態を表示するには、LicenseStatus コマンドを使用します。 このコマンドを実行するには、VPN Server の管理者権限が必要です。 このコマンドは、VPN Bridge では実行できません。 |
コマンドライン書式 |
LicenseAdd [key] |
vpncmd
コマンドで指定することができるパラメータ引数の一覧 |
key |
登録するライセンスキーを指定します。36 桁の英数字を 6 桁ごとにハイフンで区切って指定してください。 |
6.3.58 LicenseDel - 登録されているライセンスの削除
コマンド名 |
LicenseDel |
コマンドの概要 |
登録されているライセンスの削除 |
説明 |
PacketiX VPN Server に現在登録されているライセンス一覧から、指定されたライセンスを削除します。
現在登録されているライセンスの一覧を取得するには、LicenseList コマンドを使用します。 現在の VPN Server のライセンス状態を表示するには、LicenseStatus コマンドを使用します。 このコマンドを実行するには、VPN Server の管理者権限が必要です。 このコマンドは、VPN Bridge では実行できません。 |
コマンドライン書式 |
LicenseDel [id] |
vpncmd
コマンドで指定することができるパラメータ引数の一覧 |
id |
削除するライセンスの番号を指定します。 |
6.3.59 LicenseList - 登録されているライセンス一覧の取得
コマンド名 |
LicenseList |
コマンドの概要 |
登録されているライセンス一覧の取得 |
説明 |
PacketiX VPN Server に現在登録されているライセンスのライセンスキー、ライセンス種類名、状態、有効期限、ライセンス ID、ライセンス種類 ID、サーバー ID およびシリアル ID の一覧を表示します。
現在の VPN Server のライセンス状態を表示するには、LicenseStatus コマンドを使用します。 このコマンドを実行するには、VPN Server の管理者権限が必要です。 このコマンドは、VPN Bridge では実行できません。 |
コマンドライン書式 |
LicenseList |
vpncmd
コマンドで指定することができるパラメータ引数の一覧 |
このコマンドには指定すべきパラメータ引数は 1 つもありません。 |
6.3.60 LicenseStatus - 現在の VPN Server のライセンス状態の取得
コマンド名 |
LicenseStatus |
コマンドの概要 |
現在の VPN Server のライセンス状態の取得 |
説明 |
現在の PacketiX VPN Server のライセンス状態を取得して表示します。 PacketiX VPN Server の現在の製品エディション名、サーバー ID、製品ライセンスの有効期限、および利用可能なクライアント接続ライセンス数とブリッジ接続ライセンス数が表示されます。
このコマンドを実行するには、VPN Server の管理者権限が必要です。 このコマンドは、VPN Bridge では実行できません。 |
コマンドライン書式 |
LicenseStatus |
vpncmd
コマンドで指定することができるパラメータ引数の一覧 |
このコマンドには指定すべきパラメータ引数は 1 つもありません。 |
6.3.61 MakeCert - 新しい X.509 証明書と秘密鍵の作成
コマンド名 |
MakeCert |
コマンドの概要 |
新しい X.509 証明書と秘密鍵の作成 |
説明 |
新しい X.509 証明書と秘密鍵を作成し、ファイルとして保存します。 証明書の公開鍵と秘密鍵の生成アルゴリズムには、RSA 1024 bit が使用されます。 証明書の種類として、ルート証明書 (自己署名証明書) と他の証明書によって署名された証明書のどちらでも作成することができます。他の証明書によって署名された証明書を作成するためには、署名に使用する証明書 (X.509 形式のファイル) と対応する秘密鍵ファイル (Base 64 エンコード) が必要です。
作成する証明書には、名前 (CN)、所属機関 (O)、組織単位 (OU)、国 (C)、都道府県 (ST)、ローカル (L)、シリアル番号、有効期限を指定することができます。 作成された証明書は X.509 形式のファイルとして、秘密鍵ファイルは RSA 1024 bit 形式の Base 64 エンコードされたファイルとしてそれぞれ保存されます。
MakeCert コマンドは、証明書を作成するための必要最低限の機能を用意したツールです。本格的な証明書を作成したい場合は、OpenSSL などのフリーソフトや、市販の CA (証明機関) ソフトウェアを使用することを推奨します。
※注意: このコマンドは PacketiX VPN コマンドライン管理ユーティリティから呼び出すことが可能です。現在 VPN Server や VPN Client に管理モードで接続している場合も実行できますが、実際に RSA 演算を行い、証明書データを生成しファイルに保存するのはこのコマンドを実行しているコンピュータであり、管理モードで接続先のコンピュータとは一切関係無いコンテキストで実行されます。 |
コマンドライン書式 |
MakeCert [/CN:cn] [/O:o] [/OU:ou] [/C:c] [/ST:st] [/L:l] [/SERIAL:serial] [/EXPIRES:expires] [/SIGNCERT:signcert] [/SIGNKEY:signkey] [/SAVECERT:savecert] [/SAVEKEY:savekey] |
vpncmd
コマンドで指定することができるパラメータ引数の一覧 |
/CN |
作成する証明書の名前 (CN) 項目を指定します。none を指定することもできます。 |
/O |
作成する証明書の所属機関 (O) 項目を指定します。none を指定することもできます。 |
/OU |
作成する証明書の組織単位 (OU) 項目を指定します。none を指定することもできます。 |
/C |
作成する証明書の国 (C) 項目を指定します。none を指定することもできます。 |
/ST |
作成する証明書の都道府県 (ST) 項目を指定します。none を指定することもできます。 |
/L |
作成する証明書のローカル (L) 項目を指定します。none を指定することもできます。 |
/SERIAL |
作成する証明書のシリアル番号項目を指定します。16 進数で指定します。none を指定することもできます。 |
/EXPIRES |
作成する証明書の有効期限を指定します。none または 0 を指定すると、3650 日 (約 10 年) が使用されます。最大 10950 日 (約 30 年) まで指定できます。 |
/SIGNCERT |
作成する証明書を既存の証明書によって署名する場合は、署名に使用する X.509 形式の証明書のファイル名を指定します。パラメータを省略した場合は、署名は行わず新しい証明書をルート証明書として作成します。 |
/SIGNKEY |
/SIGNCERT で指定した証明書に対応する秘密鍵 (RSA, Base-64 エンコード) を指定します。 |
/SAVECERT |
作成した証明書を保存するファイル名を指定します。証明書は RSA 形式の 1024 bit の公開鍵を含んだ X.509 ファイルとして保存されます。 |
/SAVEKEY |
作成した証明書に対応する秘密鍵を保存するファイル名を指定します。秘密鍵は RSA 形式の 1024 bit の秘密鍵ファイルとして保存されます。 |
6.3.62 TrafficClient - 通信スループット測定ツールクライアントの実行
コマンド名 |
TrafficClient |
コマンドの概要 |
通信スループット測定ツールクライアントの実行 |
説明 |
通信スループット測定ツールのクライアントプログラムを実行します。 通信スループット測定ツールは TrafficClient と TrafficServer の 2 つのコマンドとして利用し、IP ネットワーク上で接続された 2 台のコンピュータの間で伝送することができる通信スループットを計測することができます。すでに別のコンピュータ上で TrafficServer コマンドを用いて通信スループット測定ツールサーバーを待機させておき、TrafficClient コマンドでそのサーバーのホスト名または IP アドレスとポート番号を指定して接続し通信速度を測定することができます。 通信速度の測定は、同時に複数本の TCP コネクションを確立し、それぞれのコネクションで最大限にストリームデータを伝送した結果、指定された時間内に実際に伝送することができたデータのビット数を計算し、それを元に通信スループットの平均値 (bps) を算出する方法で行われます。通常、1 本の TCP コネクションを用いた場合は TCP のアルゴリズム上の限界により実際のネットワークスループットよりも遅い速度でしか通信できない場合が多いため、複数本の TCP コネクションを同時に確立して通信した結果を測定することを推奨します。この測定方法によって計測されたスループットは実際に TCP でストリームとして受信側に届いたデータのビット長から計算されるため、途中で発生したパケットロスやデータ破損したパケットは実際に届いたパケットには含まれず、純粋なネットワークの最大通信可能帯域幅に近い値を算出することができます。 測定結果として TCP 内で伝送されたストリームサイズから、実際にネットワーク上を流れたデータ量の近似値を計算し、それを時間で割ってビット毎秒 (bps) を算出します。物理的なネットワークの種類は Ethernet (IEEE802.3) で、MAC フレームのペイロードサイズは 1,500 Bytes (TCP の MSS は 1,460 Bytes) と仮定して計算が行われます。/RAW オプションを指定すると、TCP/IP ヘッダや MAC ヘッダのデータ量を補正する計算は行われません。
※注意: このコマンドは PacketiX VPN コマンドライン管理ユーティリティから呼び出すことが可能です。現在 VPN Server や VPN Client に管理モードで接続している場合も実行できますが、実際に通信を行ってスループットを測定するのはこのコマンドを実行しているコンピュータであり、管理モードで接続先のコンピュータとは一切関係無いコンテキストで実行されます。 |
コマンドライン書式 |
TrafficClient [host:port] [/NUMTCP:numtcp] [/TYPE:download|upload|full] [/SPAN:span] [/DOUBLE:yes|no] [/RAW:yes|no] |
vpncmd
コマンドで指定することができるパラメータ引数の一覧 |
host:port |
通信スループット測定ツールサーバー (TrafficServer) が待機しているホスト名または IP アドレスとポート番号を指定します。ポート番号を省略した場合は、9821 が使用されます。 |
/NUMTCP |
同時にクライアントとサーバーとの間で確立されデータが伝送される TCP コネクション数を指定します。省略した場合は 16 が使用されます。 |
/TYPE |
スループット測定を行う際のデータの流れる方向を指定します。"download"、"upload"、"full" のうち 1 つを指定します。download を指定すると、サーバー側からクライアント側にデータが伝送されます。upload を指定すると、クライアント側からサーバー側にデータが伝送されます。full を指定すると、双方向にデータが伝送されます。full を指定する場合は、NUMTCP の値は 2 以上の偶数に指定する必要があります (同時に接続される TCP コネクションのうち半数がダウンロード方向、残りの半数がアップロード方向に使用されます)。このパラメータを省略した場合は full が使用されます。 |
/SPAN |
スループットを測定するためのデータ伝送を行う時間を秒数単位で指定します。このパラメータを省略した場合は 15 秒が使用されます。 |
/DOUBLE |
"yes" を指定した場合、計測した結果のスループットを 2 倍にして表示します。このオプションは、途中にネットワーク装置などがあり、そのネットワーク装置が入出力した合計のスループット能力を測定する場合に使用します。 |
/RAW |
"yes" を指定すると、TCP/IP ヘッダや MAC ヘッダのデータ量を補正する計算を行いません。 |
6.3.63 TrafficServer - 通信スループット測定ツールサーバーの実行
コマンド名 |
TrafficServer |
コマンドの概要 |
通信スループット測定ツールサーバーの実行 |
説明 |
通信スループット測定ツールのサーバープログラムを実行します。 通信スループット測定ツールは TrafficClient と TrafficServer の 2 つのコマンドとして利用し、IP ネットワーク上で接続された 2 台のコンピュータの間で伝送することができる通信スループットを計測することができます。 このコンピュータ上の TCP ポートを待機状態にして別のコンピュータからの TrafficClient からの接続を待ち受けるには、TrafficServer コマンドにポート番号を指定して起動します。 通信スループット測定ツールに関する詳細は、TrafficClient /? と入力すると表示されます。
※注意: このコマンドは PacketiX VPN コマンドライン管理ユーティリティから呼び出すことが可能です。現在 VPN Server や VPN Client に管理モードで接続している場合も実行できますが、実際に通信を行ってスループットを測定するのはこのコマンドを実行しているコンピュータであり、管理モードで接続先のコンピュータとは一切関係無いコンテキストで実行されます。 |
コマンドライン書式 |
TrafficServer [port] |
vpncmd
コマンドで指定することができるパラメータ引数の一覧 |
port |
接続を待ち受けるポート番号を整数で指定します。指定されたポートがすでに別のプログラムによって使用中の場合やポートを開くことができない場合はエラーが発生します。 |
6.3.64 Check - PacketiX VPN の動作が可能かどうかチェックする
コマンド名 |
Check |
コマンドの概要 |
PacketiX VPN の動作が可能かどうかチェックする |
説明 |
現在 vpncmd を動作させているコンピュータが、PacketiX VPN Server / Bridge の動作プラットフォームとして適切であるかどうかをチェックします。 このチェックを通過したシステム上では、PacketiX VPN ソフトウェアが正しく動作する可能性が高いと思われます。 また、このチェックを通過できないシステム上では、PacketiX VPN ソフトウェアを使用した場合に問題が発生する可能性があります。 |
コマンドライン書式 |
Check |
vpncmd
コマンドで指定することができるパラメータ引数の一覧 |
このコマンドには指定すべきパラメータ引数は 1 つもありません。 |
|