Pandora: Documentation ja: Templates and components

From Pandora FMS Wiki
Jump to: navigation, search

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

1 テンプレートとコンポーネント

1.1 概要

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

Julia1.png

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

Julia3.png

見ての通り、さまざまなモジュールのタイプとグループがあります。

  • async: 非同期データ
  • generic: 一般的なデータ
  • keep_alive: エージェントへの最終接続状態を制御するのに便利な特別な keepalive モジュール
  • icmp: ICMP チェック (ping)
  • snmp: SNMP チェック
  • tcp: TCP チェック
  • web: ウェブチェック

これらのほとんどには、いくつかのチェックタイプがあります。

  • data: 数値データ
  • proc: ブーリアン値。1 か 0 を返します。
  • string: テキスト文字列
  • inc: インクリメンタルデータ (例えば、ネットワークインタフェースから送信されたパケットの総量などの増加するデータ)
  • inc_abs: 絶対インクリメンタルデータ。前回からの増分の値を示します。

1.1.1 コンポーネントとは

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

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


1.1.2 テンプレートコンポーネントとは

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

自動検出サーバは、テンプレートに関連付けられたネットワークコンポーネントを検出したホストに適用し、指定されたモジュールを自動的に追加し、非常に高速かつ自動の監視設定の展開ができます。

1.2 ネットワークコンポーネント

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

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

Lulu.png

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

モジュールのプロパティを参照するには名前をクリックしてください。詳細ページへのリンクになっています。

Nc form2.png



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

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

テンプレートを編集すると、その時以降に行うモジュールへの適用に反映されます。すでにモジュールに適用されているものは変更されません。

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

1.2.1 新たなネットワークコンポーネントの作成

3つのタイプのネットワークコンポーネントを作成することができます。

  • ネットワーク
  • プラグイン (サーバアドオン)
  • WMI

このバージョンでは、ウェブコンポーネントは作成できません。

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

luli.png



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

Loli.png

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

Nomo.png

同様に、プラグインコンポーネントの場合は次のようになります。

Trio.png

1.3 ローカルコンポーネント

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

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

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

Hue.png

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

モジュールのプロパティを見るには、名前をクリックします。詳細のページへのリンクになっています。

Huen.png
Local component form2.png
Local component form3.png
Local component form4.png

見ての通り、ローカルコンポーネントの設定はとてもシンプルです。設定項目は次の通りです。

名前(Name): コンポーネントの名前です。この名前は、エージェントにモジュールを作成したときに、コンポーネントの選択で表示されます。
  • OS: コンポーネントのオペレーティングシステムです。
  • グループ(Group): モジュールが所属するグループです。フィルタしたりソートするのに便利です。
  • 説明(Description): モジュールの説明です。デフォルトの説明は変更が可能です。
  • 設定(Configuration): コンポーネントの設定です。ソフトウエアエージェントのモジュール設定と同様です。設定例やより詳細の情報は、設定の章のモジュール定義 を参照してください。

1.3.1 新たなローカルコンポーネントの作成

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

新たにローカルコンポーネントを作成するフォームが表示されます。

Local component form3.png



前述の情報をフォームに入力し、作成ボタンをクリックします。

1.3.2 ローカル実行マクロ

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

モジュールの編集フォームでは、マクロはユーザにとって透過的な通常のフィールドとして表示されます。

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

  • 説明(Description): モジュールフォームのフィールドに近いラベル。
  • デフォルト値(Default value): モジュールフォームでデフォルトで設定される値。
  • ヘルプ(help): フィールドの追加情報に追加される文字列。設定すると、その文字列がフィールドの近くに表示されます。

Local components macros.png

モジュールコンポーネントにマクロが含まれている場合、デフォルトで表示を簡素化するために、構成データは非表示のままになります。

Local components macros editor hidden.png

ただし、表示および編集することもできます。

Local components macros editor showed.png

1.4 モジュールテンプレート

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

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

Feisimo.png

テンプレート管理画面が表示されます。デフォルトの設定がされています。

Horro.png

詳細を見るには、テンプレートをクリックします。右のごみ箱アイコンをクリックすると削除できます。新しいテンプレートを作成する場合は、作成(Create)ボタンをクリックします。

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

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

その下に、このテンプレートに含まれるモジュールのリストがあります。

最後に、モジュール追加のためのフォームがあります。モジュールグループによってフィルタリングし、モジュールを選択して追加します。

Pla1.png
Module template edit2.png
Module template edit3.png

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

Pla2.png

1.4.1 新たなモジュールテンプレートの作成

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

新たなコンポーネントの作成フォームが表示されます。

Pla3.png

新たなテンプレートの名前と説明を入力し、作成(Create)ボタンをクリックします。

次に、テンプレートにモジュールを追加できるページが表示されます。

Pla4.png

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

不要なモジュールは、選択して削除(Delete)ボタンを押すことによって削除できます。

1.4.2 エージェントへのモジュールテンプレートの適用

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

Pla5.png

エージェントのモジュール(modules)をクリックします。

Pla6.png

この画面の先頭でテンプレートタブをクリックします。

Pla7.png

次の画面で、すでにエージェントに割り当てられているモジュールと、定義されているモジュールテンプレートの選択が表示されます。

Pla8.png

テンプレートを選択し、割当(Assign)ボタンをクリックします。選択したテンプレートに含まれるモジュールが自動的に追加されます。

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

1.5 コンポーネントグループ

コンポーネントのソートや分類をするために、コンポーネントグループがあります。コンポーネントは、作成時のグループに属します。

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

Pla9.png

定義済みのグループとその説明が表示されます。

Pla10.png

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

新たなコンポーネントグループを作成したい場合は、作成(Create)ボタンをクリックし、フォームに入力します。

Pla11.png

グループの名前を入力し、既存のグループと親子関係があればそれの選択をするだけです。あとは、作成(Create)ボタンをクリックします。

これにより、新たなコンポーネントを、作成したコンポーネントグループに追加することができます。