4.5.6. 監視タスクインポートコマンドによる監視タスクの作成について

千手システムには、監視タスクインポートコマンドを実行して、監視タスクを作成する機能があります。

4.5.6.1. 機能概要

監視タスクテンプレート情報が記述してある監視タスクテンプレート情報データファイルの記述内容に従って登録を行います。対象となるデータは、ノードプロパティの、[詳細情報]タブ、[拡張機能]タブ、[カスタム]タブで定義する情報となります。監視タスクテンプレート情報データファイルのフォーマットについては、 書き出しテンプレートファイルのフォーマット を参照して下さい。

本コマンドは運用管理サーバーのみで利用可能です。

4.5.6.2. コマンドで監視タスクを作成する方法

ここでは監視タスクインポートコマンドの使い方について説明します。

コマンド名

SpMonTaskImport

-f 監視タスクテンプレート情報データファイル

-n ノードID

[-p プローブノードID]

オプション

  • -f: 監視タスクテンプレート情報データファイル

    インポートする監視タスクテンプレート情報データファイル名を指定します。ファイルのフルパスを指定して下さい。

  • -n: ノードID

    インポートする監視タスクのノードIDを指定します。

  • -p: プローブノードID

    インポートする監視タスクのプローブノードIDを指定します。対象ノードが千手センサーの場合、省略不可です。

注釈

  • オプションと値の間は半角スペースを入れて下さい。

  • 対象ノードが既に存在しなければなりません。対象ノードが存在しない場合は、監視タスクのインポートは失敗します。

  • パラメータ値に入力された値が無効であるかの検査は行われませんので注意して記入して下さい。なお、無効な値で読み込まれた場合、その監視タスクは一時停止中となります。監視タスクのプロパティを開き正しい値に修正して下さい。

  • データの読み込みを行う際に、全てのレコードを新規監視タスクとして登録します。既に登録されている監視タスクに対して更新を行いません。

参考

  • あるドメインで登録されている内容を書き出し、別ドメインでデータの読み込みを行う際には、書き出したドメインに登録されていた監視タスクで使用している監視項目が読み込みを行うドメインに登録されていない場合、エラーとなりますので、事前に監視項目を登録し、 書き出しテンプレートファイルのフォーマット を参照し十分注意してファイル中のパラメータなどが監視項目と合うように変更してから読み込んで下さい。

  • ノード種別によっては、利用できない監視項目がありますので、監視タスクの記入時には注意して下さい。詳しくは 監視項目一覧 を参照して下さい。

  • 千手センサーの監視タスクについて、インポートする監視タスクテンプレート情報データファイルから接続に関わる全てのパラメータを省略した場合は、[接続設定]タブのアカウント/パスワードで監視が行われます。
    設定内容の詳細は ノードのプロパティ([接続設定]タブ) を参照して下さい。
    接続に関わるパラメータについては パラメータ を参照してください。

4.5.6.2.1. テンプレート情報データファイルを使用した監視タスク作成

監視タスクテンプレート情報が記述してあるデータファイルをオプションに指定して、記述内容に従って監視タスクの作成を行います。

オプションの「-f 監視タスクテンプレート情報データファイル」にインポートファイル名(フルパス)を指定して、監視タスクインポートコマンドを実行することで、監視タスクが作成されます。

注釈

  • 監視タスクインポートコマンドでインポートできるのは監視タスクテンプレート情報データファイルのみです。監視タスク情報データファイルのインポートはできません。

  • 監視タスクテンプレート情報データファイルの文字コードは常にSJISで記述してください。Unixで本コマンドを実行する場合でも、ファイルの文字コードをSJISにする必要があります。

  • その他ノードに対して監視タスクの作成はできません。

参考

監視タスクテンプレート情報データファイルのフォーマットについては、 書き出しテンプレートファイルのフォーマット を参照して下さい。

千手エージェントの監視タスクを作成する場合

監視タスクインポートコマンドを実行する際に、オプションの「-n ノードID」に千手エージェントのノードIDを指定した上、「-f 監視タスクテンプレート情報データファイル」を指定すれば、記述内容に従って指定した千手エージェントに監視タスクを作成します。

操作の流れ：

  1. ログイン

    千手稼働アカウントで千手マネージャにログインして下さい。

  2. 監視タスクインポートコマンドの実行

    監視タスクインポートコマンドを実行します。

    指定形式

    SpMonTaskImport -nノードID

    -f インポートファイル名

    [-p プローブノードID]

    以下は、Unixの千手マネージャで実行する例です。

    % SpMonTaskImport -n nodeAgent -f /tmp/taskTemplate.txt

    以下は、Windowsの千手マネージャで実行する例です。

    $ SpMonTaskImport.exe -n nodeAgent -f C:\tmp\taskTemplate.txt

    コマンド実行成功の場合、標準出力には何も出力しません。

    注釈

    [-p プローブノードID]を指定した場合、指定したノードを監視タスクのプローブノードとして設定します。指定しない場合、インポート対象ノードのエージェントでローカル監視を行います。

  3. 反映(監視属性)

    千手ブラウザでインポート対象ノードに対して反映(監視属性)を実行して下さい。

千手センサーの監視タスクを作成する場合

監視タスクインポートコマンドを実行する際に、オプションの「-n　ノードID」に千手センサーのノードIDを指定した上、「-f　監視タスクテンプレート情報データファイル」と「-p　プローブノードID」を指定すれば、記述内容に従って指定した千手センサーに監視タスクを作成します。

操作の流れ：

  1. ログイン

    千手稼働アカウントで千手マネージャにログインして下さい。

  2. 監視タスクインポートコマンドの実行

    監視タスクインポートコマンドを実行します。

    指定形式

    SpMonTaskImport -nノードID

    -f インポートファイル名

    -p プローブノードID

    以下は、Unixの千手マネージャで実行する例です。

    % SpMonTaskImport -n nodeSensor -f /tmp/taskTemplate.txt -p nodeA

    以下は、Windowsの千手マネージャで実行する例です。

    $ SpMonTaskImport.exe -n nodeSensor -f C:\tmp\taskTemplate.txt -p nodeA

    コマンド実行成功の場合、標準出力には何も出力しません。

  3. 反映(監視属性)

    千手ブラウザでインポート対象ノードに対して反映(監視属性)を実行して下さい。

4.5.6.3. インポートエラーがあった場合の判断方法

監視タスクインポートコマンドを実行して監視タスクを作成する時にエラーがあった場合、エラー情報を標準出力に出力し、コマンドの終了ステータスが1になります。

終了ステータスは以下になります。

0：正常終了

1：異常終了

標準出力に出力されるエラー内容は主に以下になります。

種別

出力内容

エラー発生のパターン

パラメータエラー

Usage出力

無効な値をオプションに指定された場合または省略不可のオプションが指定されていない場合

インポートファイル読込み失敗

Mon task template file [インポートファイル名] load failed.Please check the log file.

指定されたインポートファイルが存在しない場合または指定されたインポートファイルがフォーマット不正の場合

インポート対象ノード無効

Node [ノードID] is not exist.

指定されたノードが存在しない場合

プローブノード無効

Probe node [ノードID] is not exist.

指定されたプローブノードが存在しない場合

モニタリング機能使用不可

Target node [ノードID]is not supported for monitoring.

指定されたノードが千手エージェント、または千手センサーではなく、その他ノードの場合

Monitoring function of target node [ノードID] is off, so can not import mon task.

指定されたノードのモニタリング機能がOFFになっている場合

Monitoring function of probe node [プローブノードID] is off, so can not import mon task.

指定されたプローブノードのモニタリング機能がOFFになっている場合

ノード情報に無効なデータがある

A part of the mon task import failed.Please check the log file.

監視タスクテンプレート情報データに下記のような不正なデータがある場合

  • 使用不可の文字コードを使用している

  • 文字数が最大文字数を超えている

  • 範囲外の値が指定されている

  • 省略不可の値が省略されている

  • 依存する定義が存在しない(監視項目/タスクスケジュール)

  • ノード種別上設定できない機能を使用している(Windows監視項目をUNIX/Linuxノードに設定するなど)

  • 拡張機能に対応するライセンスがない

その他エラー

Connect to PxySvr failed. Server Name[千手マネージャ名]

千手マネージャが起動していない場合

Mon task import failed.Please check the log file.

監視タスクインポート処理で例外エラーが発生した場合