Catalyst 6500 シリーズ スイッチ CSM-S インストレーション コンフィギュレーション ノート Software Release 2.1(1)

CSM-SでのTCLスクリプトの使用

---

この章では、コンテント スイッチングの設定方法について説明します。

• 「スクリプトのロード」

• 「TCLスクリプトおよびCSM-S」

• 「プローブ スクリプト」

• 「スタンドアロン スクリプト」

• 「TCLスクリプトのFAQ」

Content Switching Module with SSL（CSM-S）により、Toolkit Command Language（TCL）スクリプトをアップロードし、CSM-S上で実行できます。TCLスクリプトを使用すると、カスタムTCLスクリプトを作成し、カスタム ヘルス プローブまたはスタンドアロン タスクを開発することができます。

CSM-SのTCLインタープリタ コードは、標準TCLのRelease 8.0に準拠しています。スクリプトを作成してヘルス プローブを設定する（ ヘルス モニタリング用プローブの設定を参照）、またはヘルス プローブに含まれないタスクをCSM-S上で実行することができます。CSM-Sはユーザ側で設定可能な間隔で、定期的にスクリプトを実行します。

CSM-S Release 3.1(1a)までは、基本ヘルス モニタリング コードに含まれないプロトコル用にヘルス プローブを設定することは不可能でした。現在は、プローブを作成し、特定のアプリケーションに合わせてCSM-Sをカスタマイズできます。CSM-S Release 3.2は、UDPソケット機能をサポートします。TCLは、ネットワーク コミュニティで普及しているスクリプト言語です。また、TCLには膨大なスクリプト ライブラリが開発されており、さまざまなサイトから容易にアクセスできます。

CSM-Sは現在、次の2種類のスクリプト モードをサポートします。

• プローブ スクリプト モード ― このタイプのスクリプトは、ある種の単純なルールに従って作成する必要があります。このスクリプトの実行は、ヘルス モニタリング モジュールが制御します。

スクリプトは、スクリプト プローブの一部として定期的に実行され、実行中のスクリプトが返した終了コードによって、特定の実サーバについて、相対的な状態と可用性がわかります。スクリプト プローブの動作は、現在のCSM-Sソフトウェアで利用できる他のヘルス プローブと同様です。

• スタンドアロン スクリプト モード ― このタイプのスクリプトは、一般的なTCLスクリプトです。このスクリプトの実行は、CSM-Sのコンフィギュレーションによって制御します。プローブ スクリプトはスタンドアロン タスクとして実行できます。

TCL機能をサポートするために、サンプル スクリプトを利用できます。その他のカスタム スクリプトも使用できますが、これらのサンプル スクリプトはシスコのTACがサポートしています。サンプル スクリプトのファイルには、次のURLからアクセスしてください。

http://www.cisco.com/cgi-bin/tablebuild.pl/cat6000-intellother

スクリプト ファイルの名前は、c6slb-script.3-3-1.tclです。

スクリプトのロード

スクリプトは、スクリプト ファイルによってCSM-Sにロードします。スクリプト ファイルには、スクリプトがない場合もあれば、1つまたは複数のスクリプトが含まれている場合もあります。1つのスクリプトに128 KBのスタック スペースが必要です。ヘルス スクリプトは最大50ありますので、スクリプト プローブのスタックスペースは、最大で6.4 MBになります。スタンドアロン スクリプトも実行できますが、そのためにさらにスタック スペースを消費します。

TCLスクリプトおよびCSM-S

CSM-S Release 1.1(1)のTCLスクリプト機能は、TCL 8.0ソース ディストリビューション ソフトウェアに準拠しています。CSM-S TCLの変更により、スタンダードTCLライブラリとは異なる他のプロセスを呼び出すために中断したり、同時にTCLインタープリタを実行したりすることが可能になりました。CSM-S TCLライブラリは、file、fcopy、およびその他の標準TCLファイル入出力コマンドをサポートしません。

表12-1 に、CSM-SがサポートするTCLコマンドを示します。

表12-2 に、CSM-SがサポートしないTCLコマンドを示します。

表12-3 に、CSM-S固有のTCLコマンドを示します。

表12-3 CSM-S固有のTCLコマンド

コマンド	定義
disable_real serverfarmName realIp port ,-1 | all probeNumId probeNameId	PROBE_FAILステートにすることで、サーバ ファームの実サーバをディセーブルにします。成功した場合、このコマンドは1を返します。失敗した場合は0を返します。 disable_real SF_TEST 1.1.1.1 -1 10 cisco   （注） サーバ ファーム名は、CSCec72471ごとに大文字を使用する必要があります。
enable_real serverfarmName realIp port ,-1 | all probeNumId probeNameId	PROBE_FAILステートから動作可能な状態に実サーバをイネーブルにします。成功した場合、このコマンドは1を返します。失敗した場合は0を返します。 enable_real SF_TEST 1.1.1.1 -1 10 cisco   （注） サーバ ファーム名は、CSCec72471ごとに大文字を使用する必要があります。
gset varname value	同じスクリプトで実行されているすべてのプローブ スレッドに対してグローバルな変数を設定することで、プローブ状態を保存できます。このコマンドは、プローブ スクリプトに対してのみ機能します。スタンドアロン スクリプトには適用されません。 プローブ スクリプトの変数は、1つのプローブ スレッド内でしか認識できません。プローブが終了するたびに、すべての変数は消去されます。たとえば、プローブ スクリプトに「gset x 1 ; incr x」が含まれている場合、変数xにはプローブごとに1が追加されます。 • スクリプトから変数の値を取得するには、 var または$ var を設定します。 • スクリプトから変数の値をリセットするには、 var の設定を解除します。 • 現在の変数の値を表示するには、 show module csm slot tech script コマンドを使用します。詳細については、「プローブ スクリプトのデバッグ」を参照してください。
socket -graceful host A.B.C.D port	デフォルトでは、すべてのCSM-Sスクリプト プローブがリセットの送信によってTCPソケットをクローズしています。このアクションは、CSM-SがアクティブTCPクローズを初期化するときに、TIME_WAITステートを回避するために実行されます。 VxWorkで使用できるソケット数が255に制限されているため、多くのプローブが同時に実行されている場合、CSM-Sのシステム リソースが足りなくなり、ソケットのオープン時に次のプローブを実行できなくなります。 ソケットに適切なコマンドが入力されると、CSM-Sはリセットの代わりにFINを使用してTCP接続をクローズします。このコマンドは、システムのプローブが250未満の場合のみ使用します。 set sock [socket -graceful 192.168.1.1 23]
ping [ numpacket ] host A.B.C.D	このコマンドはCSM-S Release 3.2では現在使用できません。 スクリプトのホストにpingを実行できます。成功した場合、このコマンドは1を返します。失敗した場合は0を返します。 set result [ping 3 1.1.1.1]   （注） リモート ホストが各CSCea67098のCSM-Sと同じサブネットにない場合、このコマンドはスクリプトをブロックします。
xml xmlConfigString	TCLスクリプトからCSM-SにXML設定ストリングを送信します。このコマンドは、XMLサーバがCSM-Sでイネーブルになっている場合のみ機能します。XML設定の章を参照してください。 このコマンドは、XML設定の結果のストリングを返します。 set cfg_result [ xml { <config> <csm_module slot="6"> <serverfarm name="SF_TEST"> </serverfarm> </config> } ]

UDPコマンド セットにより、ScottyベースのTCLスクリプトがCSM-S上で実行されます。Scottyはソフトウェア パッケージの名前で、高レベル、ストリングベースのAPIを使用するサイト特有のネットワーク管理ソフトウェアの実装を可能にします。すべてのUDPコマンドは、その他のCSM-S TCLコマンド同様、スレッド セーフ（複数のプログラム間でデータ共有が可能）です。

表12-4 に、CSM-Sで使用するUDPコマンドを示します。

プローブ スクリプト

多様なアプリケーション セットおよびヘルス プローブを使用してネットワークを管理する必要がある場合、CSM-SではHTTPヘルス プローブ、TCPヘルス プローブ、およびICMPヘルス プローブなどいくつかの特定タイプのヘルス プローブをサポートします。現在のCSM-Sソフトウェア リリースでサポートされる基本的なヘルス プローブ タイプは、ネットワークの求める特定のプローブ動作をサポートしないことがあります。より柔軟なヘルス プローブ機能をサポートするために、CSM-Sは現在、TCLスクリプトをアップロードし、CSM-S上で実行できるようになっています。

プローブに関連付けられたサーバ ファーム内の個々の実サーバに対して、CSM-Sが定期的に実行するスクリプト プローブを作成できます。スクリプトの終了コードに基づいて、実サーバはヘルシー、サスペクト、失敗と判断されます。プローブ スクリプトは、サーバへのネットワーク接続を確立し、サーバにデータを送信し、応答を確認することによって、実サーバの状態をテストします。このTCLスクリプト環境は柔軟性が高いので、プローブ機能が使用できるようになります。

各タイム インターバルを設定すると、CSM-Sの内部スケジューラがヘルス スクリプトをスケジューリングします。単一のプローブ実行が目的となるように、スクリプトを作成してください。 exit コマンドを使用して、プローブの結果を宣言する必要があります。

一般に、ヘルス スクリプトが実行する動作は次のとおりです。

• IPアドレスに対してソケットをオープンします。

• 1つまたは複数の要求を送信します。

• 応答を読み取ります。

• 応答を分析します。

• ソケットをクローズします。

• exit 5000（成功）またはexit 5001（失敗）を使用することによって、スクリプトを終了します。

新しい probe probe-name script コマンドを使用すると、Cisco IOSソフトウェアでスクリプト プローブを作成できます。このコマンドによって、従来のCSM-Sヘルス プローブ サブモード（HTTP、TCP、DNS、SMTPなど）と同様のプローブ サブモードが開始されます。プローブ スクリプト サブモードには、従来のプローブ サブモード コマンド（ failed 、 interval 、 open 、 receive 、および retries ）が含まれます。

さらに、新しい script script-name コマンドがプローブ スクリプト サブモードに追加されました。このコマンドでは5つの引数を使用できます。各引数は、実行時にヘルス プローブ機能の一部としてスクリプトに渡されます。

環境変数

ヘルス プローブ スクリプトは、前もって定義されたTCL配列によって、さまざまな設定項目にアクセスできます。この配列の最も一般的な用途は、スクリプトの起動中に疑わしいとされたもの（サスペクト）の、現在の実サーバIPアドレスを調べることです。

CSM-S上でスクリプト プローブが実行されるたびに、csm_envという特殊な配列がスクリプトに渡されます。この配列には、スクリプトが使用する重要なパラメータが格納されます。

---

（注） ここで使用する環境変数の情報は、プローブ スクリプトのみに適用されます。スタンドアロン スクリプトには適用できません。

---

表12-5 に、csm_env配列のメンバーを示します。

 

表12-5 csm_env配列のメンバー

メンバー名	内容
realIP	サスペクトのIPアドレス
realPort	サスペクトのIPポート
intervalTimeout	設定されているプローブ インターバル（秒単位）
openTimeout	このプローブに設定されているソケット オープン タイムアウト
recvTimeout	このプローブに設定されているソケット受信タイムアウト
failedTimeout	設定されている障害タイムアウト
retries	設定されている再試行回数
healthStatus	現在のサスペクトのヘルス ステータス

プローブ スクリプトのデバッグ

スクリプト プローブのデバッグ方法は次のとおりです。

• verboseモードで実行しているスクリプトにTCLの puts コマンドを使用します。

verboseモードで puts コマンドを使用すると、各プローブ サスペクトはCSM-Sコンソールにストリングを出力します。システムで実行しているサスペクトが多いと、リソースもそれだけ必要になるため、CSM-Sコンソールがハングする可能性があります。この機能は、システムに設定されたサスペクトが1つである場合にのみイネーブルにすることを推奨します。

• スクリプトで特殊変数EXIT_MSGを使用します。

各プローブ サスペクトに自身のEXIT_MSG変数が含まれています。この変数によりスクリプトのステータスを追跡して、プローブの状態を確認できます。

次に、スクリプトのEXIT_MSG変数の使用例を示します。

set EXIT_MSG "before opening socket"

set s [ socket $ip $port]

set EXIT_MSG " before receive string"

gets $s

set EXIT_MSG "before close socket"

close $s

 

メッセージ受信時にプローブ サスペクトが失敗した場合、ストリングを受信する前に
EXIT_MSG =を確認する必要があります。

• show module csm slot probe real [ ip ]コマンドを使用します。

このコマンドは、システム内で現在アクティブなプローブ サスペクトを表示します。

router1# show module csm 6 probe real

real = 10.1.0.105:80, probe = TEST1, type = script,

vserver = TEST, sfarm = TEST

status = FAILED, current = 04:06:05 UTC 01/01/70,

successes = 1, last success = 03:15:33 UTC 01/01/70,

failures = 12, last failure = 04:06:05 UTC 01/01/70,

state = Unrecognized or invalid response

script CSMTCL

last exit code = 5001

 

---

（注） 最後の終了コードには、表12-6に示す終了コードのうち1つが表示されます。

---

• show module csm slot tech probe コマンドを使用します。

このコマンドは現在のプローブ ステータスを表示します（標準およびスクリプト プローブの両方）。

router1# show module csm 6 tech probe

 

Software version: 3.2(1)

---------------------------------------------------------

------------------ Health Monitor Statistics ------------

---------------------------------------------------------

Probe templates: 1

Suspects created: 1

Open Sockets in System : 8 / 240

Active Suspect(no ICMP): 0 / 200

Active Script Suspect : 0 / 50

Num events : 1

 

Script suspects: 1

Healthy suspects: 0

Failures suspected: 0

Failures confirmed: 1

 

Probe attempts: 927 +927

Total recoveries: 3 +3

Total failures: 6 +6

Total Pending: 0 +0

 

• show module csm slot tech script コマンドを使用して、最後の終了ステータス、固定変数、errorInfo、およびEXIT_MSGの出力を検出します。

router1# show module csm 6 tech script

SCRIPT(0xc25f7e0) stat blk(0xc25f848): TCL_csmTcl.tclc25f7e0

CMDLINE ARGUMENT:

curr_id 1 argc 0 flag 0x0::

type = PROBE

task_id = 0x0: run_id = 521 ref count = 2

task_status = TASK_DONE run status = OK

start time = THU JAN 01 03:51:04 1970

end time = THU JAN 01 03:51:04 1970

 

runs = 13 +11

resets = 13 +11

notrel = 0 +0

buf read err = 1 +1

killed = 0 +0

panicd = 0 +0

 

last exit status= 5001 last Bad status = 5001

 

Exit status history:

 

**TCL Controller:

------------------------

tcl cntrl flag = 0x7fffffff

#select(0) close_n_exit(0) num_sock(2)

MEM TRACK last alloc(0) last size(0) alloc(0) size(0)

hm_ver (3) flag(0x0) script buf(0xc25ad80) new script buf(0xc25ad80)

lock owner(0x0) sig taskdel:0 del:0 syscall:0 syslock:0 sig_select

script ptr (0xc25f038) id(0)

Config(0xc2583d8) probe -> 10.1.0.105:80

tclGlob(0xc257010)

SCRIPT RESOURCE(0xc25af70)-------

#Selects(0) Close_n_exit(0) #Socket(2)

OPEN SOCKETS:

 

Persistent Variables

 

--------------------

x = 11

 

Last erroInfo =

 

Last errorCode =

Last panicInfo =

EXIT_MSG = ping failed : invalid command name "ping"

 

最後の終了ステータスには、表12-6に示す終了コード番号が表示されます。

固定変数情報は、 gset varname value コマンドで設定されます（CSM-S固有のTCLコマンドを参照）。

erroInfoはTCLコンパイラで生成されたエラーのリストです。スクリプトにTCLのランタイム エラーが含まれている場合、TCLインタープリタはスクリプトの実行を停止して、erroInfo変数のエラー情報を保存します。

EXIT_MSG（EXIT_MSG変数を参照）は、失敗の恐れがある各プローブの詳細なデバッグ情報を表示します。出力が非常に長くなる可能性があるため、次の例のようにキーワードで最初にフィルタリングすることもできます。

router1# show module csm slot tech script inc keyword

 

スタンドアロン スクリプト

スタンドアロン スクリプトは、CSM-Sにロードして実行する一般的なTCLスクリプトです。スタンドアロン スクリプトはプローブ スクリプトのように設定してサーバ ファームに適用しないため、CSM-Sの定期的な実行タスクとしてのスケジューリングは行われません。タスクを実行するには、 script task コマンドを使用する必要があります。

csm_env環境変数はスタンドアロン スクリプトには適用されません。ただし、プローブ スクリプトの終了コードにスタンドアロン スクリプトに対する特別な意味が含まれていない場合、 exit コマンドを使用できます。

TCLスクリプトのFAQ

ここでは、CSM-SのTCLスクリプトに関するよくある質問（FAQ）を取り上げます。

• システム リソースはどのように使用されますか?

VxWorksサポート アプリケーションには、ファイル ディスクリプタが255個あり、それが標準入力、標準出力、あらゆるソケット接続（受信または送信）など、すべてのアプリケーション間で分配されます。スタンドアロン スクリプトを作成する場合は、いつソケットをオープンするかについて、慎重に配慮する必要があります。リソース不足を防ぐために、動作の完了後、ただちにソケットをクローズすることを推奨します。ヘルス モニタリング モジュールは、活発に実行しているスクリプトの数を制御することによって、オープン ソケット数を制御します。スタンドアロン スクリプトには、このような制御がありません。

メモリは考慮事項ではあるものの、大きな制約をもたらすことはありません。モジュールには通常、十分なメモリが装備されているからです。スクリプトごとに128 KBのスタックを1つずつ使用し、残りのメモリが実行時にスクリプトによって割り当てられます。

スクリプトの実行中もシステムのリアルタイム特性がある程度一定に保てるように、スクリプト タスクにはシステムで最下位のプライオリティが与えられます。スクリプトのプライオリティが低いということは、システムがTCL以外の動作で忙しい場合に、どのTCLスレッドも完了に時間がかかることを意味します。このような状況では、一部のヘルス スクリプトが打ち切られ、未完了のスレッドにエラーのマークが設定されることがあります。スクリプトがエラーにならないように、すべてのスクリプト プローブで再試行値を2以上に設定する必要があります。可能なかぎり、固有のCSM-Sプローブ（HTTP、DNSなど）を使用してください。スクリプトのヘルス プローブは、サポート外のアプリケーションをサポートする場合に使用してください。

TCLは同期と非同期の両方のソケット コマンドをサポートします。非同期のソケット コマンドは、実接続を待たずに、ただちに戻ります。非同期バージョンのスクリプトを内部で実装するには、この種のコマンドごとに多数のシステムコールを使用する、非常に複雑なコード パスが必要になります。一般にこのような状況は、他のコマンドによるシステム コールの処理中にいくつかのクリティカル リソースが待機する原因となるので、システム速度を低下させます。どうしても避けられない場合以外、スクリプト プローブに非同期ソケットを使用することは推奨できません。ただし、スタンドアロン システムでこのコマンドを使用することは可能です。

• 設定したプローブが実行されているかどうかを判断する方法は?

ネットワークの実サーバ側でSnifferを実行できます。また、次の show コマンドを使用して、プローブがCSM-S上で実行されているかどうかを判断できます。

–プローブが実行されていれば、この例で示すようにプローブを試行した回数が増加していきます。

–プローブが実行されていれば、この例で示すように成功または失敗のカウントが増加します。

また、リセット（RST）の代わりにFINを使用してソケットをクローズすることもできます。

• リモート ホストが到達不能の場合、UDPプローブが実サーバをPROBE_FAILステートにできない理由は?

UDPプローブは「icmp port unreachable」メッセージを受信して、サーバにPROBE_FAILをマーキングする必要があります。リモート ホストがダウンした場合、または応答しない場合、UDPプローブはICMPメッセージを受信しないために、そのプローブのパケットは紛失したとみなされ、サーバは正常の状態にあると判断されます。

UDPプローブはRaw UDPプローブなので、CSM-Sはプローブの応答ペイロードに単一のバイトを使用します。CSM-SはUDPアプリケーションから意味のある応答がくることを想定していません。CSM-SはICMP到達不能メッセージを使用して、UDPアプリケーションが到達可能かどうかを判断します。

受信タイムアウトでICMP到達不能の応答がない場合、CSM-Sはプローブが正常に実行されていると判断します。実サーバのIPインターフェイスがダウンまたは切断された場合、UDPプローブは自身でUDPアプリケーションが到達不能にあることを判断できません。指定のサーバのUDPプローブのほかにICMPプローブを設定する必要があります。

回避策 ：常にICMPをUDPのプローブ タイプで設定します。

• ダウンロード可能なサンプル スクリプトはどこから入手できますか?

サンプル スクリプトを使用してTCL機能をサポートできます。その他のカスタム スクリプトも使用できますが、これらのサンプル スクリプトはシスコのTACがサポートしています。サンプル スクリプトのファイルには、次のURLからアクセスしてください。

http://www.cisco.com/cgi-bin/tablebuild.pl/cat6000-intellother

スクリプト ファイルの名前は、c6slb-script.3-3-1.tclです。

• TCLスクリプト情報はどこにありますか?

TCL 8.0のコマンド リファレンスには、次のURLからアクセスできます。

http://www.tcl.tk/man/tcl8.0/TclCmd/contents.html

TCL UDPコマンド リファレンスには、次のURLからアクセスできます。

http://wwwhome.cs.utwente.nl/~schoenw/scotty/