Pandora:Documentation ja:Templates and components

提供: Pandora FMS Wiki JP

移動先: 案内, 検索

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



Pandora FMS performs all checks by utilizing modules. These modules can belong to different data types Pandora FMS is designed to process. The complete default module list for Pandora FMS can be viewed by clicking on Resources -> Module Types.

Pandora FMS は全てのチェックをモジュールを通して行います。これらは、Pandora FMS が処理できる異なるデータタイプごとに異なります。Pandora FMS のデフォルトのモジュールリストは、'リソース(Resources)' -> 'モジュールタイプ(Module Types)' から参照できます。


On clicking on this menu, on the right hand side of Pandora FMS's web console, the available modules will be shown:

このメニューをクリックすると、Pandora FMS ウェブコンソールの右側に存在するモジュールが表示されます。


As we can see, diverse module types and groups exist:


  • async: asynchrounous data.
  • async: 非同期データ
  • generic: generic data.
  • generic: 一般的なデータ
  • keep_alive: special keepalive module, useful to control the status of the last contact to an agent.
  • keep_alive: エージェントへの最終接続状態を制御するのに便利な特別な keepalive モジュール
  • icmp: ICMP check (ping).
  • icmp: ICMP チェック (ping)
  • snmp: SNMP check.
  • snmp: SNMP チェック
  • tcp: TCP check.
  • tcp: TCP チェック
  • web: web check.
  • web: ウェブチェック

Most of them can have several check types:


  • data: numeric data.
  • data: 数値データ
  • proc: boolean value. For web checks it means that if the value exists, returns 1 and 0 otherwise.
  • proc: ブーリアン値。1 か 0 を返します。
  • string: text string.
  • string: テキスト文字列
  • inc: incremental data (for example, the ammount of packets sent by an interface will always grow).
  • inc: インクリメンタルデータ (例えば、ネットワークインタフェースから送信されたパケットの総量などの増加するデータ)
  • inc_abs: absolute incremental data, showing the value, increased since the last reading.
  • inc_abs: 絶対インクリメンタルデータ。前回からの増分の値を示します。


A component is a "generic module" that can be repeatedly applied on an agent, as if it was a module's "master copy", generating a module associated with an agent. This way, having a database of our organisation's most used components, it turns very easy when it comes to monitoring, since we have our own components adapted to the technologies we use to use, and we simply have to apply these components to the new agents.

コンポーネントは、エージェントに繰り返し適用することができる "一般的なモジュール" です。エージェントに関連付けるモジュールの "コピー元" になります。最も良く利用するコンポーネントを構成するデータベースと考えることができます。普段利用するコンポーネントを定義することにより、モニタリングの設定が簡単になります。新たなエージェントには、これらのコンポーネントを適用すれば良いのです。

There are two types of components. Network components, which group all remote modules (wmi, tcp, snmp, icmp, plugin, web, etc.) and local components, which are the module's definition within the software agent's configuration as "text snippets", ready to be incorporated to the config file of the agent (with the remote configuration activated), or that can be cut out and pasted into the agent's configuration manually (without the remote configuration).

コンポーネントには 2つのタイプがあります。 リモートモジュール (wmi、tcp、snmp、icmp、plugin、web など) に分類される ネットワークコンポーネント と、ソフトウェアエージェントの設定で定義するモジュールの ローカルコンポーネント です。ローカルコンポーネントは、(リモート設定を有効にして)エージェントの設定ファイルに組み込んだり、手動で(リモート設定なしで)エージェントの設定に貼り付けることができます。


Pandora FMS offers the possibility of grouping network components in "templates" so that we can apply multiple network components directly on an agent. This makes it easy to deploy monitoring, as we create several modules simultaneously through the network components associated with a template.

Pandora FMS では、複数のネットワークコンポーネントをエージェントに直接適用できるように、ネットワークコンポーネントを "テンプレート" にグループ化することができます。 テンプレートに関連付けられたネットワークコンポーネントを通して複数のモジュールを同時に作成できるので、監視設定の展開が容易になります。

The Recon server applies the network components associated with a template to detected hosts, adding the specified modules automatically and allowing a very fast and automatic monitoring deployment.



As previously stated, the network components are the elements that enable remote network checks. Pandora FMS has about 40 predetermined network checks, whereas the Enterprise version enjoys over 400 ones.

前述の通り、ネットワークコンポーネントはリモートネットワークチェックを行うためのエレメントです。Pandora FMS では、約 40 の定義済みのネットワークチェックがあります。エンタープライズ版では、400 以上あります。

The network components of Pandora FMS can be created and viewed on their management page by clicking on Configuration -> Network Components.

Pandora FMS のネットワークコンポーネントの確認および作成は、'設定(Configuration)' -> 'ネットワークコンポーネント(Network components)' をクリックし、管理ページから行えます。


In it you'll be able to search for the already existing components (filtering by grupos or by free search text), see their configuration and details, modify them and even create new ones.

ここでは、定義済のコンポーネントの検索 (グループや任意の文字での検索によるフィルタが可能です)、設定詳細の確認、修正、新規コンポーネントの作成ができます。

To view any module's properties, please click on its name. The name provides a link which is going to take you to its details page:


As you can see in the picture above, all details of the network component named 'Host Alive' are shown.

図に示しているのは、ネットワークコンポーネント 'Host Alive' の詳細です。

If applied onto a module, it's going to retrieve the network component's details except the IP address field, where it's automatically going to store the agent's main IP address the component is applied to. All parameters may be edited later (e.g. change the user or password of the WMI modules).

モジュールに適用すると、IP アドレスフィールドを除き、ネットワークコンポーネントの詳細が反映されます。IP アドレスについては、エージェントのメインのアドレスが自動的に設定されます。全てのパラメータは (例: WMI モジュールのユーザ名、パスワードなど) あとから編集可能です。

If the template is modified, its values will apply to modules created from that instant on, not to the already created ones.


Component values can be modified, simply click on the name of one them and modify the desired values, e.g. the interval. Once done, click on the Update button at the page's end. Its changes will be stored and applied from that moment onwards to the agents you add such module to.

実行間隔など、コンポーネントの値は、その名前をクリックし変更したい値を編集することにより可能です。変更したら、画面下の 更新(Update) ボタンをクリックします。変更が反映され、以降はその内容でエージェントに適用できるようになります。


You can create three types of network components:


  • Network.
  • ネットワーク
  • Plugin (server add on).
  • プラグイン (サーバアドオン)
  • WMI.
  • WMI

To create a new network component, go to the main network components management page, Administration -> Manage modules -> Network components, go to the bottom of the page, select a network component out of the three posible ones (WMI, Red o Plugin) in the pulldown menú: and click on Create button.

新たなネットワークコンポーネントを作成するには、ネットワークコンポーネント管理のページ システム管理(Administration) -> モジュール管理(Manage modules) -> コンポーネント管理(Network components) へ行きます。ページの下の方へ行き、プルダウンメニューにて 3つのタイプ (WMI、ネットワーク、プラグイン) のネットワークコンポーネントの中から一つを選択します。そして、作成(Create) ボタンをクリックします。


After that, a screen will be displayed for you to set up all component's fields. Fill in the needed ones and click on the Create button. Next, the WMI component creation screen is displayed:

その後、コンポーネントを設定するためのフィールドが表示されます。必要な設定を行った後、作成(Create) ボタンをクリックします。以下に WMI コンポーネント作成画面を示します。


As you fill in the required fields, bear in mind that you are filling in the description of a "generic" module that will be applied to different agents. Some parameters such as snmp community, user or password can differ among the agents to which the module applies, and you'll need to modify them manually in order to make them work, but if you have a common user policy for your systems, you can leave the modules completely configured inputting here users, passwords and other data common to all agents. Obviously you can also leave them blank.

フィールドを設定するとき、モジュールの説明については、それぞれエージェントに適用する時に設定するように考えても良いでしょう。SNMP のコミュニティ、ユーザ名、パスワードのようないくつかのパラメータは、適用するエージェントのモジュールごとに異なります。正しく動作させるためには、個別に設定する必要があります。しかし対象のシステムに共通のポリシーがある場合は、ユーザ名、パスワードやその他設定を共通にすることができます。もちろん、定義せずに空白にすることも可能です。


The same process applies to componets of type Plugin.




Local components are those that can be applied to software agentes. If you have the Enterprise version of Pandora FMS, these components can be applied automatically and remotely through policies or manually (one by one) in the remote configuration editor agent. See policy for how to implement local components to remote software agents in Pandora FMS Enterprise.

ローカルコンポーネントは、ソフトウエアエージェントに適用できます。エンタープライズ版の場合は、コンポーネントは自動的にそしてリモートから適用することができます。ポリリーに従って適用したり、エージェントリモート設定エディタにて手動にて行うことができます。Pandora FMS エンタープライズ版でリモートのソフトウエアエージェントにローカルコンポーネントを実装する方法については、ポリシーを参照してください。

Local components can also be used in Pandora FMS's Open version. They just won't be applied automatically, being necessary to manually copy and paste the code. The Enterprise version of Pandora FMS has dozens of local modules to implement the policies and operators automatically sorted by category.

ローカルコンポーネントは、Pandora FMS のオープンソース版でも利用可能です。エンタープライズ版との違いは、自動適用ができず手動で必要な設定を書く必要がある点のみです。エンタープライズ版の Pandora FMS には、カテゴリごとに分類された操作やポリシーを実装した多くのローカルモジュールがあります。

Local components work very similar to the network components. Please go to their management page by clicking on Configuration -> Local Components to view them.

ローカルコンポーネントは、ネットワークコンポーネントととても似た動作をします。'設定(Configuration) -> ローカルコンポーネント(Local components)' から管理ページへ行くことができます。


This screen displays the already existing local modules, which can be filtered by different parameters (group, operating system, free text query) and one can also display, modify and create new components.

この画面では、すでに定義済のローカルモジュールを表示しています。異なるパラメータ (グループ、OS、任意のテキスト文字列) でフィルタリングして表示したり、編集や新たなコンポーネントの作成ができます。

To see any module's properties, just click on its name, it has a link that will bring you to its details page:



As plain to see, the configuration of local components is very simple. The configuration elements are:


  • Name: component's name. This name will be visible at the component selection when creating a modulo for an agent.
名前(Name): コンポーネントの名前です。この名前は、エージェントにモジュールを作成したときに、コンポーネントの選択で表示されます。
  • OS: operating system, the component is for.
  • OS: コンポーネントのオペレーティングシステムです。
  • Group: the group, the module will be in. Useful to filter and sort on monitoring technologies.
  • グループ(Group): モジュールが所属するグループです。フィルタしたりソートするのに便利です。
  • Description: module description. There already exists a default description that can be changed.
  • 説明(Description): モジュールの説明です。デフォルトの説明は変更が可能です。
  • Configuration: component configuration, like the module configuration for software agents. For more examples or to get complementary information, please check section Modules Definition in Configuration chapter.
  • 設定(Configuration): コンポーネントの設定です。ソフトウエアエージェントのモジュール設定と同様です。設定例やより詳細の情報は、設定の章のモジュール定義 を参照してください。


To create a new local component, please click on 'Configuration' -> 'Local components' and click on the 'Create' button which is located on the bottom right side of the page.

新たなローカルコンポーネントを作成するには、'設定(Configuration)' -> 'ローカルコンポーネント(Local components)' をクリックし、ページの右下にある作成(Create)ボタンをクリックします。

A page with the form for creation of new local components will be displayed:


The form will just have to be filled in with the information mentioned previously and the Create button be clicked.



For Pandora FMS versions 5 and above, it's possible to define macros within local components. These macros are going to be placed into the 'module_exec' parameter. They exhibit the structure of '_field1_, _field2_ ... _fieldN_'.

Pandora FMS バージョン 5.0 以降では、ローカルコンポーネントにマクロを定義することができます。マクロは、module_exec パラメータに設定し、_field1_ , _field2_ ... _fieldN_ という構造です。

In the module's edition form the macros are going to appear as normal fields which are transparent to the user.


Each macro is going to have three fields: 'Description', 'Default Value' and 'Help'.

それぞれのマクロには、説明(Description)、デフォルト値(Default value)、ヘルプ(Help)の 3つのフィールドがあります。

  • Description: Will be the label near the field in the module form.
  • 説明(Description): モジュールフォームのフィールドに近いラベル。
  • Default value: Optative value to be charged by default in the module form.
  • デフォルト値(Default value): モジュールフォームでデフォルトで設定される値。
  • Help: Optative string to add additional info of the field. If is setted will appear a tip near the field with this string.
  • ヘルプ(help): フィールドの追加情報に追加される文字列。設定すると、その文字列がフィールドの近くに表示されます。


If a module component contains macros, the configuration data is going to remain hidden to simplify the view by default.



but it's possible view and modify it.




Module templates are templates that contain network check modules. Once created, these templates can be directly applied to agents, avoiding the need to add modules one by one, or apply the templates when carrying out a network recon task.

モジュールテンプレートは、ネットワークチェックモジュールを含むテンプレートです。これらのテンプレートを作成すると、一つ一つモジュールを追加することなく直接エージェントに適用することができます。また、自動検出処理に利用することもできます。これについては、ネットワーク検出タスク にて説明しています。

Please click on 'Configuration' and 'Module Templates' to manage the module templates.

モジュールテンプレートを管理するには、'設定(Configuration)' および 'モジュールテンプレート(Module templates)' をクリックします。


The template management screen will be displayed, which has many default ones.



You can click on any of the templates to see their details, or you can click on the rubbish bin icon in the right column to delete it, or you can create a new template by clicking the Create button.


By clicking on the name of a template you will see its details, for example, the screenshot below shows the details for the Basic Monitoring module template.

テンプレートの名前をクリックすると、その詳細が表示されます。たとえば、以下のスクリーンショットでは、Basic Monitoring のモジュールテンプレート詳細が表示されています。

Here you can see the name and description of the template in the first two fields of the form.

その中で、フォームの最初の 2つのフィールドにテンプレートの名前と説明が表示されています。

Below is the list of modules included in this template.


Finally there is the form for adding modules, being able to filter by module group, and then select the module and add it.



To delete a module, simply select it in the right column (if you select the upper cell of the right hand side, you'll select them all) anf click the Delete button.

モジュールを削除するには、右のチェックボックスで選択し (右上のチェックボックスを選択するとすべてを削除します)、削除ボタンをクリックします。



To create a new module template, go to main component template management page, Administration -> Manage modules -> Module templates and click on the Create button located at the bottom-right hand side of the page.

新たなモジュールテンプレートを作成するには、システム管理メニューから、モジュール管理(Manage modules) -> モジュールテンプレート(Module templates) をクリックし、コンポーネントテンプレート管理ページへ行きます。そして、ページ右下の作成(Create)ボタンをクリックします。

A page with the creation form for the new local component will be displayed:



Input a name and a description for the new template and click on the Create button.


Next, the page will be shown, where you'll be able to add modules to the template:



Select the modules at the bottom, filtering by group if necessary, and click on the Add button.

下の方でモジュールを選択し (必要であればグループでフィルタリングしてください)、追加(Add)ボタンをクリックします。

Remember you can delete the unwanted modules by selecting them and clicking the Delete button.



In order to apply one of the existing monitoring module template or a recently created one, please click on 'Monitoring' -> 'Views' and 'Agent Detail' as shown below.

既存のモニタリングモジュールテンプレートや新たに作成したテンプレートをエージェントに適用するには、'モニタリング(Monitoring)' -> '参照(Views)' および 'エージェント詳細(Agent Detail)' をクリックします。


And select the modules of one of the agents:



Once in this screen, click on the Templates tab, at the top of the page.



In the following screen, modules that already have an agent as well as the existing module templates are displayed to select one and apply it to the agent:



Select a template and click on the Assign button, the modules contained in this template will automatically be added. Once applied the template can delete some of the modules clicking on the X in the column of the right hand side, or you can edit them clicking on the tool's icon, also at the right hand side.


NOTE: templates applied to the agent are not displayed, just the modules contained in there are.

注意: エージェントに適用したテンプレートは表示されません。モジュールのみが表示されます。


In order to help in component sorting and classifying, component groups exist. Components are associated in groups at cration time.


In order to see the existing component groups, please click on Resources > Component groups:

定義済みのコンポーネントグループを見るには、リソース(Resources) -> コンポーネントグループ(Component Groups) をクリックします。


Existing groups and their description will be displayed on screen:



You can see the details on the groups by clicking on their name, delete them by clicking on the X at the right hand side, or create new ones by clicking on the Create button at the bottom.

グループの名前をクリックするとその詳細を見ることができます。削除するには、右側の X アイコンをクリックします。新たに作成する場合は、下にある作成(Create)ボタンをクリックします。

If you want to create a new components group, click on the Create button, and fill in the form fields:



You just need to provide a name for the group and select if it has a parent among the existing groups. Then click on the Create button.


Now you can add new components to your just created component group.