エンドポイント設定
エンドポイントとは?
They are small pieces of software that are installed in the operating systems and remain running on them to extract monitoring information and regularly send it to the Pandora FMS Data server, which processes and stores it in the database.
OS にインストールされ、監視情報を抽出して Pandora FMS (のデータを処理して DB へ保存する)データサーバへ定期的に送信するための小さなソフトウエアです。
エンドポイント設定概要
The operation of the EndPoint (operation parameters and modules) is determined by its configuration file.
エンドポイントの動作 (動作パラメータとモジュール) は、その設定ファイルによって決定されます。
- On MS Windows®:
- MS Windows® の場合:
%ProgramFiles%\pandora_agent\pandora_agent.conf
- On Linux® systems:
- Linux® システムの場合
/etc/pandora/pandora_agent.conf
エンドポイントの一般的なパラメータ
Most of the parameters are common for MS Windows® and Linux® systems. After having modified any general parameter, you must restart the EndPoint.
パラメータのほとんどは、MS Windows® および Linux® システムで共通です。 一般パラメータを変更した後は、エンドポイントを再起動する必要があります。
The EndPoint configuration file encoding is UTF-8 on both Linux® and MS Windows® systems.
エンドポイント設定ファイルのエンコードは、Linux® システムと MS Windows® システム共に UTF-8 です。ただし、日本語 Windows の場合は Shift_JIS の利用を推奨します。
The first time data is received from the EndPoint, all the information is saved in the database. For successive information submissions (and depending on whether the learning mode is enabled) only the following fields of the XML will be updated: version
, timestamp
(date) and os_version
(operating system version), as well as the following configuration file parameters gis_exec
, latitude
, longitude
, altitude
, parent_agent_name
, timezone_offset
, address
, custom_field
.
エンドポイントから初めてデータを受信すると、すべての情報がデータベースに保存されます。 連続した情報の送信では (学習モードが有効かどうかに応じて)、XML の次のフィールドのみが更新されます: version
、timestamp
(日付) および os_version
(オペレーティングシステムのバージョン)、また、次の設定ファイルパラメータ: gis_exec
、latitude
、longitude
、altitude
、parent_agent_name
、timezone_offset
、address
、custom_field
server_ip
データを保持する Pandora FMS サーバのホスト名もしくは IP アドレスを設定します。
server_path
Route of the server where it receives the data files sent by the agents and EndPoints. By default:
エージェントおよびエンドポイントから送られるデータを受け取るサーバのディレクトリパスを設定します。デフォルトは以下の通りです。
/var/spool/pandora/data_in
temporal
Path where the EndPoint stores the data files before they are sent to the server and deleted locally.
エンドポイントがサーバにデータを送信する前にローカルで利用するフォルダのパスを設定します。
description
Send the description of the EndPoint in the XML, and Pandora FMS imports this description when it creates the Logical Agent.
XML でエンドポイントが送る「説明」を設定します。Pandora FMS はエージェントを作成する時に、この「説明」を取り込みます。
group
エージェントが所属するグループ名を設定します。このパラメータで指定された名前のグループがある場合、サーバが特定のグループにエージェントを作成するようにしていなければ、指定したグループ内にエージェントが作成されます。
temporal_min_size
If the free space (in megabytes) of the partition where the temporary directory is located is less than this value (by default one megabyte), the generation of data packets is stopped. This prevents the disk from filling up if for some reason the connection to the primary and/or secondary PFMS server is lost for an extended interval of time.
テンポラリディレクトリのパーティション空き容量がここで指定したサイズ (MB 単位) より小さくなったら、データパケットの生成を停止します。 (デフォルトは 1MB) 何らかの理由でプライマリおよびセカンダリの Pandora FMS サーバへの接続が長時間切れた場合に、ディスクがいっぱいになるのを避けます。
In the Pandora FMS event view you will be able to know in a timely manner if a Software Agent, whatever the cause, has stopped delivering data to its main and/or secondary PFMS server, since in these cases its status becomes UNKNOWN
. See also, if desired, the creation of alert conditions.
In this particular example with four days offline, monitoring data will be saved until only 1 megabyte (or the value you set) of free disk space is left.
Pandora FMS イベント表示で、原因が何であれ、ソフトウェアエージェントがメインおよびセカンダリ Pandora FMS サーバへのデータ配信を停止したかどうかをタイムリーに知ることができます。この場合、その状態は 不明
になります。必要に応じて、アラート条件の作成も参照してください。
4日間オフラインのこの例では、1メガバイト(または設定した値)の空きディスク容量が残るまで、監視データが保存されます。
Because of the above, you should always keep in mind that when the Software Agent finally connects to its primary and/or secondary PFMS server, the amount of accumulated data may overload the PFMS data server.
上記の理由により、ソフトウェアエージェントが改めてプライマリおよびセカンダリ Pandora FMS サーバに接続するときに、蓄積された量のデータでPandora FMS データサーバの高負荷が発生する可能性があることに注意が必要です。
temporal_max_size
Maximum size (in megabytes) allowed for the XML buffer, default value 1024
.
XML バッファの最大サイズ(メガバイト)です。デフォルトは 1024
です。
See also temporal_min_size
.
temporal_min_size
も確認してください。
temporal_max_files
Maximum number of files allowed for the XML buffer, default value 1024
.
XML バッファの最大ファイル数です。デフォルトは 1024
です。
See also temporal_min_size
.
temporal_min_size
も確認してください。
logfile
Route of the log of the Pandora FMS EndPoint.
Pandora FMS エンドポイントのログファイルのパスです。
interval
エージェントの秒単位のデータ収集間隔です。この間隔でエージェントは情報を収集し、Pandora FMS サーバへ送ります。
disable_logfile
このパラメータは、pandora_agent.log へのログ出力を無効化します。Windows のみ。
debug
If it is active (1
), a copy of the XML file sent by the EndPoint to the server will be saved in the temporary directory and these will be stored, thus being able to open the XML files and analyze their content.
有効化 (1
) すると、エンドポイントからサーバに送信された XML ファイルのコピーが一時ディレクトリに保存され、XML ファイルを開いてその内容を分析できるようになります。
In EndPoints for MS Windows® a file called pandora_debug.log
will be created with the result of the EndPoint executions and the XML sending.
MS Windows® 用のエンドポイントでは、エンドポイントの実行と XML 送信の結果が記録された pandora_debug.log
というファイルが作成されます。
In EndPoints for Linux® the information described above will be added to the agent's own log file (pandora_agent.log
).
Linux® 用のエンドポイントでは、上記の情報がエージェント独自のログファイル (pandora_agent.log
) に追加されます。
- A EndPoint with active remote configuration and with the
debug
mode active will not take the changes made in the agent configuration file in the Pandora FMS Web console. - It is recommended to run the
debug
mode active for a short time as the XML remains stored and takes up space quickly.
- リモート設定が有効で、
debug
モードが有効なエンドポイントは、Pandora FMS コンソールのエージェント設定ファイルに加えられた変更を受け入れません。 - XML は保存されたままになり、すぐにスペースを占有するため、
debug
モードを有効にしての実行は短時間にすることをお勧めします。
agent_name
Allows you to set a custom name. If not enabled, the name of the agent receiving data from the EndPoint will be the host name of the monitored machine.
カスタム名を設定できます。設定していない場合、エンドポイントからデータを受信するエージェントの名前は、監視対象マシンのホスト名になります。
agent_name_cmd
Defines the name of the Agent that receives data from the EndPoint using an external command. If agent_name_cmd
is defined, agent_name
is ignored. The command should return the name of the agent by STDOUT. If it returns more than one line, only the first one will be used.
外部コマンドを使用してエンドポイントからデータを受信するエージェントの名前を定義します。agent_name_cmd
が定義されている場合、agent_name
は無視されます。コマンドは 標準出力 にエージェント名を返す必要があります。複数行が返された場合、最初の行のみが使用されます。
agent_alias_cmd
Defines the alias of the Agent that receives data from the EndPoint using an external command. If agent_alias_cmd
is defined, agent_alias
is ignored. The command should return the name of the agent by STDOUT. If it returns more than one line, only the first one will be used.
外部コマンドを使用してエンドポイントからデータを受信するエージェントの別名を定義します。agent_alias_cmd
が定義されている場合、agent_alias
は無視されます。コマンドは 標準出力 でエージェント名を返す必要があります。複数行を返す場合は、最初の行のみが使用されます。
address
IP address or domain name associated with the EndPoint. If set to auto
, the machine's IP address will be obtained and added to the agent as the primary address.
エンドポイントに関連付けられたIPアドレスまたはドメイン名。auto
に設定すると、マシンの IP アドレスが取得され、エージェントにプライマリアドレスとして追加されます。
encoding
ISO-8859-15 や UTF-8 のように、システムのエンコーディングの種類を設定します。
server_port
このパラメータは、リモートのサーバの待ち受けポートの設定です。Tentacle のデフォルトは 41121 です。
transfer_mode
このパラメータには、エージェントからサーバへデータを送信するための方法を設定します。デフォルトは Tentacle です。
transfer_timeout
バージョン 6.0 以上
データ転送プログラムの実行タイムアウトを秒単位で指定します。設定されていない場合のデフォルトは 30 です。
server_pwd
Windows の FTP もしくは Tentacle 転送モードのパスワードを設定します。Tentacle モードの場合はパスワードは必須ではありません。このパスワードでサーバでの認証を行います。
server_ssl
It specifies the Tentacle transfer mode. Allows to enable ( yes
) or disable ( no
) SSL network encryption. Learn more about Tentacle safe communication in this section.
Tentacle の転送モードを設定します。SSL による暗号化を有効化(yes
)または、無効化(no
)できます。Tentacle の暗号化通信については、こちらの章も参照してください。
server_opts
Tentacle の転送モードを設定します。Tentacle クライアントの拡張設定のために渡す、追加パラメータを設定します。
バージョン 3.2 以降のエージェントでは、tentacle がサーバへデータを送信するのに HTTP プロキシをサポートしています。プロキシを利用するには、つぎのような拡張オプションを使います。
server_opts "-y user:pass@proxy.inet:8080"
この例では、tentacle クライアントがポート 8080、ユーザ “user”、パスワード “pass” でプロキシ 'proxy.inet' に接続します。プロキシサーバが 192.168.1.2 で、ポート番号が 9000、また、認証が無い場合は次のようにします。
server_opts "-y 192.168.1.2:9000"
delayed_startup
Disabled by default. Waiting time (seconds or minutes) until the EndPoint starts running after it starts. For all EndPoints except on MS Windows®.
デフォルトでは無効です。 エンドポイント起動後、処理を開始するまでの待ち時間(秒 または 分)です。MS Windows 以外のエンドポイントで利用できます。
startup_delay
Disabled by default. Waiting time, in seconds, until the EndPoint starts running after it starts. For MS Windows® only.
デフォルトでは無効です。エンドポイントが起動してから実行を開始するまでの待機時間(秒単位)。MS Windows®のみ。
pandora_nice
It is only available for Unix/Linux EndPoints. This parameter allows you to specify the priority that the Pandora FMS Agent process will have in the system.
Unix/Linux エンドポイントでのみ利用可能です。このパラメータは、Pandora FMS エージェントプロセスのシステム内での優先度を指定します。
autotime
If enabled (1
) it sends a special execution timestamp (AUTO) that causes the server to use the server's local date and time to set the time of the data, ignoring the time sent by the EndPoint. This is necessary for EndPoints that, for whatever reason, have an incorrect or very different time from the server.
有効(1
)の場合、特別な実行タイムスタンプ(AUTO)が送信されます。これにより、サーバーはエンドポイントから送信された時刻を無視し、サーバのローカル日時を使用してデータの時刻を設定します。これは、何らかの理由でエンドポイントの時刻がおかしかったり、サーバの時刻と大きくずれている場合に利用します。
cron_mode
With this parameter it is possible to make the EndPoint use the Linux® crontab to run at a certain interval instead of using the EndPoint's own internal system to run from time to time. Off by default (0
).
このパラメータを有効にすると、エンドポイントをそれ自身の実行の仕組みではなく、Linux の crontab から指定した時刻に実行できるようになります。デフォルトでは無効(0
)になっています。
remote_config
It enables (1
) or disables (0
) EndPoint remote configuration. Its operation is only allowed with the Tentacle transfer mode.
エンドポイントのリモート設定を有効( 1
)または無効( 0
)にします。この操作は Tentacle 転送モードでのみ利用できます。
By enabling remote configuration, any change not made from Pandora FMS console will be discarded and overwritten.
リモート設定を有効にすると、Pandora FMS コンソールから行われなかった変更はすべて破棄され、上書きされます。
xml_buffer
If enabled ( 1
), the EndPoint will save in its temporary directory the XML files that it has not been able to send to the server in case of a connectivity problem. They will be sent when communications are restored.
有効化( 1
)すると、エンドポイントは接続障害等でサーバに XML ファイルを送信できなかったとき、それをテンポラリディレクトリに保存します。それらは、通信が復旧したときに送られます。
timezone_offset
The EndPoint may well install its timezone offset with the server. This allows the server to offset the time collected by the EndPoint 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 EndPoint's time zone from the server's time zone.
これは、エンドポイントのタイムゾーンからサーバのタイムゾーンを引いて計算されます。
parent_agent_name
Indicates the father of the EndPoint. It must be the name of an existing Agent in Pandora FMS.
エンドポイントの親を指定します。Pandora FMS に存在するエージェント名である必要があります。
agent_threads
Only available for Unix/Linux EndPoint: Number of threads that the EndPoint will launch to execute modules in parallel. By default, Modules are executed one after the other without launching any additional threads. Example:
Unix/Linuxエンドポイントのみで使用可能:エンドポイントがモジュールを並列実行するために起動するスレッド数。デフォルトでは、モジュールは追加のスレッドを起動することなく、順番に実行されます。例:
# Number of threads to execute modules in parallel agent_threads 4
include
include <file>
It allows to include an additional configuration < file >
. This file can contain additional modules and collections alongside the ones found in the main configuration file. This token is optional. The file can be uploaded by those users with (AW
) Agent writing Profiles_in_Pandora_FMS.
別の設定 <ファイル>
をインクルードすることができます。このファイルには、メインの設定ファイルに加えて追加のモジュールや収集を含めることができます。これはオプションです。ファイルのアップロードには、ユーザにエージェント書き込み(AW)のプロファイル が必要です。
broker_agent
broker_agent < broker_name >
It enables broker agent feature. To activate it, you only need to uncomment the parameter and indicate the name (< broker_name >
) that will be assigned to the broker agent.
ブローカーエージェント機能を有効化します。有効化するにはパラメータのコメントを外し、ブローカーエージェントに割り当てる名前 (< broker_name >
) を指定する必要があるだけです。メインの設定ファイルに記載したブローカーエージェントの名前で新たな設定ファイルが生成されます。この設定はメインのエージェントでのみ利用でき、作成された新たなエージェント設定内では利用できません。
pandora_user
pandora_user <user>
This parameter is optional and will allow you to run the Agent as the system user (<user>
) that you specify. This user must have the permissions to be able to execute the EndPoint and its associated resources.
このパラメータはオプションで、システムの特定のユーザ (<user>
) でエンドポイントを実行させるためのものです。指定するユーザは、エンドポイントの実行権限等を持つ必要があります。
custom_id
EndPoint custom identifier for external applications.
外部アプリケーションのための、エンドポイントのカスタム ID です。
url_address
コンソールでエージェントから開くカスタム URL です。
custom_fieldX_name
システムに設定済のエージェントのカスタムフィールド名です。存在しない場合は無視されます。
例:
custom_field1_name Model
custom_fieldX_value
前述のパラメータで定義されたカスタムフィールド X の値です。
例:
custom_field1_value C1700
module_macro
EndPoint for Unix/Linux®.
Unix/Linux® 用エンドポイント
module_macro<_macro_name_ > < value >
Defines a local execution macro that can be used in the definition of a Module. These macros are used in the Command Center (Metaconsole) system and in the local Module component system to “abstract” the difficulty of using a Module by directly editing the code, presenting a less advanced user with a local interface that allows “filling” values. These values are used underneath, using a macro system, relatively similar to the local plugins macro system.
モジュールの定義で利用可能なローカル実行マクロを定義します。これらのマクロは、コマンドセンター(メタコンソールシステム)とローカルモジュールコンポーネントシステムで使用され、コードを直接編集することで難しくなるモジュール定義を「抽象化」し、高度なユーザに値を「入力」できるローカルインターフェイスを提供します。 これらの値は、ローカルプラグインのマクロシステムに比較的似たマクロシステムを使用して、以下のように使用できます。
Local execution macros start by _fieldx_
.
_fieldx_
で始まるローカル拡張マクロ。
Example:
例:
module_begin module_name Particion_opt module_type generic_data module_exec df -kh _field1_ | tail -1 | awk '{ print $5}' | tr -d "%" module_macro_field1_ /opt module_end
group_password
group_password <password>
Password for the EndPoint group. If the group is not password protected you should leave this line as a comment.
エンドポイントグループのパスワード。グループがパスワードで保護されていない場合は、この行をコメントアウトした状態にしてください。
ehorus_conf
ehorus_conf <path>
Absolute path (path) to a valid configuration file of a eHorus agent. The Agent will create a custom field called eHorusID
that contains the identification key of the eHorus agent.
eHorus エージェントの有効な設定ファイルへの絶対パス(パス)。エージェントは、eHorus エージェントの識別キーを含む eHorusID
というカスタムフィールドを作成します。
transfer_mode_user
transfer_mode_user <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
です。
secondary_groups
secondary_groups <group name1>, <group name2>, ... <group nameN>
エージェントに割り当てるセカンダリグループ名です。複数のセカンダリグループをカンマ区切りで指定できます。サーバ上に存在しないグループを指定した場合はグループは割り当てられませんが、エージェントの作成には影響ありません。
standby
standby <1|0>
If an EndPoint has standby mode enabled ( standby 1
), the EndPoint will not perform any checks or send or generate any XML. Thanks to this, an EndPoint can be silenced at will simply by disabling it.
エンドポイントがスタンバイモード( standby 1
)を有効にすると、エンドポイントはいかなるチェックも実行せず、XMLの送信や生成も行いません。これにより、エンドポイントを無効にするだけで、任意のタイミングでサイレント状態にすることができます。
Debug mode overrides this functionality and the Agent runs normally.
デバッグモードの場合はこの機能を上書きし、エージェントは通常動作をします。
module_absoluteinterval
module_absoluteinterval <interval>[s,m,h,d]
module_absoluteinterval once
It specifies the execution interval for the module, but unlike module_interval:
モジュールの実行間隔を指定しますが、module_interval とは異なります。
- Remember the last run date when the EndPoint is restarted. The module will not run until the specified interval goes by.
- It allows you to specify the interval in seconds, minutes, hours or days (e.g.,
30s
,5m
,1h
,7d
). - It is possible to configure modules to be executed only once by specifying
once
as the interval value.
- エンドポイントを再起動するときに、最後の実行日を記憶します。 モジュールは、指定された間隔が経過するまで実行されません。
- 間隔を秒、分、時間、または日単位で指定できます (例:
30s
、5m
、1h
、7d
)。 - 間隔値として
once
を指定することで、モジュールが 1 回だけ実行されるように設定できます。
セカンダリサーバ
データを送信するセカンダリサーバを設定することができます。設定により二種類の動作モードがあります。
- on_error: プライマリサーバにデータを送信出来なかった場合のみ、セカンダリサーバにデータを送信します。
- always: プライマリサーバにデータが送信できるかどうかに関わらず、常にセカンダリサーバにもデータを送信します。
UDP サーバ
Keep in mind that UDP is by nature insecure (but efficient at sending messages without compromising a certain response).
UDPは本質的に安全ではないことに注意してください(ただし、応答を必須としないメッセージを送信するには効率的です)。
The Pandora FMS EndPoint can be configured to listen to remote commands. This server listens on a UDP port specified by the user, and allows receiving orders from a remote system, usually from the Pandora FMS Console, by executing alerts on the server.
Pandora FMS エンドポイントは、 リモートからコマンドを受け取る設定ができます。このサーバは、ユーザが指定した UDP のポートで待ち受けており、アラートが発生したときに何らかのコマンドを実行するなど、リモートシステム (基本的には Pandora FMS) から命令を受け取ることができます。
To configure the remote UDP server, there are the following options in your file or configuration pandora_agent.conf
:
リモート UDP サーバを設定するには、ファイルまたは設定 pandora_agent.conf
に次のオプションがあります。
- udp_server: To activate the UDP server set the value to
1
. By default it is disabled. - udp_server_port: Listening port number.
- udp_server_auth_address: IP addresses authorized to send orders. To specify multiple addresses, separate them by commas. If set to 0.0.0.0, it accepts commands from any address.
- udp_server:UDP サーバを有効にする場合は
1
を設定します。デフォルトでは無効です。 - udp_server_port: 待ち受けポート番号を設定します。
- udp_server_auth_address: 命令の送信を許可する IPアドレスを設定します。カンマ区切りで複数のアドレスを指定できます。0.0.0.0 に設定すると、UDP サーバはすべてのアドレスからのリクエストを受け付けます。
Although 0.0.0.0 can be set to accept from all sources, such a practice is not recommended. If you have several PFMS Servers and/or use IPv6 you can put different IP addresses separated by commas. For example if you have in IPv6:2001:0db8:0000:130F:0000:0000:087C:140B
and its abbreviation is 2001:0db8:0:130F::87C:140B
use both separated by commas.
すべてのソースからのコマンド受け入れのために 0.0.0.0 に設定できますが、この方法はお勧めしません。複数の Pandora FMS サーバがある場合、または IPv6 を使用している場合は、カンマで区切って異なる IP アドレスを追加できます。たとえば、 IPv6:2001:0db8:0000:130F:0000:0000:087C:140B
があり、その省略形が 2001:0db8:0:130F::87C:140B
の場合は、両方をカンマで区切って指定します。
- process_<name>_start <command>: Command that will start a process defined by the user.
- process_<name>_stop <command>: Command that will stop the process.
- service_<name> 1: Allows service <name> to be stopped or started remotely from the UDP server.
- process_<name>_start <command>: ユーザ定義プロセスを起動するコマンドを設定します。
- process_<name>_stop <command>: プロセスを停止するコマンドを設定します。
- service_<name> 1: リモートから停止や起動ができるサービス名 <name> を設定します。
There is a script on the server, in /util/udp_client.pl
which is used by Pandora FMS Server as an alert command, to start processes or services. It has this syntax:
サーバ上の /util/udp_client.pl
には、Pandora FMS サーバがプロセスやサービスを起動するためのアラートコマンドとして利用するスクリプトがあります。構文は以下のとおりです。
./udp_client.pl <address> <port> <command>
モジュール定義
The local execution modules are defined in the configuration file pandora_agent.conf
. The general syntax is as follows:
設定ファイル pandora_agent.conf
にてローカルモジュールの実行を定義します。利用可能な全パラメータを以下に説明します。一般的な書式は次の通りです。
module_begin module_name <モジュール名> module_type generic_data module_exec <実行するローカルコマンド> module_end
全モジュールで共通の項目
モジュールのフィールド情報はモジュール作成時にのみ反映されます(モジュールデータ、説明、拡張情報を除く)。モジュールがすでに存在する場合は更新されません。
module_begin
モジュール定義の開始を示す、必須項目です。
module_name
module_name <name>
Name (<name>
) of the Module. Said name must be unique and singular in the EndPoint. Required.
モジュールの名前 (<name>
)。この名前はエンドポイント内で一意でなければなりません。必須。
module_type
module_type <タイプ>
Type (type) of data that the Module will return. Required. The types available are:
モジュールが返すデータタイプです。いずれか一つを選択することが必須です。指定可能なデータタイプは次の通りです。
- Numeric (
generic_data
): Single, floating point, or integer numeric data. - Incremental (
generic_data_inc
): Numeric data equal to the difference between the current value and the previous value divided by the number of seconds elapsed. When this difference is negative, the value is reset, this 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 absolute (
generic_data_inc_abs
): Numeric data equal to the difference between the current value and the previous value, without dividing by the number of seconds elapsed, to measure total increment instead of increment per second. When this difference is negative, the value is reset, this means that when the difference becomes positive again, the last value from which the current increment obtained is positive will be used. - Alphanumeric (
generic_data_string
): Returns alphanumeric text strings. - Booleans (
generic_proc
): For values that can only be correct or affirmative (1) or incorrect or negative (0). Useful to check if a computer is alive, or a process or service is running. A negative value (0) is pre-assigned to the critical state, while any higher value will be considered correct. - Asynchronous alphanumeric (
async_string
): For asynchronous text strings. Asynchronous monitoring depends on events or changes that may or may not occur, so this type of Module is never in an unknown state. - Async Boolean (
async_proc
): For boolean values of async type. - Asynchronous Numeric (
async_data
): For numeric values of asynchronous type.
- Numerical (generic_data): 小数または整数の数値データです。小数値の場合は整数に切り捨てられます。
- Incremental (generic_data_inc): 前の値と現在の値の差分を間隔の時間で割ったデータです。差分がマイナスの場合は値はリセットされます。これは、差分は再びプラスになること、増分がプラスの値である限りは前のデータとの差が利用されることを意味します。
- Incremental absolute (generic_data_inc_abs): 前の値と現在の値の差分データです。絶対的な差分の値であり、単位時間あたりの差分ではありません。差分がマイナスの場合は値はリセットされます。差分が再びプラスになった場合はベースの値として利用され、そこから差分が計算されます。
- Alphanumeric (generic_data_string): 文字列です。
- Booleans (generic_proc): 正常(1)または異常(0)をとる値です。コンピュータが動いているか、プロセスやサービスが動いているかどうかのチェックに便利です。異常値(0)には障害状態があらかじめ設定されています。それよりも大きい任意の値(1より大きい数字も扱えます)は正常と判断されます。
- Asynchronous Alphanumeric (async_string): (定期実行ではない)非同期の文字列収集に使います。非同期監視は、任意のタイミングで発生するイベントや変更に依存するため、このタイプのモジュールは不明状態にはなりません。
- Async Boolean (async_proc): generic_proc と似ていますが、非同期のデータタイプです。
- Asynchronous Numeric (async_data): generic_data と似ていますが、非同期のデータタイプです。
module_min
module_min <値>
そのモジュールが返すことを許容されるデータの最小値です。範囲を外れたデータはサーバにより削除されます。
module_max
module_max <値>
そのモジュールが返すことを許容されるデータの最大値です。範囲を外れたデータはサーバにより削除されます。
module_min_warning
module_min_warning <値>
モジュールが警告状態になる最小値です。
module_max_warning
module_max_warning <値>
モジュールが警告状態になる最大値です。
module_min_critical
module_min_critical <値>
モジュールが障害状態になる最小値です。
module_max_critical
module_max_critical <値>
モジュールが障害状態になる最大値です。
module_disabled
module_disabled <値>
モジュールが、有効(0)か無効(1)かを表します。
module_min_ff_event
module_min_ff_event <値>
連続抑制回数を指定します。連続抑制回数とは、収集データに揺らぎがあるような場合に、それを変化としてとらえないように抑止するものです。
module_each_ff
module_each_ff <0|1>
有効化(1)すると、module_min_ff_event の代わりに連続抑制回数に個別状態変化(module_min_ff_event_normal, module_min_ff_event_warning および module_min_ff_event_critical)を利用します。
module_min_ff_event_normal
module_min_ff_event_normal <値>
個別状態変化で、正常状態へ移行する場合の連続抑制回数です。
module_min_ff_event_warning
module_min_ff_event_warning <値>
個別状態変化で、警告状態へ移行する場合の連続抑制回数です。
module_min_ff_event_critical
module_min_ff_event_critical <値>
個別状態変化で、障害状態へ移行する場合の連続抑制回数です。
module_ff_timeout
module_ff_timeout <秒>
指定した秒数が経過したら連続抑制回数のカウンターをリセットします。これは、module_min_ff_event に指定した抑制回数の状態変化が module_ff_timeout に指定の秒数以内に発生する必要があることを意味します。
module_ff_type
module_ff_type <値>
これは、連続抑制の高度なオプションで、モジュールの状態を制御します。 “カウンタを保持する” ことによって、値の代わりに、受け取った値を持つモジュールの状態に応じて、ある状態から別の状態に渡すカウンタ値をいくつか設定します。
有効(1)か無効(0)かを指定します。
module_ff_event
module_ff_event X
This is the flip flip execution threshold of the module (in seconds).
これは、モジュールの連続抑制実行のしきい値(秒単位)です。
module_description
module_description <テキスト>
モジュールの任意のコメントです。
module_interval
module_interval <間隔倍率>
Individual Modulo interval. This value is a multiplying factor of the EndPoint interval, not a free time.
個別のモジュールの間隔。この値はエンドポイント間隔の乗数であり、空き時間ではありません。例えば、エンドポイントが 300 (5 分)間隔の設定であった場合に、あるモジュールだけ 15分間隔にしたいときに、module_interval 3 を設定します。そのモジュールは、300秒 x 3 = 900秒 (15分) 間隔で実行されます。
For the module_interval
to work on Broker Agents, it must have the same interval as the Agent from which it comes. Otherwise, it may fail to function. As of version 776 the broker agent interval field in the Web Console has been removed.
ブローカーエージェントで module_interval
が機能するには、そのモジュールの元エージェントと同じ間隔にする必要があります。そうでない場合、機能しない可能性があります。バージョン776以降、Webコンソールのブローカーエージェント間隔フィールドは削除されました。
module_timeout
module_timeout <秒数>
In seconds, maximum time allowed for the execution of the Module. If this time is exceeded before having completed its execution, it will be interrupted. This instruction must be located between the module_begin
and module_end
instructions.
モジュールの最大実行時間を秒単位で指定します。実行中にこの時間を超過した場合は、実行が中止されます。この設定は、module_begin
と module_end
の間に配置する必要があります。
module_postprocess
module_postprocess <倍率>
モジュールから返される値を何倍するかの値です。データの単位を変換するのに便利です。もし、エージェントが取得した値に 1024 を掛けたい場合は、1024 を設定します。また、1024 で割りたい場合は、1/1024 を意味する 0.000976563 を設定します。
module_save
module_save <変数名>
このパラメータで定義された名前の変数にモジュールから返された値を保存します。この値はあとから他のモジュールで利用できます。
例:
module_begin module_name echo_1 module_type generic_data module_exec echo 41121 module_save ECHO_1 module_end
“ECHO_1” という変数に、値 41121 を保存します。
module_begin module_name echo_2 module_type generic_data module_exec echo $ECHO_1 module_end
2つ目のモジュールでは、“$ECHO_1” という変数の内容を表示します。“41121” となります。
In EndPoints on Windows® the Module syntax must be formed by enclosing the variable in percentage symbols %var%
instead of $var
. Following the given example:
Windows® 上の EndPoints では、変数を $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 the order they'll be executed on a specific date. To do this, you're required to define the module_crontab', using a similar format to that of the crontab file:
バージョン 3.2 から、モジュールを指定した日時に実行させるようにすることができます。この設定は、module_crontab にて、crontab ファイルに似た設定を行うことにより実現します。
module_crontab <分> <時間> <日> <月> <曜日>
指定可能な範囲は次の通りです。
- 分 0-59
- 時間 0-23
- 日 1-31
- 月 1-12
- 曜日 0-6 (0 が日曜です)
期間を指定する - を利用することも可能です。
例えば、あるモジュールを毎週月曜の 12時から 15時の間に実行するには、次のような設定をします。
module_begin module_name crontab_test module_type generic_data module_exec script.sh module_crontab * 12-15 * * 1 module_end
コマンドを毎時 10分に実行したい場合は、次のようにします。
module_begin module_name crontab_test3 module_type generic_data module_exec script.sh module_crontab 10 * * * * module_end
module_condition
module_condition <評価式> <コマンド>
バージョン 3.2 から、モジュールが特定の値を返す場合にコマンドを実行させることが可能です。次に示すオプションの一つを定義します。
- > [値]: モジュールの値が指定された値よりも大きい場合にコマンドを実行します。
- < [値]: モジュールの値が指定された値よりも小さい場合にコマンドを実行します。
- = [値]: モジュールの値が指定された値と同じ場合にコマンドを実行します。
- != [値]: モジュールの値が指定された値と異なる場合にコマンドを実行します。
- =~ [正規表現]: モジュールの値が指定された正規表現にマッチする場合にコマンドを実行します。
- ( 値, 値): モジュールの値が指定された値の範囲の場合にコマンドを実行します。
同一のモジュールに複数の条件を設定することも可能です。以下の例では、モジュールの値が 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
例:
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
- 注意: 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
module_precondition <評価式> <コマンド>
事前状態定義にマッチした場合モジュールを実行します。次に示すオプションの一つを定義します。
- > [値]: コマンドの実行結果が指定された値よりも大きい場合にモジュールを実行します。
- < [値]: コマンドの実行結果が指定された値よりも小さい場合にモジュールを実行します。
- = [値]: コマンドの実行結果が指定された値と同じ場合にモジュールを実行します。
- != [値]: コマンドの実行結果が指定された値と異なる場合にモジュールを実行します。
- =~ [正規表現]: コマンドの実行結果が指定された正規表現にマッチする場合にモジュールを実行します。
- ( 値, 値): コマンドの実行結果が指定された値の範囲の場合にモジュールを実行します。
以下の例では、precondition で設定した実行結果が 2 と 8 の間の場合に、モジュール monitoring_variable.bat が実行されます。この例では module_precondition の実行結果が 5 であるため、値が 2 と 8 の間であり、monitoring_variable.bat が実行されます。
module_begin module_name Precondition_test1 module_type generic_data module_precondition (2, 8) echo 5 module_exec monitoring_variable.bat module_end
module_condition と同様に、複数の事前状態定義を利用することができます。モジュールは、すべての事前状態定義にマッチした場合のみ実行されます。
module_begin module_name Precondition_test2 module_type generic_data module_precondition (2, 8) echo 5 module_precondition <3 echo 5 module_exec monitoring_variable.bat module_end
- 注意: Windows プラットホームでは、コマンドの実行にはそれが正しく実行されていることを確認するために cmd.exe /c を利用することをお勧めします。例えば次の通りです。
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
module_unit
module_unit <単位>
これは、モジュールの値に付与する単位です。
例:
module_unit %
module_group
module_group <値>
これは、モジュールグループ名です。
例:
module_group Networking
module_custom_id
module_custom_id <値>
モジュールのカスタム ID です。
例:
module_custom_id host101
module_str_warning
module_str_warning <値>
文字列タイプのモジュールで警告状態を定義する正規表現です。
例:
module_str_warning .*NOTICE.*
module_str_critical
module_str_critical <値>
文字列タイプのモジュールで障害状態を定義する正規表現です。
例:
module_str_critical .*CRITICAL.*
module_warning_instructions
module_warning_instructions <値>
モジュールが警告状態に変化したときのオペレータへの指示です。
例:
module_warning_instructions Increase incident priority
module_critical_instructions
module_critical_instructions <値>
モジュールが障害状態に変化したときのオペレータへの指示です。
例:
module_critical_instructions Call to sys department
module_unknown_instructions
module_unknown_instructions <値>
モジュールが不明状態に変化したときのオペレータへの指示です。
例:
module_unknown_instructions Open incident
module_tags
module_tags <値>
カンマ区切りでモジュールに割り当てるタグを指定します。
例:
module_tags tag1,tag2,tag3
module_warning_inverse
module_warning_inverse <値>
警告閾値範囲の反転を有効化(1)します。
例:
module_warning_inverse 1
module_critical_inverse
module_critical_inverse <値>
障害閾値範囲の反転を有効化(1)します。
例:
module_critical_inverse 1
module_native_encoding
On Win32 only.
Win32 のみ
module_native_encoding <値>
この設定トークンは、module_exec によってコマンドラインから実行されるモジュールにのみ影響します。
Windows では、コマンドラインエンコーディング(OEM)、システムエンコーディング(ANSI)および、UTF-16 の 3つのプロセスのエンコーディングがあります。いずれのエンコーディングも通常の文字を扱うことができますが、アクセントを表したものなどいくつかの文字に違いがあります。このトークンにより、Pandora エージェントが設定ファイル(pandora_agent.conf)で指定したエンコーディングに出力を変換します。
module_native_encoding は、次の 4種類の値を設定できます。
- module_native_encoding OEM: コマンドラインエンコーディングに変換
- module_native_encoding ANSI: システムエンコーディングに変換
- module_native_encoding UTFLE: UTF-16 のリトルエンディアンに変換
- module_native_encoding UTFBE: UTF-16 のビッグエンディアンに変換
module_native_encoding の設定が無い場合は、変換は行われません。
module_quiet
module_quiet <値>
If enabled (1
) the module will be in silent mode: it will not generate events nor trigger alerts.
有効化(1
)すると、モジュールは静観モードになります。イベントやアラートを生成しません。
Example:
例:
module_quiet 1
module_ff_interval
module_ff_interval <値>
収集データに揺らぎがあるような場合に、それを変化としてとらえるべきかを判断する期間のデータ収集間隔です。(秒単位)
例:
module_ff_interval 2
module_macro
module_macro<マクロ> <値>
コンソールから、ローカルコンポーネントにのみ適用できます。設定ファイルで直接設定しません。
module_alert_template
module_alert_template <テンプレート名>
このマクロは、パラメータ名(アラートテンプレート 参照)に対応したモジュールにアラートテンプレートを割り当てます。
例:
<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> <data><![CDATA[92]]></data> </module>
intensive_interval
Intensive monitoring interval. Modules using module_intensive_monitorig
can report whether their state is incorrect in this range.
高頻度モニタリング間隔です。module_intensive_monitoring
を設定したモジュールは、障害状態の場合にこの間隔で実行できます。
module_intensive_condition
Condition for intensive monitoring. When an intensive monitoring module reaches the value configured in this parameter, it must notify in the intensive_interval defined.
高頻度モニタリングのための状態です。高頻度監視モジュールがこのパラメータで設定された値に達した場合、intensive_interval で設定した間隔で実行されます。
module_end
モジュール定義の終わりを表します。必須項目です。
情報を取得するためのディレクティブ
In each Module only one of these types can be used.
各モジュールでは、これらのタイプのうち 1 つだけ使用できます。
module_exec
module_exec <コマンド>
The desired execution must be specified to obtain the information in a single line.
1行で情報を取得するコマンドを指定する必要があります。
On Linux, the command will be executed through the default shell. The default interpreter is determined by the symlink of /bin/sh
. Normally the link points to bash, but on systems like Ubuntu it doesn't. A solution that will work in most cases:
Linux では、コマンドはデフォルトのシェルを使って実行されます。デフォルトのシェルは、 /bin/sh
のシンボリックリンクによって決まります。通常は、bash ですが、Ubuntu のシステムでは異なります。ほとんどの場合に機能する解決策:
module_exec bash -c "<command>"
If the execution of the command returns an error code (return code) different from 0, it will be interpreted that the command fails and the data obtained will be discarded.
コマンドの実行により 0 以外の エラーコード (戻り値) が返された場合、コマンドは失敗したと解釈され、取得されたデータは破棄されます。
For a EndPoint on MS Windows® there are more directives to obtain data, these are described below.
Windows エンドポイントでのデータ取得のためのディレクティブは他にもあります。以下に示します。
module_exec_powershell
For MS Windows® only.
MS Windows® のみ。
module_exec_powershell <commands>
Allows you to perform native checks with PowerShell.
PowerShell を使用したネイティブチェック を実行できます。
module_service
module_service <サービス>
指定したサービスが実行中であるかどうかをチェックします。
MS Windows
サービス名にスペースが含まれる場合は、“ ” でくくるのを忘れないようにしてください。
module_begin module_name Service_Dhcp module_type generic_proc module_service Dhcp module_description Service DHCP Client module_end
サービスは、Windows サービスマネージャに表示される短い名前 (サービス名) で識別されます。
非同期モード
Pandora FMS は通常、(モジュールによって定義される)一定の秒間隔にてチェックを実行します (デフォルトでは、300秒 = 5分)。そのため、チェックの直後にサービスがダウンすると、それがダウンであると認識するのに、さらに 300秒かかります。非同期モジュールでは、Pandora に “今すぐ” サービスの障害を通知するようにできます。これは、非同期 操作モードと呼んでいます。非同期モードにするには、以下のディレクティブを設定してください。
module_async yes
この機能は、ブローカーエージェントでは利用できません。
Windows Home Edition では、この非同期機能はサポートされていません。Pandora エージェントはサービスが動作しているかどうかを定期的に確認します。大量のサービスを監視する場合システムリソースを消費するため、同期モードを利用することをお勧めします。
サービスのウォッチドッグ
サービスがダウンしたときに再起動するためのウォッチドッグモードがあります。サービスを起動するためのパラメータは 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
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 on Unix EndPoint.
Unix エンドポイントでは、ウォッチドッグと非同期検出はできません。
For module_service
you must put full path just as you see with command command ps aux
. In example, search for SSH service:
module_service
では、ps aux
で表示されるコマンドのフルパスを指定する必要があります。以下の例では、SSH サービスをチェックします。
ps aux | grep ssh
Configure it:
module_begin module_name MY_SSHD module_type generic_proc module_service /usr/sbin/sshd -D module_description Is sshd running? module_end
module_proc
module_proc <プロセス>
指定した名前のプロセスがいるかどうかをチェックします。
On MS Windows®
MS Windows® の場合
Quotation around the process name is unnecessary. Note that the process name must have the extension .exe
. The Module will return the number of processes that are running with this name.
プロセス名を引用符で囲む必要はありません。プロセス名には拡張子 .exe
が必要です。モジュールは、この名前で実行されているプロセスの数を返します。
以下に cmd.exe プロセスをモニタリングする例を示します。
module_begin module_name CMDProcess module_type generic_proc module_proc cmd.exe module_description Process Command line module_end
Asynchronous mode
非同期モード
In a similar way to services, monitoring processes can be critical in some cases. The EndPoint for Windows® now supports asynchronous checks for the module_proc
parameter. In this case the EndPoint notifies immediately when the process changes state, without waiting for the EndPoint execution interval to expire. In this way, you can find out about the failure of critical processes almost immediately after they occur. This functionality is not supported in Broker Agents.
サービスと同じように、モニタリングしているプロセスにて何らかの原因で障害が発生することがあります。Windows エンドポイントでは、module_proc
モジュールで非同期チェックをサポートしています。この場合、プロセスの状態が変化したとき、通常のモニタリング間隔における次のチェックタイミングを待たずにすぐに 通知されます。これにより、プロセスに障害が発生したのとほぼ同時にそれを知ることができます。以下にプロセスの非同期モニタリング設定の例を示します。
module_begin module_name Notepad module_type generic_proc module_proc notepad.exe module_description Notepad module_async yes module_end
違いは、“module_async yes” が設定されている点です。
Process Watchdog
プロセスのウォッチドッグ
It is important to note that Watchdog mode only works when the module type is asynchronous.
ウォッチドッグモードは、モジュールタイプが非同期の場合にのみ機能することに注意する必要があります。
Since running a process may require some parameters, there are some additional configuration options for these types of modules. Example of configuring a module_proc
with watchdog:
プロセスの実行にはいくつかのパラメータが必要になる場合があるため、これらのタイプのモジュールには追加の設定オプションがあります。ウォッチドッグを使用して 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
For versions prior to Windows Vista®, the token module_user_session
can be configured in a general way by enabling the “Interactive access with desktop” box in the Pandora FMS service properties (Allow service to interact with desktop):
Windows Vista® より前のバージョンでは、Pandora FMS サービスのプロパティで “デスクトップとの対話型アクセス” ボックスを有効にすることで、トークン module_user_session
を一般的な方法で設定できます (サービスがデスクトップと対話できるようにする):
Pandora FMS, as a service, runs under the SYSTEM
account and that the process executed will do so under that user and with that environment, so that if you need to run a specific process that needs to be used with a specific user, you must encapsulate in a script (.bat
or similar) the previous processes to initialize the environment, environment variables, etc), and execute that script as action of the Watchdog .
Pandora FMS はサービスとして SYSTEM
アカウントで実行され、実行されるプロセスはそのユーザとその環境で実行されます。そのため、特定のユーザで使用する必要がある特定のプロセスを実行する必要がある場合は、環境、環境変数などを初期化する前のプロセスをスクリプト (.bat
または類似のスクリプト) にカプセル化し、そのスクリプトを Watchdog のアクションとして実行する必要があります。
On Unix
Unix の場合
On Unix it works exactly the same as in module_service. It also does not support asynchronous mode or watchdog.
Unixではmodule_serviceと全く同じように動作します。また、非同期モードやウォッチドッグはサポートされていません。
module_cpuproc <プロセス> (Unix のみ)
特定のプロセスの CPU 使用率を返します。
module_begin module_name myserver_cpu module_type generic_data module_cpuproc myserver module_description Process Command line module_end
Unix
UNIX では、このモジュールは module_service のように動作します。非同期およびウォッチドッグモードはサポートしません。
module_memproc
module_memproc <プロセス>
Unixのみです。 特定のプロセスが利用しているメモリ量を返します。
module_begin module_name myserver_mem module_type generic_data module_memproc myserver module_description Process Command line module_end
module_freedisk
module_freedisk <ドライブ名:>|<ボリューム>
It checks for the free space in the disk unit.
このモジュールは、ディスクの空き容量をチェックします。
In Windows®
Windows® の場合
Place :
after the <disk_letter:>
ドライブ名の後に :
を記載します。
module_begin module_name freedisk module_type generic_data module_freedisk C: module_end
In Unix®
Unix® の場合
The volume to check, such as /var
.
/var
のようにチェックするボリュームを指定します。
module_begin module_name disk_var module_type generic_data module_freedisk /var module_end
module_freepercentdisk
module_freepercentdisk <ドライブ名:>|<ボリューム>
このモジュールは、ディスクの空きをパーセントで返します。
Windows
ドライブ名: (“:“を忘れないようにしてください) を指定します。
module_begin module_name freepercentdisk module_type generic_data module_freepercentdisk C: module_end
Unix
/var などのボリュームを指定します。
module_begin module_name disk_var module_type generic_data module_freepercentdisk /var module_end
module_occupiedpercentdisk
module_occupiedpercentdisk <ドライブ名:>|<ボリューム>
Unix のみです。 このモジュールは、/var 等の Unix ファイルシステムのディスク使用率(%)を返します。
module_begin module_name disk_var module_type generic_data module_occupiedpercentdisk /var module_end
module_cpuusage
module_cpuusage <cpu id|all>
このモジュールは、UNIX および Windows 双方で使えます。指定した CPU 番号の CPU 使用率を返します。CPU が 1つしかない場合は番号を指定しないか、all を指定します。
次のように、マルチ CPU 環境で全 CPU の平均使用率を得ることができます。
module_begin module_name SystemCPU module_type generic_data module_cpuusage all module_description Average CPU use in systme module_end
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
Windows および Unix 双方で使えます。システム全体の空きメモリ量を取得します。
module_begin module_name FreeMemory module_type generic_data module_freememory module_description Non-used memory on system module_end
module_freepercentmemory
Windows および Unix 双方で使えます。システム全体の空きメモリ量のパーセンテージを取得します。
module_begin module_name freepercentmemory module_type generic_data module_freepercentmemory module_end
module_tcpcheck
Only MS Windows®
MS Windows® のみ
This module tries to connect with the specified IP address and port. It returns 1
if successful and 0
if not. It is also recommended to specify an expiration time with module_timeout
.
このモジュールは、指定された IPアドレスおよびポート番号への接続確認を行います。成功すると 1
が返り、失敗すると 0
が返ります。module_timeout
でタイムアウトを設定する必要があります。
module_begin module_name tcpcheck module_type generic_proc module_tcpcheck www.artica.es module_port 80 module_timeout 5 module_end
module_regexp
It is a module for monitoring and collecting plain text logs on both Microsoft Windows® and Linux®. It is used in conjunction with module_pattern
and module_pattern_exclude
. If you want to capture events in Windows you must use another method to capture them (module_logchannel).
これは、Microsoft Windows® と Linux® の両方でプレーンテキストログを監視および収集するためのモジュールです。module_pattern
および module_pattern_exclude
と組み合わせて使用します。Windows でイベントをキャプチャする場合は、別の方法 (module_logchannel) を使用する必要があります。
module_begin module_name Syslog module_description Sample log collection of syslog messages file module_type log module_regexp /var/log/messages module_pattern .* module_pattern_exclude <regexp_to_exclude> module_end
This type of module monitors a log looking for matches using regular expressions, discarding the already existing lines at the start of the monitoring. The data returned by the Module depends on the Module type:
このタイプのモジュールは、正規表現を使用してログを監視し、一致する行を検索します。監視開始時に既存の行は破棄されます。モジュールによって返されるデータは、モジュールの種類によって異なります。
generic_data_string
,async_string
: Returns all lines matching the regular expression.generic_data
: Returns the number of lines matching the regular expression.generic_proc
: Returns1
if there is a match,0
otherwise.module_noseekeof
: By default inactive,0
. With this configuration token active (1
) in each execution, independently of the modifications in the log file, the module restarts its check without searching the end of the file (flagEOF
). In this way it will always extract in the XML all those lines that match the search pattern.log
: Used for log collection (which is different from monitoring). See more details in the section of Log collection. If you want to capture all the log information you should include:
generic_data_string
,async_string
: 正規表現にマッチした行全体を返します。generic_data
: 正規表現にマッチした行数を返します。generic_proc
: 正規表現にマッチしたら 1、そうでなければ 0 を返します。module_noseekeof
:0
がデフォルトです。これを有効 (1
) にすると、それぞれのモジュールの実行において、ターゲットのファイル更新からは独立して、ファイルの EOF を確認することなくチェック処理が実行されます。これにより、常に検索パターンにマッチするすべての行が XML 出力に展開されます。log
: ログ収集に使用されます(監視とは異なります)。詳細はログ収集のセクションをご覧ください。すべてのログ情報を取得する場合は、以下を含める必要があります。
module_pattern .*
- This module works slightly differently on Windows and Linux, since
module_pattern_exclude
is only supported on Linux. Otherwise they work the same. module_pattern_exclude
is optional and may not exist in the module definition.
- このモジュールは、Windows と Linux では動作が若干異なります。これは、
module_pattern_exclude
が Linux でのみサポートされているためです。それ以外は動作は同じです。 module_pattern_exclude
はオプションであり、モジュール定義に存在しない場合があります。
module_wmiquery
Windows のみです。WMI モジュールは、外部ツールを使わずにローカルで WMI クエリを実行できます。2つのパラメータで設定します。
- module_wmiquery: 利用する WQL クエリを設定します。さまざまなデータを含む複数の行で結果を得ることができます。
- module_wmicolumn:データソースとして利用するカラム名を設定します。
例えば、インストールされているサービス一覧を取得するには次のようにします。
module_begin module_name Services module_type generic_data_string module_wmiquery Select Name from Win32_Service module_wmicolumn Name module_end
現在の 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
Windowsのみです。 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
Windows パフォーマンスモニタは、モニタリングに利用できる何百ものパラメータを持つ強力なツールです。加えて、各ベンダによる独自のモニタ項目も追加されています。
パフォーマンスツールから、パフォーマンスカウンターを確認できます。
システムツールを用いて新たなパフォーマンスカウンターを追加することができます。その構成には、要素とサブ要素を含む管理構造があります。ここでは、Processor, % of processor time および _Total です。
このように、OS のツールを使うことにより、システムパフォーマンスのさまざまな要素を取り込むことができます。この場合、モジュールの設定は次のようになります。
module_begin module_name Processor_Time module_type generic_data_inc module_perfcounter \Processor(_Total)\% of time processor module_end
デフォルトでは、カウンタの生データが表示されます。調整値を取得するには、module_cooked 1 を設定します。
module_begin module_name Disk_E/S_Sec module_type generic_data module_cooked 1 module_perfcounter \PhysicalDisk(_Total)\E/S by second module_end
多くのデータは、カウンタ値として返ってきます。そのため、データタイプとしては generic_data_inc を使う必要があります。また、とても大きなスケール (数百万) のデータが返ってくることがありますので、事前処理モジュールで 0.000001 などを設定して値を小さくすると良いです。
module_inventory
Currently this functionality has been replaced by inventory from Agent plugins both on Windows® and Linux/Unix® systems.
現在、この機能は Windows® および Linux/Unix® システムの両方で エージェントプラグインからのインベントリ に置き換えられています。
module_logevent
Currently module_logchannel is the recommended option since module_logevent
has been deprecated and is kept working for backward compatibility.
現在、module_logevent
は非推奨となっており、下位互換性のために動作が維持されているため、module_logchannel が推奨オプションです。
module_logchannel
It is used to collect native Microsoft Windows® events and transform them into plain text information, with extended attributes stored in JSON, collected as a log by the Pandora FMS log collector. Previously it will have to be activated and configured, as described in the Log collection section.
これは、Microsoft Windows® のネイティブイベントを収集し、プレーンテキスト情報に変換して、JSON 形式の拡張属性とともに Pandora FMS ログコレクタによってログとして収集するために使用されます。ログ収集 セクションに記載されているように、事前に有効化と設定を行う必要があります。
The basic syntax is described in detail in that chapter, here you can see a basic reference of the syntax of that module:
基本的な構文についてはその章で詳しく説明されています。ここでは、そのモジュールの構文の基本的なリファレンスを確認できます。
module_begin module_name MyEvent module_type log module_logchannel module_source < source > module_eventtype < event_type/level > module_eventcode < event_id > module_application < application > module_pattern < regexp to match > module_source_type < log type, only SIEM > module_end
Where module_source
is the only mandatory field specific to this type of module.
ここで、module_source
は、このタイプのモジュールに固有の唯一の必須フィールドです。
module_name
is more relevant than it seems because many SIEM rules are triggered on a specific application name, and this name is defined in the module_name
. In fact for SysMon type events, the name must be a concrete one, and so for many SIEM rules.
多くの SIEM ルール は特定のアプリケーション名で起動されるため、module_name
は見た目以上に重要な意味を持ちます。この名前は module_name
で定義されます。SysMon タイプのイベントの場合、名前は具体的な名前である必要があり、多くの SIEM ルールでも同様です。
module_plugin
For the execution of EndPoint plugins. It is a special case since it does not require any other tags such as module_begin
or module_end
and neither does it indicate the type of Module.
エンドポイントプラグインの実行用です。module_begin
や module_end
などの他のタグを必要とせず、モジュールの種類も指定しない特別なものです。
Syntax with their respective parameters:
次のような書式です。
module_plugin plugin_filename parameter_1 parameter_2 (...) parameter_X
ただし、プラグインに状態や実行間隔などの追加パラメータを設定する場合は、次のように通常の書式を利用します。
module_begin module_plugin plugin_filename parameter_1 parameter_2 (...) parameter_X 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. To describe the operation of one of the plugins that comes by default with the EndPoint, the plugin grep_log
serves as an example 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
というモジュールであることを意味します。
Windows システムの場合の別の例を示します。(バージョン 3.1 以上)
module_plugin cscript.exe //B "%ProgramFiles%\Pandora_Agent\util\df_percent.vbs"
module_ping
Windows のみ。
module_ping <ホスト>
このモジュールは、指定したホストに ping を行い、応答があれば 1、そうでなければ 0 を返します。
次のパラメータを設定できます。
- module_ping_count x: 送信する ECHO_REQUEST パッケットの数 (1 がデフォルト)
- module_ping_timeout x: 応答を待つタイムアウトミリ秒数 (1000 がデフォルト)
- module_advanced_options: ping.exe の拡張オプション
例:
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 のみ。
このモジュールは snmpget を実行し、その応答を返します。
次のパラメータを設定できます。
- module_snmpversion [1_2c_3]: SNMP バージョン (1 がデフォルト)
- module_snmp_community <community>: SNMP コミュニティ (public がデフォルト)
- module_snmp_agent <host>: 対象の SNMP エージェント
- module_snmp_oid <oid>: 対象の OID
- module_advanced_options: snmpget.exe の拡張オプション
例:
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
module_wait_timeout
Windows のみ。
module_wait_timeout X
Expiration time used when the module module_exec and module_plugin output is checked. Value by default 500 miliseconds. Modify to 5 if the execution of a module that generates lots of outputs is slow. It is recommended no to use in the rest of cases.
モジュールの module_exec および module_plugin 出力がチェックされる際のタイムアウト時間。デフォルトの値は 500ミリ秒です。大量の出力を生成するモジュールで実行が遅い場合は、5に変更します。それ以外の場合は使用しないことをお勧めします。
module_advanced_options
For MS Windows® only.
MS Windows® のみ
module_advanced_options <parameter>
For module_ping
and module_snmpget
allow you to use additional parameters.
module_ping
および module_snmpget
では追加パラメータを使用します。たとえば、ping の場合、512 バイトのパケット サイズを指定できます。
module_advanced_options -l 512
module_pattern
See module_regexp.
module_regexp を参照してください。
module_pattern_exclude
自動エージェント設定
概要
In the EndPoint auto-configuration process, you can establish a series of rules so that they are configured automatically and it works as follows:
エンドポイントの自動設定処理では、一連のルールを確立して自動的に設定することができ、次のように機能します。
- Prepare the automatic configurations in your Pandora FMS Console or Pandora FMS Command Center (Metaconsole).
- Install the EndPoints reporting to your Pandora FMS (if you have a Command Center -Metaconsole- with the auto-provisioning system configured, establish the Command Center -Metaconsole- itself as the server).
- Pandora FMS Server will receive an XML (
.data
) with the EndPoint data for the first time. - The rules will be evaluated to determine the automatic configuration to apply.
- The EndPoint will collect the new configuration and will report in the next cycle with the updated configuration.
- Pandora FMS コンソールまたは Pandora FMS コマンドセンター (メタコンソール) で、自動設定を準備します。
- Pandora FMS にレポートする エンドポイントをインストールします (自動プロビジョニングシステムが設定されたコマンドセンター (メタコンソール) がある場合は、コマンドセンター (メタコンソール) 自体をサーバとして設定します)。
- Pandora FMS サーバは、エンドポイントデータを含む XML (
.data
) を初めて受信します。 - ルールが評価され、適用する自動設定が決定されます。 - エンドポイントは新しい設定を収集し、次回の処理から更新された設定で動作します。
自動エージェント設定の作成/編集
Console
コンソール
Access the management of automatic configurations through Configuration → Manage agent autoconfiguration.
自動設定画面へは 設定(Configuration) → 自動エージェント設定管理(Manage agent autoconfiguration) からアクセスします。
Metaconsole
メタコンソール
Go to Centralized management → Agent management → automatic agent configuration icon.
中央管理(Centralized management) → エージェント管理(Agent management) → エージェント自動設定アイコン:
By accessing the administration page you can create new automatic configurations by pressing the Add new configuration definition button. You will need to choose a name and description for your automatic configuration.
管理ページにアクセスしたら、新たな設定定義の追加(Add new configuration definition) ボタンをクリックすることにより新たな自動設定を作成することができます。自動設定の名前と説明を設定します。
Once the new auto configuration is created, you can display the configuration forms by clicking on the section you need: Rules, Agent autoconfiguration or Extra actions.
新たな自動設定を作成したら、必要な項目 (ルール(Rules)、エージェント自動設定(Agent autoconfiguration)、追加アクション(Extra actions)) をクリックすることにより設定フォームを表示できます。
ルール
To define the EndPoints to which the automatic configuration will be applied, you can first add rules to identify them.
自動設定が適用されるエンドポイントを定義するには、まずエンドポイントを識別するルールを追加します。
Expand the rules section within your automatic configuration, and select Add new rule. You can choose a series of options in the rules selector to identify the EndPoints that are going to be configured.
自動設定内のルールセクションを展開し、新しいルールの追加(Add new rule) を選択します。 ルールセレクターで一連のオプションを選択して、設定するエンドポイントを識別できます。
- Server name: Match on server name.
- Group name: Match on group name.
- OS: Match operating system name using regular expressions.
- Custom field: Match by key/value based on a custom field reported by the EndPoint. Indicate the name of the custom field and the value it should have.
- IP range: Match by range of IP (network) addresses, use IP/mask notation.
- Script output (> 0): Intended to execute a script whose execution result is evaluated as valid when the standard output is greater than 0.
- Rules script call: Supports the following macros in the 'arguments' field (you can choose between
AND
andOR
operators to modify the logic of the rules):_agent_
: Will be replaced by the name of the Agent._agentalias_
: Will be replaced by the Agent's alias._address_
: Will be replaced by the primary IP address reported by the Agent._agentgroup_
: Will be replaced by the name of the group reported by the Agent._agents_
: Will be replaced by the Agent operating system.
- Server name: マッチするサーバ名
- Group name: マッチするグループ名
- OS: マッチする OS 名 (正規表現)
- Custom field: エンドポイントが報告してくる、キー/値 のカスタムフィールドマッチ。カスタムフィールド名と値を指定する必要があります。
- IP range: IP の範囲(ネットワーク)にマッチ。IP/ネットマスク の書式を追加います。
- Script output (> 0): スクリプトの実行結果で、標準出力の結果が 0より大きい場合にルールにマッチしたと評価されます。
- Rules script call: 'arguments' フィールドに次のマクロが使えます。(演算子
AND
とOR
のどちらかを選択して、ルールロジックを変更できます)_agent_
: エージェント名に置き換えられます。_agentalias_
: エージェントの別名に置き換えられます。_address_
: エージェントから報告された IP アドレスに置き換えられます。_agentgroup_
: エージェントから報告されたグループ名に置き換えられます。_agentos_
: エージェントの OS で置き換えられます。
If you don't add any rules, the automatic settings will not be applied. If you need a single configuration for all agents, you can use the following regular expression to match any alias: .*
ルールが無い場合は、自動設定は適用されません。全てのエージェントに対して一つの設定でよい場合は、すべての別名にマッチする正規表現 .*
を使うことができます。
設定
- Agent Group: You may 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.
- Configuration Block: It adds the extra raw configuration to the Agent configuration file.
- Policies: You may select policies to be applied automatically when the Agent reaches the server. If there are several monitoring policies, you may specify a priority (zero by default) and the ones with the highest numerical value will be applied first (it is recommended to use singular values).
- エージェントグループ(Agent Group): 変更せずにそのままとするか、強制的に変更します。
- セカンダリグループ(Secondary Group): エージェントにセカンダリグループとして追加するグループを選択します。
- 設定ブロック(Configuration Block): エージェントの設定ファイルに追加する設定内容です。
- ポリシー(Policies): エージェントがサーバに接続してきたときに適用するポリシーを選択できます。監視ポリシーが複数ある場合は、優先順位(デフォルトではゼロ)を指定すると、数値が最も高いポリシーが最初に適用されます(単数値を使用することをお勧めします)。
If you try to access the automatic configuration administration from a node that belongs to a Command Center (Metaconsole), with centralized administration active, the view will be read-only.
集中管理が有効なコマンドセンター(メタコンソール)に属するノードから自動設定管理を行おうとすると、リードオンリー表示になります。
追加アクション
From this section you can associate other actions to the autoconfiguration, such as:
ここでは、自動設定に追加のアクションを行うことができます。例えば以下のような処理です。
- Launch a custom event (Launch custom event).
- Execute an alert action (Launch alert action).
- Execute a script (Launch script).
- 独自イベントを出す (Launch custom event)
- アラートアクションを実行する (Launch alert action)
- スクリプトを実行する (Launch script)
The system supports the following macros:
システムは、次のマクロをサポートします。
_agent_
Will be replaced by the name of the Agent._agentalias_
Will be replaced by the Agent's alias._address_
Will be replaced by the primary IP address reported by the agent._agentgroup_
Will be replaced by the name of the group reported by the Agent._togentos_
Will be replaced by the Agent operating system._agentid_
Replaced by the Agent ID.
_agent_
エージェント名に置き換えられます。_agentalias_
エージェントの別名に置き換えられます。_address_
エージェントが報告した IP アドレスに置き換えられます。_agentgroup_
エージェントが報告したグループ名に置き換えられます。_togentos_
エージェントの OS に置き換えられます。_agentid_
エージェント ID に置き換えられます。
Unix/Linux エンドポイント
Pandora FMS Unix エンドポイントの設定
The fundamental paths and directories to take into account are:
把握しておくべき基本的なファイルとディレクトリは次のとおりです。
/usr/share/pandora_agent
: Where the Pandora FMS EndPoint is installed. On systems where this is not allowed by policy, it is recommended to create a link to this path from the actual installation path, for example/opt/pandora
→/usr/share/pandora_agent
./etc/pandora/pandora_agent.conf
: Main configuration file of the EndPoint. Local Runtime Modules and EndPoint plugins are configured here./usr/local/bin/pandora_agent
: EndPoint executable binary. It usually has a link to/usr/bin/pandora_agent
./usr/local/bin/tentacle_client
: Tentacle executable binary, for file transfer to the server. It usually has a link to/usr/bin/tentacle_client
.systemctl pandora_agent_daemon
: Script start/stop/restart.- On AIX systems the daemon is
/etc/rc.pandora_agent_daemon
.
/var/log/pandora/pandora_agent.log
: Text file where the activity of the Pandora FMS EndPoint is saved, when the EndPoint runs in debugging mode./etc/pandora/plugins
: Directory that contains the agent plugins. It is linked to the/usr/share/pandora_agent/plugins
directory./etc/pandora/collections
: Directory containing the collections deployed to the Agent. It is linked to the/usr/share/pandora_agent/collections
directory.
/usr/share/pandora_agent
: Pandora FMS エンドポイントがインストールされる場所です。厳密なシステムポリシーがあり、ここにインストールできないシステムでは、実際のインストールパスからこのパスへのリンクを作成することを推奨します。例:/opt/pandora
→/usr/share/pandora_agent
/etc/pandora/pandora_agent.conf
: エンドポイントのメインの設定ファイルです。ここにデータの収集に使うコマンドの定義がされています。/usr/local/bin/pandora_agent
: エンドポイントの実行バイナリです。通常、/usr/bin/pandora_agent
にリンクされています。/usr/local/bin/tentacle_client
: サーバにデータファイルを送信するため Tentacle 実行バイナリです。通常、/usr/bin/tentacle_client
にリンクされています。systemctl pandora_agent_daemon
: start/stop/restart のためのスクリプトです。- AIX システムでは、
/etc/rc.pandora_agent_daemon
です。
/var/log/pandora/pandora_agent.log
: Pandora FMS エンドポイントがデバッグモードで動作している時にログが出力されるログファイルです。/etc/pandora/plugins
: エージェントプラグインを置くディレクトリです。これは/usr/share/pandora_agent/plugins
にリンクされています。/etc/pandora/collections
: エージェントのコレクションを置くディレクトリです。これは/usr/share/pandora_agent/collections
にリンクされています。
Unix エンドポイントの初期実行
To start the EndPoint it is only necessary to execute:
エンドポイントの起動は以下のようにします。
systemctl start pandora_agent_daemon
To stop the EndPoint, run:
エンドポイントの停止は以下のようにします。
systemctl stop pandora_agent_daemon
起動スクリプトで Pandora FMS エージェントの起動・停止ができます。デフォルトでは起動後はデーモーンとして動作します。
基本エンドポイントオプション
If the EndPoint has remote configuration enabled and corresponds to version 774 or later, the following options can be enabled in the Basic options section of the agent configuration in the Web Console.
エンドポイントでリモート設定が有効になっていて、バージョン 774 以降の場合は、ウェブコンソールのエージェント設定の 基本オプション(Basic options) セクションで次のオプションを有効にできます。
- Enable security hardening monitoring: It enables the plugin to strengthen security on the monitored device. The following options will be enabled in the configuration file:
- セキュリティ強化監視を有効にする(Enable security hardening monitoring): プラグインが監視対象デバイスのセキュリティを強化できるようにします。設定ファイルで次のオプションが有効になります。
#Hardening plugin for security compliance analysis. Enable to use it. module_begin module_plugin /usr/share/pandora_agent/plugins/pandora_hardening -t 150 module_absoluteinterval 7d module_end
Where the parameters are set to a timeout of 150 seconds for execution (-t 150
) at an interval of 7 days (7d
).
ここで、パラメータは、7 日間隔 (7d
) で実行のタイムアウトを 150 秒 (-t 150
) に設定されています。
- Enable log collection: This will collect the log files for forensic analysis and store all logs. The following options will be enabled in the configuration file:
- ログ収集を有効にする(Enable log collection): これにより、フォレンジック分析用のログファイルが収集され、すべてのログが保存されます。設定ファイルで次のオプションが有効になります。
# This is for LOG COLLECTION monitoring, different than log monitoring. module_plugin grep_log_module /var/log/messages Syslog \.\*
- Enable inventory: It enables the option of inventory monitoring. The following options will be enabled in the configuration file:
* インベントリの有効化(Enable inventory): インベントリ監視 のオプションを有効にします。設定ファイルでは次のオプションが有効になります。
# Plugin for inventory on the agent. module_plugin inventory 1 cpu ram video nic hd cdrom software init_services filesystem users route
Unix エンドポイントがシステム情報を取得する方法の変更
There are some Modules that obtain the information by default without the need to indicate a command with module_exec
. These modules are:
module_exec
でコマンドを指定しなくても、デフォルトで情報を取得する モジュールがいくつかあります。これらのモジュールは次のとおりです。
- module_procmem
- module_freedisk
- module_freepercentdisk
- module_cpuproc
- module_proc
- module_cpuusage
- module_freememory
- module_freepercentmemory
It is possible to modify the operation of these Modules by default by directly editing the Agent executable (by default /usr/bin/pandora_agent
). The Pandora FMS EndPoint is generally located in /usr/bin/pandora_agent
.
これらのモジュールの動作は、エージェントの実行ファイル (デフォルトでは /usr/bin/pandora_agent
) を直接編集することにより変更できます。Pandora FMS エンドポイントは一般的に /usr/bin/pandora_agent
にあります。
Search for the Commands to retrieve
string that contains the code with the internal commands. You may make the modifications you need to adapt them to your system.
コマンド名で検索することにより、内部コマンドを含むコードを見つけます。システムに合わせて変更する場合は、修正を行います。
# 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:
情報取得のための定義済の値を変更するには、コマンドを編集するだけですが、以下に注意します。
- Check that blocks
{ };
always end in semi-colon. - Check that commands are between
' '
symbols. - In turn, within said simple quotation marks, you may need additional ones, like
` `
(see the previous example). - Check that any simple quotation mark that you may want to use in the command is preceded by
\
, that means\
'. For instance, this command that usually would be:
- ブロックの終わりに
{ };
のようにセミコロンがあるがことを確認 - コマンドが
' '
でくくられているか確認 - シングルクォーテーションを使う場合は、
` `
のような追加の引用符が必要になる場合があります(前の例を参照)。 - コマンドで使用するシングルクォーテーションの前に
\
が付いていることを確認してください。これは\
' を意味します。 たとえば、このコマンドは通常次のようになります。
df -P | awk 'NR> 1 {print $2, $4, $6}'
上記は以下のようになります。
df -P | awk \'NR> 1 {print $2, $4, $6}\'
Pandora FMS Windows エンドポイント
Pandora FMS Windows エンドポイントの設定
The fundamental paths and directories in the installations of the EndPoint for MS Windows® are found in the directory where the Agent has been installed, by default %ProgramFiles%
.
Windows エンドポイントの基本的なパスやディレクトリは、エンドポイントをインストールした場所になります。デフォルトでは %ProgramFiles%
です。
理解しておきたい基本的なファイルは次の通りです。
%ProgramFiles%\pandora_agent
Where the Pandora FMS EndPoint, its executable and its directories are installed.
Pandora FMS エンドポイントの実行ファイルやディレクトリがあるインストール先です。
%ProgramFiles%\pandora_agent\pandora_agent.conf
EndPoint main configuration file. Local Runtime Modules and EndPoint plugins are configured here.
エンドポイントの設定ファイルです。実行モジュールおよびエンドポイントプラグインの設定はここにあります。
%ProgramFiles%\pandora_agent\PandoraAgent.exe
EndPoint executable binary.
エンドポイントの実行バイナリです。
%ProgramFiles%\pandora_agent\scripts
Scripts to start/stop/restart the Pandora FMS EndPoint.
Pandora FMS エンドポイントの起動・停止・再起動スクリプトです。
%ProgramFiles%\pandora_agent\pandora_agent.log
Text file where the activity of the Pandora FMS EndPoint is saved, when the EndPoint runs in debugging mode.
Pandora FMS エンドポイントがデバッグモードで実行されたときに出力されるログファイルです。
%ProgramFiles%\pandora_agent\util
Directory containing the EndPoint plugins.
エンドポイントプラグインを含むディレクトリです。
%ProgramFiles%\pandora_agent\collections
Directory containing the EndPoint collections.
エンドポイントのコレクションを含むディレクトリです。
MS Windows での基本エンドポイントオプション
When the software agent has Remote configuration enabled and the installed version is 774 or later, the following options can be enabled in the Basic options section of the agent configuration in the Web Console.
- Enable inventory: It enables the inventory monitoring option. The following parameters will be enabled in the configuration file:
ソフトウェアエージェントで リモート設定が有効 になっており、インストールされているバージョンが 774 以降の場合、ウェブコンソールのエージェント設定の 基本オプション(Basic options) セクションで次のオプションを有効にできます。
- インベントリの有効化(Enable inventory): インベントリ監視 オプションを有効にします。設定ファイルで次のパラメータが有効になります。
module_begin module_plugin cscript.exe //B //t:20 "%PROGRAMFILES%\Pandora_Agent\util\cpuinfo.vbs" module_crontab * 12-15 * * 1 module_end module_begin module_plugin cscript.exe //B //t:20 "%PROGRAMFILES%\Pandora_Agent\util\moboinfo.vbs" module_crontab * 12-15 * * 1 module_end module_begin module_plugin cscript.exe //B //t:20 "%PROGRAMFILES%\Pandora_Agent\util\diskdrives.vbs" module_crontab * 12-15 * * 1 module_end module_begin module_plugin cscript.exe //B //t:20 "%PROGRAMFILES%\Pandora_Agent\util\cdromdrives.vbs" module_crontab * 12-15 * * 1 module_end module_begin module_plugin cscript.exe //B //t:20 "%PROGRAMFILES%\Pandora_Agent\util\videocardinfo.vbs" module_crontab * 12-15 * * 1 module_end module_begin module_plugin cscript.exe //B //t:20 "%PROGRAMFILES%\Pandora_Agent\util\ifaces.vbs" module_crontab * 12-15 * * 1 module_end module_begin module_plugin cscript.exe //B //t:20 "%PROGRAMFILES%\Pandora_Agent\util\monitors.vbs" module_crontab * 12-15 * * 1 module_end module_begin module_plugin cscript.exe //B //t:20 "%PROGRAMFILES%\Pandora_Agent\util\printers.vbs" module_crontab * 12-15 * * 1 module_end module_begin module_plugin cscript.exe //B //t:20 "%PROGRAMFILES%\Pandora_Agent\util\raminfo.vbs" module_crontab * 12-15 * * 1 module_end module_begin module_plugin cscript.exe //B //t:20 "%PROGRAMFILES%\Pandora_Agent\util\software_installed.vbs" module_crontab * 12-15 * * 1 module_end module_begin module_plugin cscript.exe //B //t:20 "%PROGRAMFILES%\Pandora_Agent\util\userslogged.vbs" module_crontab * 12-15 * * 1 module_end module_begin module_plugin cscript.exe //B //t:20 "%PROGRAMFILES%\Pandora_Agent\util\productkey.vbs" module_crontab * 12-15 * * 1 module_end module_begin module_plugin cscript.exe //B //t:20 "%PROGRAMFILES%\Pandora_Agent\util\productID.vbs" module_crontab * 12-15 * * 1 module_end
- Enable security hardening monitoring: It enables the plugin to strengthen security on the monitored device. The following parameters will be enabled in the configuration file:
- セキュリティ強化監視を有効にする(Enable security hardening monitoring): プラグインが監視対象デバイスのセキュリティを強化できるようにします。設定ファイルで次のパラメータが有効になります。
#Hardening plugin for security compliance analysis. Enable to use it. module_begin module_plugin "%PROGRAMFILES%\Pandora_Agent\util\pandora_hardening.exe -t 150" module_absoluteinterval 7d module_end
Where the options are set to a timeout of 150 seconds for execution (-t 150
) in an interval of 7 days (7d
) as agent period.
- Enable log collection: This will collect the log files for forensic analysis and store all logs. The following parameters will be enabled in the configuration file:
オプションは、エージェント期間として 7 日間隔 (7d
) で実行のタイムアウトを 150 秒に設定 (-t 150
) します。
- ログ収集を有効にする(Enable log collection): これにより、フォレンジック分析用のログ ファイルが収集され、すべてのログが保存されます。設定ファイルで次のパラメータが有効になります。
module_begin module_name PandoraAgent_log module_type generic_data_string module_regexp C:\archivos de programa\pandora_agent\pandora_agent.log module_description This module will return all lines from the specified logfile module_pattern .* module_end
MS Windows でのエージェントセキュリティオプション
For PFMS EndPoint version 775 or later a plugin is included which is disabled by default. To enable it, uncomment the following instructions in the configuration file:
PFMS エンドポイント バージョン 775 以降には、デフォルトで無効になっているプラグインが含まれています。これを有効にするには、設定ファイル で、以下の指示を コメント解除 します。
# Pandora basic security check plugin for windows. #module_begin #module_plugin "%PROGRAMFILES%\Pandora_Agent\util\pandora_security_win.exe" #module_end
Once the EndPoint has been restarted, the following agent modules will be picked up:
エンドポイントが再起動されると、次のエージェントモジュールが有効になります。
- Antivirus installed and running, either Microsoft or third party, and if your virus definitions are up to date (two modules). On MS Windows server® this feature is not available so modules are not created.
- Check whether the automatic screen lock is active (Lock screen status), this protects the user's account when leaving the computer unattended, without mouse and keyboard activity (one module).
- Check whether MS Windows® was updated (Windows updated®) one week ago or less (one module).
- Firewall status, activated or not (three modules, one for each firewall profile: Domain network, Private network and Public network).
- Verification that all local accounts have a password set (one module).
- A module is dedicated to monitor whether the log of failed session attempts is active or not (only for OS installed in English and Spanish).
- Microsoft またはサードパーティのウイルス対策ソフトウェアがインストールされ、実行されており、ウイルス定義が最新であること (2 つのモジュール)。MS Windows Server® ではこの機能は利用できないため、モジュールは作成されません。
- 自動画面ロックがアクティブかどうかを確認します (画面のロック状態)。これにより、マウスやキーボードの操作なしでコンピューターを放置したときにユーザのアカウントが保護されます (1 つのモジュール)。
- MS Windows® が 1 週間以内に更新 (Windows updated®) されたかどうかを確認します (1 つのモジュール)。
- ファイアウォールのステータス、有効かどうか (3 つのモジュール、ファイアウォールプロファイルごとに 1 つ: ドメインネットワーク、プライベートネットワーク、パブリックネットワーク)。
- すべてのローカルアカウントにパスワードが設定されていることを確認 (1 つのモジュール)。
- セッション試行の失敗ログが有効かどうかを監視する専用のモジュール (英語とスペイン語でインストールされた OS のみ)。
エンドポイントの自動デプロイ
You can deploy EndPoints using the deployment center through the Discovery system, more information in this link.
自動検出システムを通したデプロイの仕組みを使ってソフトウエアエージェントをデプロイすることができます。より詳細は、 こちらを参照してください。
エンドポイントの自動アップグレード
Using the file collections and the pandora_update
tool can provide a way to “auto-update” EndPoints.
ファイルコレクションと pandora_update
ツールを使って、エンドポイントは自分自身の更新ができます。
The pandora_update
tool needs the Perl module Digest::MD5
to work. As of Perl version 5.14, this module is built in by default, but in earlier versions you will need to install it manually.
pandora_update
ツールは、Perl の Digest:MD5
モジュールが必要です。Perl 5.14 からはデフォルトで含まれていますが、古いバージョンでは手動でインストールしておく必要があります。
これは、次のように動作します。
1. EndPoints receive new binaries in the collections input directory.
1. エンドポイントが、例えば次のようなファイルコレクションの incoming ディレクトリに新たなバイナリを受信します。
Windows の例:
c:\program files\pandora_agent\collections\fc_1\PandoraAgent.exe
Linux の例:
/etc/pandora/collections/fc_1/pandora_agent
2. The EndPoint executes the plugin pandora_update
. This plugin takes a single parameter: the short name of the collection (in this example, fc_1
). It will scan the collection directory looking for the EndPoint binary (not the entire installer), it will compare the binary located in the collection with the one currently running, and if they are different, pandora_update
stops the EndPoint, replaces the binary and restarts the EndPoint again using the new binary.
2. エンドポイントは、pandora_update プラグインを実行します。このプラグインは、コレクションの短い名前をパラメータとして受け取ります(この例では fc_1
)。コレクションディレクトリ内のエンドポイントバイナリをスキャンし、現在動作しているものと比較します。違いがあれば、pandora_update
がエンドポイントを停止し、バイナリを置き換え、新しいバイナリを使ってエンドポイントを再起動します。
To update different architectures you will need to set a different collection for each architecture. For example, if you want to update 32-bit and 64-bit Windows® EndPoint, you must create two collections and in each of them include the corresponding PandoraAgent.exe
binary.
異なるアーキテクチャのアップデートを行うには、それぞれ異なるコレクションを用意する必要があります。例えば、32bit および 64bit の Windows エンドポイントをアップデートする必要がある場合は、2つのコレクションを作成し、それぞれに対応した PandoraAgent.exe
バイナリを含める必要があります。
3. Pandora_update
also writes to a small log the updated event, to be able to retrieve it on the next run and warn the user (by using an async_string
Module) about the process EndPoint Update.
3. Pandora_update
はまた、async_string
モジュールを使うことによって、次の実行タイミングでユーザに通知を出せるように、エンドポイントのアップデートプロセスに関するアップデートイベントログを出力します。
This implies that the Modules used to complete the update process may be configured to have a high interval.
以下がアップデートプロセスで使うモジュールです。間隔は長めに設定します。
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 EndPoint and update itself module_end
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 EndPoint and update itself module_end
The pandora_update
command accepts the path of the Pandora FMS installation directory as a second parameter; it is unnecessary to specify it if the installation was done in the default path.
pandora_update
コマンドの 2つ目のパラメータは、Pandora FMS のインストールパスです。このパラメータは、デフォルトのパスにインストールした際は不要です。
MS 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 EndPoint and update itself module_end
XML ファイルからのエンドポイントとモジュールの自動作成 / 学習モード
EndPoints can be configured from the Console in three work modes:
エンドポイントは、コンソールから 3つの動作モードを設定できます。
- Learning mode: If the XML received from the EndPoint contains new Modules, they will be automatically created. This is the default behavior.
- Normal mode: New Modules that arrive in the XML will not be created if they have not been previously declared in the console.
- Self-disabled mode: Similar to learning mode, in this mode, in addition, if all the Modules go to an unknown state, the EndPoint will automatically disable itself, becoming enabled again if it receives new information.
- 学習モード(Learning mode): エンドポイントから新たなモジュールを含む XML を受け取ると、それらが自動的に作成されます。これがデフォルト動作です。
- 通常モード(Normal mode): コンソールに存在しない新たなモジュールを XML で受け取っても作成しません。
- 自動無効化モード(Self-disabled mode): 学習モードに似ていますが、すべてのモジュールが不明状態になった場合にエンドポイントを自動的に無効化します。新たな情報を受け取ったときに改めて自動化します。
XMLを受け取ったときに既存のモジュールから更新されるデータ
When an XML is received that contains information from an already existing Module, only the description and extended information are updated, in addition to the Module data.
既存のモジュールからの情報を含む XML を受信すると、モジュールデータに加えて、説明と拡張情報のみが更新されます。
GIS data is always updated (if enabled) regardless of whether learning mode is off.
学習モードがオフかどうかに関係なく、GIS データは常に更新されます (有効な場合)。
(OBSOLETE)
エージェント作成時に XML からロードされるデータ
XML を受け取ったときにエージェントの作成とともに自動的に取り込まれるデータは次の通りです。
- エージェント名
- エージェントのIPアドレス
- エージェントの説明
- エージェントの親
- タイムゾーンオフセット
- グループ
- OS
- エージェントの実行間隔
- エージェントのバージョン
- カスタムフィールド
- カスタムID
- URL アドレス
- エージェントモード: 学習、通常、自動無効化
XML を受け取ったときに修正されるデータ (学習モード有効時)
- エージェントの IP アドレス
- エージェントの親
- OSバージョン
- エージェントのバージョン
- タイムゾーン
- カスタムフィールド
GIS データは(GIS が有効の場合)、学習モードが有効であるか無効であるかに関わらず、常に更新されます。
加えて、学習モードが有効の場合、XML ファイルで受け取った新たなモジュールは、Pandora で作成されます。
作成時にモジュールに追加されるデータ
初回の各モジュールの XML 受信時に反映されるデータは次の通りです。
- 名前
- タイプ
- 説明
- フィルタの最大・最小値
- 保存倍率
- モジュール実行間隔
- 障害の最大・最小値
- 警告の最大・最小値
- 無効化モジュール
- 単位
- モジュールグループ
- カスタムID
- 文字列の警告・障害
- 障害時手順
- 警告時手順
- 不明時手順
- タグ
- 障害反転モード
- 警告反転モード
- 静観モード
- 連続抑制回数
- アラートテンプレート
- Crontab
モジュールがすでに存在する場合に反映されるデータ
すでに存在するモージュールのデータを XML で受け取った場合は、モジュールのデータに加えて説明および拡張情報のみ更新されます。