04-show_file-documentCreated with Sketch.07-revisions_historyCreated with Sketch. 08-backlink_link-variantCreated with Sketch.

差分

このページの2つのバージョン間の差分を表示します。

この比較画面にリンクする

両方とも前のリビジョン 前のリビジョン
次のリビジョン 		前のリビジョン
ja:documentation:02_installation:05_configuration_agents [2021/07/10 01:02]
junichi [UDP サーバ] 		ja:documentation:02_installation:05_configuration_agents [2023/05/16 08:31] (現在)
行 5: 行 5:
 [[:ja:documentation:start|Pandora FMS ドキュメント一覧に戻る]] [[:ja:documentation:start|Pandora FMS ドキュメント一覧に戻る]]
  
-===== Pandora FMS ソフトウエアエージェント ===== +===== ソフトウエアエージェントとは? =====
- +
-==== ソフトウエアエージェントとは? ====+
  
 その名前が示すとおり、OS にインストールされ、監視情報を抽出して Pandora FMS サーバへ定期的に送信するための小さなソフトウエアです。 その名前が示すとおり、OS にインストールされ、監視情報を抽出して Pandora FMS サーバへ定期的に送信するための小さなソフトウエアです。
  
-インストールしたシステムの情報を取得するために、OS のコマンドやツールを利用します。XML フォーマットのファイルにデータをまとめ、それを処理しデータベースへ蓄える Pandora FMS データサーバへ送信します。+インストールしたシステムの情報を取得するために、OS のコマンドやツールを利用します。[[https://en.wikipedia.org/wiki/XML|XML]] フォーマットのファイルにデータをまとめ、それを処理しデータベースへ蓄える Pandora FMS データサーバへ送信します。
  
 それぞれの監視項目は、//モジュール// と呼びます。 それぞれの監視項目は、//モジュール// と呼びます。
-==== エージェント設定概要 ====+===== エージェント設定概要 =====
  
 ソフトウエアエージェントの動作は、//pandora_agent.conf// という設定ファイルによって決まります。Windows であればインストール先ディレクトリ、Linux であれば ///etc// 以下にあります。 ソフトウエアエージェントの動作は、//pandora_agent.conf// という設定ファイルによって決まります。Windows であればインストール先ディレクトリ、Linux であれば ///etc// 以下にあります。
行 20: 行 18:
 設定ファイルには、そのエージェントの動作パラメータおよびモジュールが含まれます。 設定ファイルには、そのエージェントの動作パラメータおよびモジュールが含まれます。
  
-==== エージェントの一般的なパラメータ ====+===== エージェントの一般的なパラメータ =====
  
 この章では、エージェントの一般的なパラメータ設定について説明します。Windows および UNIX 共通のものや、それぞれ専用のものがあります。以下に一般的なパラメータ詳細について記載します。 この章では、エージェントの一般的なパラメータ設定について説明します。Windows および UNIX 共通のものや、それぞれ専用のものがあります。以下に一般的なパラメータ詳細について記載します。
行 27: 行 25:
  
 <WRAP center round important 60%> Linux および Windows システム共に、**エージェント設定ファイルの文字コードは、UTF-8です。** ファイルを編集するときは、上書きする前に文字コードを確認してください。文字コードが UTF-8 ではなく、かつ記号(マークや拡張記号など)を使う場合は、エージェントが記号を誤認識する可能性があり、設定を正しく解釈するか保証できません。 </WRAP> <WRAP center round important 60%> Linux および Windows システム共に、**エージェント設定ファイルの文字コードは、UTF-8です。** ファイルを編集するときは、上書きする前に文字コードを確認してください。文字コードが UTF-8 ではなく、かつ記号(マークや拡張記号など)を使う場合は、エージェントが記号を誤認識する可能性があり、設定を正しく解釈するか保証できません。 </WRAP>
-=== server_ip ===+ 
 +Pandora FMS XML フォーマットに関する詳細は[[:ja:documentation:08_technical_reference:01_development_and_extension#pandora_fms_xml_データファイルフォーマット|こちら]]を確認してください。[[:ja:documentation:05_big_environments:08_optimization#pandora_fms_の_xml_負荷|テストデータ生成]](キャパシティ分析ツール)についても確認してください。 
 + 
 +UNIX でソフトウエアエージェントのパラメータ変更後、再起動、停止、起動するには以下のようにします。 
 + 
 +<code> 
 + 
 +/etc/init.d/pandora_agent_daemon restart 
 + 
 +</code> 
 + 
 +<code> 
 +/etc/init.d/pandora_agent_daemon stop 
 + 
 +</code> 
 + 
 +<code> 
 +/etc/init.d/pandora_agent_daemon start 
 + 
 +</code> 
 + 
 +==== server_ip ====
  
 データを保持する Pandora FMS サーバのホスト名もしくは IP アドレスを設定します。 データを保持する Pandora FMS サーバのホスト名もしくは IP アドレスを設定します。
  
-=== server_path ===+==== server_path ====
  
 エージェントから送られるデータを受け取るサーバのディレクトリパスを設定します。通常は、/var/spool/pandora/data_in です。 エージェントから送られるデータを受け取るサーバのディレクトリパスを設定します。通常は、/var/spool/pandora/data_in です。
  
-=== temporal ===+==== temporal ====
  
 エージェントがサーバにデータを送信する前にローカルで利用するフォルダのパスを設定します。 エージェントがサーバにデータを送信する前にローカルで利用するフォルダのパスを設定します。
  
-=== description ===+==== description ====
  
 XML でエージェントが送る「説明」を設定します。Pandora FMS はエージェントを作成する時に、この「説明」を取り込みます。 XML でエージェントが送る「説明」を設定します。Pandora FMS はエージェントを作成する時に、この「説明」を取り込みます。
  
-=== group ===+==== group ====
  
 エージェントが所属するグループ名を設定します。このパラメータで指定された名前のグループがある場合、サーバが特定のグループにエージェントを作成するようにしていなければ、指定したグループ内にエージェントが作成されます。 エージェントが所属するグループ名を設定します。このパラメータで指定された名前のグループがある場合、サーバが特定のグループにエージェントを作成するようにしていなければ、指定したグループ内にエージェントが作成されます。
  
-=== temporal_min_size ===+==== temporal_min_size ====
  
-テンポラリディレクトリのパーティション空き容量がここで指定したサイズ (MB 単位) より小さくなったら、データパケットの生成を停止します。何らかの理由でサーバへの接続が長時間切れた場合に、ディスクがいっぱいになるのを避けます。+テンポラリディレクトリのパーティション空き容量がここで指定したサイズ (MB 単位) より小さくなったら、**データパケットの生成を停止します。** (デフォルトは 1MB) 何らかの理由でプライマリおよび[[:ja:documentation:02_installation:05_configuration_agents#セカンダリサーバ|セカンダリ]]の Pandora FMS サーバへの接続が長時間切れた場合に、ディスクがいっぱいになるのを避けます。
  
-=== logfile ===+<WRAP center round tip 90%>[[:ja:documentation:04_using:02_events#一般情報|Pandora FMS イベント表示]]で、原因が何であれ、ソフトウェアエージェントがメインおよびセカンダリ Pandora FMS サーバへのデータ配信を停止したかどうかをタイムリーに知ることができます。この場合、その状態は ''不明'' になります。必要に応じて、[[:ja:documentation:04_using:01_alerts#ステップ_2状態|アラート条件の作成]]も参照してください。 
 + 
 +[[:wiki:pfms-gitlab_ticket_7146.png?id=ja%3Adocumentation%3A02_installation%3A05_configuration_agents&media=wiki:pfms-gitlab_ticket_7146.png|{{  :wiki:pfms-gitlab_ticket_7146.png  }}]] 
 + 
 +4日間オフラインのこの例では、1メガバイト(または設定した値)の空きディスク容量が残るまで、監視データが保存されます。</WRAP> 
 + 
 +<WRAP center round important 60%>上記の理由により、ソフトウェアエージェントが改めてプライマリおよびセカンダリ Pandora FMS サーバに接続するときに、蓄積された量のデータで[[:ja:documentation:01_understanding:02_architecture#データ_data_サーバ|Pandora FMS データサーバ]]の高負荷が発生する可能性があることに注意が必要です。</WRAP> 
 + 
 +==== temporal_max_size ==== 
 + 
 +XML バッファの最大サイズ(メガバイト)です。デフォルトは ''1024'' です。 
 + 
 +''[[:ja:documentation:02_installation:05_configuration_agents#temporal_min_size|temporal_min_size]]'' も確認してください。 
 + 
 +==== temporal_max_files ==== 
 + 
 +XML バッファの最大ファイル数です。デフォルトは ''1024'' です。 
 + 
 +''[[:ja:documentation:02_installation:05_configuration_agents#temporal_min_size|temporal_min_size]]'' も確認してください。 
 + 
 +==== logfile ====
  
 Pandora FMS エージェントのログファイルのパスです。 Pandora FMS エージェントのログファイルのパスです。
  
-=== interval ===+==== interval ====
  
 エージェントの秒単位のデータ収集間隔です。この間隔でエージェントは情報を収集し、Pandora FMS サーバへ送ります。 エージェントの秒単位のデータ収集間隔です。この間隔でエージェントは情報を収集し、Pandora FMS サーバへ送ります。
  
-=== disable_logfile ===+==== disable_logfile ====
  
 このパラメータは、pandora_agent.log へのログ出力を無効化します。Windows のみ。 このパラメータは、pandora_agent.log へのログ出力を無効化します。Windows のみ。
  
-=== debug ===+==== debug ====
  
-有効化(([[http://www.regular-expressions.info/reference.html|http://www.regular-expressions.info/reference.html]]))すると、エージェントのデータファイルはテンポラリディレクトリ内に名前を変えて保存され、サーバへ送信したあとも削除されません。XML ファイルを開いて内容を確認することができます。+有効化すると、エージェントのデータファイルはテンポラリディレクトリ内に名前を変えて保存され、サーバへ送信したあとも削除されません。XML ファイルを開いて内容を確認することができます。
  
-=== agent_name ===+==== agent_name ====
  
 カスタム名を設定できます。設定していない場合、エージェント名はマシンのホスト名になります。 カスタム名を設定できます。設定していない場合、エージェント名はマシンのホスト名になります。
  
-=== agent_name_cmd === +==== agent_name_cmd ====
- +
-<WRAP center round tip 60%>バージョン 5.1 SP2 以上</WRAP>+
  
 外部コマンドを使ってエージェント名を定義したい場合に設定します。これはオプションです。このパラメータを設定した場合、'agent_name' は無視されます。外部コマンドはエージェント名を標準出力に返す必要があります。複数行を返した場合、1行目がエージェント名として扱われます。 外部コマンドを使ってエージェント名を定義したい場合に設定します。これはオプションです。このパラメータを設定した場合、'agent_name' は無視されます。外部コマンドはエージェント名を標準出力に返す必要があります。複数行を返した場合、1行目がエージェント名として扱われます。
  
-=== agent_alias_cmd ===+==== agent_alias_cmd ====
  
 <WRAP center round tip 60%>バージョン NG 7 以上</WRAP> <WRAP center round tip 60%>バージョン NG 7 以上</WRAP>
行 83: 行 120:
 外部コマンドを使ってエージェントの別名を定義したい場合に設定します。このパラメータを設定した場合、'agent_alias' は無視されます。外部コマンドはエージェントの別名を標準出力に返す必要があります。複数行を返した場合、1行目がエージェントの別名として扱われます。 外部コマンドを使ってエージェントの別名を定義したい場合に設定します。このパラメータを設定した場合、'agent_alias' は無視されます。外部コマンドはエージェントの別名を標準出力に返す必要があります。複数行を返した場合、1行目がエージェントの別名として扱われます。
  
-=== address ===+==== address ====
  
 これは、ソフトウエアエージェントの IP アドレスです。X.X.X.X というフォーマットの IP アドレス、'localhost' のようなホスト名、または 'auto' を設定できます。IP アドレスまたはホスト名を指定した場合は、そのアドレスがエージェントに追加され、メインのアドレスとなります。'auto' を指定した場合は、ホストから IP アドレスを取得してエージェントに追加されます。 これは、ソフトウエアエージェントの IP アドレスです。X.X.X.X というフォーマットの IP アドレス、'localhost' のようなホスト名、または 'auto' を設定できます。IP アドレスまたはホスト名を指定した場合は、そのアドレスがエージェントに追加され、メインのアドレスとなります。'auto' を指定した場合は、ホストから IP アドレスを取得してエージェントに追加されます。
  
-=== encoding ===+==== encoding ====
  
 ISO-8859-15 や UTF-8 のように、システムのエンコーディングの種類を設定します。 ISO-8859-15 や UTF-8 のように、システムのエンコーディングの種類を設定します。
  
-=== server_port ===+==== server_port ====
  
 このパラメータは、リモートのサーバの待ち受けポートの設定です。Tentacle のデフォルトは 41121 です。 このパラメータは、リモートのサーバの待ち受けポートの設定です。Tentacle のデフォルトは 41121 です。
  
-=== transfer_mode ===+==== transfer_mode ====
  
 このパラメータには、エージェントからサーバへデータを送信するための方法を設定します。デフォルトは Tentacle です。 このパラメータには、エージェントからサーバへデータを送信するための方法を設定します。デフォルトは Tentacle です。
  
-=== transfer_timeout ===+==== transfer_timeout ====
  
 <WRAP center round tip 60%>バージョン 6.0 以上</WRAP> <WRAP center round tip 60%>バージョン 6.0 以上</WRAP>
行 105: 行 142:
 データ転送プログラムの実行タイムアウトを秒単位で指定します。設定されていない場合のデフォルトは 30 です。 データ転送プログラムの実行タイムアウトを秒単位で指定します。設定されていない場合のデフォルトは 30 です。
  
-=== server_pwd ===+==== server_pwd ====
  
 Windows の FTP もしくは Tentacle 転送モードのパスワードを設定します。Tentacle モードの場合はパスワードは必須ではありません。このパスワードでサーバでの認証を行います。 Windows の FTP もしくは Tentacle 転送モードのパスワードを設定します。Tentacle モードの場合はパスワードは必須ではありません。このパスワードでサーバでの認証を行います。
  
-=== server_ssl ===+==== server_ssl ====
  
-Tentacle の転送モードを設定します。SSL を利用する場合は 1、そうでなければ 0 を設定します。+Tentacle の転送モードを設定します。SSL による暗号化を有効化(''yes'')または、無効化(''no'')できます。Tentacle の暗号化通信については、[[:ja:quickguides:secure_communication_with_tentacle|こちらの章]]も参照してください。
  
-=== server_opts ===+==== server_opts ====
  
 Tentacle の転送モードを設定します。Tentacle クライアントの拡張設定のために渡す、追加パラメータを設定します。 Tentacle の転送モードを設定します。Tentacle クライアントの拡張設定のために渡す、追加パラメータを設定します。
行 131: 行 168:
 </code> </code>
  
-=== delayed_startup ===+==== delayed_startup ====
  
 //デフォルトでは無効です。// エージェント起動後、処理を開始するまでの待ち時間(**秒** または **分**)です。MS Windows 以外のソフトウエアエージェントで利用できます。 //デフォルトでは無効です。// エージェント起動後、処理を開始するまでの待ち時間(**秒** または **分**)です。MS Windows 以外のソフトウエアエージェントで利用できます。
-=== startup_delay ===+==== startup_delay ====
  
 //デフォルトでは無効です。// エージェント起動後、処理を開始するまでの秒単位の待ち時間です。MS Windows のみ。 //デフォルトでは無効です。// エージェント起動後、処理を開始するまでの秒単位の待ち時間です。MS Windows のみ。
-=== pandora_nice ===+==== pandora_nice ====
  
 このパラメータには、Pandora FMS エージェントプロセスの優先順位を設定します。この設定は、Unix/Linux エージェントにのみ存在します。 このパラメータには、Pandora FMS エージェントプロセスの優先順位を設定します。この設定は、Unix/Linux エージェントにのみ存在します。
  
-=== autotime ===+==== autotime ====
  
 これを有効に設定 (1 に設定) すると、エージェントが送信する時間データを無視し、サーバに接続した時間をサーバのローカル時間で認識するようになります。この設定は、何らかの理由によりエージェントの時刻がおかしかったり、サーバの時刻と大きくずれている場合に利用します。 これを有効に設定 (1 に設定) すると、エージェントが送信する時間データを無視し、サーバに接続した時間をサーバのローカル時間で認識するようになります。この設定は、何らかの理由によりエージェントの時刻がおかしかったり、サーバの時刻と大きくずれている場合に利用します。
  
-=== cron_mode ===+==== cron_mode ====
  
 このパラメータを有効にすると、エージェントをそれ自身の実行の仕組みではなく、Linux の crontab から指定した時刻に実行できるようになります。デフォルトでは無効になっています。 このパラメータを有効にすると、エージェントをそれ自身の実行の仕組みではなく、Linux の crontab から指定した時刻に実行できるようになります。デフォルトでは無効になっています。
  
-=== remote_config ===+==== remote_config ====
  
 (Pandora FMS Enterprise のみ) (Pandora FMS Enterprise のみ)
行 155: 行 192:
 リモートエージェント設定を有効化(1)または無効化(0)します。Tentacle 転送モードでのみ利用できます。 リモートエージェント設定を有効化(1)または無効化(0)します。Tentacle 転送モードでのみ利用できます。
  
-=== xml_buffer ===+==== xml_buffer ====
  
 有効化(1)すると、エージェントは接続障害等でサーバに XML ファイルを送信できなかったとき、それをテンポラリディレクトリに保存します。それらは、通信が復旧したときに送られます。 有効化(1)すると、エージェントは接続障害等でサーバに XML ファイルを送信できなかったとき、それをテンポラリディレクトリに保存します。それらは、通信が復旧したときに送られます。
  
-=== timezone_offset ===+==== timezone_offset ====
  
-エージェントではサーバのタイムゾーンとのオフセットを設定できます。これは、エージェントが異なるタイムゾーンのサーバで稼働しているとき、同じ時間に合わせる場合にとても便利です。エージェントは、調整したタイムゾーンでサーバに送信します。+エージェントではサーバの[[https://en.wikipedia.org/wiki/Time_zone|タイムゾーン]]とのオフセットを設定できます。これは、エージェントが異なるタイムゾーンのサーバで稼働しているとき、同じ時間に合わせる場合にとても便利です。エージェントは、調整したタイムゾーンでサーバに送信します。
  
 <code> <code>
行 171: 行 208:
 サーバのタイムゾーンからエージェントのタイムゾーンを差し引いて計算されます。例えば、サーバのタイムゾーンが UTC+1 で、エージェントのタイムゾーンが UTC-5 であれば、タイムゾーンのオフセットは、6 = 1 - (-5) です。 サーバのタイムゾーンからエージェントのタイムゾーンを差し引いて計算されます。例えば、サーバのタイムゾーンが UTC+1 で、エージェントのタイムゾーンが UTC-5 であれば、タイムゾーンのオフセットは、6 = 1 - (-5) です。
  
-=== parent_agent_name ===+==== parent_agent_name ====
  
 ソフトウエアエージェントの親を指定します。Pandora FMS に存在するエージェント名である必要があります。 ソフトウエアエージェントの親を指定します。Pandora FMS に存在するエージェント名である必要があります。
  
-=== agent_threads <スレッド数> ===+==== agent_threads ====
  
 モジュールを並行して実行するエージェントのスレッド数です。デフォルトではシングルスレッドで、すべての処理完了まで 1つずつモジュールを実行します。これは、UNIX エージェントのみの機能です。 モジュールを並行して実行するエージェントのスレッド数です。デフォルトではシングルスレッドで、すべての処理完了まで 1つずつモジュールを実行します。これは、UNIX エージェントのみの機能です。
行 185: 行 222:
 </code> </code>
  
-=== include <ファイル名> ===+==== include ====
  
-別の設定ファイルパスです。このファイルには、メインの設定ファイルに加えて追加のモジュールや収集を含めることができます。これはオプションです。ファイルのアップロードには、ユーザに少なくともエージェントの（AW）権限が必要です。+<code> 
 +include <file>
  
-=== broker_agent <名前> ===+</code>
  
-ブローカーエージェント機能を有効化します。有効化するにはパラメータのコメントを外し、ブローカーエージェントに割り当てる名前を指定する必要があるだけです。メインの設定ファイルに記載したブローカーエージェントの名前で新たな設定ファイルが生成されます。この設定はメインのエージェントでのみ利用でき、作成された新たなエージェント設定内では利用できません。+別の設定 ''<ファイル>'' をインクルードすることができます。このファイルには、メインの設定ファイルに加えて追加のモジュールや収集を含めることができます。これはオプションです。ファイルのアップロードには、ユーザにエージェント書き込み（AW）の[[:ja:documentation:04_using:11_managing_and_administration#pandora_fms_でのプロファイル|プロファイル]] が必要です。 
 + 
 +==== broker_agent ====
  
 <code> <code>
-broker_agent Name_broker+broker_agent < broker_name >
  
 </code> </code>
  
-=== pandora_user <ユーザ> ===+ブローカーエージェント機能を有効化します。有効化するにはパラメータのコメントを外し、ブローカーエージェントに割り当てる名前 (''< broker_name >'') を指定する必要があるだけです。メインの設定ファイルに記載したブローカーエージェントの名前で新たな設定ファイルが生成されます。この設定はメインのエージェントでのみ利用でき、作成された新たなエージェント設定内では利用できません。 
 +==== pandora_user ====
  
-このパラメータはオプションで、システムの特定のユーザでエージェントを実行させるためのものです。指定するユーザは、エージェントの実行権限等を持つ必要があります。+<code> 
 +pandora_user <user>
  
-=== custom_id ===+</code>
  
-<WRAP center round tip 60%>バージョン 5.X 以上</WRAP>+このパラメータはオプションで、システムの特定のユーザ (''<user>'') でエージェントを実行させるためのものです。指定するユーザは、エージェントの実行権限等を持つ必要があります。 
 + 
 +==== custom_id ====
  
 外部アプリケーションのための、エージェントのカスタム ID です。 外部アプリケーションのための、エージェントのカスタム ID です。
  
-=== url_address === +==== url_address ====
- +
-<WRAP center round tip 60%>バージョン 5.X 以上</WRAP>+
  
 コンソールでエージェントから開くカスタム URL です。 コンソールでエージェントから開くカスタム URL です。
  
-=== custom_fieldX_name === +==== custom_fieldX_name ====
- +
-<WRAP center round tip 60%>バージョン 5.X 以上</WRAP>+
  
 システムに設定済のエージェントのカスタムフィールド名です。存在しない場合は無視されます。 システムに設定済のエージェントのカスタムフィールド名です。存在しない場合は無視されます。
行 227: 行 267:
 </code> </code>
  
-=== custom_fieldX_value === +==== custom_fieldX_value ====
- +
-<WRAP center round tip 60%>バージョン 5.X 以上</WRAP>+
  
 前述のパラメータで定義されたカスタムフィールド X の値です。 前述のパラメータで定義されたカスタムフィールド X の値です。
行 240: 行 278:
 </code> </code>
  
-=== macro ===+==== module_macro ====
  
-<WRAP center round tip 60%>バージョン 5.X 以上</WRAP>+<WRAP center round tip 60%> Unix/Linux 用ソフトウエアエージェント</WRAP>
  
 <code> <code>
-macro<macro> <value>+module_macro<_macro_name_ > < value >
  
 </code> </code>
  
-モジュールの定義で利用可能なローカル実行マクロを定義します。この種のマクロは、主にメタコンソールシステムで利用します。ローカルモジュールコンポーネントシステムで、ローカルモジュールの利用を簡単にし、ソースモジュールの定義を編集する必要がないようにします。これにより、GUI に新たなフィールドが表示されます。ローカル実行マクロは、_field1_、_field2_、… のようなローカルプラグインマクロと似た名前をもちます。+モジュールの定義で利用可能な[[:ja:documentation:04_using:03_templates_and_components#ローカル実行マクロ|ローカル実行マクロ]]を定義します。これらのマクロは、メタコンソールシステムとローカルモジュールコンポーネントシステムで使用され、コードを直接編集することで難しくなるモジュール定義を「抽象化」し、高度なユーザに値を「入力」できるローカルインターフェイスを提供します。 これらの値は、ローカルプラグインのマクロシステムに比較的似たマクロシステムを使用して、以下のように使用できます。
  
-例:+''_fieldx_'' で始まるローカル拡張マクロ。
  
 +例:
 <code> <code>
 +
 module_begin module_begin
 module_name Particion_opt module_name Particion_opt
行 263: 行 303:
 </code> </code>
  
-=== group_password <パスワード> ===+==== group_password ====
  
-<WRAP center round tip 60%>バージョン 6.0SP5 以上</WRAP>+<code> 
 +group_password <password> 
 + 
 +</code>
  
 エージェントグループのパスワードです。グループのパスワード保護をしない場合は、コメントアウトした状態にしてください。 エージェントグループのパスワードです。グループのパスワード保護をしない場合は、コメントアウトした状態にしてください。
  
-=== ehorus_conf <パス> ===+==== ehorus_conf ====
  
 <WRAP center round tip 60%>バージョン NG 7 以上</WRAP> <WRAP center round tip 60%>バージョン NG 7 以上</WRAP>
  
-[[https://ehorus.com/|eHorus]] エージェント設定ファイルの絶対パスです。エージェントは、eHorus エージェントを特定するキーを含むカスタムフィールド名 //eHoursID// を作成します。 +<code> 
-=== transfer_mode_user <ユーザ> ===+ 
 +ehorus_conf <path> 
 + 
 +</code> 
 + 
 +有効な [[:ja:documentation:04_using:12_console_setup#ehorus|eHorus]] エージェント設定ファイルへの絶対パス。エージェントは、eHorus エージェントの識別キーを含む ''eHorusID'' という名前のカスタムフィールドを作成します。 
 + 
 +==== transfer_mode_user ====
  
 <WRAP center round tip 60%>バージョン NG 7.0 OUM713 以上</WRAP> <WRAP center round tip 60%>バージョン NG 7.0 OUM713 以上</WRAP>
  
-ローカル転送モードでコピーされるファイルのユーザでえす。正しく動作するためには、コンソールのフォルダで、このユーザがリモート設定ファイルを読み書きできる権限が必要です。デフォルトは //apache// です。 +<code> 
-=== secondary_groups <セカンダリグループ> ===+ 
 +transfer_mode_user <user> 
 + 
 +</code> 
 + 
 +ローカル転送モードでコピーされるファイルのユーザでえす。正しく動作するためには、コンソールのフォルダで、このユーザがリモート設定ファイルを読み書きできる権限が必要です。デフォルトは ''apache'' です。 
 + 
 +==== secondary_groups ====
  
 <WRAP center round tip 60%>バージョン NG 7.0 OUM721 以上</WRAP> <WRAP center round tip 60%>バージョン NG 7.0 OUM721 以上</WRAP>
 +
 +<code>
 +secondary_groups <group name1>, <group name2>, ... <group nameN>
 +
 +</code>
  
 エージェントに割り当てるセカンダリグループ名です。複数のセカンダリグループをカンマ区切りで指定できます。サーバ上に存在しないグループを指定した場合はグループは割り当てられませんが、エージェントの作成には影響ありません。 エージェントに割り当てるセカンダリグループ名です。複数のセカンダリグループをカンマ区切りで指定できます。サーバ上に存在しないグループを指定した場合はグループは割り当てられませんが、エージェントの作成には影響ありません。
  
-=== standby <1|0> ===+==== standby ====
  
 <WRAP center round tip 60%>バージョン NG 7.0 OUM728 以上</WRAP> <WRAP center round tip 60%>バージョン NG 7.0 OUM728 以上</WRAP>
  
-エージェントがスタンバイモード(1)の場合、エージェントは監視を実行せず XML の生成や送信を行いません。この設定は、リモート設定がある Enterprise 版の利用時に意味があります。これにより、エージェントを無効化した場合に動作を停止することができます。+<code> 
 +standby <1|0> 
 + 
 +</code> 
 + 
 +エージェントがスタンバイモード(''standby 1'')の場合、エージェントは監視を実行せず XML の生成や送信を行いません。この設定は、リモート設定がある Enterprise 版の利用時に意味があります。これにより、エージェントを無効化した場合に動作を停止することができます。
  
 デバッグモードの場合はこの機能を上書きし、エージェントは通常動作をします。 デバッグモードの場合はこの機能を上書きし、エージェントは通常動作をします。
  
-==== セカンダリサーバ ====+===== セカンダリサーバ =====
  
 データを送信するセカンダリサーバを設定することができます。設定により二種類の動作モードがあります。 データを送信するセカンダリサーバを設定することができます。設定により二種類の動作モードがあります。
行 300: 行 367:
   * **always**: プライマリサーバにデータが送信できるかどうかに関わらず、常にセカンダリサーバにもデータを送信します。   * **always**: プライマリサーバにデータが送信できるかどうかに関わらず、常にセカンダリサーバにもデータを送信します。
 設定例: 設定例:
 +
 <code> <code>
 +# Secondary server configuration
 +# ==============================
  
- secondary_server_ip     192.168.1.123 +# If secondary_mode is set to on_error, data files are copied to the secondary 
- secondary_server_path   /var/spool/pandora/data_in +# server only if the primary server fails. If set to always, data files are 
- secondary_mode          on_error +# always copied to the secondary server. 
- secondary_transfer_mode tentacle +#secondary_mode on_error 
- secondary_server_port   41121+#secondary_server_ip localhost 
 +#secondary_server_path /var/spool/pandora/data_in 
 +#secondary_server_port 41121 
 +#secondary_transfer_mode tentacle 
 +#secondary_transfer_timeout 30 
 +#secondary_server_pwd mypassword 
 +#secondary_server_ssl no 
 +#secondary_server_opts
  
 </code> </code>
  
-==== UDP サーバ ====+ 
 +===== UDP サーバ ===== 
 + 
 +<WRAP center round important 60%> 
 + 
 +UDPは本質的に安全ではないことに注意してください(ただし、応答を必須としないメッセージを送信するには効率的です)。 </WRAP>
  
 Pandora FMS エージェントは、 [[:ja:documentation:03_monitoring:02_operations#udp_リモートコマンド|リモートからコマンドを受け取る]]設定ができます。このサーバは、ユーザが指定した UDP のポートで待ち受けており、アラートが発生したときに何らかのコマンドを実行するなど、リモートシステム (基本的には Pandora FMS) から命令を受け取ることができます。 Pandora FMS エージェントは、 [[:ja:documentation:03_monitoring:02_operations#udp_リモートコマンド|リモートからコマンドを受け取る]]設定ができます。このサーバは、ユーザが指定した UDP のポートで待ち受けており、アラートが発生したときに何らかのコマンドを実行するなど、リモートシステム (基本的には Pandora FMS) から命令を受け取ることができます。
  
-UDP リモートサーバの設定には、いくつかのオプションがあり、//pandora_agent.conf// にて設定します。+UDP リモートサーバの設定には、いくつかのオプションがあり、//pandora_agent.conf//  にて設定します。
  
-   * **udp_server**:UDP サーバを有効にする場合は 1 を設定します。デフォルトでは無効です。+  * **udp_server**:UDP サーバを有効にする場合は 1 を設定します。デフォルトでは無効です。
   * **udp_server_port**: 待ち受けポート番号を設定します。   * **udp_server_port**: 待ち受けポート番号を設定します。
   * **udp_server_auth_address**: 命令の送信を許可する IPアドレスを設定します。カンマ区切りで複数のアドレスを指定できます。0.0.0.0 に設定すると、UDP サーバはすべてのアドレスからのリクエストを受け付けます。   * **udp_server_auth_address**: 命令の送信を許可する IPアドレスを設定します。カンマ区切りで複数のアドレスを指定できます。0.0.0.0 に設定すると、UDP サーバはすべてのアドレスからのリクエストを受け付けます。
 +<WRAP center round important 60%>
 +
 +すべてのソースからのコマンド受け入れのために 0.0.0.0 に設定できますが、この方法はお勧めしません。複数の Pandora FMS サーバがある場合、または IPv6 を使用している場合は、カンマで区切って異なる IP アドレスを追加できます。たとえば、 IPv6:''2001:0db8:0000:130F:0000:0000:087C:140B''  があり、その省略形が ''2001:0db8:0:130F::87C:140B''  の場合は、両方をカンマで区切って指定します。 </WRAP>
 +
   * **process_<name>_start <command>**: ユーザ定義プロセスを起動するコマンドを設定します。   * **process_<name>_start <command>**: ユーザ定義プロセスを起動するコマンドを設定します。
   * **process_<name>_stop <command>**: プロセスを停止するコマンドを設定します。   * **process_<name>_stop <command>**: プロセスを停止するコマンドを設定します。
行 366: 行 452:
 </code> </code>
  
-より詳しくは、アラート設定の章を参照ください。+より詳しくは、[[:ja:documentation:04_using:01_alerts#定義済のコマンド|アラート設定の章]]を参照ください。
  
 +===== モジュール定義 =====
  
-==== モジュール定義 ==== +[[:ja:documentation:02_installation:05_configuration_agents#エージェント設定概要|設定ファイル]] ''pandora_agent.conf'' にてローカルモジュールの実行を定義します。利用可能な全パラメータを以下に説明します。一般的な書式は次の通りです。
- +
-設定ファイル pandora_agent.conf にてローカルモジュールの実行を定義します。利用可能な全パラメータを以下に説明します。 +
- +
-一般的な書式は次の通りです。+
  
 <code> <code>
 +
  module_begin  module_begin
  module_name <モジュール名>  module_name <モジュール名>
行 384: 行 468:
 </code> </code>
  
-モジュールの種類によって違いがあります。この例は、ほとんどのモジュールで使われる共通で必須の行のみです。+ここで ''<モジュール名>'' はモジュールの名前で、''<実行するローカルコマンド>'' は実行されるコマンドです。モジュールには複数の追加オプションがあります。この例では、ほとんどの場合に共通の必須行のみが使用されています。 
 + 
 +以下のビデオチュートリアルも参照ください。 
 + 
 +  * [[https://www.youtube.com/watch?v=Ya-aZ7EpaD4|"How to configure a Linux module in Pandora FMS"]]. 
 +  * [[https://www.youtube.com/watch?v=iJXvKySFZ8M|"Windows local module creation in Pandora FMS"]]. 
 + 
 +以下の章ではそれぞれの詳細を説明します。
  
-=== 全モジュールで共通の項目 ===+==== 全モジュールで共通の項目 ====
  
 <WRAP center round important 60%> モジュールのフィールド情報はモジュール作成時にのみ反映されます(モジュールデータ、説明、拡張情報を除く)。モジュールがすでに存在する場合は更新されません。 </WRAP> <WRAP center round important 60%> モジュールのフィールド情報はモジュール作成時にのみ反映されます(モジュールデータ、説明、拡張情報を除く)。モジュールがすでに存在する場合は更新されません。 </WRAP>
  
-== **module_begin** ==+=== module_begin ===
  
 モジュール定義の開始を示す、必須項目です。 モジュール定義の開始を示す、必須項目です。
  
-== module_name <名前> ==+=== module_name ===
  
 モジュールの名前です(必須)。重複した名前は設定できません。 モジュールの名前です(必須)。重複した名前は設定できません。
  
-== module_type ==+<code> 
 +module_name <名前> 
 + 
 +</code> 
 + 
 +=== module_type === 
 + 
 +<code> 
 +module_type <タイプ> 
 + 
 +</code>
  
 モジュールが返すデータタイプです。いずれか一つを選択することが必須です。指定可能なデータタイプは次の通りです。 モジュールが返すデータタイプです。いずれか一つを選択することが必須です。指定可能なデータタイプは次の通りです。
行 410: 行 511:
   * **Asynchronous Monitor**  (async_proc): generic_proc と似ていますが、非同期のデータタイプです。   * **Asynchronous Monitor**  (async_proc): generic_proc と似ていますが、非同期のデータタイプです。
   * **Asynchronous Numerical**  (async_data): generic_data と似ていますが、非同期のデータタイプです。   * **Asynchronous Numerical**  (async_data): generic_data と似ていますが、非同期のデータタイプです。
-== module_min <値> ==+=== module_min === 
 + 
 +<code> 
 +module_min <値> 
 + 
 +</code>
  
 そのモジュールが返すことを許容されるデータの最小値です。範囲を外れたデータはサーバにより削除されます。 そのモジュールが返すことを許容されるデータの最小値です。範囲を外れたデータはサーバにより削除されます。
  
-== module_max <値> ==+=== module_max === 
 + 
 +<code> 
 +module_max <値> 
 + 
 +</code>
  
 そのモジュールが返すことを許容されるデータの最大値です。範囲を外れたデータはサーバにより削除されます。 そのモジュールが返すことを許容されるデータの最大値です。範囲を外れたデータはサーバにより削除されます。
  
-== module_min_warning <値> ==+=== module_min_warning === 
 + 
 +<code> 
 +module_min_warning <値> 
 + 
 +</code>
  
 モジュールが警告状態になる最小値です。 モジュールが警告状態になる最小値です。
  
-== module_max_warning <値> ==+=== module_max_warning === 
 + 
 +<code> 
 +module_max_warning <値> 
 + 
 +</code>
  
 モジュールが警告状態になる最大値です。 モジュールが警告状態になる最大値です。
  
-== module_min_critical <値> ==+=== module_min_critical === 
 + 
 +<code> 
 +module_min_critical <値> 
 + 
 +</code>
  
 モジュールが障害状態になる最小値です。 モジュールが障害状態になる最小値です。
  
-== module_max_critical <値> ==+=== module_max_critical === 
 + 
 +<code> 
 +module_max_critical <値> 
 + 
 +</code>
  
 モジュールが障害状態になる最大値です。 モジュールが障害状態になる最大値です。
  
-== module_disabled <値> ==+=== module_disabled === 
 + 
 +<code> 
 +module_disabled <値> 
 + 
 +</code>
  
 モジュールが、有効(0)か無効(1)かを表します。 モジュールが、有効(0)か無効(1)かを表します。
  
-== module_min_ff_event <値> ==+=== module_min_ff_event === 
 + 
 +<code> 
 +module_min_ff_event <値> 
 + 
 +</code>
  
 連続抑制回数を指定します。連続抑制回数とは、収集データに揺らぎがあるような場合に、それを変化としてとらえないように抑止するものです。 連続抑制回数を指定します。連続抑制回数とは、収集データに揺らぎがあるような場合に、それを変化としてとらえないように抑止するものです。
  
-== (>= 6.0 SP4) module_each_ff <値> ==+=== module_each_ff === 
 + 
 +<code> 
 +module_each_ff <0|1> 
 + 
 +</code>
  
 有効化(1)すると、module_min_ff_event の代わりに連続抑制回数に個別状態変化(module_min_ff_event_normal, module_min_ff_event_warning および module_min_ff_event_critical)を利用します。 有効化(1)すると、module_min_ff_event の代わりに連続抑制回数に個別状態変化(module_min_ff_event_normal, module_min_ff_event_warning および module_min_ff_event_critical)を利用します。
  
-== (>= 6.0 SP4) module_min_ff_event_normal <値> ==+=== module_min_ff_event_normal === 
 + 
 +<code> 
 + 
 +module_min_ff_event_normal <値> 
 + 
 +</code>
  
 個別状態変化で、正常状態へ移行する場合の連続抑制回数です。 個別状態変化で、正常状態へ移行する場合の連続抑制回数です。
  
-== (>= 6.0 SP4) module_min_ff_event_warning <値> ==+=== module_min_ff_event_warning === 
 + 
 +<code> 
 +module_min_ff_event_warning <値> 
 + 
 +</code>
  
 個別状態変化で、警告状態へ移行する場合の連続抑制回数です。 個別状態変化で、警告状態へ移行する場合の連続抑制回数です。
  
-== (>= 6.0 SP4) module_min_ff_event_critical <値> ==+=== module_min_ff_event_critical === 
 + 
 +<code> 
 +module_min_ff_event_critical <値> 
 + 
 +</code>
  
 個別状態変化で、障害状態へ移行する場合の連続抑制回数です。 個別状態変化で、障害状態へ移行する場合の連続抑制回数です。
  
-== (>= 6.0 SP4) module_ff_timeout <秒> ==+=== module_ff_timeout === 
 + 
 +<code> 
 +module_ff_timeout <秒> 
 + 
 +</code>
  
 指定した秒数が経過したら連続抑制回数のカウンターをリセットします。これは、//module_min_ff_event//  に指定した抑制回数の状態変化が //module_ff_timeout//  に指定の秒数以内に発生する必要があることを意味します。 指定した秒数が経過したら連続抑制回数のカウンターをリセットします。これは、//module_min_ff_event//  に指定した抑制回数の状態変化が //module_ff_timeout//  に指定の秒数以内に発生する必要があることを意味します。
  
-== (>= 734) module_ff_type <値> ==+=== module_ff_type === 
 + 
 +<code> 
 +module_ff_type <値> 
 + 
 +</code>
  
 これは、連続抑制の高度なオプションで、モジュールの状態を制御します。 "カウンタを保持する" ことによって、値の代わりに、受け取った値を持つモジュールの状態に応じて、ある状態から別の状態に渡すカウンタ値をいくつか設定します。 これは、連続抑制の高度なオプションで、モジュールの状態を制御します。 "カウンタを保持する" ことによって、値の代わりに、受け取った値を持つモジュールの状態に応じて、ある状態から別の状態に渡すカウンタ値をいくつか設定します。
行 468: 行 640:
 有効(1)か無効(0)かを指定します。 有効(1)か無効(0)かを指定します。
  
-== module_description <テキスト> ==+=== module_ff_event === 
 +<code> 
 + 
 +module_ff_event X 
 + 
 +</code> 
 + 
 +これは、モジュールの連続抑制実行のしきい値(秒単位)です。 
 + 
 +=== module_description === 
 + 
 +<code> 
 +module_description <テキスト> 
 + 
 +</code>
  
 モジュールの任意のコメントです。 モジュールの任意のコメントです。
  
-== module_interval <間隔倍率> ==+=== module_interval === 
 + 
 +<code> 
 +module_interval <間隔倍率> 
 + 
 +</code>
  
 それぞれのモジュールの実行間隔をエージェントの間隔の倍率で設定することができます。例えば、エージェントが 300 (5 分)間隔の設定であった場合に、あるモジュールだけ 15分間隔にしたいときに、module_interval 3 を設定します。そのモジュールは、300秒 x 3 = 900秒 (15分) 間隔で実行されます。 それぞれのモジュールの実行間隔をエージェントの間隔の倍率で設定することができます。例えば、エージェントが 300 (5 分)間隔の設定であった場合に、あるモジュールだけ 15分間隔にしたいときに、module_interval 3 を設定します。そのモジュールは、300秒 x 3 = 900秒 (15分) 間隔で実行されます。
行 478: 行 669:
 <WRAP center round important 60%> ブローカーエージェントで module_interval が動作するようにするには、元のエージェントと同じ間隔に設定する必要があります。 そうしないと、正しく動作しない可能性があります。 </WRAP> <WRAP center round important 60%> ブローカーエージェントで module_interval が動作するようにするには、元のエージェントと同じ間隔に設定する必要があります。 そうしないと、正しく動作しない可能性があります。 </WRAP>
  
-== module_timeout <秒数> ==+=== module_timeout === 
 + 
 +<code> 
 +module_timeout <秒数> 
 + 
 +</code>
  
 モジュールの最大実行時間を秒単位で指定します。実行中にこの時間を超過した場合は、実行が中止されます。 モジュールの最大実行時間を秒単位で指定します。実行中にこの時間を超過した場合は、実行が中止されます。
  
-== module_postprocess <倍率> ==+=== module_postprocess === 
 + 
 +<code> 
 +module_postprocess <倍率> 
 + 
 +</code>
  
 モジュールから返される値を何倍するかの値です。データの単位を変換するのに便利です。もし、エージェントが取得した値に 1024 を掛けたい場合は、1024 を設定します。また、1024 で割りたい場合は、1/1024 を意味する 0.000976563 を設定します。 モジュールから返される値を何倍するかの値です。データの単位を変換するのに便利です。もし、エージェントが取得した値に 1024 を掛けたい場合は、1024 を設定します。また、1024 で割りたい場合は、1/1024 を意味する 0.000976563 を設定します。
  
-== module_save <変数名> ==+=== module_save === 
 + 
 +<code> 
 +module_save <変数名> 
 + 
 +</code>
  
 このパラメータで定義された名前の変数にモジュールから返された値を保存します。この値はあとから他のモジュールで利用できます。 このパラメータで定義された名前の変数にモジュールから返された値を保存します。この値はあとから他のモジュールで利用できます。
行 526: 行 732:
 </code> </code>
  
-== module_crontab <分> <時間> <日> <月> <曜日> ==+=== module_crontab ===
  
-バージョン 3.2 から、モジュールを指定した日時に実行させるようにすることができます。この設定は、**module_crontab**  にて、crontab に似た設定を行うことにより実現します。+バージョン 3.2 から、モジュールを指定した日時に実行させるようにすることができます。この設定は、**module_crontab**  にて、[[https://en.wikipedia.org/wiki/Cron#CRON_expression|crontab]] ファイルに似た設定を行うことにより実現します。
  
 +<code>
 module_crontab <分> <時間> <日> <月> <曜日> module_crontab <分> <時間> <日> <月> <曜日>
 +
 +</code>
  
 指定可能な範囲は次の通りです。 指定可能な範囲は次の通りです。
行 566: 行 775:
 </code> </code>
  
-== module_condition <評価式> <コマンド> ==+=== module_condition === 
 + 
 +<code> 
 +module_condition <評価式> <コマンド> 
 + 
 +</code>
  
 バージョン 3.2 から、モジュールが特定の値を返す場合にコマンドを実行させることが可能です。次に示すオプションの一つを定義します。 バージョン 3.2 から、モジュールが特定の値を返す場合にコマンドを実行させることが可能です。次に示すオプションの一つを定義します。
行 575: 行 789:
   * **!=**  [値]: モジュールの値が指定された値と異なる場合にコマンドを実行します。   * **!=**  [値]: モジュールの値が指定された値と異なる場合にコマンドを実行します。
   * **=~**  [正規表現]: モジュールの値が指定された正規表現にマッチする場合にコマンドを実行します。   * **=~**  [正規表現]: モジュールの値が指定された正規表現にマッチする場合にコマンドを実行します。
-  * **(** 値, 値**)**: モジュールの値が指定された値の範囲の場合にコマンドを実行します。+  * **(**  値, 値**)**: モジュールの値が指定された値の範囲の場合にコマンドを実行します。
 同一のモジュールに複数の条件を設定することも可能です。以下の例では、モジュールの値が 1 と 3 の間の時に//script_1.sh//  が実行されます。また、モジュールの値が 5.5 より大きい時に //script_2.sh//  が実行されます。//module_exec//  の結果が 2.5 なので、最初の //script_1.sh//  のみ実行されます。 同一のモジュールに複数の条件を設定することも可能です。以下の例では、モジュールの値が 1 と 3 の間の時に//script_1.sh//  が実行されます。また、モジュールの値が 5.5 より大きい時に //script_2.sh//  が実行されます。//module_exec//  の結果が 2.5 なので、最初の //script_1.sh//  のみ実行されます。
  
行 621: 行 835:
 </code> </code>
  
-  * 注意**: Windows プラットホームでは、コマンドの実行にはそれが正しく実行されていることを確認するために **cmd.exe /c** を利用することをお勧めします。例えば次の通りです。 '' module_begin module_name condition_test module_type generic_data module_exec echo 5 module_condition (2, 8) cmd.exe /c script.bat module_end ''  == module_precondition <評価式> <コマンド> == 事前状態定義にマッチした場合モジュールを実行します。次に示すオプションの一つを定義します。 * **>** [値]: コマンドの実行結果が指定された値よりも大きい場合にモジュールを実行します。 * **<** [値]: コマンドの実行結果が指定された値よりも小さい場合にモジュールを実行します。 * ** =** [値]: コマンドの実行結果が指定された値と同じ場合にモジュールを実行します。 * **!=** [値]: コマンドの実行結果が指定された値と異なる場合にモジュールを実行します。 * ** =~** [正規表現]: コマンドの実行結果が指定された正規表現にマッチする場合にモジュールを実行します。 * ** (**値, 値**)**: コマンドの実行結果が指定された値の範囲の場合にモジュールを実行します。 以下の例では、precondition で設定した実行結果が 2 と 8 の間の場合に、モジュール //monitoring_variable.bat//  が実行されます。この例では //module_precondition//  の実行結果が 5 であるため、値が 2 と 8 の間であり、//monitoring_variable.bat//  が実行されます。 '' module_begin module_name Precondition_test1 module_type generic_data module_precondition (2, 8) echo 5 module_exec monitoring_variable.bat module_end ''  module_condition と同様に、複数の事前状態定義を利用することができます。モジュールは、すべての事前状態定義にマッチした場合のみ実行されます。 '' module_begin module_name Precondition_test2 module_type generic_data module_precondition (2, 8) echo 5 module_precondition < 3 echo 5 module_exec monitoring_variable.bat module_end ''  * 注意**: Windows プラットホームでは、コマンドの実行にはそれが正しく実行されていることを確認するために **cmd.exe /c**  を利用することをお勧めします。例えば次の通りです。+  * 注意: Windows プラットホームでは、コマンドの実行にはそれが正しく実行されていることを確認するために **cmd.exe /c**  を利用することをお勧めします。例えば次の通りです。 
 + 
 +<code> 
 + module_begin 
 + module_name condition_test 
 + module_type generic_data 
 + module_exec echo 5 
 + module_condition (2, 8) cmd.exe /c script.bat 
 + module_end 
 + 
 +</code> 
 + 
 +=== module_precondition === 
 + 
 +<code> 
 +module_precondition <評価式> <コマンド> 
 + 
 +</code> 
 + 
 +事前状態定義にマッチした場合モジュールを実行します。次に示すオプションの一つを定義します。 
 + 
 +  * **>**  [値]: コマンドの実行結果が指定された値よりも大きい場合にモジュールを実行します。 
 +  * **<**  [値]: コマンドの実行結果が指定された値よりも小さい場合にモジュールを実行します。 
 +  * **=**  [値]: コマンドの実行結果が指定された値と同じ場合にモジュールを実行します。 
 +  * **!=**  [値]: コマンドの実行結果が指定された値と異なる場合にモジュールを実行します。 
 +  * **=~**  [正規表現]: コマンドの実行結果が指定された正規表現にマッチする場合にモジュールを実行します。 
 +  * **(**  値, 値**)**: コマンドの実行結果が指定された値の範囲の場合にモジュールを実行します。 
 +以下の例では、precondition で設定した実行結果が 2 と 8 の間の場合に、モジュール //monitoring_variable.bat//  が実行されます。この例では //module_precondition//  の実行結果が 5 であるため、値が 2 と 8 の間であり、//monitoring_variable.bat//  が実行されます。 
 + 
 +<code> 
 + module_begin 
 + module_name Precondition_test1 
 + module_type generic_data 
 + module_precondition (2, 8) echo 5 
 + module_exec monitoring_variable.bat 
 + module_end 
 + 
 +</code> 
 + 
 +module_condition と同様に、複数の事前状態定義を利用することができます。モジュールは、すべての事前状態定義にマッチした場合のみ実行されます。 
 + 
 +<code> 
 + module_begin 
 + module_name Precondition_test2 
 + module_type generic_data 
 + module_precondition (2, 8) echo 5 
 + module_precondition <3 echo 5 
 + module_exec monitoring_variable.bat 
 + module_end 
 + 
 +</code> 
 + 
 +  * 注意: Windows プラットホームでは、コマンドの実行にはそれが正しく実行されていることを確認するために **cmd.exe /c**  を利用することをお勧めします。例えば次の通りです。
  
 <code> <code>
行 633: 行 899:
 </code> </code>
  
-== (>= 5.x) module_unit <単位> ==+=== module_unit === 
 + 
 +<code> 
 +module_unit <単位> 
 + 
 +</code>
  
 これは、モジュールの値に付与する単位です。 これは、モジュールの値に付与する単位です。
行 644: 行 915:
 </code> </code>
  
-== (>= 5.x) module_group <値> ==+=== module_group === 
 + 
 +<code> 
 +module_group <値> 
 + 
 +</code>
  
 これは、モジュールグループ名です。 これは、モジュールグループ名です。
行 655: 行 931:
 </code> </code>
  
-== (>= 5.x) module_custom_id <値> ==+=== module_custom_id === 
 + 
 +<code> 
 +module_custom_id <値> 
 + 
 +</code>
  
 モジュールのカスタム ID です。 モジュールのカスタム ID です。
行 666: 行 947:
 </code> </code>
  
-== (>= 5.x) module_str_warning <値> ==+=== module_str_warning === 
 + 
 +<code> 
 +module_str_warning <値> 
 + 
 +</code>
  
 文字列タイプのモジュールで警告状態を定義する正規表現です。 文字列タイプのモジュールで警告状態を定義する正規表現です。
行 677: 行 963:
 </code> </code>
  
-== (>= 5.x) module_str_critical <値> ==+=== module_str_critical === 
 + 
 +<code> 
 +module_str_critical <値> 
 + 
 +</code>
  
 文字列タイプのモジュールで障害状態を定義する正規表現です。 文字列タイプのモジュールで障害状態を定義する正規表現です。
行 688: 行 979:
 </code> </code>
  
-== (>= 5.x) module_warning_instructions <値> ==+=== module_warning_instructions === 
 + 
 +<code> 
 +module_warning_instructions <値> 
 + 
 +</code>
  
 モジュールが警告状態に変化したときのオペレータへの指示です。 モジュールが警告状態に変化したときのオペレータへの指示です。
行 699: 行 995:
 </code> </code>
  
-== (>= 5.x) module_critical_instructions <値> ==+=== module_critical_instructions === 
 + 
 +<code> 
 +module_critical_instructions <値> 
 + 
 +</code>
  
 モジュールが障害状態に変化したときのオペレータへの指示です。 モジュールが障害状態に変化したときのオペレータへの指示です。
行 710: 行 1011:
 </code> </code>
  
-== (>= 5.x) module_unknown_instructions <値> ==+=== module_unknown_instructions === 
 + 
 +<code> 
 +module_unknown_instructions <値> 
 + 
 +</code>
  
 モジュールが不明状態に変化したときのオペレータへの指示です。 モジュールが不明状態に変化したときのオペレータへの指示です。
行 721: 行 1027:
 </code> </code>
  
-== (>= 5.x) module_tags <値> ==+=== module_tags === 
 + 
 +<code> 
 +module_tags <値> 
 + 
 +</code>
  
 カンマ区切りでモジュールに割り当てるタグを指定します。 カンマ区切りでモジュールに割り当てるタグを指定します。
行 729: 行 1040:
 module_tags tag1,tag2,tag3 module_tags tag1,tag2,tag3
  
-== (>= 5.x) module_warning_inverse <値> ==+=== module_warning_inverse === 
 + 
 +<code> 
 +module_warning_inverse <値> 
 + 
 +</code>
  
 警告閾値範囲の反転を有効化(1)します。 警告閾値範囲の反転を有効化(1)します。
行 740: 行 1056:
 </code> </code>
  
-== (>= 5.x) module_critical_inverse <値> ==+=== module_critical_inverse === 
 + 
 +<code> 
 +module_critical_inverse <値> 
 + 
 +</code>
  
 障害閾値範囲の反転を有効化(1)します。 障害閾値範囲の反転を有効化(1)します。
行 751: 行 1072:
 </code> </code>
  
-== (>= 5.x) module_native_encoding <値> ==+=== module_native_encoding ===
  
-(Win32 のみ)+<WRAP center round tip 60%>Win32 のみ</WRAP> 
 + 
 +<code> 
 +module_native_encoding <値> 
 + 
 +</code>
  
 この設定トークンは、module_exec によってコマンドラインから実行されるモジュールにのみ影響します。 この設定トークンは、module_exec によってコマンドラインから実行されるモジュールにのみ影響します。
行 768: 行 1094:
 module_native_encoding の設定が無い場合は、変換は行われません。 module_native_encoding の設定が無い場合は、変換は行われません。
  
-== (>= 5.x) module_quiet <値> ==+=== module_quiet ===
  
-有効化(1)すると、モジュールは静観モードになります。イベントやアラートを生成せずデータの保存も行いません。+<code> 
 +module_quiet <値> 
 + 
 +</code> 
 + 
 +有効化(''1'')すると、モジュールは静観モードになります。イベントやアラートを生成しません。
  
 例: 例:
行 779: 行 1110:
 </code> </code>
  
-== (>= 5.x) module_ff_interval <値> ==+=== module_ff_interval === 
 + 
 +<code> 
 +module_ff_interval <値> 
 + 
 +</code>
  
 収集データに揺らぎがあるような場合に、それを変化としてとらえるべきかを判断する期間のデータ収集間隔です。(秒単位) 収集データに揺らぎがあるような場合に、それを変化としてとらえるべきかを判断する期間のデータ収集間隔です。(秒単位)
行 790: 行 1126:
 </code> </code>
  
-== (>= 5.x) module_macro<macro> <値> ==+=== module_macro === 
 + 
 +<code> 
 +module_macro<マクロ> <値> 
 + 
 +</code>
  
 コンソールから、ローカルコンポーネントにのみ適用できます。設定ファイルで直接設定しません。 コンソールから、ローカルコンポーネントにのみ適用できます。設定ファイルで直接設定しません。
  
-== (>= 5.1 SP4) module_alert_template <テンプレート名> ==+=== module_alert_template === 
 + 
 +<code> 
 +module_alert_template <テンプレート名> 
 + 
 +</code>
  
-このマクロは、パラメータ名([[:ja:documentation:04_using:01_alerts#e382a2e383a9e383bce38388e38386e383b3e38397e383ace383bce38388|アラートテンプレート]] 参照)に対応したモジュールにアラートテンプレートを割り当てます。+このマクロは、パラメータ名([[:ja:documentation:04_using:01_alerts#アラートテンプレート|アラートテンプレート]] 参照)に対応したモジュールにアラートテンプレートを割り当てます。
  
 例: 例:
行 815: 行 1161:
 </code> </code>
  
-== module_end ==+=== intensive_interval === 
 + 
 +[[:ja:documentation:03_monitoring:02_operations#高頻度モニタリング|高頻度モニタリング]]間隔です。''module_intensive_monitoring'' を設定したモジュールは、障害状態の場合にこの間隔で実行できます。 
 + 
 +=== module_intensive_condition === 
 + 
 +[[:ja:documentation:03_monitoring:02_operations#高頻度モニタリング|高頻度モニタリング]]のための状態です。高頻度監視モジュールがこのパラメータで設定された値に達した場合、[[:ja:documentation:02_installation:05_configuration_agents#intensive_interval|intensive_interval]] で設定した間隔で実行されます。 
 + 
 +=== module_end ===
  
 モジュール定義の終わりを表します。必須項目です。 モジュール定義の終わりを表します。必須項目です。
  
-=== 情報を取得するためのディレクティブ ===+==== 情報を取得するためのディレクティブ ====
  
 次に、それぞれのモジュールで情報を取得するためのディレクティブを示します。それぞれのモジュールで、1回ずつ利用できます。 次に、それぞれのモジュールで情報を取得するためのディレクティブを示します。それぞれのモジュールで、1回ずつ利用できます。
  
-== module_exec <コマンド> ==+=== module_exec === 
 + 
 +<code> 
 +module_exec <コマンド> 
 + 
 +</code>
  
-一般的なコマンド実行行です。 1行で情報を取得するコマンドを指定する必要があります。+一般的な''<コマンド>''実行行です。 1行で情報を取得するコマンドを指定する必要があります。
  
-Linux では、コマンドはデフォルトのシェルを使って実行されます。デフォルトのシェルは、 **/bin/sh**  のシンボリックリンクによって決まります。通常は、//bash//  ですが、Ubuntu のシステムでは異なります(この場合 //dash//)。端末でコマンドをテストしても、エージェントからの実行ではエラーが発生する可能性があります。解決策としては、次のようにコマンドラインの実行で明示的に bash を記載します。+GNU/Linux では、コマンドはデフォルトのシェルを使って実行されます。デフォルトのシェルは、 ''/bin/sh''  のシンボリックリンクによって決まります。通常は、**bash**  ですが、Ubuntu のシステムでは異なります(この場合 [[http://manpages.ubuntu.com/manpages/hirsute/man1/dash.1.html|dash]])。端末でコマンドをテストしても、エージェントからの実行ではエラーが発生する可能性があります。解決策としては、次のようにコマンドラインの実行で明示的に **bash** を記載します。
  
 <code> <code>
行 838: 行 1197:
 Windows エージェントでのデータ取得のためのディレクティブは他にもあります。以下に示します。 Windows エージェントでのデータ取得のためのディレクティブは他にもあります。以下に示します。
  
-== module_service <サービス> ==+=== module_service ===
  
-指定したサービスが実行中であるかどうかをチェックします。サービス名にスペースが含まれる場合は、" " でくくるのを忘れないようにしてください。+<code> 
 +module_service <サービス> 
 + 
 +</code> 
 + 
 +指定したサービスが実行中であるかどうかをチェックします。 
 + 
 +== MS Windows == 
 + 
 +サービス名にスペースが含まれる場合は、" " でくくるのを忘れないようにしてください。
  
 <code> <code>
行 854: 行 1222:
 サービスは、Windows サービスマネージャに表示される短い名前 (サービス名) で識別されます。 サービスは、Windows サービスマネージャに表示される短い名前 (サービス名) で識別されます。
  
-{{  :wiki:service_name_id.png  }}+[[:wiki:service_name_id.png?id=ja:documentation:02_installation:05_configuration_agents&media=wiki:service_name_id.png|{{  :wiki:service_name_id.png?nolink&  }}]]
  
 //非同期モード // //非同期モード //
  
-Pandora FMS は通常、(モジュールによって定義される)一定の秒間隔にてチェックを実行します (デフォルトでは、300秒 = 5分)。そのため、チェックの直後にサービスがダウンすると、それがダウンであると認識するのに、さらに 300秒かかります。非同期モジュールでは、Pandora に "今すぐ" サービスの障害を通知するようにできます。これは、//非同期// 操作モードと呼んでいます。非同期モードにするには、以下のディレクティブを設定してください。 +Pandora FMS は通常、(モジュールによって定義される)一定の秒間隔にてチェックを実行します (デフォルトでは、300秒 = 5分)。そのため、チェックの直後にサービスがダウンすると、それがダウンであると認識するのに、さらに 300秒かかります。非同期モジュールでは、Pandora に "今すぐ" サービスの障害を通知するようにできます。これは、//非同期//  操作モードと呼んでいます。非同期モードにするには、以下のディレクティブを設定してください。
 <code> <code>
 +
 module_async yes module_async yes
  
行 885: 行 1253:
 </code> </code>
  
-**Unix**+== Unix ==
  
 Unix でも Windows と同様に動作します。違いは Unix であることだけで、プロセスおよびサービスは同じ考え方です。例えば、bash プロセスが動作しているかを確認するには次のようにします。 Unix でも Windows と同様に動作します。違いは Unix であることだけで、プロセスおよびサービスは同じ考え方です。例えば、bash プロセスが動作しているかを確認するには次のようにします。
行 899: 行 1267:
 </code> </code>
  
-Unix エージェントでは、ウォッチドッグと非同期検出はできません。+<WRAP center round info 60%>Unix エージェントでは、ウォッチドッグと非同期検出はできません。</WRAP>
  
-== module_proc <プロセス> ==+''module_service'' では、''ps aux'' で表示されるコマンドのフルパスを指定する必要があります。以下の例では、SSH サービスをチェックします。
  
-指定した名前のプロセスがいるかどうかをチェックします。プロセス名にスペースが含まれていても、" " は**使わない** でください。プロセス名に拡張子 .exe がつくかどうかを良く確認してください。モジュールは、指定した名前で実行されているプロセスの数を返します。+<code> 
 + ps aux | grep ssh 
 + 
 +</code> 
 + 
 +{{  :wiki:pfms-software_agent-module_service-example.png  }} 
 + 
 +Configure it: 
 + 
 +<code bash> 
 +module_begin 
 +module_name MY_SSHD 
 +module_type generic_proc 
 +module_service /usr/sbin/sshd -D 
 +module_description Is sshd running? 
 +module_end 
 + 
 +</code> 
 + 
 +=== module_proc === 
 + 
 +<code> 
 +module_proc <プロセス> 
 + 
 +</code> 
 + 
 +指定した名前のプロセスがいるかどうかをチェックします。 
 + 
 +**Windows**<WRAP center round tip 60%>プロセス名にスペースが含まれていても、" " は**使わない**  でください。プロセス名に拡張子 .exe がつくかどうかを良く確認してください。モジュールは、指定した名前で実行されているプロセスの数を返します。</WRAP>
  
 以下に cmd.exe プロセスをモニタリングする例を示します。 以下に cmd.exe プロセスをモニタリングする例を示します。
行 916: 行 1312:
  
 </code> </code>
- 
-**Unix** 
- 
-UNIX では、このモジュールは module_service のように動作します。非同期およびウォッチドッグモードはサポートしません。 
  
 //非同期モード // //非同期モード //
  
-サービスと同じように、モニタリングしているプロセスにて何らかの原因で障害が発生することがあります。Windows エージェントでは、//module_proc//  モジュールで非同期チェックをサポートしています。この場合、プロセスの状態が変化したとき、通常のモニタリング間隔における次のチェックタイミングを待たずに**すぐに** 通知されます。これにより、プロセスに障害が発生したのとほぼ同時にそれを知ることができます。以下にプロセスの非同期モニタリング設定の例を示します。+サービスと同じように、モニタリングしているプロセスにて何らかの原因で障害が発生することがあります。Windows エージェントでは、//module_proc//  モジュールで非同期チェックをサポートしています。この場合、プロセスの状態が変化したとき、通常のモニタリング間隔における次のチェックタイミングを待たずに**すぐに**  通知されます。これにより、プロセスに障害が発生したのとほぼ同時にそれを知ることができます。以下にプロセスの非同期モニタリング設定の例を示します。
  
 <code> <code>
行 942: 行 1334:
 ウォッチドッグは、ダウンしたプロセスを見つけた場合にそれをすぐに起動させることができます。Pandora FMS の Windows エージェントは、プロセスがダウンしたときにウォッチドッグとして動作させることができます。 ウォッチドッグは、ダウンしたプロセスを見つけた場合にそれをすぐに起動させることができます。Pandora FMS の Windows エージェントは、プロセスがダウンしたときにウォッチドッグとして動作させることができます。
  
-プロセスの実行には、いくつかのパラメータが必要です。このモジュールには、いくつかの追加設定オプションがあります。//ウォッチドッグ// モードは、モジュールタイプが//非同期// の場合のみ動作することに注意してください。ウォッチドッグでの module_proc の設定例を見てみます。+プロセスの実行には、いくつかのパラメータが必要です。このモジュールには、いくつかの追加設定オプションがあります。//ウォッチドッグ//  モードは、モジュールタイプが//非同期//  の場合のみ動作することに注意してください。ウォッチドッグでの module_proc の設定例を見てみます。
  
 <code> <code>
行 968: 行 1360:
 <WRAP center round important 60%> Windows Vista 以前のバージョンでは、Pandora FMS サービスプロパティで、"Interactive access with desktop" を有効にすることにより //module_user_session//  を設定することができます。以下のスクリーンショットに示します。 <WRAP center round important 60%> Windows Vista 以前のバージョンでは、Pandora FMS サービスプロパティで、"Interactive access with desktop" を有効にすることにより //module_user_session//  を設定することができます。以下のスクリーンショットに示します。
  
-{{  :wiki:service_interactive.png  }}</WRAP>+[[:wiki:service_interactive.png?id=ja:documentation:02_installation:05_configuration_agents&media=wiki:service_interactive.png|{{  :wiki:service_interactive.png?nolink&  }}]] </WRAP>
  
 また、Pandora FMS は "SYSTEM" アカウントのサービスとして動作するため、実行されるコマンドはこのユーザおよびこのユーザの環境で動作することに注意してください。したがって、特定のプロセスを特定のユーザで実行したい場合は、環境変数の設定やその他事前処理を行う呼び出し用スクリプト (.bat など) を用意し、そのスクリプトをウォッチドッグの起動プログラムとして設定する必要があります。 また、Pandora FMS は "SYSTEM" アカウントのサービスとして動作するため、実行されるコマンドはこのユーザおよびこのユーザの環境で動作することに注意してください。したがって、特定のプロセスを特定のユーザで実行したい場合は、環境変数の設定やその他事前処理を行う呼び出し用スクリプト (.bat など) を用意し、そのスクリプトをウォッチドッグの起動プログラムとして設定する必要があります。
  
-== module_cpuproc <プロセス> (Unix のみ) ==+=== module_cpuproc <プロセス> (Unix のみ) ===
  
 特定のプロセスの CPU 使用率を返します。 特定のプロセスの CPU 使用率を返します。
- 
 <code> <code>
 +
  module_begin  module_begin
  module_name myserver_cpu  module_name myserver_cpu
行 986: 行 1378:
 </code> </code>
  
-== module_memproc <プロセス> (Unix のみ) ==+**Unix** 
 + 
 +UNIX では、このモジュールは module_service のように動作します。非同期およびウォッチドッグモードはサポートしません。 
 + 
 +=== module_memproc === 
 + 
 +<code> 
 +module_memproc <プロセス> 
 + 
 +</code>
  
-特定のプロセスが利用しているメモリ量を返します。+**Unixのみです。**  特定のプロセスが利用しているメモリ量を返します。
  
 <code> <code>
行 1000: 行 1401:
 </code> </code>
  
-== module_freedisk <ドライブ名:>|<ボリューム> ==+=== module_freedisk === 
 + 
 +<code> 
 +module_freedisk <ドライブ名:>|<ボリューム> 
 + 
 +</code> 
 + 
 +このモジュールは、ディスクの空き容量をチェックします。 
 + 
 +**Windows® の場合** 
 + 
 +ドライブ名の後に '':'' を記載します。
  
-このモジュールは、UNIX および Windows 双方で利用できます。ディスクの空き容量をチェックします。(Windows では **ドライブ名** のあとに ":" を忘れないようにしてください。) UNIX であれば、/var などのボリュームを指定します。 
 <code> <code>
  
行 1012: 行 1423:
  
 </code> </code>
 +
 +**Unix® の場合**
 +
 +''/var'' のようにチェックするボリュームを指定します。
  
 <code> <code>
行 1022: 行 1437:
 </code> </code>
  
-== module_freepercentdisk <ドライブ名:>|<ボリューム> ==+=== module_freepercentdisk === 
 + 
 +<code> 
 +module_freepercentdisk <ドライブ名:>|<ボリューム> 
 + 
 +</code> 
 + 
 +このモジュールは、ディスクの空きをパーセントで返します。 
 + 
 +**Windows** 
 + 
 +ドライブ名: (":"を忘れないようにしてください) を指定します。
  
-このモジュールは、ディスクの空きをパーセントで返します。Windows であれば、ドライブ名: (":"を忘れないようにしてください) で、UNIX であれば、/var などのボリュームを指定します。 
 <code> <code>
  
行 1034: 行 1459:
  
 </code> </code>
 +
 +**Unix**
 +
 +/var などのボリュームを指定します。
  
 <code> <code>
行 1044: 行 1473:
 </code> </code>
  
-== module_occupiedpercentdisk <ドライブ名:>|<ボリューム> ==+=== module_occupiedpercentdisk ===
  
-(Unix のみ)+<code> 
 +module_occupiedpercentdisk <ドライブ名:>|<ボリューム> 
 + 
 +</code>
  
-このモジュールは、/var 等の Unix ファイルシステムのディスク使用率(%)を返します。+**Unix のみです。**  このモジュールは、/var 等の Unix ファイルシステムのディスク使用率(%)を返します。
 <code> <code>
  
行 1059: 行 1491:
 </code> </code>
  
-== module_cpuusage <cpu id> ==+=== module_cpuusage === 
 + 
 +<code> 
 +module_cpuusage <cpu id|all> 
 + 
 +</code>
  
 このモジュールは、UNIX および Windows 双方で使えます。指定した CPU 番号の CPU 使用率を返します。CPU が 1つしかない場合は番号を指定しないか、all を指定します。 このモジュールは、UNIX および Windows 双方で使えます。指定した CPU 番号の CPU 使用率を返します。CPU が 1つしかない場合は番号を指定しないか、all を指定します。
  
 次のように、マルチ CPU 環境で全 CPU の平均使用率を得ることができます。 次のように、マルチ CPU 環境で全 CPU の平均使用率を得ることができます。
- 
 <code> <code>
 +
  module_begin  module_begin
  module_name SystemCPU  module_name SystemCPU
行 1087: 行 1524:
 </code> </code>
  
-== module_freememory ==+=== module_freememory ===
  
 Windows および Unix 双方で使えます。システム全体の空きメモリ量を取得します。 Windows および Unix 双方で使えます。システム全体の空きメモリ量を取得します。
行 1101: 行 1538:
 </code> </code>
  
-== module_freepercentmemory ==+=== module_freepercentmemory ===
  
 Windows および Unix 双方で使えます。システム全体の空きメモリ量のパーセンテージを取得します。 Windows および Unix 双方で使えます。システム全体の空きメモリ量のパーセンテージを取得します。
行 1114: 行 1551:
 </code> </code>
  
-== module_tcpcheck ==+=== module_tcpcheck ===
  
-(Windows のみ) +**Windows のみです。**  このモジュールは、指定された IPアドレスおよびポート番号への接続確認を行います。成功すると 1 が返り、失敗すると 0 が返ります。なお、タイムアウトを設定する必要があります。
- +
-このモジュールは、指定された IPアドレスおよびポート番号への接続確認を行います。成功すると 1 が返り、失敗すると 0 が返ります。なお、タイムアウトを設定する必要があります。+
  
 <code> <code>
行 1131: 行 1566:
 </code> </code>
  
-== module_regexp == +=== module_regexp ===
- +
-(Windows のみ)+
  
-このモジュールは、正規表現を使ってファイル(ログ)の内容の比較を行います。モニタリングを開始した時点ですでに存在している行については無視します。モジュールが返す値はモジュールタイプにより異なります。+Windows のみです。このモジュールは、 [[http://www.regular-expressions.info/reference.html|正規表現]]を使ってファイル(ログ)の内容の比較を行います。モニタリングを開始した時点ですでに存在している行については無視します。モジュールが返す値はモジュールタイプにより異なります。
  
   * **generic_data_string**, **async_string**: 正規表現にマッチした行全体を返します。   * **generic_data_string**, **async_string**: 正規表現にマッチした行全体を返します。
行 1142: 行 1575:
   * **module_noseekeof**: 0 がデフォルトです。これを有効にすると、それぞれのモジュールの実行において、ターゲットのファイル更新からは独立して、ファイルの EOF を確認することなくチェック処理が実行されます。これにより、常に検索パターンにマッチするすべての行が XML 出力に展開されます。   * **module_noseekeof**: 0 がデフォルトです。これを有効にすると、それぞれのモジュールの実行において、ターゲットのファイル更新からは独立して、ファイルの EOF を確認することなくチェック処理が実行されます。これにより、常に検索パターンにマッチするすべての行が XML 出力に展開されます。
 <code> <code>
 +
  module_begin  module_begin
  module_name regexp  module_name regexp
行 1152: 行 1586:
 </code> </code>
  
-正規表現の詳細の書式については、こちら   を参照してください。 +=== module_wmiquery ===
- +
-== module_wmiquery == +
- +
-(Windows のみ)+
  
-WMI モジュールは、外部ツールを使わずにローカルで WMI クエリを実行できます。2つのパラメータで設定します。+Windows のみです。WMI モジュールは、外部ツールを使わずにローカルで WMI クエリを実行できます。2つのパラメータで設定します。
  
   * **module_wmiquery**: 利用する WQL クエリを設定します。さまざまなデータを含む複数の行で結果を得ることができます。   * **module_wmiquery**: 利用する WQL クエリを設定します。さまざまなデータを含む複数の行で結果を得ることができます。
行 1186: 行 1616:
 </code> </code>
  
-== module_perfcounter ==+=== module_perfcounter ===
  
-(Win32 のみ) +**Windowsのみです。**  PDH インタフェースを通して、パフォーマンスカウンタ ([[http://msdn.microsoft.com/ja-jp/library/aa373083(v = vs.85).aspx|http://msdn.microsoft.com/ja-jp/library/aa373083(v = vs.85).aspx パフォーマンスカウンタドキュメント]]) からデータを取得します。Windows のライブラリの //pdh.dll//  がインストールされている必要があります。もしインストールされていない場合は、Windows パフォーマンス解析ツールをインストールする必要があります (通常はデフォルトでインストールされています)。
- +
-PDH インタフェースを通して、パフォーマンスカウンタ ([[http://msdn.microsoft.com/ja-jp/library/aa373083(v = vs.85).aspx|http://msdn.microsoft.com/ja-jp/library/aa373083(v = vs.85).aspx パフォーマンスカウンタドキュメント]]) からデータを取得します。Windows のライブラリの //pdh.dll//  がインストールされている必要があります。もしインストールされていない場合は、Windows パフォーマンス解析ツールをインストールする必要があります (通常はデフォルトでインストールされています)。+
 <code> <code>
  
行 1205: 行 1633:
 パフォーマンスツールから、パフォーマンスカウンターを確認できます。 パフォーマンスツールから、パフォーマンスカウンターを確認できます。
  
-{{  :wiki:perfcounter_screen1.png?450  }}+[[:wiki:perfcounter_screen1.png?id=ja:documentation:02_installation:05_configuration_agents&media=wiki:perfcounter_screen1.png|{{  :wiki:perfcounter_screen1.png?nolink&450  }}]]
  
 システムツールを用いて新たなパフォーマンスカウンターを追加することができます。その構成には、要素とサブ要素を含む管理構造があります。ここでは、//Processor, % of processor time//  および //_Total//  です。 システムツールを用いて新たなパフォーマンスカウンターを追加することができます。その構成には、要素とサブ要素を含む管理構造があります。ここでは、//Processor, % of processor time//  および //_Total//  です。
  
-{{  :wiki:perfcounter_screen2.png  }}+[[:wiki:perfcounter_screen2.png?id=ja:documentation:02_installation:05_configuration_agents&media=wiki:perfcounter_screen2.png|{{  :wiki:perfcounter_screen2.png?nolink&  }}]]
  
 このように、OS のツールを使うことにより、システムパフォーマンスのさまざまな要素を取り込むことができます。この場合、モジュールの設定は次のようになります。 このように、OS のツールを使うことにより、システムパフォーマンスのさまざまな要素を取り込むことができます。この場合、モジュールの設定は次のようになります。
- 
 <code> <code>
  module_begin  module_begin
  module_name Processor_Time  module_name Processor_Time
  module_type generic_data_inc  module_type generic_data_inc
- module_perfcounter \Procesador(_Total)\% de tiempo de procesador+ module_perfcounter \Processor(_Total)\% of time processor
  module_end  module_end
 +
  
 </code> </code>
行 1226: 行 1654:
 <code> <code>
  module_begin  module_begin
- module_name Disk_E/S_Seg+ module_name Disk_E/S_Sec
  module_type generic_data  module_type generic_data
  module_cooked 1  module_cooked 1
- module_perfcounter \DiscoFísico(_Total)\E/S divididas por seg.+ module_perfcounter \PhysicalDisk(_Total)\E/S by second
  module_end  module_end
  
行 1236: 行 1664:
 多くのデータは、カウンタ値として返ってきます。そのため、データタイプとしては generic_data_inc を使う必要があります。また、とても大きなスケール (数百万) のデータが返ってくることがありますので、事前処理モジュールで 0.000001 などを設定して値を小さくすると良いです。 多くのデータは、カウンタ値として返ってきます。そのため、データタイプとしては generic_data_inc を使う必要があります。また、とても大きなスケール (数百万) のデータが返ってくることがありますので、事前処理モジュールで 0.000001 などを設定して値を小さくすると良いです。
  
-== module_inventory (廃止) ==+=== module_inventory (廃止) ===
  
 <WRAP center round important 60%> Windows および Linux/UNIX 双方で、現在この機能はエージェントプラグインによるインベントリで置き換えられています。 </WRAP> <WRAP center round important 60%> Windows および Linux/UNIX 双方で、現在この機能はエージェントプラグインによるインベントリで置き換えられています。 </WRAP>
行 1257: 行 1685:
 追加モジュールパラメータ: 追加モジュールパラメータ:
  
-  * **module_interval**: このモジュールは、//日単位で// 情報収集するための間隔を定義する追加設定です。+  * **module_interval**: このモジュールは、//日単位で//  情報収集するための間隔を定義する追加設定です。
 このモジュールの利用例を以下に示します。 このモジュールの利用例を以下に示します。
  
行 1271: 行 1699:
 </code> </code>
  
-== module_logevent == +=== module_logevent ===
- +
-(Win32 のみ)+
  
-指定されたパターンに基づいて Windows イベントログから情報を取得し、ソースおよびイベントタイプに従ってフィルタリングする機能を提供します。+Windows のみです。指定されたパターンに基づいて Windows イベントログから情報を取得し、ソースおよびイベントタイプに従ってフィルタリングする機能を提供します。
  
 このモジュールの一般的な書式は次の通りです。 このモジュールの一般的な書式は次の通りです。
行 1333: 行 1759:
 その他例として、以下にイベントフィルタリングのスナップショットを示します。 その他例として、以下にイベントフィルタリングのスナップショットを示します。
  
-{{  :wiki:event_sample.png?450  }} +[[:wiki:event_sample.png?id=ja:documentation:02_installation:05_configuration_agents&media=wiki:event_sample.png|{{  :wiki:event_sample.png?nolink&450  }}]]
 <code> <code>
 +
  module_begin  module_begin
  module_name MyEvent  module_name MyEvent
行 1349: 行 1775:
 </code> </code>
  
-Pandora FMS は、**ログを収集するシステムではない** ということを理解してください。このツールは、これらのクリティカルまたは重要なイベントを選択し、監視するためのシステムです。すべてのイベントを未分類で収集すると、データベースが飽和状態になりシステムパフォーマンスが著しく低下し、長期的に問題をもたらします。Pandora FMS を一般的なイベント収集ツールとして使うべきではありません。+Pandora FMS は、**ログを収集するシステムではない**  ということを理解してください。このツールは、これらのクリティカルまたは重要なイベントを選択し、監視するためのシステムです。すべてのイベントを未分類で収集すると、データベースが飽和状態になりシステムパフォーマンスが著しく低下し、長期的に問題をもたらします。Pandora FMS を一般的なイベント収集ツールとして使うべきではありません。
  
-== module_logchannel ==+=== module_logchannel ===
  
-(Windows のみ、7.0OUM715以降)+<WRAP center round tip 60%>バージョン NG 715 以上および、Windows のみ</WRAP>
  
 Windows ログチャネルに関する情報を取得するモジュールです。//module_logevent//  は Windows ログにのみアクセスしますが、これは、チャネルとして設定された他のログファイルからデータを展開することができます。これにより、サービスやアプリケーションログを含めたログ取得が可能になります。 Windows ログチャネルに関する情報を取得するモジュールです。//module_logevent//  は Windows ログにのみアクセスしますが、これは、チャネルとして設定された他のログファイルからデータを展開することができます。これにより、サービスやアプリケーションログを含めたログ取得が可能になります。
行 1383: 行 1809:
   * **module_eventcode**: 5112 等のイベント ID 番号です。このフィールドはオプションです。   * **module_eventcode**: 5112 等のイベント ID 番号です。このフィールドはオプションです。
   * **module_application**: イベント発生元のアプリケーションを指定します。イベントが検索される名前やログファイルを示す module_source と混同しないように注意してください。   * **module_application**: イベント発生元のアプリケーションを指定します。イベントが検索される名前やログファイルを示す module_source と混同しないように注意してください。
-例えば、チャネル //Microsoft-Windows-TaskScheduler/Operational//  の //information//  タイプ、コード //201// 、文字列 //code 0//  を含むすべてのイベントを表示するモジュールは次のようになります。+例えば、チャネル //Microsoft-Windows-TaskScheduler/Operational//  の //information//  タイプ、コード //201//  、文字列 //code 0//  を含むすべてのイベントを表示するモジュールは次のようになります。
  
 <code> <code>
行 1401: 行 1827:
 このモジュール設定により、Pandora FMS エージェントは次のようなログを収集します。 このモジュール設定により、Pandora FMS エージェントは次のようなログを収集します。
  
-{{  :wiki:logchannel_example.png?700  }}+[[:wiki:logchannel_example.png?id=ja:documentation:02_installation:05_configuration_agents&media=wiki:logchannel_example.png|{{  :wiki:logchannel_example.png?nolink&700  }}]]
  
 <WRAP center round important 60%> イベントチャネルの名前を取得するには、チャネルを右クリックして、"**プロパティ(properties)**" を選択し、パラメータ "**フルネーム(Full name)**" をコピーします。これは、**module_source**  で必要です。 </WRAP> <WRAP center round important 60%> イベントチャネルの名前を取得するには、チャネルを右クリックして、"**プロパティ(properties)**" を選択し、パラメータ "**フルネーム(Full name)**" をコピーします。これは、**module_source**  で必要です。 </WRAP>
  
-== module_plugin ==+=== module_plugin ===
  
-プラグインから取得したデータを定義するためのパラメータです。これは、特殊なモジュールで、'module_begin' や 'module_type' などの **他の識別子は必要ありません** 。+プラグインから取得したデータを定義するためのパラメータです。これは、特殊なモジュールで、'module_begin' や 'module_type' などの **他の識別子は必要ありません**  。
  
 次のような書式です。 次のような書式です。
- 
 <code> <code>
-module_plugin plugin_filename parameter_1 parameter_2 parameter_3+ 
 +module_plugin plugin_filename parameter_1 parameter_2 (...) parameter_X
  
 </code> </code>
行 1420: 行 1846:
 <code> <code>
  module_begin  module_begin
- module_plugin plugin_filename parameter_1 parameter_2 parameter_3+ module_plugin plugin_filename parameter_1 parameter_2 (...) parameter_X
  module_interval 2  module_interval 2
  module_condition (0, 1) script.sh  module_condition (0, 1) script.sh
行 1434: 行 1860:
 </code> </code>
  
-この例では、プラグインの名前が "grep_log" で、"/var/log/syslog" を正規表現 "ssh" で検索する "Syslog" というモジュールであることを意味します。+この例では、プラグインの名前が ''grep_log'' で、''/var/log/syslog'' を正規表現 ''ssh'' で検索する ''Syslog'' というモジュールであることを意味します。
  
 Windows システムの場合の別の例を示します。(バージョン 3.1 以上) Windows システムの場合の別の例を示します。(バージョン 3.1 以上)
行 1443: 行 1869:
 </code> </code>
  
-== module_ping <ホスト> ==+=== module_ping ===
  
-(バージョン 4.0.1 以降、Windows のみ)+**Windows のみ。** 
 + 
 +<code> 
 +module_ping <ホスト> 
 + 
 +</code>
  
 このモジュールは、指定したホストに ping を行い、応答があれば 1、そうでなければ 0 を返します。 このモジュールは、指定したホストに ping を行い、応答があれば 1、そうでなければ 0 を返します。
行 1467: 行 1898:
 </code> </code>
  
-== module_snmpget ==+=== module_snmpget ===
  
-(Windows のみ)+**Windows のみ。**
  
 このモジュールは snmpget を実行し、その応答を返します。 このモジュールは snmpget を実行し、その応答を返します。
行 1495: 行 1926:
 </code> </code>
  
-==== 自動エージェント設定 ====+=== module_wait_timeout ===
  
-=== 概要 ===+**Windows のみ。**
  
-Pandora FMS バージョン 725 から、エージェントを自動的に設定するための一連のルールを設定できます。+<code> 
 +module_wait_timeout X
  
-エージェントの自動設定処理は次のように動作します。+</code> 
 + 
 +モジュールの module_exec および module_plugin 出力がチェックされる際のタイムアウト時間。デフォルトの値は 500ミリ秒です。大量の出力を生成するモジュールで実行が遅い場合は、5に変更します。それ以外の場合は使用しないことをお勧めします。 
 + 
 +=== module_advanced_options === 
 + 
 +**MS Windows® のみ** 
 + 
 +<code> 
 +module_advanced_options <parameter> 
 + 
 +</code> 
 + 
 +''[[:ja:documentation:02_installation:05_configuration_agents#module_ping|module_ping]]'' および ''[[:ja:documentation:02_installation:05_configuration_agents#module_snmpget|module_snmpget]]'' では追加パラメータを使用します。たとえば、**ping** の場合、512 バイトのパケット サイズを指定できます。 
 + 
 +<code> 
 + 
 +module_advanced_options -l 512 
 + 
 +</code>
  
-**1-**  Pandora FMS コンソールまたは、Pandora FMS メタコンソールで、自動設定の準備をします。+===== 自動エージェント設定 =====
  
-**2-**  Pandora FMS へ接続するエージェントをインストールします。(単一のコンソールの場合はエージェントの接続先は Pandora FMS サーバです。自動プロビジョニングを設定したメタコンソールがある場合は、メタコンソールをサーバとして設定します。)+==== 概要 ====
  
-**3-**  Pandora FMS サーバが、エージェントのデータを含む XML (.data) を初回受信します。+<WRAP center round tip 60%> バージョン NG 725 以降</WRAP>
  
-**4-**  適用される自動設定を決定するためのルールが評価されます。+エージェント設定処理では、エージェントを自動的に設定するための一連のルールを設定できます。 それはこのように動作します：
  
-**5-**  エージェントが新たな設定を受け取り、次回の処理から更新された設定で動作します。+  - Pandora FMS コンソールまたは、Pandora FMS メタコンソールで、自動設定の準備をします。 
 +  - Pandora FMS へ接続するエージェントをインストールします。(単一のコンソールの場合はエージェントの接続先は Pandora FMS サーバです。自動プロビジョニングを設定したメタコンソールがある場合は、メタコンソールをサーバとして設定します。) 
 +  - Pandora FMS サーバが、エージェントのデータを含む XML (.data) を初回受信します。 
 +  - 適用される自動設定を決定するためのルールが評価されます。 
 +  - エージェントが新たな設定を受け取り、次回の処理から更新された設定で動作します。
  
-=== 自動エージェント設定の作成 ===+==== 自動エージェント設定の作成/編集 ====
  
-自動設定画面へは次のようにアクセスできます。+**コンソール**
  
-**コンソール**  管理(Management) > 自動エージェント設定管理(Manage automatic agent configuration)+自動設定画面へは **設定(Configuration)** → **自動エージェント設定管理(Manage automatic agent configuration)** からアクセスします。
  
 {{  :wiki:autoconf_menu_console.png  }} {{  :wiki:autoconf_menu_console.png  }}
  
-**メタコンソール**  拡張 > エージェント管理 > 自動エージェント設定+**メタコンソール** 
 + 
 +**中央管理(Centralized management)** → **エージェント管理(Agent management)** → エージェント自動設定アイコン:
  
 {{  :wiki:autoconf1.png  }} {{  :wiki:autoconf1.png  }}
  
-管理ページにアクセスしたら、"自動設定の作成(Create automatic configuration)" ボタンをクリックすることにより新たな自動設定を作成することができます。+管理ページにアクセスしたら、**新たな設定定義の追加(Add new configuration definition)** ボタンをクリックすることにより新たな自動設定を作成することができます。自動設定の名前と説明を設定します。 
 + 
 +{{  :wiki:autoconf_new.png  }} 
 + 
 +<WRAP center round info 90%> 
 + 
 +**バージョン 764 以降**:
  
-自動設定の名前と説明を設定します。+Pandora FMS サーバのタイムゾーンに応じて、自動設定タスクを定期的に実行できます。
  
-{{  :wiki:autoconf_new.png}}+\\ 
 +{{  :wiki:autoconf_new_2.png  }}</WRAP>
  
 新たな自動設定を作成したら、必要な項目をクリックすることにより設定フォームを表示できます。 新たな自動設定を作成したら、必要な項目をクリックすることにより設定フォームを表示できます。
行 1535: 行 1999:
 {{  :wiki:autoconf_options.png  }} {{  :wiki:autoconf_options.png  }}
  
-== ルール ==+=== ルール ===
  
 自動設定を適用するエージェントを定義するには、ルールを追加します。 自動設定を適用するエージェントを定義するには、ルールを追加します。
行 1543: 行 2007:
 設定対象のエージェントを特定するために、ルールのオプションを選択できます。 設定対象のエージェントを特定するために、ルールのオプションを選択できます。
  
-{{  :wiki:autoconf_rules1.png?750  }}+{{  :wiki:autoconf_rules1.png  }}
  
 **Server name** **Server name**
行 1563: 行 2027:
 **IP range** **IP range**
  
-IP の範囲(ネットワーク)にマッチ。IP/ネットマスク の書式を追加います。例: 192.168.1.0/24+IP の範囲(ネットワーク)にマッチ。IP/ネットマスク の書式を追加います。例: 
 + 
 +<code> 
 +192.168.1.0/24 
 +</code>
  
 **Script output (> 0)** **Script output (> 0)**
行 1569: 行 2037:
 スクリプトの実行結果で、標準出力の結果が 0より大きい場合にルールにマッチしたと評価されます。 スクリプトの実行結果で、標準出力の結果が 0より大きい場合にルールにマッチしたと評価されます。
  
-ルールスクリプトでは、'arguments' フィールドに次のマクロが使えます。+**Call to the rule script**
  
-**_agent_ **+ルールスクリプトでは、'arguments' フィールドに次のマクロが使えます。(演算子 ''AND''  と ''OR''  のどちらかを選択して、ルールロジックを変更できます)
  
-エージェント名に置き換えられます。+  * **_agent_ :**  エージェント名に置き換えられます。 
 +  * **_agentalias_ : **  エージェントの別名に置き換えられます。 
 +  * **_address_ :**  エージェントから報告された IP アドレスに置き換えられます。 
 +  * **_agentgroup_ :**  エージェントから報告されたグループ名に置き換えられます。 
 +  * **_agentos_ :**  エージェントの OS で置き換えられます。 
 +{{  :wiki:autoconf_rules2.png?400  }}
  
-**_agentalias_ **+<WRAP center round tip 60%>ルールが無い場合は、自動設定は適用されません。全てのエージェントに対して一つの設定でよい場合は、すべての別名にマッチする正規表現 ''.*''  を使うことができます。</WRAP>
  
-エージェントの別名に置き換えられます。 +=== 設定 ===
- +
-**_address_** +
- +
-エージェントから報告された IP アドレスに置き換えられます。 +
- +
-**_agentgroup_ ** +
- +
-エージェントから報告されたグループ名に置き換えられます。 +
- +
-**_agentos_** +
- +
-エージェントの OS で置き換えられます。 +
- +
-ルールの適用条件で <i>AND</i> および <i>OR</i> を選択できます。 +
- +
-{{  :wiki:autoconf_rules2.png?750  }} +
- +
-**注意:**  ルールが無い場合は、自動設定は適用されません。 +
- +
-全てのエージェントに対して一つの設定でよい場合は、すべての<i>別名</i>にマッチする次の正規表現を使うことができます。 +
- +
-<code> +
-.* +
- +
-</code> +
- +
-== 設定 ==+
  
 ここから設定に進みます。 ここから設定に進みます。
行 1624: 行 2070:
 エージェントの設定ファイルに追加する設定内容です。 エージェントの設定ファイルに追加する設定内容です。
  
-{{  :wiki:autoconf_config.png  }}+[[:wiki:autoconf_config.png?id=ja:documentation:02_installation:05_configuration_agents&media=wiki:autoconf_config.png|{{  :wiki:autoconf_config.png?nolink&  }}]]
  
 **注意:**  集中管理が有効なメタコンソールに属するノードから自動設定管理を行おうとすると、リードオンリー表示になります。 **注意:**  集中管理が有効なメタコンソールに属するノードから自動設定管理を行おうとすると、リードオンリー表示になります。
  
-{{  :wiki:autoconf_ro.png  }}+[[:wiki:autoconf_ro.png?id=ja:documentation:02_installation:05_configuration_agents&media=wiki:autoconf_ro.png|{{  :wiki:autoconf_ro.png?nolink&  }}]]
  
-== 追加アクション ==+=== 追加アクション ===
  
 ここでは、自動設定に追加のアクションを行うことができます。例えば以下のような処理です。 ここでは、自動設定に追加のアクションを行うことができます。例えば以下のような処理です。
  
-  - 独自イベントを出す +  - **独自イベントを出す** 
-  - アラートアクションを実行する +  - **アラートアクションを実行する** 
-  - スクリプトを実行する+  - **スクリプトを実行する**
  
-{{  :wiki:autoconf_actions.png  }}+{{  :wiki:autoconf_actions.png?400  }}
  
 システムは、次のマクロをサポートします。 システムは、次のマクロをサポートします。
行 1666: 行 2112:
 エージェント ID に置き換えられます。 エージェント ID に置き換えられます。
  
-==== Unix/Linux エージェント ====+===== Unix/Linux エージェント =====
  
-UNIX には、簡単にデータを収集できるいくつかのコマンドラインツールがあります。UNIX エージェントはこれをベースにしており、次の 2つの種類があります。 +==== Pandora FMS Unix エージェントの設定 ====
- +
-  * ShellScript:さまざまな OS にある、bash、ksh、csh などのシェルスクリプトを用いたエージェントです。Linux や MAC 向けにはすべての機能が実装されていますが、伝統的な UNIX システム (Solaris、AIX、HPUX) 向けには、すべての機能は実装されていません。 +
- +
-  * Perl:全ての UNIX システムで動作する、Perl 5.8 をベースにしたマルチプラットフォームエージェントです。Perl 5.8 以上が必要です。 +
- +
-シェルスクリプトエージェントは、古い UNIX (HPUX11.0、AIX 4.1、Solaris 2.6 など) でも動くように作られています。ただし、機能は制限されており、Tentacle クライアントがありません。サーバにモニタデータをアップロードするには、FTP もしくは SSH を利用する必要があります。 +
- +
-=== Pandora FMS Unix エージェントの設定 ===+
  
 把握しておくべき基本的なファイルとディレクトリは次のとおりです。 把握しておくべき基本的なファイルとディレクトリは次のとおりです。
  
-  * ///usr/share/pandora_agent// /: Pandora FMS エージェントがインストールされる場所です。厳密なシステムポリシーがあり、ここにインストールできないシステムでは、実際のインストールパスからこのパスへのリンクを作成することを推奨します。例: '/opt/pandora' → '/usr/share/pandora_agent'+  * ///usr/share/pandora_agent//  /: Pandora FMS エージェントがインストールされる場所です。厳密なシステムポリシーがあり、ここにインストールできないシステムでは、実際のインストールパスからこのパスへのリンクを作成することを推奨します。例: '/opt/pandora' → '/usr/share/pandora_agent'
   * ///etc/pandora/pandora_agent.conf//: エージェントのメインの設定ファイルです。ここにデータの収集に使うコマンドの定義がされています。   * ///etc/pandora/pandora_agent.conf//: エージェントのメインの設定ファイルです。ここにデータの収集に使うコマンドの定義がされています。
   * ///usr/local/bin/pandora_agent//: Pandora FMS エージェント本体です。これは、pandora_agent.conf で設定されたデータ収集を行うシェルスクリプトです。これはまた、Pandora サーバにデータパケットを送信します。通常、/usr/bin/pandora_agent にリンクされています。   * ///usr/local/bin/pandora_agent//: Pandora FMS エージェント本体です。これは、pandora_agent.conf で設定されたデータ収集を行うシェルスクリプトです。これはまた、Pandora サーバにデータパケットを送信します。通常、/usr/bin/pandora_agent にリンクされています。
行 1689: 行 2127:
 *///etc/pandora/collections//: エージェントのコレクションを置くディレクトリです。これは ///usr/share/pandora_agent/collections//  にリンクされています。 *///etc/pandora/collections//: エージェントのコレクションを置くディレクトリです。これは ///usr/share/pandora_agent/collections//  にリンクされています。
  
-=== Unix エージェントの実行 ===+==== Unix エージェントの実行 ====
  
 エージェントの起動は以下のようにします。 エージェントの起動は以下のようにします。
 +<code>
  
-<code> 
 /etc/init.d/pandora_agent_daemon start /etc/init.d/pandora_agent_daemon start
  
行 1707: 行 2145:
 起動スクリプトで Pandora FMS エージェントの起動・停止ができます。デフォルトでは起動後はデーモーンとして動作します。 起動スクリプトで Pandora FMS エージェントの起動・停止ができます。デフォルトでは起動後はデーモーンとして動作します。
  
-=== Unix エージェントでシステム情報を取得する別の方法 ===+==== Unix エージェントでシステム情報を取得する別の方法 ====
  
-設定の章で示した通り、module_exec で特定のコマンドを実行することなく定義済の情報を取得できるモジュールがあります。以下がそれらです。+設定の章で示した通り、''module_exec'' で特定のコマンドを実行することなく[[:ja:documentation:02_installation:05_configuration_agents#情報を取得するためのディレクティブ|定義済の情報]]を取得できるモジュールがあります。以下がそれらです。
  
   * module_procmem   * module_procmem
行 1721: 行 2159:
   * module_freepercentmemory   * module_freepercentmemory
  
-これらのモジュールの動作は、エージェントの実行ファイル (デフォルトでは ///usr/bin/pandora_agent//) を直接編集することにより変更できます。Pandora FMS エージェントは一般的に ///usr/bin/pandora_agent//  にあります。コマンド名で検索することにより、内部コマンドを含むコードを見つけます。システムに合わせて変更する場合は、修正を行います。+これらのモジュールの動作は、エージェントの実行ファイル (デフォルトでは ''/usr/bin/pandora_agent'') を直接編集することにより変更できます。Pandora FMS エージェントは一般的に ''/usr/bin/pandora_agent''  にあります。
  
-<code> +コマンド名で検索することにより、内部コマンドを含むコードを見つけます。システムに合わせて変更する場合は、修正を行います。
- # Commands to retrieve total memory information in kB +
- use constant TOTALMEMORY_CMDS => { +
-     linux => 'cat /proc/meminfo  | grep MemTotal: | awk \'{ print $2 }\//, +
-     solaris => 'MEM =`prtconf | grep Memory | awk \'{print $3}\'` bash -c \'echo $(( 1024 * $MEM ))\//, +
-     hpux => 'swapinfo -t | grep memory | awk \'{print $2}\// +
- };+
  
-</code> 
 <code> <code>
  
- # Commands to retrieve partition information in kB +# Commands to retrieve total memory information in kB 
- use constant PART_CMDS => { +use constant TOTALMEMORY_CMDS => { 
-     # total, available, mount point +   linux => 'cat /proc/meminfo | grep MemTotal: | awk \'{ print $2 }\, 
-     linux => 'df -P | awk \'NR> 1 {print $2, $4, $6}\//, +   solaris => 'MEM=`prtconf | grep Memory | awk \'{print $3}\'` bash -c \'echo $(( 1024 * $MEM ))\, 
-     solaris => 'df -k | awk \'NR> 1 {print $2, $4, $6}\//, +   hpux => 'swapinfo -t | grep memory | awk \'{print $2}\ 
-     hpux => 'df -P | awk \'NR> 1 {print $2, $4, $6}\//, +}; 
-     aix => 'df -kP | awk \'NR> 1 {print $2, $4, $6}\// + 
- };+# Commands to retrieve partition information in kB 
 +use constant PART_CMDS => { 
 +    # total, available, mount point 
 +    linux => 'df -P | awk \'NR> 1 {print $2, $4, $6}\, 
 +    solaris => 'df -k | awk \'NR> 1 {print $2, $4, $6}\, 
 +    hpux => 'df -P | awk \'NR> 1 {print $2, $4, $6}\, 
 +    aix => 'df -kP | awk \'NR> 1 {print $2, $4, $6}\ 
 +};
  
 </code> </code>
行 1747: 行 2185:
 情報取得のための定義済の値を変更するには、コマンドを編集するだけですが、以下に注意します。 情報取得のための定義済の値を変更するには、コマンドを編集するだけですが、以下に注意します。
  
-  - 行の終わりに ";" があることを確認 +  - ブロックの終わりに ''{ };'' のようにセミコロンがあるがことを確認 
-  - コマンドが ' ' でくくられているか確認 +  - コマンドが '' ' ' '' でくくられているか確認 
-  - ' を使う場合は、次のように  でエスケープしているか確認+  - シングルクォーテーションを使う場合は、''` `'' のような追加の引用符が必要になる場合があります(前の例を参照)。 
 +  - コマンドで使用するシングルクォーテーションの前に ''\'' が付いていることを確認してください。これは ''\''' を意味します。 たとえば、このコマンドは通常次のようになります。
 <code> <code>
  
行 1763: 行 2202:
 </code> </code>
  
-==== Pandora FMS Windows エージェント ====+===== Pandora FMS Windows エージェント ===== 
 + 
 +==== Pandora FMS Windows エージェントの設定 ==== 
 + 
 +Windows エージェントの基本的なパスやディレクトリは、エージェントをインストールした場所になります。デフォルトでは ''%ProgramFiles%'' です。 
 + 
 +{{  :wiki:programfiles-pandora_agent.png?500  }} 
 + 
 +理解しておきたい基本的なファイルは次の通りです。 
 + 
 +**''%ProgramFiles%\pandora_agent''  ** 
 + 
 +Pandora FMS エージェントの実行ファイルやディレクトリがあるインストール先です。 
 + 
 +**''%ProgramFiles%\pandora_agent\pandora_agent.conf''  ** 
 + 
 +エージェントの設定ファイルです。実行モジュールおよびエージェントプラグインの設定はここにあります。 
 + 
 +**''%ProgramFiles%\pandora_agent\PandoraAgent.exe''  ** 
 + 
 +エージェントの実行バイナリです。 
 + 
 +**''%ProgramFiles%\pandora_agent\util\tentacle_client.exe''  ** 
 + 
 +サーバへファイルを転送するための Tentacle 実行バイナリです。 
 + 
 +**''%ProgramFiles%\pandora_agent\scripts''  ** 
 + 
 +Pandora FMS エージェントの起動・停止・再起動スクリプトです。 
 + 
 +**''%ProgramFiles%\pandora_agent\pandora_agent.log''  ** 
 + 
 +Pandora FMS エージェントがデバッグモードで実行されたときに出力されるログファイルです。 
 + 
 +**''%ProgramFiles%\pandora_agent\util''  ** 
 + 
 +エージェントプラグインを含むディレクトリです。 
 + 
 +**''%ProgramFiles%\pandora_agent\collections''  ** 
 + 
 +エージェントのコレクションを含むディレクトリです。
  
-=== Pandora FMS Windows エージェントの設定 ===+===== ソフトウエアエージェントの自動デプロイ =====
  
-Windows エージェントの基本的なパスやディレクトリは、エージェントをインストールした場所になります。デフォルトでは //C:\Program files//  です。理解しておきたい基本的なファイルは次の通りです。+自動検出システムを通したデプロイの仕組みを使ってソフトウエアエージェントをデプロイすることができます。より詳細は、 [[:ja:documentation:03_monitoring:04_discovery#自動エージェントデプロイ|こちら]]を参照してください。
  
-  * //C:\Program Files\pandora_agent//: Pandora FMS エージェントの実行ファイルやディレクトリがあるインストール先です。 +===== ソフトウエアエージェントの自動アップグレード =====
-  * //C:\Program Files\pandora_agent\pandora_agent.conf//: エージェントの設定ファイルです。実行モジュールおよびエージェントプラグインの設定はここにあります。 +
-  * //C:\Program Files\pandora_agent\PandoraAgent.exe//: エージェントの実行バイナリです。 +
-  * //C:\Program Files\pandora_agent\util\tentacle_client.exe//: サーバへファイルを転送するための Tentacle 実行バイナリです。 +
-  * //C:\Program Files\pandora_agent\scripts//: Pandora FMS エージェントの起動・停止・再起動スクリプトです。 +
-  * //C:\Program Files\pandora_agent\pandora_agent.log//: Pandora FMS エージェントがデバッグモードで実行されたときに出力されるログファイルです。 +
-  * //C:\Program Files\pandora_agent\util//: エージェントプラグインを含むディレクトリです。 +
-  * //C:\Program Files\pandora_agent\collections//: エージェントのコレクションを含むディレクトリです。 +
-==== ソフトウエアエージェントの自動アップグレード ====+
  
 ファイルコレクションと pandora_update ツールを使って、ソフトウエアエージェントは自分自身の更新ができます。 ファイルコレクションと pandora_update ツールを使って、ソフトウエアエージェントは自分自身の更新ができます。
行 1850: 行 2321:
 </code> </code>
  
-==== XML ファイルからのエージェント・モジュールの自動作成 / 学習モード ====+===== XML ファイルからのエージェント・モジュールの自動作成 / 学習モード =====
  
 エージェントは、コンソールから 3つの動作モードを設定できます。 エージェントは、コンソールから 3つの動作モードを設定できます。
行 1857: 行 2328:
   * **通常モード(Normal mode)**: コンソールに存在しない新たなモジュールを XML で受け取っても作成しません。   * **通常モード(Normal mode)**: コンソールに存在しない新たなモジュールを XML で受け取っても作成しません。
   * **自動無効化モード(Autodisable mode)**: 学習モードに似ていますが、すべてのモジュールが不明状態になった場合にエージェントを自動的に無効化します。新たな情報を受け取ったときに改めて自動化します。   * **自動無効化モード(Autodisable mode)**: 学習モードに似ていますが、すべてのモジュールが不明状態になった場合にエージェントを自動的に無効化します。新たな情報を受け取ったときに改めて自動化します。
-{{  :wiki:learning_mode.png  }}+[[:wiki:learning_mode.png?id=ja:documentation:02_installation:05_configuration_agents&media=wiki:learning_mode.png|{{  :wiki:learning_mode.png?nolink&  }}]]
  
-=== エージェント作成時に XML からロードされるデータ ===+==== エージェント作成時に XML からロードされるデータ ====
  
 XML を受け取ったときにエージェントの作成とともに自動的に取り込まれるデータは次の通りです。 XML を受け取ったときにエージェントの作成とともに自動的に取り込まれるデータは次の通りです。
行 1877: 行 2348:
   * エージェントモード: 学習、通常、自動無効化   * エージェントモード: 学習、通常、自動無効化
  
-=== XML を受け取ったときに修正されるデータ (学習モード有効時) ===+==== XML を受け取ったときに修正されるデータ (学習モード有効時) ====
  
   * エージェントの IP アドレス   * エージェントの IP アドレス
行 1890: 行 2361:
 加えて、学習モードが有効の場合、XML ファイルで受け取った新たなモジュールは、Pandora で作成されます。 加えて、学習モードが有効の場合、XML ファイルで受け取った新たなモジュールは、Pandora で作成されます。
  
-=== 作成時にモジュールに追加されるデータ ===+==== 作成時にモジュールに追加されるデータ ====
  
 初回の各モジュールの XML 受信時に反映されるデータは次の通りです。 初回の各モジュールの XML 受信時に反映されるデータは次の通りです。
行 1918: 行 2389:
   * Crontab   * Crontab
  
-=== モジュールがすでに存在する場合に反映されるデータ ===+==== モジュールがすでに存在する場合に反映されるデータ ====
  
 すでに存在するモージュールのデータを XML で受け取った場合は、モジュールのデータに加えて説明および拡張情報のみ更新されます。 すでに存在するモージュールのデータを XML で受け取った場合は、モジュールのデータに加えて説明および拡張情報のみ更新されます。
  
 +[[:ja:documentation:start|Pandora FMS ドキュメント一覧に戻る]]
  
ºº