コマンドの戻りコードのモニター

コマンドの戻りコード を使用してアプリケーションまたはシステムをモニターするためのデータ・ソースを定義できます。エージェントは、コマンドを実行し、戻りコードを収集し、可用性データ・セットに結果を追加します。

1. 「エージェントの初期データ・ソース」ページまたは「データ・ソース・ロケーション」ページで、「データ・カテゴリーのモニター」領域の「コマンドまたはスクリプト」を選択します。
2. 「データ・ソース」域で、「コマンドの戻りコード」をクリックします。
3. 「次へ」をクリックします。
4. 「コマンドの戻りコード」ページの「コマンドの戻りコード情報」域に表示名を入力します。
5. コマンド戻りコードで使用するコマンド行を定義し、記述するには、以下のサブステップを実行します。
   注: エージェントによってサポートされるオペレーティング・システムごとにコマンドを定義してください。コマンドは共有可能ですが、すべてのコマンドに対応するオペレーティング・システムの集合全体が、エージェントがサポートしているオペレーティング・システムの集合と同じになっている必要があります。
   1. 「コマンドの戻りコード」ウィンドウの「コマンド」領域で「追加」をクリックし、「コマンド情報」ウィンドウを開きます。
   2. コマンド行を入力して、「コマンド情報」ウィンドウの「オペレーティング・システム」域に表示されたリストからオペレーティング・システムを選択します。
      注:

      1. Windows コマンドの場合は、コマンドの完全な名前を入力する必要があります。例えば、command_to_run のみではなく、command_to_run.bat と入力する必要があります。
      2. コマンド・インタープリターによる構文解析が行われないように、名前は引用符で囲んでください。例えば、this is a test.batargument と入力します。this is a test.bat argument とは入力しないでください。
      3. コマンドをクリックして「編集」をクリックすると、そのコマンドを変更することができ、「削除」をクリックするとそのコマンドを削除することができます。
   3. 「コマンド情報」ウィンドウの「戻りコード」域で「追加」をクリックします。
   4. 「戻りコード定義」ウィンドウに表示されたリストから、戻りコードのタイプを選択します。

      テスト戻りコードに以下の状態を割り当てることができます。

      • ALREADY_RUNNING
      • DEPENDENT_NOT_RUNNING
      • GENERAL_ERROR
      • NOT_RUNNING
      • OK
      • PREREQ_NOT_RUNNING
      • WARNING

   5. 選択した戻りコード・タイプに対応する数値を入力してください。
      戻りコード値は、コマンド戻りコードに関して定義された戻りコードを指定する整数です。 オペレーティング・システム間での移植性を 考慮して、0 から 255 の戻りコード値を使用してください。Windows のみで実行するコマンドの場合は、戻りコードの値を -2147483648 から 2147483647 までにすることができます。
   6. それぞれの戻りコードごとにメッセージを定義して、メッセージとコードを一緒に表示できるようにします。「参照」をクリックして、メッセージ・テキストをセットアップします。
      メッセージ・ウィンドウには、エージェントで定義されたメッセージがリストされます。「メッセージ」(リスト) ウィンドウが開きます。

      注:

      1. 「参照」をクリックする代わりに、以前に入力したテキストをメッセージ・テキストのリストで選択することにより、そのテキストを指定できます。その後は、 ステップ 5k に進んでください。
      2. メッセージを定義するまで、リストはブランクになっています。 「編集」を使用すると定義済みメッセージを変更することができ、「削除」を使用すると定義済みの 1 つ以上のメッセージを削除することができます。
   7. 「メッセージ」(リスト) ウィンドウで、「追加」をクリックします。
      「メッセージ定義」ウィンドウが開きます。

      注: メッセージ ID は自動的に生成されます。
   8. 「メッセージ・テキスト」フィールドに、新規メッセージの意味を示すテキストを入力します。
   9. 「OK」をクリックします。
      「メッセージ」(リスト) ウィンドウが開き、新規メッセージが表示されます。
   10. メッセージを確認して永続させるためには、リストからそれを選択して「OK」をクリックします。
       「戻りコードの定義」ウィンドウに、新しい戻りコードのタイプ、値、およびテキストが表示されます。
   11. このコマンドの戻りコードについて、他のオペレーティング・システムにおける他のコマンドでもこの戻りコードを使用できるようにする場合は、「グローバル戻りコードをすべてのコマンドに適用する」を 選択します。この戻りコードをこのコマンドのみで使用できるようにする場合は、 「ローカル戻りコードをこのコマンドにのみに適用する」が 選択されたままにします。
   12. 「戻りコードの定義」ウィンドウで「OK」をクリックします。
   13. 少なくとも 2 つの戻りコードを定義してから、「コマンド情報」ウィンドウを終了します。戻りコードの 1 つは可用性の問題がないことを示すもの、もう 1 つは問題が発生したかどうかを示すものです。別の戻りコードを追加する場合は、 ステップ c に戻ります。
   14. オプション: エージェントが実行する 1 つ以上のスクリプトまたは実行可能ファイルを選択する場合は、「コマンド情報」ウィンドウの「コマンド・ファイル」領域で「追加」をクリックします。
       このファイルは、scripts/operating system の下にあるエージェントのプロジェクト・フォルダーにコピーされます。operating system は、「コマンド情報」ウィンドウの「オペレーティング・システム」 領域で選択した内容に応じた変数です。これらのファイルは、エージェントを使用してパッケージ化され、配布されます。既存のコマンド・ファイルの定義を編集したり、プロジェクトへのコピー後に元のコマンド・ファイルの定義を編集したりするには、ファイルを選択して「編集」をクリックします。コマンド・ファイル定義の編集 を参照してください。
   15. 「コマンド情報」ウィンドウで「OK」をクリックします。
       注: コマンド・ファイル・テーブルには、エージェント・パッケージに含めるすべての外部ファイルが定義されています。 これらのファイルはプロジェクト・ディレクトリーにコピーされ、エージェントと一緒にパッケージ化されて配布されます。
6. まだ定義していない戻りコードがある場合は、コマンド戻りコードで使用できるグローバル戻りコードを定義し、記述します。
   1. 「コマンドの戻りコード」ページの「グローバル戻りコード」領域で「追加」をクリックします。
      注: ここで定義した戻りコードはグローバルです。 つまり、コマンド戻りコード用に定義されたすべてのコマンドに適用される戻りコードです。(コマンドの戻りコードの間では 共有されません)。また、コマンド情報を入力するときに戻りコードを定義することもできます。ここで定義した戻りコードは、 グローバルにすることもローカルにすることもできます。ローカルな戻りコードは、 このコマンドだけに適用されます。この階層は、戻りコードが全オペレーティング・システムを通じて同じである場合に役立ちます。(例えば、戻りコード 0 は、すべてが正常に機能していることを意味します。グローバル・レベルでこのように定義しておくと、定義済みのすべてのコマンドで 0 がそのように解釈されます。) 他のどのオペレーティング・システムでも 5 が返されない場合は、戻りコード 5 を Windows コマンドにのみ定義することができます。既にグローバル・レベルで定義した戻りコードをローカル・コマンド・レベルで定義した場合は、コマンド・レベルのものが使用されます。この方法により、特定のオペレーティング・システムの戻りコードをオーバーライドすることができます。例えば、すべての UNIX オペレーティング・システムでは戻りコード 2 がある状態を表し、Windows では戻りコード 2 が違う状態を表すとします。この場合には、戻りコード 2 を、UNIX オペレーティング・システムで予期されるものとして、まずグローバル・レベルで定義します。次に、Windows のコマンドで、戻りコード 2 を Windows での意味に再定義できます。
   2. 「戻りコード定義」ウィンドウに表示されたリストから、戻りコードのタイプを選択します。

      テスト戻りコードに以下の状態を割り当てることができます。

      • ALREADY_RUNNING
      • DEPENDENT_NOT_RUNNING
      • GENERAL_ERROR
      • NOT_RUNNING
      • OK
      • PREREQ_NOT_RUNNING
      • WARNING
   3. 選択した戻りコード・タイプに対応する数値を入力してください。戻りコード値は、コマンド戻りコードに関して定義された戻りコードを指定する整数です。
   4. 「参照」をクリックして、メッセージ・テキストとそれに関連付ける意味をセットアップします。それぞれの戻りコードごとにメッセージを定義して、メッセージとコードを一緒に表示するようにする必要があります。

      「メッセージ」ウィンドウには、エージェントで定義されたメッセージがリストされます。

      注:

      1. メッセージを定義するまで、リストはブランクになっています。 「編集」を使用して定義済みメッセージを変更することができ、また、「削除」を使用して定義済みの 1 つ以上のメッセージを削除することができます。
      2. 「参照」をクリックする代わりに、 以前に入力したテキストを「メッセージ・テキスト」リストで選択することができます。その後は、 ステップ 6h に進んでください。
   5. 「メッセージ」(リスト) ウィンドウで「追加」をクリックして、「メッセージ定義」ウィンドウを表示します。このウィンドウで、新規メッセージの意味を示すテキストを入力できます。
   6. 「OK」をクリックします。
   7. 「メッセージ」(リスト) ウィンドウが開き、新規メッセージが表示されます。メッセージを確認して永続させるためには、リストからそれを選択して「OK」をクリックします。
   8. 新しいテキスト、タイプ、および値が「戻りコードの定義」ウィンドウに表示されたら 、「OK」をクリックします。
   9. 「コマンドの戻りコード」ページで、サポートされるすべてのオペレーティング・システムについて戻りコードおよびコマンドの定義が完了したら、以下のいずれかのステップを実行します。
      • 新規エージェント・ウィザードを使用している場合は「次へ」または「終了」をクリックして、データ・ソースを保存し Agent Editor を開いてください。
      • 新規エージェント・コンポーネント・ウィザードを使用している場合は、 「完了」をクリックして Agent Editor に戻ります。