コンポーネントウィザード

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

SNMP ウィザードおよび WMI ウィザードの機能には、コンポーネントウィザード と呼ばれるリモートコンポーネントタイプがあります。

これらのコンポーネントを使用すると、ウィザード (SNMP または WMI) の実行時にエージェントで生成されるモジュールの基本設定を確立できます。 また、単一のコンポーネントで複数のモジュールを動的に生成することもできます。

これらのコンポーネントを作成するには、メニュー 管理(Management) → 設定(Configuration) → テンプレート(Templates) → Remote components(リモートコンポーネント) を使用します。 新しいウィザード コンポーネントを作成(Create a new wizard component) オプションを選択し、作成(Create) ボタンをクリックします。

作成ダイアログボックスには、使用するモジュールプロトコルという重要なオプションがあります。 使用可能なプロトコルは SNMP (デフォルト) と WMI の 2 つで、どちらも共通のフィールドもありますが、異なるフィールドもあります。

共通フィールド

  • 有効化(Enabled): この トークン を有効にすると、コンポーネントが ウィザード の実行時にスキャンを試行します。
  • デフォルトで追加(Add by default): ウィザード の実行時に、コンポーネントによって生成されたモジュールがデフォルトで追加されるようにマークされるかどうかを選択できます。
  • モジュール名(Module name): コンポーネントが持つ名前、およびコンポーネントによって生成されるモジュールのデフォルト名。 一部のマクロが利用できます。
  • モジュールタイプ(Module type): コンポーネントによって生成されたモジュールによって取得されるデータのタイプ。
  • コンポーネントグループ(Component group): コンポーネントが属するグループ。 モジュールの表示方法を整理できます。
  • モジュール単位(Module unit): コンポーネントによって生成されたモジュールによって取得されるデータの単位。
  • 警告(Warning): このセクションでは、ウィザード によって生成されたモジュールの警告状態のデフォルトのしきい値を設定できます。
  • 障害状態(Critical status): このセクションでは、ウィザード によって生成されたモジュールの障害状態のデフォルトのしきい値を設定できます。
  • 説明(Description): コンポーネントとそれによって生成されるモジュールの説明。 一部のマクロが利用できます。

スキャンタイプ(Scan type): ウィザード がこのコンポーネントで実行できる 2 つのスキャンモードを選択できます。

  • 固定(Fixed): コンポーネントはモジュールを 1 つだけ生成します。
  • 動的(Dynamic): コンポーネントは 1 つ以上のモジュールを生成する場合があります。

実行タイプ(Execution type): このフィールドは、コンポーネントによって生成されたモジュールの実行タイプを示します。 これは、ウィザード がどこから実行されるかに応じて、モジュール作成時にモジュールが属する Pandora FMS サーバを決定するために使用されます。

  • ネットワーク(Network): コンポーネントによって生成されたモジュールは、Pandora FMS 独自の SNMP および WMI モジュールのメカニズムを使用してデータを取得します。 これらは次のとおりです: ネットワークサーバWMI サーバ、および サテライト サーバ
  • プラグイン(Plugin): コンポーネントによって生成されたモジュールは、カスタムコマンド プラグイン または スクリプト の実行結果からデータを取得します。 これらは プラグインサーバ またはタイプ exec のモジュールを介してサテライトサーバによって実行されます。

SNMP ウィザード

管理(Management) → 設定(Configuration) → テンプレート(Templates) → リモートコンポーネント(Remote components) → 新しいウィザードコンポーネントの作成(Create a new wizard component) → 作成(Create) → モジュールプロトコル(Module protocol) → SNMP メニュー。

特定のフィールド:

  • OID 名(Name OID): マクロを使用してモジュール名に追加できる値を取得する OID を指定できます。 この OID の値はマクロ _nameOID_ に保存され、モジュール名 フィールドで使用できます。 ベンダに すべて が示されている場合、コンポーネントは Pandora FMS に登録されている PEN に対してスキャンされます。
  • ベンダID(Manufacturer ID): SNMP コンポーネント ウィザード が有効になる特定のベンダの ID を指定できます。
  • 実行タイプネットワークの場合: OID値
  • 実行タイププラグインに設定されている場合: マクロOID値操作サテライト実行サーバプラグイン

ベンダID を使用するには、Private Enterprise Number (PEN) を Pandora FMS コンソールに登録する必要があります。

SNMP ネットワーク実行

管理(Management) → 設定(Configuration) → テンプレート(Templates) → リモートコンポーネント(Remote components) → 新しいウィザードコンポーネントの作成(Create a new wizard components) → 作成(Create) → モジュールプロトコル(Module protocol) → SNMP (実行タイプ(Execution type) → ネットワーク(Network)) メニュー。

実行タイプが ネットワーク の場合、OID値 により、コンポーネントによって生成されたモジュールのデータが取得される OID を示すことができます。

  • 動的コンポーネントで使用する場合、このフィールドに指定される OID は、終了 OID ではなく SNMP ブランチである必要があります。
  • 固定コンポーネントで使用する場合、このフィールドに示される OID は最終 OID である必要があります。

SNMP プラグイン実行

管理(Management) → 設定(Configuration) → テンプレート(Templates) → リモートコンポーネント(Remote components) → 新しいウィザードコンポーネントの作成(Create a new wizard component) → 作成 → モジュールプロトコル(Module protocol) → SNMP (実行タイプ(Execution type) → プラグイン(Plugin)) メニュー。

プラグイン タイプのコンポーネントを使用する主な目的は、同じデバイス内の 1 つ以上の OID の値を使用して操作を実行できるようにすることです。 このため、これらのコンポーネントでは、他のフィールドで使用するために必要な数の OID を指定できます。

OID マクロ_oid_N_

さらに、これらの OID またはその値は、_oid_N_ マクロから使用できます。 マクロが次のどのフィールドで使用されるかに応じて、OID 値または OID 自体が使用されます。

動的コンポーネントで使用する場合、これらのフィールドに示される OID は、終了 OID ではなく SNMP ブランチである必要があります。 固定コンポーネントで使用する場合、これらのフィールドに示される OID は終了 OID である必要があります。

値の操作

コンポーネントによって生成された各モジュールの現在の値を ウィザード モジュールプレビューで取得する算術演算を指定できます。 いずれの場合も、生成されたモジュールの最終的な実行には影響しません。

文字 + - * / ( ) .、数字、および操作の値を取得するマクロ _oid_N_ が利用できます。

サテライト実行

exec server を使用して、サテライトサーバから ウィザード を実行するときに生成されるモジュールに対して、サテライトサーバによって実行できるようにします。 これは、サテライトサーバの module_exec で使用されるコマンド プラグイン または スクリプト です。 SNMP ウィザード用のマクロと、各モジュールで使用される OID を取得するための _oid_N_ マクロを利用できます。

サテライトサーバは、次の一連のコンポーネントに必要な プラグイン を配布します。

/etc/pandora/satellite_plugins/wizard_snmp_module
/etc/pandora/satellite_plugins/wizard_snmp_process

サーバプラグイン

このリストを通じて、Pandora FMS コンソールに以前に登録された プラグイン を指定できます。これは、コンポーネントによって生成された各モジュールとともにプラグインサーバによって使用されます。 プラグイン を選択すると、それを使用する特定のフィールドがフォームに表示されます。

プラグイン独自のフィールドでは、SNMP ウィザード用のマクロと、各モジュールで使用される OID を取得するための _oid_N_ マクロを利用できます。

Pandora FMS コンソールには、SNMP モジュールウィザード および SNMP プロセスウィザード のコンポーネントに推奨されるプラグインがすでに登録されています。 どちらかの使用に応じて、SNMP を介して監視を実行するには、それぞれのフィールドの残りの部分を設定する必要があります。

WMI ウィザード

管理(Management) → 設定(Configuration) → テンプレート(Templates) → リモートコンポーネント(Remote components) → 新しいウィザードコンポーネントの作成(Create a new wizard component) → 作成(Create) → モジュールプロトコル(Module protocol) → WMI メニュー。

WMI ネットワーク実行

管理(Management) → 設定(Configuration) → テンプレート(Templates) → リモートコンポーネント(Remote components) → 新しいウィザードコンポーネントの作成(Create a new wizard component) → 作成(Create4) → モジュールプロトコル(Module protocol) → WMI (実行タイプ(Execution type) → ネットワーク(Network)) メニュー。

実行タイプがネットワークの場合:

  • WMI クラス(WMI class): クエリを実行する WMI クラスを指定できます。 WMI クラスは、各 Windows Management Instrumentation® (WMI) カーネル名前空間に含まれる事前定義されたクラスです。
  • クエリフィルタ(Query filters) → 実行(Execution): このスペースを使用すると、コンポーネントによって生成された各モジュールによって起動される WMI クエリの条件を示すことができます。 クエリフィールドの名前 (_FIELDNAME_) を指定したマクロの利用ができ、そのフィールドの各レコードの値を取得します。
  • フィールド値(Field value): モジュール値を取得する WMI クエリフィールドの番号を示します。フィールド 0 はクラスのキーフィールド、フィールド 1 以降はクラスの追加フィールドです。
  • キー文字列(Key string): フィールド値 で示されるフィールドの値がこのフィールドで示される文字列と一致するかどうかに応じて、モジュール値を boolean (1 または 0) に変換できます。

exec サーバ を介してサテライトサーバからウィザードを起動する場合、キー文字列オプションは考慮されません。

WMI プラグイン実行

管理(Management) → 設定(Configuration) → テンプレート(Templates) → リモートコンポーネント(Remote components) → 新しいウィザードコンポーネントの作成(Create a new wizard component) → 作成(Create) → モジュールプロトコル(Module protocol) → WMI (実行タイプ(Execution type) → プラグイン(Plugin)) メニュー。

実行タイプがプラグインの場合:

  • クエリフィルタ(Query filters) (スキャン(Scan)) フィールドまでは、ネットワーク と共通です。
  • 値の操作(Value operation): このフィールドを使用すると、ウィザード モジュールプレビュー内のコンポーネントによって生成された各モジュールの現在の値を取得する算術演算を指定できます。 いずれの場合も、生成されたモジュールの最終的な実行には影響しません。 文字 +-*/().、数字、および、クラス _FIELDNAME_ フィールドのマクロが利用できます。
  • サテライト実行(Satellite execution): exec サーバ を使用して ウィザード がサテライトサーバから起動されるときに生成されるモジュールについて、サテライトサーバによる実行を設定できます。 これは、サテライトサーバの module_exec で使用されるコマンド、プラグイン または スクリプト です。 WMI ウィザード用のマクロと、WMI クラス名を取得するマクロ _class_wmi_ および各モジュールで使用されるクラスフィールドの名前を取得するマクロ _field_wmi_N_ を利用できます。サテライトサーバは、次のコンポーネント用に必要な プラグイン を配布します: /etc/pandora/satellite_plugins/wizard_wmi_module
  • サーバプラグイン(Server plugin): これにより、コンポーネントによって生成された各モジュールとともに プラグイン サーバによって使用される、Pandora FMS コンソールに登録された プラグイン を示すことができます。 プラグイン を選択すると、それを使用する特定のフィールドがフォーム内に同時に表示されます。

WMI モジュールウィザード

Pandora FMS コンソールには、WMI モジュールウィザードのコンポーネント用に必要な プラグイン がすでに登録されています。

プラグインの独自のフィールドでは、WMI ウィザード用のマクロと、WMI クラス名を取得するマクロ _class_wmi_ および各モジュールで使用されるクラスフィールドの名前を取得するマクロ _field_wmi_N_ を利用できます。

プラグイン タイプの実行のフィールドで使用できる WMI ウィザードコンポーネントの特定のマクロは次のとおりです。

  • _address_: WMI ウィザードで使用される IP アドレス。 このマクロは、ポリシーで ウィザード が起動されても置き換えられません。
  • _namespace_wmi_: WMI ウィザードで使用される 名前空間
  • _user_wmi_: WMI ウィザードで使用されるユーザ。
  • _pass_wmi_: WMI ウィザードで使用されるパスワード。

WMI ウィザードコンポーネント特有のフィールドは次のとおりです。

  • WMI class: これは、コンポーネントによって生成されたモジュールのクエリで使用される WMI クラスを指します。 たとえば、Win32_LogicalDisk
  • これらは、マクロ _class_wmi_ を使用して、これと同じ形式の他のフィールドで使用できます。

クエリキーフィールド ( _field_wmi_0_ )

これは、生成されたモジュールで使用される WMI クエリで取得されるキーフィールドの名前です。 通常、WMI クラスにはキーフィールドがあり、指定されているかどうかに関係なく、クエリで常にこのフィールドが返されます。 それがここで示されるべきフィールドです。 たとえば、Win32_Processor のキーフィールドは DeviceID になります。

このフィールドの名前は、マクロ _field_wmi_0_ を通じてフォームの他のフィールドで取得でき、WMI クエリの各レコードに対してフィールドが持つ値は、フィールドと同じ名前のマクロ _FIELDNAME_ を通じて取得できます。これらの _FIELDNAME_ マクロは、コンポーネントの モジュール名 および 説明 フィールドなどで使用して、名前と説明を動的に生成できます。 たとえば、DeviceID フィールドの場合、値を含むマクロは _DeviceID_ になります。

クエリ追加フィールド_field_wmi_N_:

これらのフィールドには、生成されたモジュールで使用される WMI クエリで使用される追加フィールドの名前が示されます。

これらのフィールドの名前は、_field_wmi_N_ マクロを使用してフォームの他のフィールドで取得でき、WMI クエリの各レコードに対してフィールドが持つ値は、同じ名前のマクロ _FIELDNAME_ を使用して取得できます。これらの _FIELDNAME_ マクロは、コンポーネントの モジュール名 および 説明 フィールドなどで使用して、名前と説明を動的に生成できます。 たとえば、FreeSpace フィールドの場合、値を含むマクロは _FreeSpace_ になります。

クエリフィルタ → スキャン

このスペースには、スキャンで起動された WMI クエリの条件が示されており、これにより 1 つ以上のレコードを取得できるようになります。 例: DriveType = 3

WMI ウィザードコンポーネントでは、WMI スキャンクエリによって返されたレコードごとに個別のモジュールが生成されます。

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