個人用ツール

Pandora:Documentation ja:Configuration Agents

提供: Pandora FMS Wiki JP

移動先: 案内, 検索

Pandora FMS ドキュメント一覧に戻る

目次

Pandora FMS ソフトウエアエージェント

ソフトウエアエージェントとは?

As its name indicates, they are small pieces of software that are installed in the operating systems and remain running in them to extract monitoring information and send it to the Pandora FMS server regularly.

その名前が示すとおり、OS にインストールされ、監視情報を抽出して Pandora FMS サーバへ定期的に送信するための小さなソフトウエアです。

They use the commands and tools of the operating system in which they are installed to obtain the information. They conform the data in a file in XML format and send them to the Pandora FMS data server, which processes and stores them in the database.

インストールしたシステムの情報を取得するために、OS のコマンドやツールを利用します。XML フォーマットのファイルにデータをまとめ、それを処理しデータベースへ蓄える Pandora FMS データサーバへ送信します。

Each of the individual checks is called Module.

それぞれの監視項目は、モジュール と呼びます。

エージェント設定概要

The operation of the software agent is determined by its configuration file, called pandora_agent.conf, located in the installation directory on Windows systems, and /etc on Linux systems.

ソフトウエアエージェントの動作は、pandora_agent.conf という設定ファイルによって決まります。Windows であればインストール先ディレクトリ、Linux であれば /etc 以下にあります。

The configuration file contains all the operating parameters and modules of that agent.

設定ファイルには、そのエージェントの動作パラメータおよびモジュールが含まれます。

エージェントの一般的なパラメータ

The Configuration of the General Agent Parameters is defined in this section. Some of them are common for all systems and others are intended specifically for Windows or Unix machines. The general parameters are:

この章では、エージェントの一般的なパラメータ設定について説明します。Windows および UNIX 共通のものや、それぞれ専用のものがあります。以下に一般的なパラメータ詳細について記載します。

Template warning.png

The first time the server receives data from an agent is going to save all of the information into the database. For the following received data it will only update (depending on learning mode status enabled/disabled) the following fields from XML file: version, date, OS version, and the following parameters from the configuration file: gis_exec, latitude, longitude, altitude parent_agent_name, timezone_offset, address and custom_field.


Template warning.png

エージェントから最初にサーバがデータを受け取った時は全ての情報がデータベースに保存されます。以降に受信したデータは(学習モードの有効・無効により)、XML ファイルにおける version, date, OS version および、設定ファイルの gis_exec, latitude, longitude, altitude parent_agent_name, timezone_offset, address, custom_field フィールドのみ更新されます。


Template warning.png

The agent configuration file encoding is UTF-8 on both Linux and Windows systems. If you make manual edits of this file, verify that the encoding is correct before overwriting it. If the encoding is not UTF-8 and you use symbols (such as stress marks or extended symbols), the agent will misinterpret these symbols, not being able to guarantee a correct interpretation of its configuration.


Template warning.png

Linux および Windows システム共に、エージェント設定ファイルの文字コードは、UTF-8です。 ファイルを編集するときは、上書きする前に文字コードを確認してください。文字コードが UTF-8 ではなく、かつ記号(マークや拡張記号など)を使う場合は、エージェントが記号を誤認識する可能性があり、設定を正しく解釈するか保証できません。


server_ip

The IP address or the name of the Pandora FMS Server Host where all data will be stored.

データを保持する Pandora FMS サーバのホスト名もしくは IP アドレスを設定します。

server_path

The server path is the comprehensive file path where the server stores all the data sent by the agents. The default path is /var/spool/pandora/data_in.

エージェントから送られるデータを受け取るサーバのディレクトリパスを設定します。通常は、/var/spool/pandora/data_in です。

temporal

The path where the agent stores the data files before they are sent to the server and deleted locally.

エージェントがサーバにデータを送信する前にローカルで利用するフォルダのパスを設定します。

description

Send the description of the agent in the XML and Pandora FMS imports this description when it creates the agent.

XML でエージェントが送る「説明」を設定します。Pandora FMS はエージェントを作成する時に、この「説明」を取り込みます。

group

If there is a group with the name specified in this parameter, the agent will be created within this group unless the server forces the creation of all agents in a given group.

エージェントが所属するグループ名を設定します。このパラメータで指定された名前のグループがある場合、サーバが特定のグループにエージェントを作成するようにしていなければ、指定したグループ内にエージェントが作成されます。

temporal_min_size

If the free space (in MB) of the partition in which the temporary directory is located is lower than this value, it won't continue generating data packets. This prevents the disk from being full if for any reason connection to the server is lost for an extended period of time.

テンポラリディレクトリのパーティション空き容量がここで指定したサイズ (MB 単位) より小さくなったら、データパケットの生成を停止します。何らかの理由でサーバへの接続が長時間切れた場合に、ディスクがいっぱいになるのを避けます。

logfile

The path to the Pandora FMS agent events record file.

Pandora FMS エージェントのログファイルのパスです。

interval

It is the agent sampling time, in seconds. Each time this interval is completed, the agent will collect information and send it to the Pandora FMS server.

エージェントの秒単位のデータ収集間隔です。この間隔でエージェントは情報を収集し、Pandora FMS サーバへ送ります。

disable_logfile

This parameter disables log writing in pandora_agent.log. Only for Windows.

このパラメータは、pandora_agent.log へのログ出力を無効化します。Windows のみ。

debug

If it is active (1), the agent data files are stored and renamed in the temporary directory and are not deleted after being sent to the server, being able to open XML files and analyze their content.

有効化(1)すると、エージェントのデータファイルはテンポラリディレクトリ内に名前を変えて保存され、サーバへ送信したあとも削除されません。XML ファイルを開いて内容を確認することができます。

agent_name

It allows setting a custom name. If it is not enabled, the agent name will be the hostname of the machine.

カスタム名を設定できます。設定していない場合、エージェント名はマシンのホスト名になります。

(>=5.1SP2) agent_name_cmd

Defines the agent name using an external command. If agent_name_cmd is set, agent_name is ignored. The command must return the agent name by STDOUT. If you return more than one line, only the first line will be used.

外部コマンドを使ってエージェント名を定義したい場合に設定します。これはオプションです。このパラメータを設定した場合、'agent_name' は無視されます。外部コマンドはエージェント名を標準出力に返す必要があります。複数行を返した場合、1行目がエージェント名として扱われます。

(>=7.0) agent_alias_cmd

Defines the agent alias using an external command. If agent_alias_cmd is defined, agent_alias is ignored. The command must return the agent name by STDOUT. If you return more than one line, only the first line will be used.

外部コマンドを使ってエージェントの別名を定義したい場合に設定します。このパラメータを設定した場合、'agent_alias' は無視されます。外部コマンドはエージェントの別名を標準出力に返す必要があります。複数行を返した場合、1行目がエージェントの別名として扱われます。

address

This is the IP addres of the software agent. Could be an IP addres with the format X.X.X.X, a domain name as 'localhost', or 'auto'. If is an IP addres or a domain name, this will be added to the addresses of the agent and will be established as main address. If is 'auto', it will obtain the IP addres from the host and will be added to the agent as the previous case.

これは、ソフトウエアエージェントの IP アドレスです。X.X.X.X というフォーマットの IP アドレス、'localhost' のようなホスト名、または 'auto' を設定できます。IP アドレスまたはホスト名を指定した場合は、そのアドレスがエージェントに追加され、メインのアドレスとなります。'auto' を指定した場合は、ホストから IP アドレスを取得してエージェントに追加されます。

encoding

Installs the kind of codification of the local system, such as ISO-8859-15 or UTF-8.

ISO-8859-15 や UTF-8 のように、システムのエンコーディングの種類を設定します。

server_port

This parameter allows to identify the remote port of the server that is waiting. By default it's 41121 for Tentacle.

このパラメータは、リモートのサーバの待ち受けポートの設定です。Tentacle のデフォルトは 41121 です。

transfer_mode

This parameter specifies the transfer mode we have to install in order send the agent data to the server. Tentacle by default.

このパラメータには、エージェントからサーバへデータを送信するための方法を設定します。デフォルトは Tentacle です。

(>= 6.0) transfer_timeout

It is the timeout for file transfer, if the indicated number of seconds is exceeded without completing the transfer, it will be cancelled.

データ転送プログラムの実行タイムアウトを秒単位で指定します。設定されていない場合のデフォルトは 30 です。

server_pwd

Specific for the password of Windows FTP and for the Tentacle transference mode, although the password for the latter is optional. Server password for authentication with password.

Windows の FTP もしくは Tentacle 転送モードのパスワードを設定します。Tentacle モードの場合はパスワードは必須ではありません。このパスワードでサーバでの認証を行います。

server_ssl

Specific for the Tentacle transfer mode. Allows to authorize ('1') or deny ('0) the SSL network encryption.

Tentacle の転送モードを設定します。SSL を利用する場合は 1、そうでなければ 0 を設定します。

server_opts

Specific for the Tentacle transfer mode. Allows to give additional parameters to the Tentacle client for advanced configurations with security options.

Tentacle の転送モードを設定します。Tentacle クライアントの拡張設定のために渡す、追加パラメータを設定します。

Coming with the 3.2 agent version, Tentacle supports the optional use of a HTTP proxy (using CONNECT) mode to send information to the server. In order to be able to use the output through a proxy, we use the following advanced option (example):

バージョン 3.2 以降のエージェントでは、tentacle がサーバへデータを送信するのに HTTP プロキシをサポートしています。プロキシを利用するには、つぎのような拡張オプションを使います。

server_opts "-y user:pass@proxy.inet:8080"

This will force the Tentacle client to use 'proxy.inet' on port 8080 using "user" and "pass" for authentication. If you intend to use a proxy on e.g. 192.168.1.2 on port 9000 without credentials, the command would have to be:

この例では、tentacle クライアントがポート 8080、ユーザ "user"、パスワード "pass" でプロキシ 'proxy.inet' に接続します。プロキシサーバが 192.168.1.2 で、ポート番号が 9000、また、認証が無い場合は次のようにします。

server_opts "-y 192.168.1.2:9000"

delayed_startup

This parameter allows the Pandora FMS agent to be configured in order to start working after any specific amount of time (in seconds) after manual execution. It's deactivated by default. This option is only valid on Linux/Unix agents.

このパラメータに設定した時間 (秒単位)、Pandora FMS エージェントの起動を遅らせます。デフォルトでは無効になっています。このオプションは、Linux/UNIX エージェントでのみ有効です。

pandora_nice

This parameter allows to specify the priority that the Pandora FMS agent process will have within the system. It's only available for Unix / Linux agents.

このパラメータには、Pandora FMS エージェントプロセスの優先順位を設定します。この設定は、Unix/Linux エージェントにのみ存在します。

autotime

If it's enabled ('1') it sends a timestamp of special execution (AUTO) that makes the server use its local date / time to establish the data time, not paying attention to the time sent by the agent. This is necessary in agents which have a wrong time or a different hour from the server for any reason.

これを有効に設定 (1 に設定) すると、エージェントが送信する時間データを無視し、サーバに接続した時間をサーバのローカル時間で認識するようになります。この設定は、何らかの理由によりエージェントの時刻がおかしかったり、サーバの時刻と大きくずれている場合に利用します。

cron_mode

With this parameter, it's possible to make the agents using the Linux crontab functions to execute itself in a predetermined interval instead of using the agents internal system to execute itself at a certain time. It's deactivated by default.

このパラメータを有効にすると、エージェントをそれ自身の実行の仕組みではなく、Linux の crontab から指定した時刻に実行できるようになります。デフォルトでは無効になっています。

remote_config

(Pandora FMS Enterprise only)

(Pandora FMS Enterprise のみ)

Enables (1) or disables (0) remote agent configuration. Operation is only allowed with Tentacle transfer mode.

リモートエージェント設定を有効化(1)または無効化(0)します。Tentacle 転送モードでのみ利用できます。

xml_buffer

If enabled (1), the agent will save in its temporary directory the XML files that it could not send to the server in case of a connectivity problem. They will be sent when communications are restored.

有効化(1)すると、エージェントは接続障害等でサーバに XML ファイルを送信できなかったとき、それをテンポラリディレクトリに保存します。それらは、通信が復旧したときに送られます。

timezone_offset

The agent can now install its timezone offset with the server. This allows the server to make a scrolling of the time collected by the agent, so that it matches the local time of the server.

エージェントではサーバのタイムゾーンとのオフセットを設定できます。これは、エージェントが異なるタイムゾーンのサーバで稼働しているとき、同じ時間に合わせる場合にとても便利です。エージェントは、調整したタイムゾーンでサーバに送信します。

# Timezone offset: Difference with the server timezone
timezone_offset 3

It is calculated by subtracting the agent's timezone from the server's timezone. For example, if the server's timezone is UTC+1 and the agent's timezone is UTC-5, the timezone offset should be 6 = 1 - (-5).

サーバのタイムゾーンからエージェントのタイムゾーンを差し引いて計算されます。例えば、サーバのタイムゾーンが UTC+1 で、エージェントのタイムゾーンが UTC-5 であれば、タイムゾーンのオフセットは、6 = 1 - (-5) です。

agent_parent_name

Indicates the parent of the software agent. It must be the name of an existing agent in Pandora FMS.

ソフトウエアエージェントの親を指定します。Pandora FMS に存在するエージェント名である必要があります。

agent_threads <スレッド数>

Number of threads the agent is going to launch to execute modules simultaneously.By default, the modules are executed one after the other without launching any additional thread. This is only available in Linux/Unix agents.

モジュールを並行して実行するエージェントのスレッド数です。デフォルトではシングルスレッドで、すべての処理完了まで 1つずつモジュールを実行します。これは、UNIX エージェントのみの機能です。

# Number of threads to execute modules in parallel
agent_threads 4

include <ファイル名>

This file can contain additional modules and collections alongside the ones found in the main configuration file. This token is optional. El fichero lo podrán subir aquellos usuarios que tengan permisos de, al menos, escritura sobre agentes(AW).

別の設定ファイルパスです。このファイルには、メインの設定ファイルに加えて追加のモジュールや収集を含めることができます。これはオプションです。ファイルのアップロードには、ユーザに少なくともエージェントの(AW)権限が必要です。

broker_agent <名前>

Enables broker agent functionality. To activate it, you only need to uncomment the parameter and indicate the name that will be assigned to the broker agent:

ブローカーエージェント機能を有効化します。有効化するにはパラメータのコメントを外し、ブローカーエージェントに割り当てる名前を指定する必要があるだけです。メインの設定ファイルに記載したブローカーエージェントの名前で新たな設定ファイルが生成されます。この設定はメインのエージェントでのみ利用でき、作成された新たなエージェント設定内では利用できません。

broker_agent Name_broker

pandora_user <ユーザ>

This parameter is optional and allows the agent to be executed with a specified system user. This user has to have permissions to execute the agent and all associated resources.

このパラメータはオプションで、システムの特定のユーザでエージェントを実行させるためのものです。指定するユーザは、エージェントの実行権限等を持つ必要があります。

(>= 5.X) custom_id

Custom Id of the agent for extern applications.

外部アプリケーションのための、エージェントのカスタム ID です。

(>= 5.X) url_address

Custom URL to open it from the agent in the console.

コンソールでエージェントから開くカスタム URL です。

(>= 5.X) custom_fieldX_name

Name of an agent custom field that already exists on the system. If doesnt exist, will be ignored.

システムに設定済のエージェントのカスタムフィールド名です。存在しない場合は無視されます。

Example:

例:

custom_field1_name Model

(>= 5.X) custom_fieldX_value

Value for the custom field X defined in the previous parameter.

前述のパラメータで定義されたカスタムフィールド X の値です。

Example:

例:

custom_field1_value C1700

(> 5.1 Unix エージェントのみ) macro<macro> <value>

Defines a local execution macro that can be used in the definition of a module. These macros are used in the meta console system and local module components system to "abstract" the difficulty of using a module by directly editing the code, presenting a local interface that allows to "fill in" values to a less advanced user. These values are used below, using a macros system, relatively similar to the macros system of the local plugins.

モジュールの定義で利用可能なローカル実行マクロを定義します。この種のマクロは、主にメタコンソールシステムで利用します。ローカルモジュールコンポーネントシステムで、ローカルモジュールの利用を簡単にし、ソースモジュールの定義を編集する必要がないようにします。これにより、GUI に新たなフィールドが表示されます。ローカル実行マクロは、_field1_、_field2_、... のようなローカルプラグインマクロと似た名前をもちます。

Example:

例:

module_begin
module_name FreeDisk_opt
module_type generic_data
module_exec df -kh _field1_ | tail -1 |  awk '{ print $5}' | tr -d "%"
module_macro_field1_ /opt
module_end

(>= 6.0SP5) group_password <パスワード>

Password for the agent group. Leave it commented if the group is not password protected.

エージェントグループのパスワードです。グループのパスワード保護をしない場合は、コメントアウトした状態にしてください。

(>= 7.0) ehorus_conf <パス>

Absolute path to a valid eHorus agent configuration file. The agent will create a custom field named eHorusID that contains the eHorus agent's identifying key.

eHorus エージェント設定ファイルの絶対パスです。エージェントは、eHorus エージェントを特定するキーを含むカスタムフィールド名 eHoursID を作成します。

(>= 7.0OUM713) transfer_mode_user <ユーザ>

User of files copied in the local transfer mode. In console folders, this user must have reading and writing permissions for the remote configuration to work properly. By default it is apache.

ローカル転送モードでコピーされるファイルのユーザでえす。正しく動作するためには、コンソールのフォルダで、このユーザがリモート設定ファイルを読み書きできる権限が必要です。デフォルトは apache です。

(>= 7.0OUM721) secondary_groups <セカンダリグループ>

Name of the secondary groups assigned to the agent. Several secondary groups separated by commas can be specified. If any of the groups does not exist on the server to which the information is sent, that group will not be assigned, but the creation of the agent will not be affected.

エージェントに割り当てるセカンダリグループ名です。複数のセカンダリグループをカンマ区切りで指定できます。サーバ上に存在しないグループを指定した場合はグループは割り当てられませんが、エージェントの作成には影響ありません。

(>= 7.0OUM728) standby <1|0>

If an agent has standby 1 mode, the agent will not perform any check or send or generate any XML. This configuration directive makes sense in enterprise installations where there is remote configuration. Thanks to it, it is possible to silence an agent at will just by disabling it.

エージェントがスタンバイモード(1)の場合、エージェントは監視を実行せず XML の生成や送信を行いません。この設定は、リモート設定がある Enterprise 版の利用時に意味があります。これにより、エージェントを無効化した場合に動作を停止することができます。

The debug mode overwrites this functionality and the agent is executed normally.

デバッグモードの場合はこの機能を上書きし、エージェントは通常動作をします。

セカンダリサーバ

We can define a secondary server to which the data will be sent in two possible situations depending on the configuration:

データを送信するセカンダリサーバを設定することができます。設定により二種類の動作モードがあります。

  • on_error: Send data to the secondary server only if it cold not send them to the primary.
  • on_error: プライマリサーバにデータを送信出来なかった場合のみ、セカンダリサーバにデータを送信します。
  • always: Always send data to the secondary server, regardless if it can contact or not with the main server.
  • always: プライマリサーバにデータが送信できるかどうかに関わらず、常にセカンダリサーバにもデータを送信します。

Configuration example:

設定例:

secondary_server_ip     192.168.1.123
secondary_server_path   /var/spool/pandora/data_in
secondary_mode          on_error
secondary_transfer_mode tentacle
secondary_server_port   41121

UDP サーバ

The Pandora FMS Agent can be configured to listen to remote commands. This server listens to a UDP port spcified by the user and allows orders to be received from a remote system - usually from Pandora FMS' console through the execution of alerts on the server.

Pandora FMS エージェントは、リモートからコマンドを受け取る設定ができます。このサーバは、ユーザが指定した UDP のポートで待ち受けており、アラートが発生したときに何らかのコマンドを実行するなど、リモートシステム (基本的には Pandora FMS) から命令を受け取ることができます。

There are several options to configure the UDP remote server. They are at pandora_agent.conf

UDP リモートサーバの設定には、いくつかのオプションがあり、pandora_agent.conf にて設定します。

  • udp_server:To activate the UDP server put it at 1. It is deactivated by default.
  • udp_server:UDP サーバを有効にする場合は 1 を設定します。デフォルトでは無効です。
  • udp_server_port: Port where it listen.
  • udp_server_port: 待ち受けポート番号を設定します。
  • udp_server_auth_address: Authorized IP address to send orders. Several Addresses can be set splitting them by comma. If it is configured with 0.0.0.0, UDP Server will accept orders from all addresses.
  • udp_server_auth_address: 命令の送信を許可する IPアドレスを設定します。カンマ区切りで複数のアドレスを指定できます。0.0.0.0 に設定すると、UDP サーバはすべてのアドレスからのリクエストを受け付けます。
  • process_<name>_start <command>: Command which is going to start a process defined by the user.
  • process_<name>_start <command>: ユーザ定義プロセスを起動するコマンドを設定します。
  • process_<name>_stop <command>: Command that will stop the process.
  • process_<name>_stop <command>: プロセスを停止するコマンドを設定します。
  • service_<name> 1: Allows that the service <name> could be stop or started remotely from UDP server.
  • service_<name> 1: リモートから停止や起動ができるサービス名 <name> を設定します。

Configuration example:

設定例:

udp_server 1
udp_server_port 4321
udp_server_auth_address 192.168.1.23
process_firefox_start firefox
process_firefox_stop killall firefox 
service_messenger 1 

The server accept the following commands:

サーバは、次のコマンドを受け付けます。

* <START|STOP> SERVICE <nombre del servicio>: Start or stop a service.
* <START|STOP> SERVICE <サービス名>: サービスの起動や停止を行います。
* <START|STOP> PROCESS <nombre del proceso>: Start or stop a process.
* <START|STOP> PROCESS <プロセス名>: プロセスの起動や停止を行います。
* REFRESH AGENT <nombre del agente>: Forces one execution of the agent, refreshing data.
* REFRESH AGENT <エージェント名>: エージェントの強制実行および、データの更新を行います。

For example:

例:

STOP SERVICE messenger
START PROCESS firefox
REFRESH AGENT 007

There is a script on the server at /util/udp_client.pl which is used by the Pandora FMS Server as a command of an alert to start processes or services. It has this syntax:

サーバの /util/udp_client.pl に、Pandora FMS サーバでアラート発生時にプロセスやサービスを起動できる実行コマンドとして利用できるスクリプトがあります。次のような書式で利用します。

./udp_client.pl <address> <port> <command>

For example, to restart an agent:

例えば、エージェントを再起動するには次のようにします。

./udp_client.pl 192.168.50.30 41122 "REFRESH AGENT"

For more information, please go to the Alert configuration section.

より詳しくは、アラート設定の章を参照ください。

モジュール定義

The local execution modules are defined in the configuration file pandora_agent. conf. Below we explain all the parameters that can be accepted.

設定ファイル pandora_agent.conf にてローカルモジュールの実行を定義します。利用可能な全パラメータを以下に説明します。

The general syntax is the following:

一般的な書式は次の通りです。

module_begin
module_name <Module Name>
module_type generic_data
module_exec <local command to execute>
module_end 
module_begin
module_name <モジュール名>
module_type generic_data
module_exec <実行するローカルコマンド>
module_end 

There are different kinds of modules,; in this example we have only used the common and mandatory lines for most of them.

モジュールの種類によって違いがあります。この例は、ほとんどのモジュールで使われる共通で必須の行のみです。

全モジュールで共通の項目

Template warning.png

Module fields (except module data, description and extended info) are only stored on module creation and will never be updated if the module is already created.


Template warning.png

モジュールのフィールド情報はモジュール作成時にのみ反映されます(モジュールデータ、説明、拡張情報を除く)。モジュールがすでに存在する場合は更新されません。


module_begin

Defines the beginning of the module. Compulsory.

モジュール定義の開始を示す、必須項目です。

module_name <名前>

Name of the module (compulsory). This name CANNOT be duplicated.

モジュールの名前です(必須)。重複した名前は設定できません。

module_type

Type of data the module will return. It is compulsory to choose one of these. The available types are:

モジュールが返すデータタイプです。いずれか一つを選択することが必須です。指定可能なデータタイプは次の通りです。


  • Numerical (generic_data). Simple numerical data, in floating points or wholes.
  • Numerical (generic_data): 小数または整数の数値データです。小数値の場合は整数に切り捨てられます。
  • Incremental (generic_data_inc). Numeric data equal to the difference between the current value and the previous one divided by the elapsed time in seconds. When this difference is negative, the value is reset, which means that when the difference becomes positive again, the previous value will be taken as long as the increment returns to a positive value.
  • Incremental (generic_data_inc): 前の値と現在の値の差分を間隔の時間で割ったデータです。差分がマイナスの場合は値はリセットされます。これは、差分は再びプラスになること、増分がプラスの値である限りは前のデータとの差が利用されることを意味します。
  • Absolute incremental (generic_data_inc_abs). Numeric data equal to the difference between the current value and the previous one, with no division made, so the value is the total difference or increment, and not the increment per second. When this difference is negative, the value is reset, this means that at the time when the difference is again a positive value, the base value used to make this calculation is the last one from which the incremental value is positive.
  • Absolute incremental (generic_data_inc_abs): 前の値と現在の値の差分データです。絶対的な差分の値であり、単位時間あたりの差分ではありません。差分がマイナスの場合は値はリセットされます。差分が再びプラスになった場合はベースの値として利用され、そこから差分が計算されます。
  • Alphanumeric (generic_data_string). Collects alphanumeric text strings.
  • Alphanumeric (generic_data_string): 文字列です。
  • Booleans (generic_proc). For values that can only be correct/affirmative (1) or incorrect/negative (0). Useful to check if a computer is alive, or a process/service is running. A negative value (0) has the critical status preassigned, while any higher value is considered correct.
  • Booleans (generic_proc): 正常(1)または異常(0)をとる値です。コンピュータが動いているか、プロセスやサービスが動いているかどうかのチェックに便利です。異常値(0)には障害状態があらかじめ設定されています。それよりも大きい任意の値(1より大きい数字も扱えます)は正常と判断されます。
  • Asynchronous Alphanumeric (async_string). For asynchronous text strings. Asynchronous monitoring depends on events or changes that may or may not occur, so these types of modules are never in unknown status.
  • Asynchronous Alphanumeric (async_string): (定期実行ではない)非同期の文字列収集に使います。非同期監視は、任意のタイミングで発生するイベントや変更に依存するため、このタイプのモジュールは不明状態にはなりません。
  • Asynchronous Boolean (async_proc). Similar to 'generic_proc' but asynchronous.
  • Asynchronous Boolean (async_proc): generic_proc と似ていますが、非同期のデータタイプです。
  • Asynchronous Numerical (async_data). Similar to 'generic_data' but asynchronous.
  • Asynchronous Numerical (async_data): generic_data と似ていますが、非同期のデータタイプです。
module_min <値>

Minimum value that the module must return to be accepted. Otherwise it will be discarded and will not be displayed on the console.

そのモジュールが返すことを許容されるデータの最小値です。範囲を外れたデータは削除されコンソールに表示されません。

module_max <値>

Maximum value that the module must return to be accepted. Otherwise it will be discarded and will not be displayed on the console.

そのモジュールが返すことを許容されるデータの最大値です。範囲を外れたデータは削除されコンソールに表示されません。

module_min_warning <値>

This is the minimum value that will make the module go into 'warning' status.

モジュールが警告状態になる最小値です。

module_max_warning <値>

This is the maximum value that will make the module go into 'warning' status.

モジュールが警告状態になる最大値です。

module_min_critical <値>

This is the minimum value that will make the module go into 'critical' status.

モジュールが障害状態になる最小値です。

module_max_critical <値>

This is the maximum value that will make the module go into 'critical' status.

モジュールが障害状態になる最大値です。

module_disabled <値>

Indicates if the module is enabled ('0') or disabled ('1').

モジュールが、有効(0)か無効(1)かを表します。

module_min_ff_event <値>

Flip flop protection value for false positives. The number of status changes indicated in this value will be necessary for the module to visually modify its status in the web console.

連続抑制回数を指定します。連続抑制回数とは、収集データに揺らぎがあるような場合に、それを変化としてとらえないように抑止するものです。

(>= 6.0 SP4) module_each_ff <値>

If enabled (1), flip flop thresholds per status will be used (module_min_ff_event_normal, module_min_ff_event_warning and module_min_ff_event_critical). Set to 0 to disable.

有効化(1)すると、module_min_ff_event の代わりに連続抑制回数に個別状態変化(module_min_ff_event_normal, module_min_ff_event_warning および module_min_ff_event_critical)を利用します。0 に設定すると無効です。

(>= 6.0 SP4) module_min_ff_event_normal <値>

Flip flop protection value for switching to normal status.

個別状態変化で、正常状態へ移行する場合の連続抑制回数です。

(>= 6.0 SP4) module_min_ff_event_warning <値>

Flip flop protection value for switching to warning status.

個別状態変化で、警告状態へ移行する場合の連続抑制回数です。

(>= 6.0 SP4) module_min_ff_event_critical <値>

Flip flop protection value for switching to critical status.

個別状態変化で、障害状態へ移行する場合の連続抑制回数です。

(>= 6.0 SP4) module_ff_timeout <秒>

Resets the flip flop threshold counter after the given number of seconds. This implies that the number of status changes determined in module_min_ff_event must occur at an interval module_ff_timeout seconds before the state changes in the console's visual level.

指定した秒数が経過したら連続抑制回数のカウンターをリセットします。これは、module_min_ff_event に指定した抑制回数の状態変化が module_ff_timeout に指定の秒数以内に発生する必要があることを意味します。

(>= 734) module_ff_type <値>

This is an advanced option of the Flip Flop to control the status of a module. By means of "keep counters" we will establish some counter values to pass from one status to another depending, instead of the value, on the status of the module with the received value.

これは、連続抑制の高度なオプションで、モジュールの状態を制御します。 "カウンタを保持する" ことによって、値の代わりに、受け取った値を持つモジュールの状態に応じて、ある状態から別の状態に渡すカウンタ値をいくつか設定します。

Indicates if the keep counters is enabled ('1') or disabled ('0').

有効(1)か無効(0)かを指定します。

module_description <テキスト>

Free text with information about the module.

モジュールの任意のコメントです。

module_interval <間隔倍率>

This interval is calculated as a multiplier for the agent interval. If the agent has e.g. an interval 300 (5 minutes) but you want a module which is going to get processed every 15 minutes only; so you should add this line: module_interval 3. This module will be processed every 300sec x 3 = 900sec (15 minutes).

それぞれのモジュールの実行間隔をエージェントの間隔の倍率で設定することができます。例えば、エージェントが 300 (5 分)間隔の設定であった場合に、あるモジュールだけ 15分間隔にしたいときに、module_interval 3 を設定します。そのモジュールは、300秒 x 3 = 900秒 (15分) 間隔で実行されます。

module_timeout <秒数>

In seconds, maximum time allowed for the execution of the module. If this time is exceeded before the end of its execution, it will be interrupted.

モジュールの最大実行時間を秒単位で指定します。実行中にこの時間を超過した場合は、実行が中止されます。

module_postprocess <倍率>

Numerical value by which the data returned by the module will be multiplied. It is useful for unit conversions.

モジュールから返される値を何倍するかの値です。データの単位を変換するのに便利です。もし、エージェントが取得した値に 1024 を掛けたい場合は、1024 を設定します。また、1024 で割りたい場合は、1/1024 を意味する 0.000976563 を設定します。

module_save <変数名>

Stores the value returned by the module in a variable with the name indicated in this parameter. This value can be used later in other modules.

このパラメータで定義された名前の変数にモジュールから返された値を保存します。この値はあとから他のモジュールで利用できます。

For example:

例:

module_begin
module_name echo_1
module_type generic_data
module_exec echo 41121
module_save ECHO_1
module_end

It will store the value"41121" in the "ECHO_1" variable.

"ECHO_1" という変数に、値 41121 を保存します。

module_begin
module_name echo_2
module_type generic_data
module_exec echo $ECHO_1
module_end

This second module will show the contents of the variable "$ECHO_1", it being "41121".

2つ目のモジュールでは、"$ECHO_1" という変数の内容を表示します。"41121" となります。

In Windows agents the module would have to be formed with %var% instead of $var. Following the example

Windows エージェントでは、変数は $var ではなく %var% で指定します。 以下に例を示します。

module_begin
module_name echo_2
module_type generic_data
module_exec echo %ECHO_1%
module_end
module_crontab <分> <時間> <日> <月> <曜日>

From version 3.2 it's possible to schedule modules in order they'll be executed in an specific date. To do this, you should have to define the module_crontab' using a similar format to that of the crontab file:(http://es.wikipedia.org/wiki/Cron_(Unix)#Sintaxis)

バージョン 3.2 から、モジュールを指定した日時に実行させるようにすることができます。この設定は、module_crontab にて、crontab に似た設定を行うことにより実現します。

module_crontab <minute> <hour> <day> <month> <day of the week>

module_crontab <分> <時間> <日> <月> <曜日>

Being:

指定可能な範囲は次の通りです。

  • Minute 0-59
  • 分 0-59
  • Hour 0-23
  • 時間 0-23
  • Day of the month 1-31
  • 日 1-31
  • Month 1-12
  • 月 1-12
  • Day of the week 0-6 (0 is Sunday)
  • 曜日 0-6 (0 が日曜です)

It's also possible to specify intervals using the -character as divider.

期間を指定する - を利用することも可能です。

In order for one module to be executed e.g. every Monday between 12 and 15, we could use the following configuration:

例えば、あるモジュールを毎週月曜の 12時から 15時の間に実行するには、次のような設定をします。

module_begin
module_name crontab_test
module_type generic_data
module_exec script.sh
module_crontab * 12-15 * * 1
module_end

To execute a command every hour, in an hour and 10 minutes:

コマンドを毎時 10分に実行したい場合は、次のようにします。

module_begin
module_name crontab_test3
module_type generic_data
module_exec script.sh
module_crontab 10 * * * *
module_end
module_condition <評価式> <コマンド>

From version 3.2 it's possible to define commands that will be executed when the module returns some specific values. It's necessary to specify one of the following options:

バージョン 3.2 から、モジュールが特定の値を返す場合にコマンドを実行させることが可能です。次に示すオプションの一つを定義します。

  • > [value]: Executes the command when the module value is higher that the given value.
  • > [値]: モジュールの値が指定された値よりも大きい場合にコマンドを実行します。
  • < [valor]: Executes the command when the module value is lower than the given value.
  • < [値]: モジュールの値が指定された値よりも小さい場合にコマンドを実行します。
  • = [valor]: Executes the command when the module value is the same as the given value.
  • = [値]: モジュールの値が指定された値と同じ場合にコマンドを実行します。
  • != [valor]: Executes the command when the module value is different to the given value.
  • != [値]: モジュールの値が指定された値と異なる場合にコマンドを実行します。
  • =~ [regular expression]: Executes the command when the module value coincides with the given regular expresion.
  • =~ [正規表現]: モジュールの値が指定された正規表現にマッチする場合にコマンドを実行します。
  • (valor, valor): Executes the command when the module value is ranged between the given values.
  • (値, 値): モジュールの値が指定された値の範囲の場合にコマンドを実行します。

Multiple conditions can be specified for a single module. In the following case, the script_1.sh will be executed if the value returned by the module is between 1 and 3, and script_2.sh will be executed if the value of the module is greater than 5.5, so in this case, being 2.5 the value returned in the module_exec line , only the first condition script_1.sh will be executed:

同一のモジュールに複数の条件を設定することも可能です。以下の例では、モジュールの値が 1 と 3 の間の時にscript_1.sh が実行されます。また、モジュールの値が 5.5 より大きい時に script_2.sh が実行されます。module_exec の結果が 2.5 なので、最初の script_1.sh のみ実行されます。

module_begin
module_name condition_test
module_type generic_data
module_exec echo 2.5
module_condition (1, 3) script_1.sh
module_condition > 5.5 script_2.sh
module_end

Examples of possible real cases:

例:

module_begin
module_name MyProcess
module_type generic_data
module_exec tasklist | grep MyProcess | wc -l
module_condition > 2 taskkill /IM MyProcess* /F
module_end
module_begin
module_name PandoraLogSize
module_type generic_data
module_exec ls -la "c:\Archivos de programa\pandora_agent\pandora_agent.log" | gawk "{ print $5 }"
module_condition > 10000 del "c:\Archivos de programa\pandora_agent\pandora_agent.log"
module_end
module_begin
module_name Service_Spooler
module_type generic_proc
module_service Spooler
module_condition = 0 net start Spooler
module_end
  • NOTE: On Windows platforms is recommended to use cmd.exe /c to execute the command to ensure it is executed properly. For example:
  • 注意: 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 <評価式> <コマンド>

if the precondition is true, the module will run. It's necessary to specify one of the following options:

事前状態定義にマッチした場合モジュールを実行します。次に示すオプションの一つを定義します。

  • > [value]: Executes the command when the module value is higher that the given value.
  • > [値]: コマンドの実行結果が指定された値よりも大きい場合にモジュールを実行します。
  • < [valor]: Executes the command when the module value is lower than the given value.
  • < [値]: コマンドの実行結果が指定された値よりも小さい場合にモジュールを実行します。
  • = [valor]: Executes the command when the module value is the same as the given value.
  • = [値]: コマンドの実行結果が指定された値と同じ場合にモジュールを実行します。
  • != [valor]: Executes the command when the module value is different to the given value.
  • != [値]: コマンドの実行結果が指定された値と異なる場合にモジュールを実行します。
  • =~ [regular expression]: Executes the command when the module value coincides with the given regular expresion.
  • =~ [正規表現]: コマンドの実行結果が指定された正規表現にマッチする場合にモジュールを実行します。
  • (valor, valor): Executes the command when the module value is ranged between the given values.
  • (値, 値): コマンドの実行結果が指定された値の範囲の場合にモジュールを実行します。

In the following example, the module monitoring_variable.bat will only be executed if the result of the execution indicated in the precondition is between 2 and 8. In this case, the execution result indicated in the module_precondition line is 5, a value between 2 and 8, so monitoring_variable.bat will be executed correctly:

以下の例では、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

Like postconditions is possible to use several precondition. The module will only be executed if all preconditions are successfull:

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
  • NOTE: On Windows platforms is recommended to use cmd.exe /c to execute the command to ensure it is executed properly. For example:
  • 注意: Windows プラットホームでは、コマンドの実行にはそれが正しく実行されていることを確認するために cmd.exe /c を利用することをお勧めします。例えば次の通りです。
module_begin
module_name Precondition_test3
module_type generic_data
module_precondition (2, 8) cmd.exe /c script.bat
module_exec monitoring_variable.bat
module_end
(>= 5.x) module_unit <単位>

Units shown next to the value obtained by the module.

これは、モジュールの値に付与する単位です。

Example:

例:

module_unit %
(>= 5.x) module_group <値>

This is the name of the module group.

これは、モジュールグループ名です。

Example:

例:

module_group Networking
(>= 5.x) module_custom_id <値>

This is a custom identifier for the module.

モジュールのカスタム ID です。

Example:

例:

module_custom_id host101
(>= 5.x) module_str_warning <値>

This is a regular expression to define the Warning status in the string types modules.

文字列タイプのモジュールで警告状態を定義する正規表現です。

Example:

例:

module_str_warning .*NOTICE.*
(>= 5.x) module_str_critical <値>

This is a regular expression to define the Critical status in the string types modules.

文字列タイプのモジュールで障害状態を定義する正規表現です。

Example:

例:

module_str_critical .*CRITICAL.*
(>= 5.x) module_warning_instructions <値>

This is instructions to the operator when the modules changes to Warning status.

モジュールが警告状態に変化したときのオペレータへの指示です。

Example:

例:

module_warning_instructions Increase incident priority
(>= 5.x) module_critical_instructions <値>

This is instructions to the operator when the modules changes to Critical status.

モジュールが障害状態に変化したときのオペレータへの指示です。

Example:

例:

module_critical_instructions Call to sys department
(>= 5.x) module_unknown_instructions <値>

This is instructions to the operator when the modules changes to Unknown status.

モジュールが不明状態に変化したときのオペレータへの指示です。

Example:

例:

module_unknown_instructions Open incident
(>= 5.x) module_tags <値>

This is the tags that will be assigned to module separated by commas.

カンマ区切りでモジュールに割り当てるタグを指定します。

Example:

例:

module_tags tag1,tag2,tag3
(>= 5.x) module_warning_inverse <値>

Allows activating (1) the inverse interval for the warning threshold.

警告閾値範囲の反転を有効化(1)します。

Example:

例:

module_warning_inverse 1
(>= 5.x) module_critical_inverse <値>

Allows activating (1) the inverse interval for the critical threshold.

障害閾値範囲の反転を有効化(1)します。

Example:

例:

module_critical_inverse 1
(>= 5.x) module_native_encoding <値>

(Win32 only)

(Win32 のみ)

This configuration token only affects executed modules by command line, that is, there is a module_exec in the module configuration.

この設定トークンは、module_exec によってコマンドラインから実行されるモジュールにのみ影響します。

Windows manages three encodings for its processes: the command line encoding (OEM), the system encoding (ANSI) and UTF-16. Both encodings are agree on basic characters, but they are different on less common characters, like written accent. With this token, the Pandora's agent transforms the output to the encoding specified in the configuration file (pandora_agent.conf).

Windows では、コマンドラインエンコーディング(OEM)、システムエンコーディング(ANSI)および、UTF-16 の 3つのプロセスのエンコーディングがあります。いずれのエンコーディングも通常の文字を扱うことができますが、アクセントを表したものなどいくつかの文字に違いがあります。このトークンにより、Pandora エージェントが設定ファイル(pandora_agent.conf)で指定したエンコーディングに出力を変換します。

module_native_encoding has four acceptable values:

module_native_encoding は、次の 4種類の値を設定できます。

  • module_native_encoding OEM: to command line encoding
  • module_native_encoding ANSI: to system encoding
  • module_native_encoding UTFLE: to UTF-16 little-endian
  • module_native_encoding UTFBE: to UTF-16 big-endian
  • module_native_encoding OEM: コマンドラインエンコーディングに変換
  • module_native_encoding ANSI: システムエンコーディングに変換
  • module_native_encoding UTFLE: UTF-16 のリトルエンディアンに変換
  • module_native_encoding UTFBE: UTF-16 のビッグエンディアンに変換

If module_native_encoding does not appear, no re-encoding will be done.

module_native_encoding の設定が無い場合は、変換は行われません。

(>= 5.x) module_quiet <値>

If enabled (1) the module will be in silent mode: it will not generate events or trigger alerts, nor will it store data history.

有効化(1)すると、モジュールは静観モードになります。イベントやアラートを生成せずデータの保存も行いません。

Example:

例:

module_quiet 1
(>= 5.x) module_ff_event <値>

This is the flip flip execution threshold of the module (in seconds)

モジュールの連続抑制回数です。(秒単位)

Example:

例:

module_ff_event 2
(>= 5.x) module_macro<macro> <値>

Only applicable to local components from the console. It has no utility in the configuration file.

コンソールから、ローカルコンポーネントにのみ適用できます。設定ファイルで直接設定しません。

(>= 5.1 SP4) module_alert_template <テンプレート名>

This macro assigns to the module the alert template that corresponds to the name introduced as parameter(see Alert templates)

このマクロは、パラメータ名(アラートテンプレート 参照)に対応したモジュールにアラートテンプレートを割り当てます。

Example:

例:

<module>
<name><![CDATA[CPU usage]]></name>
<type>generic_data</type>
<module_interval>1</module_interval>
<min_critical>91</min_critical>
<max_critical>100</max_critical>
<min_warning>70</min_warning>
<max_warning>90</max_warning>
<alert_template><![CDATA[Critical condition]]></alert_template>
<![CDATA[92]]>
</module>
module_end

Defines the end of the module. It is compulsory.

モジュール定義の終わりを表します。必須項目です。

情報を取得するためのディレクティブ

Furthermore, there are the specific guidelines that could be specified for each module in order to obtain information. Only one kind of them can be used in each module.

次に、それぞれのモジュールで情報を取得するためのディレクティブを示します。それぞれのモジュールで、1回ずつ利用できます。

module_exec <コマンド>

General command execution line. The desired run must be specified to obtain the information in a single line.

一般的なコマンド実行行です。 1行で情報を取得するコマンドを指定する必要があります。

On Linux, the command will be executed using the default command prompt. Which is the default interpreter will be determined by the symbolic link /bin/sh. Normally the link points to bash, but in systems like Ubuntu this is not the case (in this case it points to dash). Therefore, it can happen that a command is tested in the terminal and then an error occurs when the agent executes it. A solution that will work in most cases will be to force the bash execution of the command as follows:

Linux では、コマンドはデフォルトのシェルを使って実行されます。デフォルトのシェルは、 /bin/sh のシンボリックリンクによって決まります。通常は、bash ですが、Ubuntu のシステムでは異なります(この場合 dash)。端末でコマンドをテストしても、エージェントからの実行ではエラーが発生する可能性があります。解決策としては、次のようにコマンドラインの実行で明示的に bash を記載します。

module_exec bash -c "<command>"

Template warning.png

If execution returns a return code different from '0', it will be interpreted as "execution error" and the information will be discarded.


Template warning.png

実行結果が '0' 以外を返す場合は、実行エラーであり情報は取り込まれません。


For a Windows agent there are more guidelines for obtaining data, which are described below.

Windows エージェントでのデータ取得のためのディレクティブは他にもあります。以下に示します。

module_service <サービス>

Checks if an specific service is being executed at the machine. Remember to use the «" "» characters if the name of the service contains blanks.

指定したサービスが実行中であるかどうかをチェックします。サービス名にスペースが含まれる場合は、" " でくくるのを忘れないようにしてください。

module_begin
module_name Service_Dhcp
module_type generic_proc
module_service Dhcp
module_description Service DHCP Client
module_end

The service is identified with the short name of the service (service name), such as it appears in the Windows services manager.

サービスは、Windows サービスマネージャに表示される短い名前 (サービス名) で識別されます。

ファイル:Service name id.png

Asynchronous Mode

非同期モード

Pandora FMS usually executes a test battery (each of it defined by a module) every X seconds (300 seg. = 5 min. by default). If a service is down just after an execution of Pandora, it's going to take 300 additional seconds to find out the service went down. The difference on asynchronous mode is that modules immediatly notify Pandora FMS about the fail or shutdown of this service. This is called asynchronous operation mode. It would be sufficient to add the following command to the guideline to use it:

Pandora FMS は通常、(モジュールによって定義される)一定の秒間隔にてチェックを実行します (デフォルトでは、300秒 = 5分)。そのため、チェックの直後にサービスがダウンすると、それがダウンであると認識するのに、さらに 300秒かかります。非同期モジュールでは、Pandora に "今すぐ" サービスの障害を通知するようにできます。これは、非同期操作モードと呼んでいます。非同期モードにするには、以下のディレクティブを設定してください。

module_async yes

This feature is not supported on broker agents.

この機能は、ブローカーエージェントでは利用できません。

Template warning.png

In Windows Home Edition versions, this asynchronous functionality is not supported and, only in those versions, the Pandora agent makes a periodic query to know if the service is running or not. This can be quite resource-intensive so it is recommended to use the synchronous version if a large number of services are being monitored.


Template warning.png

Windows Home Edition では、この非同期機能はサポートされていません。Pandora エージェントはサービスが動作しているかどうかを定期的に確認します。大量のサービスを監視する場合システムリソースを消費するため、同期モードを利用することをお勧めします。


Service Watchdog

サービスのウォッチドッグ

There is a watchdog mode for the services, so the agent could start them again if they stop. In this case, the service that is restarted does not requires any parameter, because Windows already knows how to do it.In this case the configuration is easier and this could be an example:

サービスがダウンしたときに再起動するためのウォッチドッグモードがあります。サービスを起動するためのパラメータは Windows が認識しているため必要ありません。設定は簡単で、以下に例を示します。

module_begin
module_name ServiceSched
module_type generic_proc
module_service Schedule
module_description Service Task scheduler
module_async yes
module_watchdog yes
module_end

Unix

In Unix, it works the same as in Windows, the only difference is that for Unix, process and service is the same concept, for example to see if the bash process is active in the system, just run:

Unix でも Windows と同様に動作します。違いは Unix であることだけで、プロセスおよびサービスは同じ考え方です。例えば、bash プロセスが動作しているかを確認するには次のようにします。

module_begin
module_name Service_bash
module_type generic_proc
module_service /bin/bash
module_description Process bash running
module_end

Watchdog mode and asynchronous detection are not possible in the Unix agent.

Unix エージェントでは、ウォッチドッグと非同期検出はできません。

module_proc <プロセス>

Checks if an specific name of process is working in this machine. If the name of the process has blanks do not use «" " »; please consider that the name of the process should have the .exe extension. The module is going to return the number of processes executed with this name.

指定した名前のプロセスがいるかどうかをチェックします。プロセス名にスペースが含まれていても、" " は使わないでください。プロセス名に拡張子 .exe がつくかどうかを良く確認してください。モジュールは、指定した名前で実行されているプロセスの数を返します。

This would be an example of the monitoring of process cmd.exe:

以下に cmd.exe プロセスをモニタリングする例を示します。

module_begin
module_name CMDProcess
module_type generic_proc
module_proc cmd.exe
module_description Process Command line
module_end

Unix

In Unix this module works like the module_service. It doesn't support asynchronous and/or watchdog mode.

UNIX では、このモジュールは module_service のように動作します。非同期およびウォッチドッグモードはサポートしません。

非同期モード

In a similar way to the services, monitoring processes can be critical in some cases. The Windows agent supports asynchronous checking for the module_proc. module now. In this case, the agent immediately reports it if the process changes its status without waiting for the agent's execution interval to be reached again. In this way, you're able to get informed about the failure of critical processes almost instantly. This is an example of asynchronous monitoring of the processes:

サービスと同じように、モニタリングしているプロセスにて何らかの原因で障害が発生することがあります。Windows エージェントでは、module_proc モジュールで非同期チェックをサポートしています。この場合、プロセスの状態が変化したとき、通常のモニタリング間隔における次のチェックタイミングを待たずにすぐに通知されます。これにより、プロセスに障害が発生したのとほぼ同時にそれを知ることができます。以下にプロセスの非同期モニタリング設定の例を示します。

module_begin
module_name Notepad
module_type generic_proc
module_proc notepad.exe
module_description Notepad
module_async yes
module_end

The difference is in the configuration token "module_async yes".

違いは、"module_async yes" が設定されている点です。

プロセスのウォッチドッグ

A Watchdog is a system that allows to act immediately if an agent is down, usually raising the process that went down. The Pandora FMS Windows Agent could act as a watchdog when a process is down.

ウォッチドッグは、ダウンしたプロセスを見つけた場合にそれをすぐに起動させることができます。Pandora FMS の Windows エージェントは、プロセスがダウンしたときにウォッチドッグとして動作させることができます。

Since executing a process would require some parameters, there are some additional configuration options for these kind of modules. It is important to keep in mind that the watchdog mode only works if the module type is set to asynchronous. This is an example of configuration of 'module_proc' with 'watchdog' enabled:

プロセスの実行には、いくつかのパラメータが必要です。このモジュールには、いくつかの追加設定オプションがあります。ウォッチドッグモードは、モジュールタイプが非同期の場合のみ動作することに注意してください。ウォッチドッグでの module_proc の設定例を見てみます。

module_begin
module_name Notepad
module_type generic_proc
module_proc notepad.exe
module_description Notepad
module_async yes
module_watchdog yes
module_start_command c:\windows\notepad.exe
module_startdelay 3000
module_retrydelay 2000
module_retries 5
module_end

This is the definition of the additional parameters for module_proc with watchdog:

以下に、ウォッチドッグを行う場合の module_proc の追加パラメータを示します。

  • module_retries: Number of consecutive attempts that the module will try to raise the process before deactivating the watchdog. If the limit is reached, the watchdog mechanism for this module will be deactivated and will never attempt to launch the process again until the agent is restarted. Unlimited by default.
  • module_retries:ウォッチドッグによりプロセスを起動させるリトライ回数を指定します。指定した回数に達した場合、該当モジュールのウォッチドッグは無効になり、ユーザによる復旧 (少なくともエージェントの再起動) がされるまでプロセスの起動を行わなくなります。デフォルトでは上限はありません。
  • module_startdelay: Number of milliseconds the module is going to wait before starting the process for the first time.
  • module_startdelay:プロセスのダウンを認識した後、最初にプロセスを起動させるまでの待ち時間をミリ秒単位で指定します。
  • module_retrydelay: Number of milliseconds that the module will wait before trying to launch the process in each retry.
  • module_retrydelay: プロセスダウンを検知した後に起動に失敗した場合の再実行の待ち時間をミリ秒単位で指定します。
  • module_user_session: it vontrols in which session you want the process to be launched. If set to 'no', the process will start in the services session and therefore remain in the background (default setting). Otherwise, if set to 'yes', the process will be launched in the user's session and will be visible from the PC desktop.
  • module_user_session: プロセスの起動をどのセッションで行うかを制御します。'no' に設定すると、プロセスはサービスセッションで起動し、バックグラウンドで動作します(デフォルト)。'yes' に設定すると、プロセスはユーザセッションで起動し、PC のデスクトップに表示されます。

Template warning.png

For versions prior to Windows Vista, the module_user_session token can be configured in a general way by enabling the checkbox "Interactive access with desktop" in the Pandora FMS service properties, as shown in the following screenshot:

ファイル:Service interactive.png


Template warning.png

Windows Vista 以前のバージョンでは、Pandora FMS サービスプロパティで、"Interactive access with desktop" を有効にすることにより module_user_session を設定することができます。以下のスクリーンショットに示します。

ファイル:Service interactive.png


It's also necessary to understand that Pandora FMS is executed under the "SYSTEM" account if started as a service. The executed process will do it under that user and with that environment, so that if you want to execute any particular process that requires to be used with a certain user, you will have to include in a script (.bat or similar) the previous processes to initialize the environment, environment variables, etc, and execute that script as a watchdog action.

また、Pandora FMS は "SYSTEM" アカウントのサービスとして動作するため、実行されるコマンドはこのユーザおよびこのユーザの環境で動作することに注意してください。したがって、特定のプロセスを特定のユーザで実行したい場合は、環境変数の設定やその他事前処理を行う呼び出し用スクリプト (.bat など) を用意し、そのスクリプトをウォッチドッグの起動プログラムとして設定する必要があります。

module_cpuproc <プロセス> (Unix のみ)

Return the CPU usage of a specific process.

特定のプロセスの CPU 使用率を返します。

module_begin
module_name myserver_cpu
module_type generic_data
module_cpuproc myserver
module_description Process Command line
module_end
module_memproc <プロセス> (Unix のみ)

Return the memory used by a specific process.

特定のプロセスが利用しているメモリ量を返します。

module_begin
module_name myserver_mem
module_type generic_data
module_memproc myserver
module_description Process Command line
module_end
module_freedisk <ドライブ名:>|<ボリューム>

This module works under UNIX and Windows. It checks for the free space in the disk unit (don't forget «":"» after the unit_letter in Windows) or the UNIX volume e.g. '/var'.

このモジュールは、UNIX および Windows 双方で利用できます。ディスクの空き容量をチェックします。(Windows では ドライブ名のあとに ":" を忘れないようにしてください。) UNIX であれば、/var などのボリュームを指定します。

module_begin
module_name freedisk
module_type generic_data
module_freedisk C:
module_end
module_begin
module_name disk_var
module_type generic_data
module_freedisk /var
module_end
module_freepercentdisk <ドライブ名:>|<ボリューム>

This module returns the free disk percentage in a windows unit: (don't forget the ":") or on a Unix system, the volume, like /var.

このモジュールは、ディスクの空きをパーセントで返します。Windows であれば、ドライブ名: (":"を忘れないようにしてください) で、UNIX であれば、/var などのボリュームを指定します。

 module_begin
 module_name freepercentdisk
 module_type generic_data
 module_freepercentdisk C:
 module_end
module_begin
module_name disk_var
module_type generic_data
module_freepercentdisk /var
module_end
module_occupiedpercentdisk <ドライブ名:>|<ボリューム>

(Unix only)

(Unix のみ)

This module returns the occupied disk percentage in a Unix volume, like /var.

このモジュールは、/var 等の Unix ファイルシステムのディスク使用率(%)を返します。

module_begin
module_name disk_var
module_type generic_data
module_occupiedpercentdisk /var
module_end
module_cpuusage <cpu id>

This works under UNIX and Windows. It returns the CPU usage in a CPU number. If there is only one CPU, please leave it blank or use 'all'.

このモジュールは、UNIX および Windows 双方で使えます。指定した CPU 番号の CPU 使用率を返します。CPU が 1つしかない場合は番号を指定しないか、all を指定します。

It's also possible to obtain the average use of all CPU in multiprocessor systems this way:

次のように、マルチ CPU 環境で全 CPU の平均使用率を得ることができます。

module_begin
module_name SystemCPU
module_type generic_data
module_cpuusage all
module_description Average CPU use in system
module_end

To check CPU usage in CPU #1

1つ目の CPU 使用率を確認するのは次のようにします。

module_begin
module_name SystemCPU_1
module_type generic_data
module_cpuusage 1
module_description Average CPU use in system for CPU #1
module_end
module_freememory

Supported in Windows and Unix. Gives back the free memory in the whole system.

Windows および Unix 双方で使えます。システム全体の空きメモリ量を取得します。

module_begin
module_name FreeMemory
module_type generic_data
module_freememory
module_description Non-used memory on system
module_end
module_freepercentmemory

Supported in Unix and Windows. This module gives back the free memory percentage in one system:

Windows および Unix 双方で使えます。システム全体の空きメモリ量のパーセンテージを取得します。

module_begin
module_name freepercentmemory
module_type generic_data
module_freepercentmemory
module_end
module_tcpcheck

(Windows のみ)

This module tries to connect with the IP and port specified.It returns 1 if it had success and 0 if it had other way.You should specify a time out.

このモジュールは、指定された IPアドレスおよびポート番号への接続確認を行います。成功すると 1 が返り、失敗すると 0 が返ります。なお、タイムアウトを設定する必要があります。

module_begin
module_name tcpcheck
module_type generic_proc
module_tcpcheck www.artica.es
module_port 80
module_timeout 5
module_end
module_regexp

(Windows のみ)

This module monitors a record file (log) looking for coincidences using regular expressions, ruling out the already existing lines when starting the monitoring . The data returned by the module depends on the module type:

このモジュールは、正規表現を使ってファイル(ログ)の内容の比較を行います。モニタリングを開始した時点ですでに存在している行については無視します。モジュールが返す値はモジュールタイプにより異なります。

  • generic_data_string, async_string: Gives back all the lines that fit with the regular expression.
  • generic_data_string, async_string: 正規表現にマッチした行全体を返します。
  • generic_data: Gives back the number of lines that fit with the regular expression.
  • generic_data: 正規表現にマッチした行数を返します。
  • generic_proc: Gives back 1 if there is any coincidence, 0 if other way.
  • generic_proc: 正規表現にマッチしたら 1、そうでなければ 0 を返します。
  • module_noseekeof: With a 0 value by default, with this configuration token active, in each module execution, independently from any modification the target file suffers, the module will restart its check process without searching for the EOF flag of the file, so it will always extract to the XML output all those lines matching our search pattern.
  • module_noseekeof: 0 がデフォルトです。これを有効にすると、それぞれのモジュールの実行において、ターゲットのファイル更新からは独立して、ファイルの EOF を確認することなくチェック処理が実行されます。これにより、常に検索パターンにマッチするすべての行が XML 出力に展開されます。
module_begin
module_name regexp
module_type generic_data_string
module_regexp C:\WINDOWS\my.log
module_pattern ^\[error\].*
module_noseekeof 1
module_end

To obtain more information about the syntax of the regular expressions, please have a look at this: [1]

正規表現の詳細の書式については、こちら [2] を参照してください。

module_wmiquery

(Windows のみ)

The WMI modules allow to execute locally any WMI query without using an external tool. It is configured through two parameters:

WMI モジュールは、外部ツールを使わずにローカルで WMI クエリを実行できます。2つのパラメータで設定します。

  • module_wmiquery: Used WQL query. As a result, several lines could be obtained which will be inserted as several data.
  • module_wmiquery: 利用する WQL クエリを設定します。さまざまなデータを含む複数の行で結果を得ることができます。
  • module_wmicolumn: Name of the column that that is going to be used as a data source.
  • module_wmicolumn:データソースとして利用するカラム名を設定します。

For example, we could obtain a list of the installed services.

例えば、インストールされているサービス一覧を取得するには次のようにします。

module_begin
module_name Services
module_type generic_data_string
module_wmiquery Select Name from Win32_Service
module_wmicolumn Name
module_end

Or of the current CPU load:

現在の CPU 負荷であれば次のようにします。

module_begin
module_name CPU_speed
module_type generic_data
module_wmiquery SELECT LoadPercentage FROM Win32_Processor
module_wmicolumn LoadPercentage
module_end
module_perfcounter

(Win32 のみ)

Obtains data from the performance counter (http://msdn.microsoft.com/en-us/library/aa373083(v=vs.85).aspx Performance Counters (Documentación en ingles Performance Counters Documentation) through the PDH interface (the library pdh.dll should be installed in the system. PDH.DLL is a Windows library. If you have not installed it then you would have to install the Windows performance analysis tool (that usually is installed by default).

PDH インタフェースを通して、パフォーマンスカウンタ (http://msdn.microsoft.com/ja-jp/library/aa373083(v=vs.85).aspx パフォーマンスカウンタドキュメント) からデータを取得します。Windows のライブラリの pdh.dll がインストールされている必要があります。もしインストールされていない場合は、Windows パフォーマンス解析ツールをインストールする必要があります (通常はデフォルトでインストールされています)。

module_begin
module_name perfcounter
module_type generic_data
module_perfcounter \Memory\Pages/sec
module_end

The Windows performance monitor is a powerful tool with hundreds of parameters that can be used for monitoring. In addition, each manufacturer incorporates its own counters.

Windows パフォーマンスモニタは、モニタリングに利用できる何百ものパラメータを持つ強力なツールです。加えて、各ベンダによる独自のモニタ項目も追加されています。

Performance counters can be observed using the Performance tool:

パフォーマンスツールから、パフォーマンスカウンターを確認できます。

New performance counters can be added using the system tool. Its configuration has a management structure with elements and sub-elements. In this case Processor, % of processor time and _Total:

システムツールを用いて新たなパフォーマンスカウンターを追加することができます。その構成には、要素とサブ要素を含む管理構造があります。ここでは、Processor, % of processor time および _Total です。

ファイル:Perfcounter screen2.png

In this way, surfing with the SO tool, we could get different elements of the system performance. For this specific example, the module would be:

このように、OS のツールを使うことにより、システムパフォーマンスのさまざまな要素を取り込むことができます。この場合、モジュールの設定は次のようになります。

module_begin
module_name Processor_Time
module_type generic_data_inc
module_perfcounter \Procesador(_Total)\% de tiempo de procesador
module_end

By default the raw value of the counter is shown, to get the cooked value add the module_cooked 1 parameter:

デフォルトでは、カウンタの生データが表示されます。調整値を取得するには、module_cooked 1 を設定します。

module_begin
module_name Disk_E/S_Seg
module_type generic_data
module_cooked 1
module_perfcounter \DiscoFísico(_Total)\E/S divididas por seg.
module_end

Most of the returned data arejust counters, so you should use 'generic_data_inc' as data type. It's also able to return values in very high data scales (several millions), so you could reduce these values using the module post process with values like '0.000001' or similar.

多くのデータは、カウンタ値として返ってきます。そのため、データタイプとしては generic_data_inc を使う必要があります。また、とても大きなスケール (数百万) のデータが返ってくることがありますので、事前処理モジュールで 0.000001 などを設定して値を小さくすると良いです。

module_inventory (廃止)

Template warning.png

Currently this functionality has been replaced by inventory from agent plugins on both Windows and Linux/Unix systems.


Template warning.png

Windows および Linux/UNIX 双方で、現在この機能はエージェントプラグインによるインベントリで置き換えられています。


(Win32 のみ。Linux/Unix ではエージェントプラグインとして実装されています。)

Using predefined WMI consults and queries on the registry.This module obtains information about the different aspects of a machine. From software to hardware.

前述の WMI を利用することにより、このモジュールはソフトウエアおよびハードウエアの違った情報を取得します。

The module can get different parameters to mark the kind of information that it gets. Here is the parameter list and the kind of information that it gives:

モジュールは、取得した情報の種類を分類し収集します。以下に情報の種類の一覧を示します。

  • cpu: Gets information about the system CPUs( processor name, watch frequency, and description).
  • cpu: システムの CPU 情報を取得します。(プロセッサ名、クロック数、説明)
  • CDROM: Gets information about the CD-ROM(name, description and unity letter).
  • CDROM: CD-ROM の情報を取得します。(名称およびドライブ名)
  • Video: Gets information about video cards(description, RAM, and processor).
  • Video: ビデオカードの情報を取得します。(説明、RAM容量、プロセッサ)
  • HDs: Gets information about the hard disks(model, size and name in the system).
  • HDs: ハードディスクの情報を取得します。(モデル、サイズおよび、システムにおける名前)
  • NICs: Gets information about the network interface controllers(description, MAC address and IP address).
  • NICs: ネットワークコントローラの情報を取得します。(説明、MAC アドレスおよび、IPアドレス)
  • Patches: Gets information about the installed patches(identifier, description and comments).
  • Patches: インストール済のパッチ情報を取得します。(ID、説明、コメント)
  • Software: Gets information about MSI packages installed(name and version).
  • Software: MSI パッケージの情報を取得します。(名前およびバージョン)
  • RAM: Gets information about RAM modules(tag, capacity and name).
  • RAM: RAM モジュールの情報を取得します。(タグ、容量および名前)
  • Services: Gets information about the installed services. The short name shown in the first column is the name of the service that Pandora FMS uses to could monitor services.
  • Service: インストールされたサービスの情報を取得します。最初のカラムに、Pandora FMS がサービスのモニタリングに使う、サービスの短い名前が表示されます。

Additional Module Parameters:

追加モジュールパラメータ:

  • module_inventory_interval: This module has an additional line to specify the interval, in days, where he can obtain the information for the module.
  • module_inventory_interval: このモジュールは、日単位で情報収集するための間隔を定義する追加設定です。

An example of the use of this module would be this:

このモジュールの利用例を以下に示します。

module_begin
module_name Inventory
module_inventory_interval 7
module_type generic_data_string
module_inventory RAM Patches Software Services
module_description Inventory
module_end
module_logevent

(Win32 のみ)

Allows obtaining information from the Windows event log based on the indicated patterns, providing the possibility to filter according to the source and event type.

指定されたパターンに基づいて Windows イベントログから情報を取得し、ソースおよびイベントタイプに従ってフィルタリングする機能を提供します。

The general format of this module is as follows:

このモジュールの一般的な書式は次の通りです。

module_begin
module_name MyEvent
module_type async_string
module_logevent
module_source <logName>
module_eventtype <event_type/level>
module_eventcode <event_id>
module_application <source>
module_pattern <text substring to match>
module_description
module_end

To avoid showing ducplicated information, only those events which occurred since the last time the agent was executed will be considered.

すでに表示されたものを再度表示するのを防ぐために、エージェントが実行された最終時間より後のイベントのみを対象とします。

module_logevent accepts the following parameters (all of them case-sensitive):

module_logevent には、次のパラメータを設定できます。(すべて大文字小文字を区別します)

  • module_source: Event source(System, Application, Security).This field is compulsory.
  • module_source: イベントソース (System, Application, Security) を指定します。このフィールドは必須項目です。
  • module_eventtype: Event type(failure, information). It is an optional field.
  • module_eventtype: イベントタイプ (Error, Information 等) を指定します。このフィールドはオプションです。
  • module_pattern: Pattern to search (substring). It is an optional field.
  • module_pattern: 検索するパターン (文字列) を指定します。このフィールドはオプションです。
  • module_eventcode: It is a numeric ID of the event, p.e: 5112. It is an optional field.
  • module_eventcode: 5112 等のイベント ID 番号です。このフィールドはオプションです。
  • module_application: Aplication source of the event. Watch out not mistake with module_source that shows the name or the source or log file where the events are looked for.
  • module_application: イベント発生元のアプリケーションを指定します。イベントが検索される名前やログファイルを示す module_source と混同しないように注意してください。

For example, to show all events of an error type system we should define the following module:

例えば、system の error に分類される全てのイベントを表示するには、次のように設定します。

module_begin
module_name log_events
module_type generic_data_string
module_description System errors
module_logevent
module_source System
module_eventtype error
module_end

To show all events that have the word PandoraAgent:

PandoraAgent という文字を含む全イベントを表示するには次のようにします。

module_begin
module_name log_events_pandora
module_type async_string
module_description PandoraAgent related events
module_logevent
module_source System
module_pattern PandoraAgent
module_end

Another example, filtering the event showed in the snapshot:

その他例として、以下にイベントフィルタリングのスナップショットを示します。


module_begin
module_name MyEvent
module_type async_string
module_source Application
module_eventtype Information
module_eventcode 6000
module_application Winlogon
module_pattern unavailable to handle
module_description
module_end

It is very important to understand that Pandora FMS is not a system to collect logs and that this tool should be used to select those critical or important events for monitoring, and that collect all events, without classify them, from, a common source, as could be the "System" one, will only cause problems so the DDBB will be collapsed and the system will work in a very bad way.It is extremely important understand that the event collection with Pandora FMS should be done taking this in account and not using Pandora FMS as a generic event collector.

Pandora FMS は、ログを収集するシステムではないということを理解してください。このツールは、これらのクリティカルまたは重要なイベントを選択し、監視するためのシステムです。すべてのイベントを未分類で収集すると、データベースが飽和状態になりシステムパフォーマンスが著しく低下し、長期的に問題をもたらします。Pandora FMS を一般的なイベント収集ツールとして使うべきではありません。

module_logchannel

(Windows only, from 7.0OUM715 on)

(Windows のみ、7.0OUM715以降)

Type of module that allows you to obtain information about Windows logging channels. Although module_logevent only has access to Windows Logs, this type of module allows you to extract data from other log files that are configured as channels. In this way, it is possible to obtain the logs included in the services and application logs.

Windows ログチャネルに関する情報を取得するモジュールです。module_logevent は Windows ログにのみアクセスしますが、これは、チャネルとして設定された他のログファイルからデータを展開することができます。これにより、サービスやアプリケーションログを含めたログ取得が可能になります。

The general format of this module is as follows:

このモジュールの一般的な書式は次の通りです。

module_begin
module_name MyEvent
module_type async_string
module_logchannel
module_source <logChannel>
module_eventtype <event_type/level>
module_eventcode <event_id>
module_pattern <text substring to match>
module_description <description>
module_end
module_begin
module_name MyEvent
module_type async_string
module_logchannel
module_source <ログチャネル>
module_eventtype <イベントタイプ/レベル>
module_eventcode <イベントID>
module_pattern <マッチするテキスト文字列>
module_description <説明>
module_end

To avoid displaying repeated information, only those events that have occurred since the start of the agent are taken into account.

すでに表示されたものを再度表示するのを防ぐために、エージェントが実行された最終時間より後のイベントのみを対象とします。

module_logchannel accepts the following parameters (all case-sensitive):

module_logchannel には、次のパラメータを設定できます。(すべて大文字小文字を区別します)

  • module_source: Event channel. With the command wevtutil. exe enum-logs a list of all the local log channels of the machine is obtained. Required field.
  • module_eventtype: Event type (critical, error, warning, info or verbose). Optional field
  • module_pattern: Pattern to search (substring). Optional field.
  • module_eventcode: Numeric ID of the event, e.g. 5112.Optional field.
  • module_source: イベントチャネルを指定します。wevtutil.exe enum-logs を実行すると、ローカルログチャネルの一覧を取得できます。このフィールドは必須項目です。
  • module_eventtype: イベントタイプ (critical, error, warning, info, verbose) を指定します。このフィールドはオプションです。
  • module_pattern: 検索するパターン (文字列) を指定します。このフィールドはオプションです。
  • module_eventcode: 5112 等のイベント ID 番号です。このフィールドはオプションです。

For example, we would define the following module to show all the events of the channel Microsoft-Windows-TaskScheduler/Operational, information type, with code 201 and with log text code 0:

例えば、チャネル Microsoft-Windows-TaskScheduler/Operationalinformation タイプ、コード 201、文字列 code 0 を含むすべてのイベントを表示するモジュールは次のようになります。

module_begin
module_name New logs
module_type async_string
module_logchannel
module_description Successfully completed tasks
module_source Microsoft-Windows-TaskScheduler/Operational
module_eventtype information
module_eventcode 201
module_pattern code 0
module_end

With this module configuration, the Pandora FMS agent would collect the following log:

このモジュール設定により、Pandora FMS エージェントは次のようなログを収集します。


module_plugin

A parameter to define the data which is obtained at the exit of a plugin agent. It's a special case , since it doesn't require any other delimiter like 'module_begin', 'module_type', nor will it need the module type.

プラグインから取得したデータを定義するためのパラメータです。これは、特殊なモジュールで、'module_begin' や 'module_type' などの 他の識別子は必要ありません

It just requires this format:

次のような書式です。

module_plugin plugin_filename parameter_1 parameter_2 parameter_3

However, it can be used between the usual module labels to add additional options such as conditions or interval:

ただし、プラグインに状態や実行間隔などの追加パラメータを設定する場合は、次のように通常の書式を利用します。

module_begin
module_plugin plugin_filename parameter_1 parameter_2 parameter_3
module_interval 2
module_condition (0, 1) script.sh
module_end

The parameters to be used will be different for each plugin, so it will be necessary to refer to your particular documentation. We will describe the operation of one of the plugins that comes by default with the Agent, the grep_log plugin to search for matches in a file:

それぞれのプラグインには個別のパラメータが使われます。そのため、それぞれの特定のドキュメントを参照する必要があります。ここでは、エージェントにデフォルトで付属しているプラグインの一つであるファイル内を検索する grep_log で説明します。

module_plugin grep_log /var/log/syslog Syslog ssh

In this example, the name of the plugin is 'grep_log' and it's going to search for the regular expression 'ssh' in the file '/var/log/syslog' which will be kept in a module called 'Syslog'.

この例では、プラグインの名前が "grep_log" で、"/var/log/syslog" を正規表現 "ssh" で検索する "Syslog" というモジュールであることを意味します。

Another example intended to be solely used on Windows-based systems (and only on versions 3.1 or later):

Windows システムの場合の別の例を示します。(バージョン 3.1 以上)

module_plugin cscript.exe //B "%ProgramFiles%\Pandora_Agent\util\df_percent.vbs"
module_ping <ホスト>

(From version 4.0.1 onwards, Windows only)

(バージョン 4.0.1 以降、Windows のみ)

This module pings the preset host and returns '1' if it's up and '0' if not.

このモジュールは、指定したホストに ping を行い、応答があれば 1、そうでなければ 0 を返します。

Is supports the following configuration parameters:

次のパラメータを設定できます。

  • module_ping_count x: Number of ECHO_REQUEST packets to be sent (1 by default).
  • module_ping_count x: 送信する ECHO_REQUEST パッケットの数 (1 がデフォルト)
  • module_ping_timeout x: Timeout in milliseconds to wait for each reply (1000 by default).
  • module_ping_timeout x: 応答を待つタイムアウトミリ秒数 (1000 がデフォルト)
  • module_advanced_options: Advanced options for ping.exe.
  • module_advanced_options: ping.exe の拡張オプション

Example:

例:

module_begin
module_name Ping
module_type generic_proc
module_ping 192.168.1.1
module_ping_count 2
module_ping_timeout 500
module_end
module_snmpget

(Windows only)

(Windows のみ)

This module performs an SNMP get query and returns the requested value.

このモジュールは snmpget を実行し、その応答を返します。

It supports the following configuration parameters:

次のパラメータを設定できます。

  • module_snmpversion [1,2c,3]: SNMP version (1 by default).
  • module_snmpversion [1,2c,3]: SNMP バージョン (1 がデフォルト)
  • module_snmp_community <community>: SNMP community (public by default).
  • module_snmp_community <community>: SNMP コミュニティ (public がデフォルト)
  • module_snmp_agent <host>: Target SNMP agent.
  • module_snmp_agent <host>: 対象の SNMP エージェント
  • module_snmp_oid <oid>: Target OID.
  • module_snmp_oid <oid>: 対象の OID
  • module_advanced_options: Advanced options for snmpget.exe.
  • module_advanced_options: snmpget.exe の拡張オプション

Example:

例:

module_begin
module_name SNMP get
module_type generic_data
module_snmpget
module_snmpversion 1
module_snmp_community public
module_snmp_agent 192.168.1.1
module_snmp_oid .1.3.6.1.2.1.2.2.1.1.148
module_end

自動エージェント設定

概要

Starting from Pandora FMS version 725, you can establish a series of rules for your agents to be configured automatically.

Pandora FMS バージョン 725 から、エージェントを自動的に設定するための一連のルールを設定できます。

The agent auto-configuration process works as follows:

エージェントの自動設定処理は次のように動作します。

1- Automatic configurations are prepared in your Pandora FMS Console o Pandora FMS Metaconsole.

1- Pandora FMS コンソールまたは、Pandora FMS メタコンソールで、自動設定の準備をします。

2- The agents are installed reporting against your Pandora FMS (if you have a single console, point the agent against your Pandora FMS server, if you have a Metaconsole with the automatic provisioning system configured, set the Metaconsole itself as server).

2- Pandora FMS へ接続するエージェントをインストールします。(単一のコンソールの場合はエージェントの接続先は Pandora FMS サーバです。自動プロビジョニングを設定したメタコンソールがある場合は、メタコンソールをサーバとして設定します。)

3- Pandora FMS Server will receive a XML (.data) with the agent's data for the first time.

3- Pandora FMS サーバが、エージェントのデータを含む XML (.data) を初回受信します。

4- The rules for determining the automatic configuration to be applied will be evaluated.

4- 適用される自動設定を決定するためのルールが評価されます。

5- The agent will pick up the new configuration and report in the next cycle with the updated configuration.

5- エージェントが新たな設定を受け取り、次回の処理から更新された設定で動作します。

自動エージェント設定の作成

You can access the form that manages the automatic settings through:

自動設定画面へは次のようにアクセスできます。

Console Management > Manage automatic agent configuration

コンソール 管理(Management) > 自動エージェント設定管理(Manage automatic agent configuration)

ファイル:Autoconf menu console.png

Metaconsole Advanced > Agent Management > Automatic Agent Configuration

メタコンソール 拡張 > エージェント管理 > 自動エージェント設定

ファイル:Autoconf1.png

Once you access the administration page you can create new automatic configurations by pressing the "Create automatic configuration" button.

管理ページにアクセスしたら、"自動設定の作成(Create automatic configuration)" ボタンをクリックすることにより新たな自動設定を作成することができます。

You will need to choose a name and description for its automatic configuration.

自動設定の名前と説明を設定します。

ファイル:Autoconf new.png


Once the new automatic configuration is created, you can display the configuration forms by clicking on the section you need:

新たな自動設定を作成したら、必要な項目をクリックすることにより設定フォームを表示できます。

ファイル:Autoconf options.png


ルール

To define the agents to which the automatic configuration will be applied, you can add rules to identify them.

自動設定を適用するエージェントを定義するには、ルールを追加します。

Display the rules section within your automatic configuration, and select "Add new rule".

自動設定のルールセクションを表示し、"新規ルール追加(Add new rule)" を選択します。

You can choose a series of options in the rules selector to identify the agents to be configured.

設定対象のエージェントを特定するために、ルールのオプションを選択できます。

750px‎‎
Server name
Server name match
Group name
Group name match
OS
OS name match (uses regular expressions)
Custom field
Match by key/value based on a custom field reported by the agent. Specify the name of the custom field and the value it should have.
IP range
Match by IP range (network), use IP/mask notation, for example
192.168.1.0/24
Server name
マッチするサーバ名
Group name
マッチするグループ名
OS
マッチする OS 名 (正規表現)
Custom field
エージェントが報告してくる、キー/値 のカスタムフィールドマッチ。カスタムフィールド名と値を指定する必要があります。
IP range
IP の範囲(ネットワーク)にマッチ。IP/ネットマスク の書式を追加います。例: 192.168.1.0/24
Script output (> 0)
Result of the execution of a script, the rule will be evaluated as valid as long as the result in the standard output is greater than 0.
Script output (> 0)
スクリプトの実行結果で、標準出力の結果が 0より大きい場合にルールにマッチしたと評価されます。

The rule script call supports the following macros in the field 'arguments':

_agent_ 
will be replaced by the agent's name
_agentalias_ 
will be replaced by the agent's alias;
_address_ 
will be replaced by the principal IP addresss, reported by the agent
_agentgroup_ 
will be replaced by the group's nname, reported by the agent
_agentos_ 
will be replaced by the agent's OS

ルールスクリプトでは、'arguments' フィールドに次のマクロが使えます。

_agent_ 
エージェント名に置き換えられます。
_agentalias_ 
エージェントの別名に置き換えられます。
_address_ 
エージェントから報告された IP アドレスに置き換えられます。
_agentgroup_ 
エージェントから報告されたグループ名に置き換えられます。
_agentos_ 
エージェントの OS で置き換えられます。

You can choose between AND and OR operators to modify the logic of the rules.

ルールの適用条件で AND および OR を選択できます。

750px‎‎


Note: If you do not add any rules, the automatic configuration will not apply.

注意: ルールが無い場合は、自動設定は適用されません。

If you need a single configuration for all agents, you can use the following regular expression to match any alias

全てのエージェントに対して一つの設定でよい場合は、すべての別名にマッチする次の正規表現を使うことができます。

.*


設定

From this section we will be able to configure:

ここから設定に進みます。

Agent's group
We can keep it unchanged or force it to be a specific one.
Secondary groups
The groups selected here will be added as secondary groups to the agent.
Policies
We can select policies to be applied automatically when the agent reaches the server.
Configuration block
Adds the extra raw configuration to the agent configuration file.
エージェントグループ
変更せずにそのままとするか、強制的に変更します。
セカンダリグループ: エージェントにセカンダリグループとして追加するグループを選択します。
ポリシー
エージェントがサーバに接続してきたときに適用するポリシーを選択できます。
設定ブロック
エージェントの設定ファイルに追加する設定内容です。
ファイル:Autoconf config.png

Note: If you try to access automatic configuration management from a node belonging to a Metaconsole, with centralized management active, the view will be read-only:

注意: 集中管理が有効なメタコンソールに属するノードから自動設定管理を行おうとすると、リードオンリー表示になります。

ファイル:Autoconf ro.png


追加アクション

From this section you can associate other actions to the autoconfiguration, for example:

ここでは、自動設定に追加のアクションを行うことができます。例えば以下のような処理です。

  1. Launch a personalized event
  2. Execute an alert action
  3. Execute a script
  1. 独自イベントを出す
  2. アラートアクションを実行する
  3. スクリプトを実行する
ファイル:Autoconf actions.png


The system supports the following macros:

_agent_ 
will be replaced by the agent's name
_agentalias_ 
will be replaced by the agent's alias;
_address_ 
will be replaced by the principal IP addresss, reported by the agent
_agentgroup_ 
will be replaced by the group's nname, reported by the agent
_agentos_ 
will be replaced by the agent's OS
_agentid_ 
will be replaced by the agent's ID

システムは、次のマクロをサポートします。

_agent_ 
エージェント名に置き換えられます。
_agentalias_ 
エージェントの別名に置き換えられます。
_address_ 
エージェントが報告した IP アドレスに置き換えられます。
_agentgroup_ 
エージェントが報告したグループ名に置き換えられます。
_agentos_ 
エージェントの OS に置き換えられます。
_agentid_ 
エージェント ID に置き換えられます。

Unix/Linux エージェント

Unix has several command line tools that allow that get data through commands would be a very simple thing.The Unix agents are based in this premise.There are two kinds of Unix agents:

UNIX には、簡単にデータを収集できるいくつかのコマンドラインツールがあります。UNIX エージェントはこれをベースにしており、次の 2つの種類があります。

  • ShellScript:with a shellscript defined for each kind of SO, based on bash, ksh or csh. In the classic Unix Systems (Solaris, AIX, HPUX) all functionalities are not implemented. But in Linux and MAC they are.
  • ShellScript:さまざまな OS にある、bash、ksh、csh などのシェルスクリプトを用いたエージェントです。Linux や MAC 向けにはすべての機能が実装されていますが、伝統的な UNIX システム (Solaris、AIX、HPUX) 向けには、すべての機能は実装されていません。
  • Perl:There is a unique multiplataform agent, based on Perl 5.8 that functions equally in all Unix systems. They should necessarily have a Perl 5.8 system or another higher to operate.
  • Perl:全ての UNIX システムで動作する、Perl 5.8 をベースにしたマルチプラットフォームエージェントです。Perl 5.8 以上が必要です。

The shellscript agents have been designed to function even in the oldest UNIX versions: HPUX11.0, AIX 4.1, Solaris 6... They work, but are limited with some features, such as not having the Tentacle client and having to use the FTP system or SSH to upload the monitoring data to the server.

シェルスクリプトエージェントは、古い UNIX (HPUX11.0、AIX 4.1、Solaris 2.6 など) でも動くように作られています。ただし、機能は制限されており、Tentacle クライアントがありません。サーバにモニタデータをアップロードするには、FTP もしくは SSH を利用する必要があります。

Pandora FMS Unix エージェントの設定

The fundamental routes and directories to consider are:

把握しておくべき基本的なファイルとディレクトリは次のとおりです。

  • /usr/share/pandora_agent/: where the Pandora FMS agent is installed. In systems where this isn't possible for reasons like a strict system policy, we recommend creating a link to this path from the real installation path, e.g. '/opt/pandora' -> '/usr/share/pandora_agent'.
  • /usr/share/pandora_agent/: Pandora FMS エージェントがインストールされる場所です。厳密なシステムポリシーがあり、ここにインストールできないシステムでは、実際のインストールパスからこのパスへのリンクを作成することを推奨します。例: '/opt/pandora' -> '/usr/share/pandora_agent'
  • /etc/pandora/pandora_agent.conf: Main agent configuration folder. The definition of where the data is collected is defined by the used command.
  • /etc/pandora/pandora_agent.conf: エージェントのメインの設定ファイルです。ここにデータの収集に使うコマンドの定義がされています。
  • /usr/local/bin/pandora_agent: the current Pandora FMS agent. This file is a shellscript that collects the configured data in the pandora_agent.conf files.It also send the data packages to the Pandora Server. It usually has a link to /usr/bin/pandora_agent
  • /usr/local/bin/pandora_agent: Pandora FMS エージェント本体です。これは、pandora_agent.conf で設定されたデータ収集を行うシェルスクリプトです。これはまた、Pandora サーバにデータパケットを送信します。通常、/usr/bin/pandora_agent にリンクされています。
  • /usr/local/bin/tentacle_client: The agent which adds the Tentacle client for being able to send the data files to the server. This is a client written in Perl 5.8. It usually has a link to '/usr/bin/tentacle_client'.
  • /usr/local/bin/tentacle_client: サーバにデータファイルを送信するためにエージェントが追加する Tentacle クライアントです。これは、Perl 5.8 で動作するように作られています。通常、/usr/bin/tentacle_client にリンクされています。
  • /etc/init.d/pandora_agent_daemon: Script for starting and stopping. This daemon calls up 'pandora_agent' and gives two options (start / stop). On the AIX systems, the daemon's name is /etc/rc.pandora_agent_daemon.
  • /etc/init.d/pandora_agent_daemon: エージェントの起動スクリプトです。pandora_agent を呼び出します。オプションとして、start/stop を利用できます。AIX システムでは、/etc/rc.pandora_agent_daemon です。
  • /var/log/pandora/pandora_agent.log: Text file where the activity of the Pandora FMS agent is kept if the agent is executed in depuration mode.
  • /var/log/pandora/pandora_agent.log: Pandora FMS エージェントがデバッグモードで動作している時にログが出力されるログファイルです。
  • /etc/pandora/plugins: Directory which keeps the agent's plugins. It's a link to /usr/share/pandora_agent/plugins.
  • /etc/pandora/plugins: エージェントプラグインを置くディレクトリです。これは /usr/share/pandora_agent/plugins にリンクされています。
  • /etc/pandora/collections: Directory containing the collections of the agent. It is linked to the directory /usr/share/pandora_agent/collections.
  • /etc/pandora/collections: エージェントのコレクションを置くディレクトリです。これは /usr/share/pandora_agent/collections にリンクされています。

Unix エージェントの実行

To start the agent, simply execute:

エージェントの起動は以下のようにします。

/etc/init.d/pandora_agent_daemon start

To stop the agent, just execute:

エージェントの停止は以下のようにします。

/etc/init.d/pandora_agent_daemon stop

This boot script will be able to start or stop the Pandora FMS agent, which will be running in the system as a daemon by default after started.

起動スクリプトで Pandora FMS エージェントの起動・停止ができます。デフォルトでは起動後はデーモーンとして動作します。

Unix エージェントでシステム情報を取得する別の方法

As we saw in the configuration section, there are some modules that obtain the information in a predefined way without having to specify a command with module_exec. These modules are:

設定の章で示した通り、module_exec で特定のコマンドを実行することなく定義済の情報を取得できるモジュールがあります。以下がそれらです。

  • module_procmem
  • module_freedisk
  • module_freepercentdisk
  • module_cpuproc
  • module_proc
  • module_procmem
  • module_cpuusage
  • module_freememory
  • module_freepercentmemory

It is possible to modify the operation of these modules by directly editing the agent executable (/usr/bin/pandora_agent by default). The Pandora FMS agent is generally located in /usr/bin/pandora_agent. Searching for the string "Commands to retrieve" we get to the code part that contains the internal commands. We can make the modifications we need to adapt them to our system.

これらのモジュールの動作は、エージェントの実行ファイル (デフォルトでは /usr/bin/pandora_agent) を直接編集することにより変更できます。Pandora FMS エージェントは一般的に /usr/bin/pandora_agent にあります。コマンド名で検索することにより、内部コマンドを含むコードを見つけます。システムに合わせて変更する場合は、修正を行います。

# 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}\
};
# 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}\
};

To change any of the predefined values to get the information, just edit the command but be careful with the following:

情報取得のための定義済の値を変更するには、コマンドを編集するだけですが、以下に注意します。

  1. Check that lines end with ";"
  2. Check that commands are between ' ' symbols.
  3. Check that any ' symbol you use ends on the \ symbol, e.g.:
  1. 行の終わりに ";" があることを確認
  2. コマンドが ' ' でくくられているか確認
  3. ' を使う場合は、次のように \ でエスケープしているか確認
df -P | awk 'NR > 1 {print $2, $4, $6}'

Will be

上記は以下のようになります。

df -P | awk \'NR > 1 {print $2, $4, $6}\'

Pandora FMS Windows エージェント

Pandora FMS Windows エージェントの設定

The fundamental paths and directories in the Windows agent installation will be found in the directory where the agent is installed, by default C: \Program Files. The most important ones to keep in mind are:

Windows エージェントの基本的なパスやディレクトリは、エージェントをインストールした場所になります。デフォルトでは C:\Program files です。理解しておきたい基本的なファイルは次の通りです。

  • C:\Program Files\pandora_agent: where the Pandora FMS agent is installed, its executable and its directories.
  • C:\Program Files\pandora_agent\pandora_agent.conf: Agent configuration main file. Local execution modules and agent plugins are configured here.
  • C:\Program Files\pandora_agent\PandoraAgent.exe: Executable binary of the agent.
  • C:\Program Files\pandora_agent\util\tentacle_client.exe: Tentacle executable binary for transferring files to the server.
  • C:\Program Files\pandora_agent\scripts: Pandora FMS agent start/stop/restart scripts
  • C:\Program Files\pandora_agent\pandora_agent.log: Text file where Pandora FMS agent activity is saved, when the agent is executed in debug mode.
  • C:\Program Files\pandora_agent\util: Directory containing the agent plugins.
  • C:\Program Files\pandora_agent\collections: Directory containing the agent's collections.
  • 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: エージェントのコレクションを含むディレクトリです。

ソフトウエアエージェントの自動アップグレード

Using the file collections and pandora_update tool we can provide a way to "self-update" the software agents.

ファイルコレクションと pandora_update ツールを使って、ソフトウエアエージェントは自分自身の更新ができます。

Info.png

Pandora_update tool requires Perl's Digest:MD5 module to function. It is included by default from Perl 5.14, but for earlier versions it has to be manually installed.


Info.png

Pandora_update ツールは、Perl の Digest:MD5 モジュールが必要です。Perl 5.14 からはデフォルトで含まれていますが、古いバージョンでは手動でインストールしておく必要があります。


It works the following way:

これは、次のように動作します。

1. Agents receive new binaries e.g. in the file collection's incoming directory:

1. エージェントが、例えば次のようなファイルコレクションの incoming ディレクトリに新たなバイナリを受信します。

Windows example:

Windows の例:

c:\program files\pandora_agent\collections\fc_1\PandoraAgent.exe

Linux example:

Linux の例:

/etc/pandora/collections/fc_1/pandora_agent

2. The agent runs the pandora_update plugin. This plugin receives a single parameter: the short name of the collection (in this example, fc_1). It will scan the collection directory for the agent binary, compare the binary located in the collection with the one currently running and if they are different, pandora_update stops the agent, replaces the binary and restarts the agent again using the new binary.

2. エージェントは、pandora_update プラグインを実行します。このプラグインは、コレクションの短い名前をパラメータとして受け取ります(この例では fc_1)。コレクションディレクトリ内のエージェントバイナリをスキャンし、現在動作しているものと比較します。違いがあれば、pandora_update がエージェントを停止し、バイナリを置き換え、新しいバイナリを使ってエージェントを再起動します。

To update different architectures, a different collection must be established for each one of them. For example, if you need to update 32-bit and 64-bit Windows agents, you will have to create two collections and include the corresponding PandoraAgent.exe binary in each one of them.

異なるアーキテクチャのアップデートを行うには、それぞれ異なるコレクションを用意する必要があります。例えば、32bit および 64bit の Windows エージェントをアップデートする必要がある場合は、2つのコレクションを作成し、それぞれに対応した PandoraAgent.exe バイナリを含める必要があります。

3. Pandora_update also writes the updated event to a small log, to be able to recover in the next execution and warn the user, by using an async_string module, about the agent update process.

3. Pandora_update はまた、async_string モジュールを使うことによって、次の実行タイミングでユーザに通知を出せるように、エージェントのアップデートプロセスに関するアップデートイベントログを出力します。

This means that the used modules could be configured to have a high interval to perform the update process.

以下がアップデートプロセスで使うモジュールです。間隔は長めに設定します。

Unix standar installation

Unix 通常インストール

module_begin
module_name Pandora_Update
module_type async_string
module_interval 20
module_exec nohup /etc/pandora/plugins/pandora_update fc_1 2> /dev/null && tail -1 nohup.out 2> /dev/null
module_description Module to check new version of pandora agent and update itself
module_end

Unix custon installation

Unix カスタムインストール

module_begin
module_name Pandora_Update
module_type async_string
module_interval 20
module_exec nohup /var/opt/PandoraFMS/etc/pandora/plugins/pandora_update fc_1 /var/opt/PandoraFMS 2> /dev/null && tail -1 nohup.out 2> /dev/null
module_description Module to check new version of pandora agent and update itself
module_end

NOTE: The second parameter of pandora_update command the installation path of Pandora FMS. This parameter is required only when you have installed Pandora FMS in another path different from default path.

注意: pandora_update コマンドの 2つ目のパラメータは、Pandora FMS のインストールパスです。このパラメータは、デフォルトのパスとは異なる場所に Pandora FMS をインストールした場合にのみ必要です。

Windows

module_begin
module_name Pandora_Update
module_type async_string
module_interval 20
module_exec pandora_update.exe fc_1
module_description Module to check new version of pandora agent and update itself
module_end

XML ファイルからのエージェント・モジュールの自動作成 / 学習モード

Agents can be configured from the console in three working modes:

エージェントは、コンソールから 3つの動作モードを設定できます。

  • Learning mode: If the XML received from the software agent contains new modules, they will be automatically created. This is the default behavior.
  • Normal mode: No new modules will be created that arrive in XML if they have not been previously declared in the console.
  • Autodisable mode: Similar to learning mode, in this mode, also, if all modules pass to unknown state the agent will be automatically disabled, going to be enabled again if it receives new information.
  • 学習モード(Learning mode): ソフトウエアエージェントから新たなモジュールを含む XML を受け取ると、それらが自動的に作成されます。これがデフォルト動作です。
  • 通常モード(Normal mode): コンソールに存在しない新たなモジュールを XML で受け取っても作成しません。
  • 自動無効化モード(Autodisable mode): 学習モードに似ていますが、すべてのモジュールが不明状態になった場合にエージェントを自動的に無効化します。新たな情報を受け取ったときに改めて自動化します。

ファイル:Learning mode.png


エージェント作成時に XML からロードされるデータ

The data that is incorporated into the agent at the moment of its creation automatically when receiving an XML is the following:

XML を受け取ったときにエージェントの作成とともに自動的に取り込まれるデータは次の通りです。

  • Agent name.
  • Agent's IP address.
  • Agent description.
  • Agent's parent.
  • Timezone offset.
  • Group.
  • Operating system.
  • Agent interval.
  • Agent version
  • Custom fields.
  • Custom ID.
  • URL address.
  • Agent mode: Learning, Normal, Autodisable.
  • エージェント名
  • エージェントのIPアドレス
  • エージェントの説明
  • エージェントの親
  • タイムゾーンオフセット
  • グループ
  • OS
  • エージェントの実行間隔
  • エージェントのバージョン
  • カスタムフィールド
  • カスタムID
  • URL アドレス
  • エージェントモード: 学習、通常、自動無効化

XML を受け取ったときに修正されるデータ (学習モード有効時)

  • Agent's IP address.
  • Agent's parent .
  • OS Version.
  • Agent's version.
  • Timezone.
  • Custom fields.
  • エージェントの IP アドレス
  • エージェントの親
  • OSバージョン
  • エージェントのバージョン
  • タイムゾーン
  • カスタムフィールド

Info.png

The GIS data are always updated (if enabled). It doesn't matter at all if the learning mode is enabled or not.


Info.png

GIS データは(GIS が有効の場合)、学習モードが有効であるか無効であるかに関わらず、常に更新されます。


In addition, with the learning mode activated, new modules will be created in Pandora FMS when received through XMLs.

加えて、学習モードが有効の場合、XML ファイルで受け取った新たなモジュールは、Pandora で作成されます。

作成時にモジュールに追加されるデータ

The data entered in the module the first time an XML is received is as follows:

初回の各モジュールの XML 受信時に反映されるデータは次の通りです。

  • Name.
  • Type.
  • Description.
  • Max Min value filter.
  • Post process.
  • Module interval.
  • Min / Max Critical.
  • Min / Max Warning.
  • Disabled module.
  • Units.
  • Module group.
  • Custom ID.
  • Str. Warning / Critical.
  • Critical instructions.
  • Warning instructions.
  • Unknown instructions.
  • Tags.
  • Critical inversion mode.
  • Warning inversion mode.
  • Quiet mode.
  • Min. FF Threshold.
  • Alert template.
  • Crontab.
  • 名前
  • タイプ
  • 説明
  • フィルタの最大・最小値
  • 保存倍率
  • モジュール実行間隔
  • 障害の最大・最小値
  • 警告の最大・最小値
  • 無効化モジュール
  • 単位
  • モジュールグループ
  • カスタムID
  • 文字列の警告・障害
  • 障害時手順
  • 警告時手順
  • 不明時手順
  • タグ
  • 障害反転モード
  • 警告反転モード
  • 静観モード
  • 連続抑制回数
  • アラートテンプレート
  • Crontab

モジュールがすでに存在する場合に反映されるデータ

When an XML containing information from an existing module is received, only the description and extended information are updated, in addition to the module data.

すでに存在するモージュールのデータを XML で受け取った場合は、モジュールのデータに加えて説明および拡張情報のみ更新されます。

(OBSOLETE)

Pandora FMS Drone エージェント

Drone エージェントとは ?

Pandora FMS Drone Agent is a running mode of Pandora FMS Software Agent. This running mode only works on Windows and Linux machines.

Pandora FMS Drone エージェントは、Pandora FMS ソフトウエアエージェントの一つの実行モードです。この実行モードは、Windows および Linux マシンでのみ動作します。

Pandora FMS Drone Agent was developed to deal with complicated environments with restricted access to the machines. The Drone Agent has two main features:

Pandora FMS Drone エージェントは、マシンへのアクセスが制限された複雑な環境を扱うために開発されました。Drone エージェントには、2つの主な機能があります。

  • Proxy mode
  • プロキシモード
  • Broker mode
  • ブローカーモード

Furthermore running this mode Drone Agent can report data and use all features of standard Pandora FMS Software Agent.

加えて、Drone エージェントとしての実行時も、通常の Pandora FMS ソフトウエアエージェントのすべての機能を利用でき、データを送ることができます。

The picture below shows an architecture of Pandora FMS using Drone Agents:

Drone エージェントを使った Pandora FMS の構成を以下に示します。

500px

プロキシモード

Proxy Mode is very useful for networks that have restrictions in their communications. The agent running this mode enabled a Tentacle Proxy Server to allow agents communicate with Pandora FMS Server through itself.

プロキシモードは、通信が制限されているネットワークに対してとても便利です。このモードで動作しているエージェントでは Tentacle プロキシサーバが有効になり、それを通して他のエージェントが Pandora FMS サーバと通信することができます。

The new Tentacle version supports proxy usage (HTTP/Connect mode), so agents can contact directly with the server using an intermediate standard proxy. You also can use a new tool called Tentacle Proxy Server, which as its name says, is used to centralize all communication between Pandora FMS and the agents, allowing the file management and remote configuration for policy based-monitoring. You can see more about Tentacle Proxy Server here.

新たなバージョンの Tentacle は、プロキシ (HTTP接続) の利用をサポートしています。そのため、エージェントは途中の通常のプロキシを使って、サーバへ接続することができます。また、新たな Tentacle プロキシサーバを利用することもでき、そのプロキシサーバは、Pandora FMS とエージェント間の通信をとりまとめ、ファイル管理やポリシーによるモニタリングのためのリモート設定が可能です。Tentacle プロキシサーバの詳細はこちらにあります。

With this feature you get all functionalities of a proxy but managed by Pandora FMS Software Agent. This mode has two requirements and are that the agent must cannot be run by the root and if you want to use the proxy mode with Unix agent then must be installed with a user without root privileges (the same user will execute later the agent in proxy mode).

この機能により、プロキシのすべての機能を利用できますが、Pandora FMS ソフトウエアエージェントを通して設定管理を行います。このモードには、root では実行できないのと、UNIX エージェントで利用する場合はroot 以外のユーザでインストールしなければいけない(プロキシモードでエージェントを動かすユーザと同じユーザ)という制限事項があります。

All parameters to configure Tentacle Proxy Server are available trough agent configuration file, and are the following:

Tentacle プロキシサーバを設定するための全パラメータは、エージェント設定ファイルに存在し、次のようなものです。

server_ip

Is the IP address or the name of Pandora FMS server host. Be careful with Proxy Mode enabled this parameter cannot take values such as: 127.0.0.1, locahost, 0.0.0.0, or related.

Pandora FMS サーバの IP アドレスもしくはホスト名です。プロキシモードでは、このパラメータは 172.0.0.1、localhost、0.0.0.0 やそれに類するものは設定できないことに注意してください。

proxy_mode

Proxy mode status. If proxy_mode is 1 Proxy feature of Drone Agent is activated, If proxy_mode is 0 Proxy feature is off. By default this feature is disabled.

プロキシモードのステータスを設定します。proxy_mode が 1 であれば、Drone エージェントのプロキシ機能が有効になります。proxy_mode が 0 であれば、この機能は無効になります。デフォルトでは無効です。

proxy_max_connection

Number of proxy simultaneous connections. By default 10 connections are allowed.

プロキシの同時接続数です。デフォルトでは 10 接続が許可されています。

proxy_timeout

Timeout for proxied server. By default 1 second.

プロキシのタイムアウトです。デフォルトは 1秒です。

利用例

I only have one connection to Pandora FMS Server

Pandora FMS サーバへの接続が 1つのみの場合

This situation is not a problem for Pandora FMS Drone Agent. To configure Proxy Mode just set server_ip to Pandora FMS IP and proxy_mode parameter to 1. If is needed you can configure some parameters like the number of connections and timeout. With this configuration you will have the agent and the Tentacle Proxy Server up and running in the machine that can connect with Pandora FMS Server.

この状態は、Pandora FMS Drone エージェントにとって問題ではありません。プロキシモードを設定するために、server_ip に Pandora FMS の IP アドレスを設定し、proxy_mode パラメータを 1 に設定します。必要であれば接続数とタイムアウトパラメータを設定します。この設定で、エージェントと Tentacle プロキシサーバが起動し、そのマシンから Pandora FMS サーバへ接続ができます。

To configure the other agent just set server_ip parameter to IP address of Drone Agent with proxy mode enabled and that all. The agents will use Drone Agent to connect with Pandora FMS Server.

他のエージェントでは、server_ip パラメータを、プロキシモードで動作している Drone エージェントの IP アドレスに設定するだけです。エージェントは、Pandora FMS サーバへの接続に Drone エージェントを利用します。

I must do a double proxied connection

2段プロキシ接続が必要な場合

If you need you can connect a Drone Agent to another Drone Agent, and it is very easy.

Drone エージェントが他の Drone エージェントへ接続する必要がある場合でもとても簡単です。

To perform the double proxy you must configure Drone Agent which can connect to Pandora FMS Server setting server_ip to Pandora FMS IP address, proxy_mode to 1 and the other parameters if you need.

2段プロキシを実現するには、Pandora FMS サーバへ接続できる Drone エージェントにて server_ip を Pandora FMS の IP アドレス、proxy_mode を 1 に設定します。その他パラメータは必要に応じて設定します。

To configure the second Drone Agent just set server_ip to first Drone Agent and of course enable the proxy mode by setting proxy_mode to 1.

2つ目の Drone エージェントの設定では、server_ip を 1つ目の Drone エージェントの IP アドレスに設定し、もちろんプロキシモードを有効にするために proxy_mode を 1 に設定します。

With this configuration, an agent connected to the second Drone Agent can send data to Pandora FMS Server through the two proxies.

この設定で、2つ目の Drone エージェントに接続したエージェントが、Pandora FMS サーバへ 2つのプロキシを通してデータを送信できるようになります。

ブローカーモード

Broker mode is designed to "recreate" diferent agents (as entity) from a single software agent installed in a server. Broker agent execute different setups, like if it has different personalities or different agents installed in the same server with different configurations. Each configuration file is independent and can have it's own plugins, inventory modules, etc. Of course it can be remotely managed, as any other agent. This is perfecto to monitor servers / comm devices nearby the Broker mode, and useful when you cannot reach a router but can install an agent in a nearby host. You can for example, monitor ten routers from a single agent, and have eleven agents in your Pandora FMS console (10 routers + 1 host).

ブローカーモードは、サーバにインストールされた一つのソフトウエアエージェントから、異なるエージェントを "再生成" するために設計されています。ブローカーエージェントは、異なる設定で同一サーバに複数インストールされたエージェントのように、異なる処理を行います。それぞれの設定ファイルは独立しており、インベントリモジュールなど、それぞれ別のプラグインを持つことができます。もちろん、他のエージェントと同様に、リモートからの管理もできます。これにより、サーバやネットワークデバイスを完全にモニタリングできます。また、監視サーバから監視対象ルータに接続できないが、接続可能なホストにエージェントのインストールが可能といった場合に便利です。たとえば、一つのエージェントで 10台のルータを監視することができ、Pandora FMS コンソールには 11 のエージェント(10台のルータと 1台のホスト)として表示されます。

Is important to note that in the configuration of the agent set like a broker agent the broker_agent token will be ignored.

ブローカーエージェント自身の設定内では、broker_agent の記述は無視されることに注意してください。

Modify your pandora_agent.conf with following lines:

pandora_agent.conf を次のように編集します。

broker_agent router_1
broker_agent router_2
broker_agent router_3

Automatically (in next execution or restart) you will have three new files: 'router_1.conf', 'router_2.conf' y 'router_3.conf', will be an exact copy from origial "pandora_agent.conf" file, excepting "agent_name" which will be selected from broker_agent call.

自動的に、'router_1.conf'、'router_2.conf' および 'router_3.conf' という新たなファイルが、"agent_name" の設定を除き、オリジナルの "pandora_agent.conf" ファイルのコピーにて作成されます。

You now have four agents, with different configuration files, you can now add different modules in each configuration file, for example, edit “router_1.conf” and add:

異なる設定ファイルで 4つのエージェントが存在することになり、それぞれの設定ファイルに異なるモジュールを追加できるようになります。例えば、"router_1.conf" を編集し以下を追加します。

Sample of remote check

リモートチェック例

module_begin
module_name Check SSH Status
module_type generic_proc
module_tcpcheck 192.168.1.1
module_port 22
module_timeout 5
module_end

This feature is available since 4.0 version.

この機能は、バージョン 4.0 から実装されています。