VPN Client アドミニストレータ ガイド Release 4.0
VPN Client コマンドライン インター フェイスの使用
VPN Client コマンドライン インターフェイスの使用
発行日;2012/02/03 | ドキュメントご利用ガイド | ダウンロード ; この章pdf | フィードバック

目次

VPN Client コマンドライン インターフェイスの使用

CLI コマンド

VPN Client コマンドのリストの表示

接続の開始:vpnclient connect

通知の表示:vpnclient notify

VPN 自動開始の設定の表示:Windows の場合

ステートフルなファイアウォールの一時停止/再開(Windows の場合)

接続の終了:vpnclient disconnect

接続に関する情報の表示:vpnclient stat

戻りコード

アプリケーションの例:Windows の場合

VPN Client コマンドライン インターフェイスの使用

この章では、VPN Client のコマンドライン インターフェイス(CLI)を使用して、Cisco VPN 装置との接続、統計レポートの生成、および装置との接続の切断を行う方法を説明します。日常業務でよく行うタスク(たとえば、企業サーバに接続し、レポートを作成した後、そのサーバとの接続を切断する)を実行するために、CLI コマンドを使用する独自のスクリプト ファイルを作成できます。

CLI コマンド

ここでは、各コマンドとその構文について説明します。また、各コマンドに対するサンプル出力も示します。ここでの説明は、タスク別に構成されています。

VPN Client コマンドのリストの表示

すべての VPN Client コマンドのリストを表示するには、次のように、コマンドライン プロンプトで VPN Client ソフトウェアが格納されているディレクトリに移動し、 vpnclient コマンドを入力します。

 


) vpnclient コマンドを実行すると、使用しているプラットフォームで使用できるすべてのコマンドとパラメータのリストが表示されます。使用できるコマンドとパラメータはプラットフォームによって異なります。


接続の開始:vpnclient connect

接続を開始するには、次のコマンドを入力します。

vpnclient connect <profile> [user <username>][eraseuserpwd | pwd <password>]
[nocertpwd] [cliauth]

表 4-1 には、vpnclient connect コマンドと共に使用できるコマンド オプションをリストしてあります。また、各オプションで実行されるタスク、および各オプションの使用例を示してあります。

 

表 4-1 コマンドライン オプション

オプション
説明
注記および例

profile

ネットワーク管理者により設定済みの接続エントリ(.pcf ファイル)の名前。必須です。

ファイル名にスペースが含まれている場合は、コマンドライン上でそのファイル名を二重引用符で囲んでください。

例: vpnclient connect “to work”

user

認証のためのユーザ名を pwd オプションと共に指定し、認証ダイアログでユーザ名の入力が求められないようにします。省略可能です。

.pcf ファイル内のユーザ名を指定した名前で更新します。ただし指定した名前が無効である場合は、次の要求時に認証ダイアログが表示されます。

例: vpnclient connect user robron pwd siltango toVPN

eraseuserpwd

Client PC 上に保存されていたユーザ パスワードを消去し、VPN Client でパスワードの入力が求められるようにします。
省略可能です。

接続に必要なパスワードが設定され、保存されている場合には、バッチ ファイルを使用して接続する際にパスワード プロンプトが表示されません。その場合、eraseuserpwd を使用すると、接続時にコンソールからのパスワード入力を求める、よりセキュアな状態に戻すことができます。

例: vpnclient connect eraseuserpwd toVPN

pwd

コマンドライン上で、認証のためのパスワードをユーザ オプションと共に指定し、認証ダイアログでパスワードの入力が求められないようにします。
省略可能です。

ただし指定したパスワードが無効である場合、VPN Client で次の要求時に認証ダイアログが表示されます。接続に必要なパスワードを暗号化して使用した後には、VPN Client により .pcf ファイル内のパスワードが消去されます。コマンドライン上でこのオプションを使用すると、セキュリティを弱めることになるので、推奨できません。

例: vpnclient connect user robron pwd siltango toVPN

nocertpwd

証明書のパスワードの入力が求められないようにします。
省略可能です。

例: vpnclient connect nocertpwd toVPN

cliauth(Windows プラットフォームの場合)

コマンドラインで認証情報の入力が求められます。コマンドラインからの接続要求時に GUI プロンプトが表示されなくなります。

ユーザ名とパスワードの入力が求められます。パスワードはアスタリスクで表示されます。

例: vpnclient connect cliauth towork

例4-1 vpnclient connect コマンド

この例では、プロファイル名「engineering」を使用して Engineering Server に接続する、vpnclient connect コマンドを示しています。

 

この時点で、VPN Client により、ユーザ名とパスワードの入力を求める認証ダイアログ ボックスが表示されます。

図 4-1 ユーザの認証

 

名前とパスワードを入力すると、認証が成功し、コマンドが引き続き実行されます。

 

例4-2 cliauth を使用する vpn connect コマンド

例 4-1 で示した[ユーザ認証]ウィンドウ(Windows 版)または User Authentication ウィンドウ(Mac 版)を非表示にするには、cliauth パラメータを使用することもできます。これにより、コマンドラインでユーザ名とパスワードの入力が求められます。cliauth パラメータを使用すると、パスワードがクリア テキストでコマンドラインに表示されなくなります。

 

例4-3 パラメータを使用する vpnclient connect コマンド

次のコマンドでは、ユーザによる操作なしでリモート ネットワークへの接続が実行されます。パスワードがクリア テキストでコマンドラインに表示されますので注意してください。

 

通知の表示:vpnclient notify

vpnclient notify コマンドを使用して、接続時に通知を表示できます。

vpnclient notify

例4-4 vpnclient notify コマンド

たとえば、次のセッションは、vpnclient notify コマンドを使用してネットワーク管理者からの通知を表示する方法を示しています。

 

C:\Program Files\Cisco Systems\Vpn Client\ vpnclient notify
Cisco Systems VPN Client Version 4.0
Copyright <C> 1998-2003 Cisco Systems, Inc. All Rights Reserved.
Client Type<s>:Windows
Running on: 5.0.2195
 
Notification:
Your network administrator has placed an update of the Cisco Systems VPN Client at the following location:
http://www.mycompany.com/clientupdate

VPN 自動開始の設定の表示:Windows の場合

自動開始の設定を表示するには、次のコマンドを入力します。

vpnclient verify autoinitconfig

) 出力表示中のマスクがプロファイル中の値と一致しない場合は、マスクが無効です。無効なマスクは、255.255.255.255 と表示されます。


例4-5 vpnclient verify コマンド

次のコマンドは、1 つのアクセス ポイントに対する自動開始設定を示しています。

 

ステートフルなファイアウォールの一時停止/再開(Windows の場合)

ステートフルなファイアウォールを一時停止するには、次のコマンドを入力します。

vpnclient suspendfw
 

一時停止中のステートフルなファイアウォールを再開するには、次のコマンドを入力します。

vpnclient resume.fw

例4-6 ステートフルなファイアウォールの一時停止と再開

次のコマンドを使用してステートフルなファイアウォールの設定を制御します。最初のコマンド出力は、コマンド実行時にステートフルなファイアウォールが有効でない場合に表示される応答を示します。ステートフルなファイアウォールを有効にした後、次の 2 つのコマンドを実行すると、ファイアウォールが一時停止し、その後再開されます。

 


) ステートフルなファイアウォールの一時停止後に PC をリブートすると、Stateful Firewall の設定が再度有効になり、トラフィックが阻止されます。


接続の終了:vpnclient disconnect

セッションの接続を切断するには、次のコマンドを入力します。

vpnclient disconnect

例4-7 vpnclient disconnect コマンド

次のコマンドは、セキュアな接続を切断します。

 

接続に関する情報の表示:vpnclient stat

接続に関するステータス情報を生成するには、次のコマンドを入力します。

vpnclient stat [reset] [traffic] [tunnel] [route] [firewall] [repeat]
 

オプションのパラメータを何も指定しないで vpnclient stat コマンドを入力すると、すべてのステータス情報が表示されます。次のパラメータをオプションとして指定できます。

 

reset

すべての接続カウントをゼロから再開します。SA stat はリセットされません。

traffic

入力および出力されたバイト数、暗号化および復号化されたパケット数、バイパスされたパケット数、および廃棄されたパケット数の概要を表示します。

tunnel

IPSec トンネリング情報を表示します。

route

設定済みのルートを表示します。

firewall

使用中のファイアウォールのタイプを確認し、ファイアウォール設定により生成された情報を表示します。

repeat

画面を数秒ごとに更新して、連続的に表示します。連続した表示を終了するには、<Ctrl キーを押した状態で C キー>を押します。

次の例は、 vpnclient stat コマンドを実行したときの出力例を示しています。統計的な出力に関する詳細は、『VPN Client ユーザ ガイド Windows 版』を参照してください。

例4-8 vpnclient stat コマンド

次に示すのは、vpnclient stat コマンドで表示される情報の例です。

 

例4-9 vpnclient stat reset コマンド

vpnclient stat reset コマンドを使用すると、すべての接続カウンタがリセットされます。

 

例4-10 vpnclient stat traffic コマンド

次に示すのは、vpnclient stat traffic コマンドで生成される情報の例です。

 

例4-11 vpnclient stat tunnel コマンド

vpnclient stat tunnel コマンドを使用すると、トンネリング情報だけが表示されます。次に示すのは、その表示例です。

 

例4-12 vpnclient stat route コマンド

vpnclient stat route コマンドを使用すると、次のような情報が表示されます。

 

例4-13 vpnclient stat firewall コマンド:Windows の場合

vpnclient stat firewall コマンドを使用すると、次のような情報が表示されます。

 

戻りコード

ここでは、VPN Client コマンドライン インターフェイスを使用するときに表示される可能性がある、エラー レベル(戻りコード)について説明します。

 

戻りコード
メッセージ
説明

200

SUCCESS_START

VPN Client 接続が正常に開始されました。

201

SUCCESS_STOP

VPN Client 接続が終了しました。

202

SUCCESS_STAT

VPN Client により統計情報が正常に生成されました。

203

SUCCESS_ENUMPPP

enumppp コマンドが正常に実行されました。このコマンドでは、ダイヤルアップを使用してインターネットに接続するときに電話帳エントリが表示されます。

1

ERR_UNKNOWN

コマンドラインの解析時に不明なエラーが発生しました。

2

ERR_MISSING_COMMAND

コマンドラインでコマンドが入力されていません。

3

ERR_BAD_COMMAND

入力されたコマンドが誤っています。スペルをチェックしてください。

4

ERR_MISSING_PARAMS

コマンドラインで必須パラメータが入力されていません。

5

ERR_BAD_PARAMS

コマンドで入力されたパラメータが誤っています。スペルをチェックしてください。

6

ERR_TOO_MANY_PARAMS

コマンドラインで指定されたパラメータが多すぎます。

7

ERR_NO_PARAMS_NEEDED

入力されたコマンドにはパラメータが不要です。

8

ERR_ATTACH_FAILED

汎用インターフェイスへの接続時に、プロセス間通信エラーが発生しました。

9

ERR_DETACH_FAILED

汎用インターフェイスからの接続切断時に、プロセス間通信エラーが発生しました。

10

ERR_NO_PROFILE

VPN Client でプロファイルを読み取れませんでした。

11

ERR_PWD_MISMATCHED

予約済み

12

ERR_PWD_TOO_LONG

パスワードに指定されている文字数が多すぎます。グループ パスワードは、最長 32 文字です。証明書パスワードは、最長 255 文字です。

13

ERR_TOO_MANY_TRIES

許可されている回数内で有効なパスワードを入力できませんでした。上限は 3 回です。

14

ERR_START_FAILED

接続の試行が失敗しました。接続できません。

15

ERR_STOP_FAILED

接続が失敗しました。接続を切断できません。

16

ERR_STAT_FAILED

接続ステータスの表示が失敗しました。

17

ERR_ENUM_FAILED

電話帳エントリを表示できません。

18

ERR_COMMUNICATION_FAILED

重大なプロセス間通信エラーが発生しました。

19

ERR_SET_HANDLER_FAILED

コンソール制御ハンドラの設定が失敗しました。

20

ERR_CLEAR_HANDLER_FAILED

ユーザによる中断後の終結処理が失敗しました。

21

ERR_OUT_OF_MEMORY

メモリ不足。メモリの割り当てが失敗しました。

22

ERR_BAD_INTERFACE

内部表示エラー

23

ERR_UNEXPECTED_CALLBACK

Connection Manager との通信時に、予期しないコールバック(応答)が発生しました。

24

ERR_DO_NOT_CONTINUE

「continue?」を要求するバナーで、ユーザが処理を中止しました。

25

ERR_GUI_RUNNING

グラフィカル インターフェイス Dialer アプリケーションを使用して接続するときに、コマンドライン インターフェイスが使用できません。

26

ERR_SET_WORK_DIR_FAILED

作業ディレクトリの設定が失敗しました。作業ディレクトリとは、プログラム ファイルが保存されているディレクトリです。

27

ERR_NOT_CONNECTED

有効な接続が存在しないため、ステータスの表示が失敗しました。

28

ERR_BAD_GROUP_NAME

接続に対して設定されたグループ名が長すぎます。上限は 128 文字です。

29

ERR_BAD_GROUP_PWD

接続に対して設定されたグループ パスワードが長すぎます。上限は 32 文字です。

30

ERR_BAD_AUTHTYPE

接続に対して設定された認証タイプが無効です。

31

RESERVED_01

予約済み

32

RESERVED_02

予約済み

33

ERR_COMMUNICATION_TIMED_OUT

プロセス間通信がタイムアウトになりました。

34

ERR_BAD_3RD_PARTY_DIAL

サードパーティ製ダイヤラの起動が失敗しました。

35

ERR_DAEMON_NOT_RUNNING(CVPND.EXE):Windows 以外の場合

コマンドの実行には接続を確立する必要があります。

36

ERR_DAEMON_ALREADY_RUNNING(CVPND.EXE):Windows 以外の場合

すでに接続が確立されているので、コマンドは実行できません。

アプリケーションの例:Windows の場合

次の例は、CLI コマンドを使用して営業所から本社に接続し、アプリケーションを実行した後、本社サイトとの接続を切断する DOS バッチ ファイル(.bat)を示しています。

runxls.bat
rem assume you have generated a report in the middle of the night that needs
rem to be sent to the corporate office.
 
rem .. generate report.xls . .
 
rem connect to the home office
vpnclient connect myprofile user admin pwd admin
 
rem check return code from vpnclient call....
if %errorlevel% neq 200 goto failed
rem if okay continue and copy report
 
copy report.xls \\mycorpserver\directory\overnight_reports /v
 
rem now disconnect the VPN connection
vpnclient disconnect
echo Spreadsheet uploaded
goto end
:failed
echo failed to connect with error = %errorlevel%
:end