Cisco VPN クライアント管理者ガイド リリース 5.0
VPN クライアント コマンドライン インターフェイスの使用
VPN クライアント コマンドライン インターフェイスの使用
発行日;2012/06/01 | 英語版ドキュメント(2010/05/19 版) | ドキュメントご利用ガイド | ダウンロード ; この章pdf , ドキュメント全体pdf (PDF - 2MB) | フィードバック

目次

VPN クライアント コマンドライン インターフェイスの使用

CLI コマンド

VPN クライアント コマンドのリストの表示

接続の開始:vpnclient connect

通知の表示:vpnclient notify

自動 VPN 実行の表示:Windows のみ

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

接続の終了:vpnclient disconnect

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

戻りコード

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

VPN クライアント コマンドライン インターフェイスの使用

この章では、VPN クライアント コマンドライン インターフェイス(CLI)を使用して、Cisco VPN デバイスに接続し、統計情報レポートを生成して、デバイスから切断する方法について説明します。CLI コマンドを使用するスクリプト ファイルを独自に作成すれば、企業サーバに接続し、レポートを実行して、サーバから切断するなど日常業務を行うことができます。

CLI コマンド

この項では、各コマンドとその構文を示し、コマンドごとにサンプル出力を示しています。作業ごとにまとめています。

VPN クライアント コマンドのリストの表示

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

 


vpnclient コマンドにより、プラットフォームで使用できるすべてのコマンドとパラメータのリストが表示されます。すべてのコマンドとパラメータがすべてのプラットフォームで使用できるわけではありません。


接続の開始:vpnclient connect

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

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

表 8-1 は vpnclient connect コマンドで使用できるコマンド オプションを示し、各オプションが実行する作業を記載して、各オプションの例を示しています。

 

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

オプション
定義
注意事項と例

profile

以前に設定した接続エントリ(.pcf ファイル)の名前です。必須。

ファイル名にスペースが含まれている場合は、コマンド ライン上で二重引用符で囲みます。

例: vpnclient connect "to VPN"

user

認証のためユーザ名を指定します。pwd オプションを指定すると、認証ダイアログでユーザ名の入力を求めるプロンプトが表示されなくなります。任意。

.pcf ファイルのユーザ名をこの名前に更新します。ただし、指定された名前が有効でない場合は、VPN クライアントは、以降の要求で認証ダイアログを表示します。

例: vpnclient connect user robron
pwd siltango toVPN

eraseuserpwd

クライアント PC に保存されたユーザ パスワードを消去し、それに伴って VPN クライアントは強制的にパスワードを要求します。
任意。

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

例: vpnclient connect eraseuserpwd toVPN

pwd

認証のためパスワードを指定します。コマンド ラインで user オプションを指定すると、認証ダイアログでパスワードの入力を求めるプロンプトが表示されなくなります。
任意。

指定されたパスワードが有効でない場合は、VPN クライアントは、以降の要求で認証ダイアログを表示します。パスワードを暗号化して接続した後、VPN クライアントは .pcf ファイルのパスワードをクリアします。コマンド ラインでこのオプションを使用すると、セキュリティが低下するため、推奨しません。

例: vpnclient connect user robron
pwd siltango toVPN

nocertpwd

証明書のパスワードの入力を求めるプロンプトが表示されなくなります。
任意。

例: vpnclient connect nocertpwd toVPN

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

コマンド ラインで認証情報の入力を求めます。コマンド ラインから接続要求中に GUI プロンプトが表示されないようにします。

ユーザ名およびパスワードの VPN クライアント プロンプトです。パスワードはアスタリスクで表示されます。

例: vpnclient connect cliauth toVPN

stdin

CLI はコンソールではなく、標準入力パイプから入力データを読み取ります。

このオプションを指定すると、サード パーティ ソフトウェアは入力データを直接 CLI に提供できます。

例: vpnclient connect toVPN stdin

sd

Microsoft ダイヤルアップ ネットワークを使用している場合に発生する「Do you wish to disconnect your Dial-Up Networking connection?」というメッセージを表示しないようにします。

バージョン 4.0.3D 以降は、このスイッチはここに記載されたとおりに動作します。

例: vpnclient connect toVPN sd

domain

接続のドメインを指定します。

Domain キーワードを最後に指定します。Radius ではほとんどの場合、[Domain] フィールドは使用されないため、次の例のように NULL にする必要があります。

vpnclient connect profile-name user name pwd password domain
 

ドメイン名が NULL の場合、GUI によりユーザはドメイン名の入力を求められます。


) CLI の「pwd」オプションを使用する場合、無効なパスワードが実際、セキュア ゲートウェイに 3 回送信されます。このため、失敗したパスワード入力を記録している一部の認証デバイスに問題が発生します。パスワードを 1 回だけ送信し、スクリプトの戻りコードを使用しない cliauth コマンドを使用します。


例 8-1 vpnclient connect コマンド

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

 

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

図 8-1 ユーザの認証

 

ユーザ名とパスワードを入力すると、認証が行われ、コマンドは実行を続けます。

 

例 8-2 cliauth を使用した vpn connect コマンド

あるいは、例 4-1 に示す [User Authentication] ウィンドウを表示しないようにするには、cliauth パラメータを使用できます。コマンド ラインで、ユーザ名とパスワードを入力するよう求められます。cliauth パラメータを使用すると、コマンド ラインでパスワードをクリア テキストで表示しなくても済みます。

 

例 8-3 パラメータを使用した vpnclient connect コマンド

次のコマンドでは、ユーザが介入せずにリモート ネットワークに接続します。パスワードがコマンド ラインにクリア テキストで表示されている点に注目してください。

 

通知の表示:vpnclient notify

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

vpnclient notify

例 8-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 と表示されます。


例 8-5 vpnclient verify コマンド

次のコマンドは、あるアクセス ポイントの自動実行の構成を示します。

 

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

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

vpnclient suspendfw
 

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

vpnclient resumefw
 

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

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

 


) ステートフル ファイアウォールを一時停止した後に PC をリブートすると、Stateful Firewall 設定は enable に戻り、トラフィックはブロックされます。最初にファイアウォールがイネーブル、または一時停止されていないと、resumefw コマンドはファイアウォールをイネーブルにできません。


接続の終了:vpnclient disconnect

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

vpnclient disconnect

例 8-7 vpnclient disconnect コマンド

次のコマンドは、ユーザをセキュア接続から切断します。

 

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

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

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

オプションのパラメータを指定せずに入力した場合は、 vpnclient stat コマンドはすべてのステータス情報を表示します。次のパラメータはオプションです。

 

オプション

定義

reset

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

vpnclient stat reset

traffic

着信バイトおよび発信バイト、暗号化されたパケットおよび復号化されたパケット、バイパスされたパケット、および破棄されたパケットの概要を表示します。

vpnclient stat traffic

tunnel

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

vpnclient stat tunnel

route

設定されているルートを表示します。

vpnclient stat routes

firewall

使用しているファイアウォールのタイプを識別し、ファイアウォール設定で生成された情報を表示します。このオプションは Windows プラットフォームでのみ使用できます。

vpnclient stat firewall

repeat

数秒単位でリフレッシュして、連続して表示します。表示を修了するには、<ctrl-C> を押します。

まず、統計情報をリセットするには、 reset オプションと repeat オプションを合わせて使用します(例を参照)。

vpnclient stat traffic repeat
vpnclient stat repeat
vpnclient stat reset traffic repeat
vpnclient stat reset repeat

次の例は、 vpnclient stat コマンドのサンプル出力を示します。統計情報の出力の詳細については、『 VPN Client User Guide for Windows 』を参照してください。

例 8-8 vpnclient stat コマンド

次に、vpnclient stat コマンドにより表示される情報の例を示します。

 

例 8-9 vpnclient stat reset コマンド

vpnclient stat reset コマンドは、すべての接続カウンタをリセットします。

 

例 8-10 vpnclient stat traffic コマンド

次に、vpnclient stat traffic コマンドにより生成される情報のサンプルを示します。

 

例 8-11 vpnclient stat tunnel コマンド

トンネリング情報のみ表示するには、vpnclient stat tunnel コマンドを使用します。次にサンプルを示します。

 

例 8-12 vpnclient stat route コマンド

vpnclient stat route コマンドは、次の表示に似た情報を表示します。

 

例 8-13 vpnclient stat firewall コマンド:Windows のみ

vpnclient stat firewall コマンドは、次の表示に似た情報を表示します。

 


) VPN クライアント統計カウントの最大サイズは 4,294,967,296 です。VPN クライアント ソフトウェアでこの制限値になると、統計カウントはゼロにロールバックし、再度開始します。


戻りコード

この項では、VPN クライアント コマンドライン インターフェイスを使用中に受信する可能性があるエラー レベル(戻りコード)を示します。

 

戻りコード
メッセージ
意味

200

SUCCESS_START

VPN クライアント接続は正常に開始されました。

201

SUCCESS_STOP

VPN クライアント接続が終了しました。

202

SUCCESS_STAT

VPN クライアントは統計情報を正常に生成しました。

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 クライアントはプロファイルを読み込むことができませんでした。

11

ERR_PWD_MISMATCHED

予備

12

ERR_PWD_TOO_LONG

パスワードの文字が多すぎます。グループ パスワードの最大文字数は 128 文字です。証明書のパスワードの最大文字数は 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

グラフィカル インターフェイス ダイヤラ アプリケーションで接続している場合は、コマンドライン インターフェイスを使用できません。

26

ERR_SET_WORK_DIR_FAILED

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

27

ERR_NOT_CONNECTED

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

28

ERR_BAD_GROUP_NAME

接続に設定されたグループ名が長すぎます。最大文字数は 128 文字です。

29

ERR_BAD_GROUP_PWD

接続に設定されたグループ パスワードが長すぎます。最大文字数は 128 文字です。

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)--Non-Windows only

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

36

ERR_DAEMON_ALREADY_RUNNING (CVPND.EXE)--Non-Windows only

接続がすでに確立されているため、コマンドが機能できません。

アプリケーション例: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