ja:documentation:pandorafms:management_and_operation:03_templates_and_components

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

Pandora FMS performs all the checks through Modules, allowing to process different types of data depending on the element to monitor. The complete list of default Modules contained in Pandora FMS can be checked in the following section Management → Resources → Module types.

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

There are different module types in Pandora FMS:

Pandora FMS には、異なるモジュールのタイプとグループがあります。

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

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

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

A component is a Generic Module that can be applied repeatedly on an Agent, as if it were a “master copy” of a Module, generating a Module associated to an Agent. With this tool you may create and maintain a list of the most used components to apply them to new agents.

コンポーネントは、モジュールの「マスターコピー」であるかのようにエージェントに繰り返し適用できる 汎用モジュール であり、エージェントに関連付けられたモジュールを生成します。このツールを使用すると、最もよく使用されるコンポーネントのリストを作成して管理し、新しいエージェントに適用できます。

  • Network components: Group all remote modules (WMI, TCP, SNMP, ICMP, plugin, etc).
  • Local components: Include the definition of the Software Agent modules, as “chunks” of text to be incorporated into the configuration file of the Agent that has the remote configuration enabled.
  • ネットワークコンポーネント(Network components): すべてのリモートモジュール (WMI、TCP、SNMP、ICMP、プラグインなど) のグループです。
  • ローカルコンポーネント(Local components): リモート設定が有効になっているエージェントの設定ファイルに組み込まれるテキストの「チャンク」として、ソフトウェアエージェントモジュールの定義を含めます。

Network components can be grouped in templates, so that multiple network components can be applied directly on an Agent. Several modules can thus be created simultaneously through the network components associated with a template.

ネットワークコンポーネントは テンプレート にグループ化できるため、複数のネットワークコンポーネントをエージェントに直接適用できます。これにより、テンプレートに関連付けられたネットワークコンポーネントを通じて複数のモジュールを同時に作成できます。

The Recon server applies the network components associated with a template on the detected hosts, adding the specified modules automatically and thus enabling automatic monitoring deployment.

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

Menu Management → Configuration → Templates → Remote components.

メニュー 管理(Management) → 設定(Configuration) → テンプレート(Templates) → リモートコンポーネント(Remote components)

In this list you may search for existing components (filtering by groups or by free search text), view their configuration in details, modify or create new components. To edit the properties of any module, click on its name.

この一覧では、既存のコンポーネントを検索 (グループまたはフリー検索テキストでフィルタリング) したり、その設定の詳細を表示したり、新しいコンポーネントを変更または作成したりできます。モジュールのプロパティを編集するには、その名前をクリックします。

If the template is modified, its values will be applied to the modules created from that moment on, not to those already created.

テンプレートが変更されると、その値は すでに作成されたモジュールには適用されず、その時点以降に作成されるモジュールに適用されます。

To create a network component use the Configuration → Templates → Remote components menu, and at the bottom of the page, from the drop-down menu, select a network component from the four possible ones (Network, Plugin, Wizard, WMI) and then click Create.

ネットワーク コンポーネントを作成するには、設定(Configuration) → テンプレート(Templates) → リモートコンポーネント(Remote componetnts) メニューを使用し、ページの下部にあるドロップダウンメニューから、4 つの選択可能なネットワークコンポーネント (ネットワーク(Network)、プラグイン(Plugin)、ウィザード(Wizard)、WMI) からネットワークコンポーネントを選択して、作成(Create) をクリックします。

Because it is a generic component, some parameters such as snmp community, user, password can be different according to the agents to which the Module will be applied later, in those cases they can be left blank. If a common user policy is available for the systems, the modules can be left fully configured by entering user names, passwords and other data that are common to all agents.

これは汎用コンポーネントであるため、 snmp communityuserpassword などの一部のパラメータは、後でモジュールが適用されるエージェントに応じて変更する必要がある場合があります。その場合は、空白のままにすることができます。システムに共通のユーザポリシーが使用可能な場合は、ユーザ名、パスワード、およびすべてのエージェントに共通するその他のデータを入力して、モジュールを完全に設定した状態にすることができます。

The same process is performed for plugin components, by selecting Plugin in the list, in the interface the fields defined in the macros of the selected plugin will appear.

プラグインコンポーネントに対しても同じ処理が実行され、リストで プラグイン(Plugin) を選択すると、選択したプラグインのマクロで定義されたフィールドがインターフェイスに表示されます。

Menu Management → Configuration → Templates → Local components.

メニュー 管理(Management) → 設定(Configuration) → テンプレート(Templates) → ローカルコンポーネント(Local components)

The local components refer to the components that can be applied to Software Agents. These components can be applied automatically to all the agents through policies or manually (one by one) in the remote configuration editor of the Agent. Pandora FMS has dozens of local modules to apply to policies and agents automatically, sorted by categories.

ローカル コンポーネントとは、ソフトウェアエージェントに適用できるコンポーネントを指します。これらのコンポーネントは、ポリシーを通じてすべてのエージェントに自動的に適用することも、エージェントのリモート設定エディタで手動で (1 つずつ) 適用することもできます。Pandora FMS には、ポリシーとエージェントに自動的に適用する多数のローカルモジュールがあり、カテゴリ別に分類されています。

See the policy section for how to apply local components to software agents remotely.

ローカルコンポーネントをソフトウェアエージェントにリモートで適用する方法については、ポリシーの章を参照してください。

The list of existing local modules can be filtered by different parameters (group, operating system, free text query) and you may also view, modify and create new components. To edit any module, click on its name.

既存のローカルモジュールの一覧は、さまざまなパラメーター (グループ、オペレーティングシステム、フリーテキスト検索) でフィルター処理できます。また、新しいコンポーネントを表示、変更、作成することもできます。モジュールを編集するには、その名前をクリックします。

To create a new local component, go to the main local component management page, menu Management → Configuration → Templates → Local components and click Create at the bottom right of the page.

新たなローカルコンポーネントを作成するには、管理(Management) → 設定(Configuration) → テンプレート(Templates) → ローカルコンポーネント(Local components) をクリックし、ページの右下にある 作成(Create) をクリックします。

The page with the new local component creation form will appear. The form is filled in with the above information and click Create again to save.

新しいローカルコンポーネント作成フォームのページが表示されます。フォームに上記の情報を入力し、もう一度 作成(Create) をクリックして保存します。

It is possible to define macros in the local components. These macros will be used in the parameter module_exec and will have the following structure _field1_ , _field2__fieldN_.

ローカルコンポーネントでマクロを定義することができます。これらのマクロは、パラメータ module_exec で使用され、_field1__field2__fieldN_ という構造です。

The macros will appear in the Modules edit form as normal fields, transparent to the user.

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

If a Module component has macros, the configuration data will be hidden by default to simplify the view, but it is possible to display and modify them. If a string is defined in the Help field, a hint will appear next to the field with this string.

モジュールコンポーネントにマクロがある場合、表示を簡素化するために設定データはデフォルトで非表示になりますが、表示および変更することは可能です。ヘルプ(Help) フィールドに文字列が定義されている場合、この文字列を含むフィールドの横にヒントが表示されます。

Module templates are templates that contain network checking modules. These templates, once created, can be applied directly to agents, avoiding having to add the modules one by one, or apply the templates when performing a network recon task.

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

Menu Management → Configuration → Templates → Module templates.

メニュー 管理(Management) → 設定(Configuration) → テンプレート(Templates) → モジュールテンプレート(Module templates)

From the list shown, clicking on the name of any of the templates will allow you to edit them, and clicking on the trash can icon in the right column will allow you to delete them.

表示された一覧から、いずれかのテンプレートの名前をクリックするとテンプレートを編集でき、右側の列にあるゴミ箱アイコンをクリックするとテンプレートを削除できます。

The Create button is used to add a new template. The Name and PEN fields are filled in and saved by clicking Create again. The Add components button appears where you may filter by group, select the required components and click OK. To finish the creation process, click Update.

作成(Create) ボタンは、新しいテンプレートを追加する際に使用します。名前(Name) および PEN フィールドを入力し、作成(Create) を再度クリックすると保存されます。コンポーネントの追加(Add components) ボタンが表示され、グループでフィルタリングし、必要なコンポーネントを選択して、OK をクリックできます。作成プロセスを終了するには、更新(Update) をクリックします。

To apply one of the existing monitoring module templates, or one created, go to the configuration of an agent through the Management → Resources → Manage agents menu. From the list of agents, one is selected through the corresponding Modules link. Once this screen is accessed, click on the templates tab, Module templates, at the top of the page.

既存の監視モジュールテンプレートまたは作成したテンプレートのいずれかを適用するには、管理(Management) → リソース(Resources) → エージェントの管理(Manage agents) メニューからエージェントの設定に移動します。エージェントの一覧から、対応する モジュール(Modules) リンクを介して 1 つを選択します。この画面にアクセスしたら、ページの上部にあるテンプレートタブ モジュールテンプレート(Module templates) をクリックします。

The modules that the Agent already has and the existing Modules templates will be shown. Select a template and click Assign. The modules contained in that template will be automatically added. Once the template is applied, you may delete some of the modules by clicking on the trash can icon, or you may edit them by clicking on the corresponding tool icon. The modules added will have an automatic description based on the template name.

エージェントがすでに持っているモジュールと既存のモジュール テンプレートが表示されます。テンプレートを選択し、割り当て(Assign) をクリックします。そのテンプレートに含まれるモジュールが自動的に追加されます。テンプレートが適用されると、ゴミ箱アイコンをクリックしてモジュールの一部を削除したり、対応するツールアイコンをクリックして編集したりできます。追加されたモジュールには、テンプレート名に基づいて自動的に説明が付けられます

The templates applied on the agent are not shown, only the modules they contain.

エージェントに適用されたテンプレートは表示されず、そこに含まれるモジュールのみが表示されます。

All SNMP devices have an identifying string (OID), which is unique for each make and model of device. Within these strings there is a number in the seventh position that determines which manufacturer the device belongs to.

すべての SNMP デバイスには識別文字列 (OID) があり、これはデバイスのメーカーとモデルごとに一意です。これらの文字列の 7 番目の位置には、デバイスがどのメーカーに属しているかを示す数字があります。

This number is the Private Enterprise Number (PEN) of a manufacturer and it is registered in the IANA. You may configure these PENs in Pandora FMS to use them together with the module templates and thus add monitoring dynamically.

この番号は製造元の プライベートエンタープライズ番号 (PEN) であり、IANA に登録されています。Pandora FMS でこれらの PEN を設定し、モジュールテンプレートと一緒に使用して動的に監視を追加することができます。

In the Management → Configuration → Templates → Private Enterprise Numbers menu you have access to the list of registered PENs. You may edit and/or delete each registered PEN by clicking on the corresponding icons in the Options column.

管理(Management) → 設定(Configuration) → テンプレート(Template) → プライベートエンタープライズ番号(Private Enterprise Numbers) メニューでは、登録済みの PEN のリストにアクセスできます。オプション(Options) 列の対応するアイコンをクリックすると、登録済みの各 PEN を編集や削除できます。

To register a new manufacturer, click Register manufacturer. It will only be necessary to insert the corresponding PEN of the manufacturer, indicate its name and a description. It will then be added to the existing list.

新しいメーカーを登録するには、メーカーの登録(Register manufacturer) をクリックします。メーカーの対応する PEN を入力し、メーカー名と説明を入力するだけです。これで、既存のリストに追加されます。

In module templates, one or several PENs will be indicated so that when a discovery task is carried out, Pandora FMS will be able to obtain the device manufacturer and add the appropriate monitoring to it.

モジュールテンプレートでは、1 つまたは複数の PEN が指定されるため、自動検出タスクの実行時に、Pandora FMS はデバイスの製造元を取得し、適切な監視を追加できます。

Within the SNMP wizard and WMI wizard capabilities, there is a type of remote components called Wizard components .

SNMP および WMI ウィザードの機能には、ウィザードコンポーネント(Wizard components)と呼ばれる種類のリモートコンポーネントがあります。

These components allow establishing a base configuration for the modules that will be generated in the agents when executing any of the wizard (SNMP or WMI). It also offers the possibility of dynamically generating several modules with only one component. For example, a component to explore the different storage units of a device or the running processes.

これらのコンポーネントを使用すると、任意のウィザード(SNMP または WMI)の実行時にエージェントで生成されるモジュールの基本設定を行えます。さらに、1つのコンポーネントのみで複数のモジュールを動的に生成することができます。たとえば、実行中のストレージデバイスのユニットや、プロセスをスキャンするコンポーネントです。

These components can be created from the menu Management → Configuration → Templates → Remote components.

これらのコンポーネントは、管理(Management) → 設定(Configuration) → テンプレート(Templates) → リモートコンポーネント(Remote components)メニューから作成できます。

To help sort and classify components, there are component groups. Components are associated into component groups when they are created.

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

To view the existing component groups use the menu Management → Resources → Component groups. The existing groups and their description will be displayed on the screen. You may view the details of the groups by clicking on their name, delete them by clicking on the trash can icon on the right, in the Action column, and create new ones by clicking on the bottom Create button. You may also select several of them by means of their corresponding checkbox and delete them in bulk by means of the Delete button.

既存のコンポーネントグループを表示するには、メニュー 管理(Management) → リソース(Resources) → コンポーネントグループ(Component group) を使用します。既存のグループとその説明が画面に表示されます。グループの詳細を表示するには、グループの名前をクリックします。グループを削除するには、右側の アクション(Action) 列にあるゴミ箱アイコンをクリックします。新しいグループを作成するには、下部の 作成(Create) ボタンをクリックします。対応するチェックボックスを使用して複数のグループを選択し、削除(Delete) ボタンを使用して一括で削除することもできます。

With the Create button you may create a new component group. Fill in the fields in the form, provide a name for the group and select whether it has a parent within the existing groups. Then click Create again. Now new components can be added to the newly created component group.

作成(Create) ボタンを使用すると、新しいコンポーネントグループを作成できます。フォームのフィールドに入力し、グループの名前を指定して、既存のグループ内に があるかどうかを選択します。次に、もう一度 作成(Create) をクリックします。これで、新しく作成されたコンポーネントグループに新しいコンポーネントを追加できます。

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

In order to create a new module template, go to the main management page, ConfigurationTemplatesModule templates and click on Create at the bottom-right side of the page.

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

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

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

Then you may add modules to the template by clicking on Add components.

次に、コンポーネントの追加(Add components) をクリックすることにより、テンプレートにモジュールを追加できます。

Select the modules at the bottom, filtering them by group if necessary and click on OK.

下の方でモジュールを選択し (必要であればグループでフィルタリングして) OK をクリックします。

Keep in mind that you may delete the unwanted modules by selecting them and clicking Delete.

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

To finish off, remember to save the added modules by clicking on Update.

最後に、 更新(Update) をクリックして、追加したモジュールを保存することを忘れないでください。

SNMP ウィザードコンポーネント特有のフィールドは次の通りです:

  • Name OID
  • Manufacturer ID
  • When Execution type is set in Network:
    • Value OID
  • When Execution type is set in Plugin:
    • OID Macros
    • Value operation
    • Satellite execution
    • Server plugin
  • 名前 OID(Name OID)
  • 製造元 ID(Manufacturer ID)
  • 実行タイプ(Execution type)Network の場合:
    • Value OID
  • 実行タイプ(Execution type)Plugin の場合:
    • OID Macros
    • Value operation
    • Satellite execution
    • Server plugin

名前 OID(Name OID)

マクロを介してモジュール名に追加できる値を取得する OID を設定することができます。 これは、動的コンポーネントによって生成された複数のモジュールを取得するときに特に役立ちます。 これにより、デフォルトで異なる名前が付けられます。ただし、固定スキャンコンポーネントにも使用できるため、動的コンポーネントに限定されません。

この OID の値は、マクロ _nameOID_ に格納され、モジュール名(Module name) フィールドで使用できます。

動的コンポーネントで使用する場合、このフィールドに示される OID は、最終的な OID ではなく、SNMP のブランチのものである必要があります。例えば、OID .1.3.6.1.4.1.2021.10.1.2 が示されている場合、各モジュールでマクロが持つ値は、OID .1.3.6.1.4.1.2021.10.1.2. x から取得されます。 ここで x はブランチが持つ最後を表します。

固定コンポーネントで使用する場合、このフィールドに示される OID は最終的な OID でなければなりません。 例えば、OID .1.3.6.1.2.1.5.0 が示されている場合、マクロがモジュールに持つ値は、その OID から直接取得されます。

製造元 ID(Manufacturer ID)

SNMP ウィザードコンポーネントが有効になる特定の製造元の ID を指定することができます。 このようにして、ウィザードが起動され、コンポーネントに割り当てられた製造元 ID の Pandora FMS にプライベートエンタープライズ番号(PEN)が登録されているすべてのデバイスに対して、生成されたモジュールの取得が試行されます。 たとえば、general_snmp に割り当てられたコンポーネントは、PEN 2021 および 8072 のすべてのデバイスに対してスキャンされます。

製造元として すべて(All) を指定すると、Pandora に登録されている任意の PEN に対してコンポーネントのスキャンが行われます。

製造元 ID を使用するには、Pandora FMS コンソールにプライベートエンタープライズ番号(PEN)を登録する必要があります。

ネットワーク SNMP 実行

実行タイプが ネットワーク(Netrowrk) の場合は次の通りです:

値 OID(Value OID)

これにより、コンポーネントが生成したモジュールデータを取得する OID を設定できます。 動的コンポーネントで使用する場合、このフィールドに示される OID は、最終的な OID ではなく、SNMP のブランチのものである必要があります。例えば、OID .1.3.6.1.4.1.2021.10.1.3 が示されている場合、各モジュールでマクロが持つ値は、OID .1.3.6.1.4.1.2021.10.1.3.x から取得されます。 また、各 OID の X ノードは、名前 OID フィールドの X ノードにと同じ値を使用する必要があります。

固定コンポーネントで使用する場合、このフィールドに示される OID は最終的な OID でなければなりません。 例えば、OID .1.3.6.1.4.1.2021.11.9.0 が示されている場合、マクロがモジュールに持つ値は、その OID から直接取得されます。

SNMP プラグイン実行

実行タイプが プラグイン(Plugin) の場合は次の通りです:

OID マクロ(OID Macros)_oid_N_

プラグインタイプのコンポーネントを使用する主な目的は、使用済みメモリ量と使用可能な合計メモリ量から使用済メモリの割合を取得するなど、同じデバイスで 1つ以上の OID の値を使用して操作を実行できるようにすることです。

そのため、これらのコンポーネントでは、他のフィールドで使用するために必要な数の OID を指定できます。

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

動的コンポーネントで使用する場合、このフィールドに示される OID は、最終的な OID ではなく、SNMP のブランチのものである必要があります。例えば、OID .1.3.6.1.4.1.2021.10.1.3 が示されている場合、各モジュールでマクロが持つ値は、OID .1.3.6.1.4.1.2021.10.1.3.x から取得されます。 また、各 OID の X ノードは、名前 OID フィールドの X ノードにと同じ値を使用する必要があります。

固定コンポーネントで使用する場合、このフィールドに示される OID は最終的な OID でなければなりません。 例えば、OID .1.3.6.1.4.1.2021.4.6.0 が示されている場合、マクロがモジュールに持つ値は、その OID から直接取得されます。

値の計算(Value operation)

ここでは、ウィザードモジュールのプレビューにおいてコンポーネントで生成された各モジュールの現在の値に対する算術計算を設定できます。生成されたモジュールの最終的な実行には影響しません。

“+ - * / ( ) .” を利用できます。数値および _oid_N_ マクロの値が計算に利用されます。例:

(_oid_1_ * 100) / _oid_2_

サテライト実行(Satellite execution)

ここでは、exec server を使用してサテライトサーバからウィザードが起動されたときに、サテライトサーバが生成されたモジュールに対して実行する内容を指定できます。これは、サテライトサーバの module_exec で利用するコマンド、プラグイン、またはスクリプトです。

各モジュールで使用される OID を取得するために、SNMP ウィザードのマクロ(後で詳しく説明します)および _oid_N_ マクロを利用できます。

サテライトサーバは、これらのコンポーネントに推奨される一連のプラグインを配布します。

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

サーバプラグイン(Server plugin)

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

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

Pandora FMS コンソールには、これらのコンポーネントに必要な一連の登録済みプラグインがあります。

      	- Wizard SNMP module.
      	- Wizard SNMP process.

プラグインタイプの実行フィールドで利用可能な SNMP ウィザードコンポーネント特有のマクロは次の通りです。

  • _address_: SNMP ウィザードで使われる IP アドレス。このマクロは、ウィザードがポリシー内で実行された場合は置き換えできません。
  • _port_: SNMP ウィザードで使われるポート番号。
  • _version_: SNMP ウィザードで使われる SNMP バージョン。1, 2c または 3 の値を利用できます。
  • _community_: SNMP ウィザードで使われる SNMP コミュニティ。
  • _sec_level_: SNMP ウィザードで使われる SNMPv3 セキュリティレベル。noAuthNoPriv, authNoPriv または authPriv のいずれかです。
  • _auth_user_: SNMP ウィザードで使われる SNMPv3 ユーザ。
  • _auth_method_: SNMP ウィザードで使われる SNMPv3 認証手法。MD5 または SHA のいずれかです。
  • _auth_pass_: SNMP ウィザードで使われる SNMPv3 認証パスワード。
  • _priv_method_: SNMP ウィザードで使われる SNMPv3 暗号化手法。DES または AES のいずれかです。
  • _priv_pass_: SNMP ウィザードで使われる SNMPv3 暗号化パスワード。

ネットワーク WMI 実行

When the type of execution is Network:

実行タイプが ネットワーク(Network) の場合は次の通りです。

​​​​WMI class

WMI クラス

It allows to specify the WMI class to check. WMI classes are predefined and included in each namespace from Windows Management Instrumentation® (WMI) core.

チェックする WMI クラスを指定できます。 WMI クラスは事前定義されており、WindowsManagementInstrumentation®(WMI)コアの各名前空間に含まれています。

Query key field ( _field_wmi_0_ )

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

Query extra fields ( _field_wmi_1_ )

追加フィールドクエリ(Query extra fields) ( _field_wmi_1_ )

Query filters → Execution:

クエリフィルタ(Query filters) → 実行(Execution)

This space allows indicating the conditions for the WMI query launched by each module generated by the component. It accepts the use of macros with the names of the query felds (_FIELDNAME_) to obtain the value of each field log. For instance:

これにより、コンポーネントによって生成された各モジュールによって起動された WMI クエリの条件を示すことができます。 各フィールドログの値を取得するために、クエリフィールド (_FIELDNAME_) の名前を持つマクロの使用ができます。 例:

DriveType = 3 AND DeviceID = '_DeviceID_'.

The query is the final execution of a module generated by the component to obtain the free space of the C: disk unit is:

以下のクエリは、C: ドライブの空き領域を取得取得します。

SELECT DeviceID, FreeSpace FROM Win32_LogicalDisk WHERE DriveType = 3 AND DeviceID = 'C:'

Field value

フィールド値(Field value)

Indicate the number of the field of the WMI query from which you want to obtain the module value. Field 0 is the key field of its class and fields 1, and higher, the additional ones of their class.

モジュール値を取得する WMI クエリのフィールドの番号を示します。フィールド 0 はそのクラスのキーフィールドであり、フィールド 1 以上はそれらのクラスの追加フィールドです。

Key string

キー文字列(Key string)

It will allow to convert the module value into boolean (1 or 0) depending on whether the value of the field indicated in Field value matches the text string indicated in this field.

フィールド値 に示されているフィールドの値がこのフィールドに示されているテキスト文字列と一致するかどうかによって、モジュール値をブール値(1 または 0)に変換できます。

The Key string option will not be taken into account when the wizard is launched from a Satellite Server by exec server

exec server によってサテライトサーバからウィザードが起動された場合、キー文字列オプションは考慮されません。

WMI プラグイン実行

When there is a plugin execution:

実行タイプが プラグイン(Plugin) の場合は次の通りです:

It has common fields with Network execution until field Scan (Query filters).

スキャンクエリフィルター)フィールドまでは、ネットワーク 実行と共通のフィールドです。

Value operation

値の計算(Value operation)

The main purpose of using plugin type components is to be able to perform operations with the values of different query fields, such as obtaining the used-disk percentage from the free-disk bytes and the total disk bytes available.

プラグインタイプのコンポーネントを使用する主な目的は、空きディスク容量と使用可能な合計ディスク容量からディスク使用率を取得するなど、さまざまなクエリフィールドの値を使用して計算を実行できるようにすることです。

This field allows to indicate an arithmetic operation with which you will obtain the current value of each module generated by the component in the wizard's module preview. It does not affect in any case the final execution of the generated modules.

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

It accepts the characters + - * / ( ) ., numbers and the macros with the names of the fields this type (_FIELDNAME_), from which the values for the operation will be obtained. For example:

計算した値を得るために、“+ - * / ( ) .”、数値、およびフィールド名のマクロ(_FIELDNAME_)を利用できます。例:

((_Size_ - _FreeSpace_) * 100) / _Size_

Satellite execution

サテライト実行(Satellite execution)

It allows to indicate the execution that a Satellite Server should perform for the generated modules when the wizard is launched from a Satellite Server by using the exec server. It is the command, plugin or script that must be used in a Satellite server module_exec.

exec server を使用してサテライトサーバからウィザードを起動したときに、生成されたモジュールに対してサテライトサーバが実行するものを指定することができます。 これは、サテライトサーバの module_exec で使用するコマンド、プラグイン、またはスクリプトです。

It accepts the use of macros for the WMI wizard and of _class_wmi_ macros to obtain the name of the WMI class and _field_wmi_N_ to obtain the names of the fields of the class used in each module.

これは、WMI ウィザードのマクロと _class_wmi_ マクロを使用して WMI クラスの名前を取得し、_field_wmi_N_ を使用して各モジュールで使用されるクラスのフィールドの名前を取得できます。

The Satellite Server distributes a recommended plugin for these components:

サテライトサーバには、これらのコンポーネントが要求するプラグインがあります。

/etc/pandora/satellite_plugins/wizard_wmi_module.

Server plugin

サーバプラグイン(Server plugin)

It allows to indicate a plugin registered in Pandora FMS console that will be used by the plugin server with each module generated by the component. The choice of a plugin shows at the same time the specific fields for its use in the form.

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

The own plugin fields accept the use of macros for the WMI wizard and _class_wmi_ macros to get the name of the WMI class and _field_wmi_N_ to get the names of the fields of the class used in each module.

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

Pandora FMS console has an already registered and recommended plugin for these components: Wizard WMI module.

Pandora FMS コンソールには、これらのコンポーネント用の登録済みのプラグインがあります。

The specific macros for the WMI wizard components that can be used in the plugin execution fields are

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

  • _address_ : IP address used in the WMI wizard. This macro will not be replaced when the wizard is launched in a policy.
  • _namespace_wmi_ : Namespace used in the WMI wizard.
  • _user_wmi_ : User used in the WMI wizard.
  • _pass_wmi_ : Password used in the WMI wizard.
  • _address_: WMI ウィザードで利用される IP アドレス。ウィザードがポリシーから起動された場合は、このマクロは置き換えられません。
  • _namespace_wmi_: WMI ウィザードで利用されるネームスペース。
  • _user_wmi_: WMI ウィザードで利用されるユーザ。
  • _pass_wmi_: WMI ウィザードで利用されるパスワード。

The specified fields for WMI Wizard components are:

WMI ウィザードコンポーネントに指定されているフィールドは次のとおりです。

  • WMI class: It refers to the WMI class that will be used in the queries of the modules generated by the component. For example: Win32_LogicalDisk.
  • WMI class: これは、コンポーネントによって生成されたモジュールのクエリで使用されるWMIクラスを指します。例: Win32_LogicalDisk.

It can be used in other fields from the same form through the macro _class_wmi_.

Query key field ( _field_wmi_0_ )

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

It is the name of the key field that will be obtained in the WMI query used in the generated modules. Usually, WMI classes have a key field they always return in any query, whether indicated or not. That is the field that should be indicated here. For instance, the key field of class Win32_Processor would be DeviceID.

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

the name of this field can be obtained in other form fields through the macro _field_wmi_0_, and the value the field has for the WMI query log can be obtained through a macro with the same field name ( _FIELDNAME_ ). These macros _FIELDNAME_ can be used, among others, in component Module name and Description fields, to generate names and descriptions dinamically. For instance, for field DeviceID the macro with value would be _DeviceID_.

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

Query extra fields_field_wmi_N_:

追加フィールドクエリ(Query extra fields)_field_wmi_N_

In these fields indicate the names of the additional fields that must be used in the WMI query used in the generated modules.

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

The names of these fields can be obtained in other form fields through the macros _field_wmi_N_, and the values that the fields for each WMI query log have can be obtained through macros with the same names as those of the fields (_FIELDNAME_). These macros _FIELDNAME_ can be used, among others, in Module name and Description component fields, to generate names and descriptions dinamically. For example for the field FreeSpace the macro with the value would be _FreeSpace_.

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

Query filters → Scan

クエリフィルタ(Query filters) → スキャン(Scan)

In this space the conditions for the WMI query launched in the scan are indicated, which will allow you to obtain one or more logs. E.g.: DriveType = 3.

ここには、スキャンで起動する WMI クエリの条件を指定します。これにより、1つ以上のレコードを取得できます。 たとえば、DriveType = 3 です。

In WMI wizard components, a different module is generated for each log returned by the WMI scan query. Based on the examples pruvided up to now, the scan query would obtain the free space of the disk units from the Windows computer:

WMI ウィザードコンポーネントでは、WMI スキャンクエリによって返されるレコードごとに異なるモジュールが生成されます。これまでに示した例に基づいて、Windows コンピューターのドライブの空き領域を取得するスキャンクエリは次のようになります。

SELECT DeviceID, FreeSpace FROM Win32_LogicalDisk WHERE DriveType = 3

  • ja/documentation/pandorafms/management_and_operation/03_templates_and_components.txt
  • 最終更新: 2024/08/18 07:05
  • by junichi