Pandora: Documentation en: Templates and components

From Pandora FMS Wiki
Revision as of 11:48, 13 June 2017 by Tatiana (talk | contribs)
Jump to: navigation, search

Go back to Pandora FMS documentation index

1 Templates and Plug Ins

1.1 Introduction

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' and 'Module Types'.


By clicking on this menu, the available modules are going to be shown on the web console's right side of Pandora FMS.


As you can see, there are several module types and groups to choose from:

  • async: The asynchrounous data.
  • generic: The generic data.
  • keep_alive: A special keepalive module, useful to control the status of the last contact to an agent.
  • icmp: The ICMP check (ping).
  • snmp: The SNMP check.
  • tcp: The TCP check.
  • web: The network check.

Most of them are able to consist of several types of checks:

  • data: The numerical data.
  • proc: The boolean values. Regarding network checks, this means that if the value exists, it returns a value of '1' and a value of '0' if not.
  • string: The text string.
  • inc: The incremental data, e.g. the amount of packets sent by an interface are always going to grow.

1.1.1 What's a Component?

A component is a 'generic module' which can be repeatedly applied onto an agent, as if it were a module's 'master copy', generating a module associated with an agent. This way, having a database of our organization's most used components, turns out to come in handy when it comes to monitoring, since we have our own components adapted to the technologies we're using 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 cut out and pasted into the agent's configuration.

1.1.2 What are Template Components?

A template is a set of network components which can be directly applied onto an agent, rendering the monitoring task a little easier, since we simultaneously create various modules by means of the components associated to a network template. The Recon Server utilizes the network templates to automatically create a series of modules on a detected host, thereby allowing for a very fast and automatic monitoring deployment.

1.2 Network Components

The network components are the elements that enable remote network checks. Pandora FMS has about 40 preconfigured network checks, while the Enterprise Version comes with a disposal of over 400 of them.

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


Within it, you're able to view the already existing components (by filtering 'by groups' or by 'free-text search'), to view their configurations and details, to modify them and to 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:

Nc form2.png
Nc form3.png
Nc form4.png

As you can see on the picture above, all details of the network component named 'Host Alive' are shown. 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.

{Tip|If any template is modified, its new values are only going to apply to the modules created from that moment on, not to the the ones already created.}

The component's values are also able to be modified. To do so, please click on the name of one them and modify the desired values, e.g. the interval. Once you're done, please click on the 'Update' button on the page's bottom. From that moment on, its changes are going to be stored and applied to the agents you're adding this module to.

1.2.1 Creating new Network Components

You may create three types of network components:

  • Network components
  • Plug-in components (server add ons)
  • WMI components

You're also unable to create web components within this version, yet.

To create a new network component, please click on 'Administration' -> 'Manage Modules' and 'Network Components'. Please go to the bottom of the page, select a network component within the pull-down menu and click on the 'Create' button.


Subsequently, a window to setup all the component's fields is going to be shown. Please fill out the desired fields and click on the 'Create' button when ready. The WMI component creation screen is going to be shown.


As you fill in the required fields, please keep in mind that you're going to fill out the description of a 'generic' module which is going to be applied to different agents. Some parameters such as 'snmp community', 'user' or 'password' can be different among the module's applied agents. You're also required to modify them manually in order to make them work. If you have a common user policy for your systems, you may leave the modules completely configured by inputting users, passwords and other data common to all agents here. You're also able to leave them blank.


The same process applies to the components of the plug-in type.

If you select the plug in within the interface like during the plug-in modules creation, the defined fields of the plug-in macros are going to appear in this case.


1.3 Local Components

Local components are the ones which can be applied to software agents. If you have the Pandora FMS Enterprise Version, these components are applied automatically and remotely way by policies or manually within the agent's remote configuration editor. Please check the policy section in order to know how to remotely apply a local component to a software agent under Pandora FMS Enterprise.

Local components may also be used within the open-source version of Pandora FMS. They just won't be applied automatically. It's necessary to manually copy and paste the code here. The Pandora FMS Enterprise version has dozens of local modules to apply to the policies and to the agents automatically, assorted by categories.

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


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

To view any module's properties, please click on its name. The provides a link which will lead you to its details page which is shown below.

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

As you can see, the configuration of local components is quite simple. The configuration's elements are described below.

  • Name: The component's name. This name is going to be visible within the component selection in the moment of creating an agent's module.
  • OS: The operating system the component is intended for.
  • Group: The group the module is going to belong to. It quite useful to filter and assort monitoring technologies.
  • Description: The module's description. A default description which can be changed is already in there.
  • Configuration: The component's configuration like the module's configuration for software agents. For more examples or to get complementary information, please check section named Configuration.
  • Warning Status: The interval in which the status changes to a 'warning' state. If the box 'inverse interval' is checked, the status isn't 'warning' if it's within range of this interval.
  • Critical Status: Interval in which the status changes to a 'critical' state. If the box 'inverse interval' is checked, the status isn't 'critical' if it's within range of this interval.
  • Warning Instructions: The instructions for if the state moved to 'warning'.
  • Critical Instructions: The instructions for if the state moved to 'critical'.
  • Unknown Instructions: The instructions for if the state moved to 'unknown'.
  • Category: If you're required to group or categorize differently, you may define categories here.
  • Tags: You may assign tags here.
  • Macros: You may define macros within the execution module (module_exec) or plug-in parameters.

1.3.1 Creating new Local Components

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.

A page containing the form for the creation of new local components is going to be displayed:

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

Please fill out the form by the information given above and click on the 'Create' button.

1.3.2 Local execution macros

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_'.

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

Local components macros.png

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

  • Description: It's the label near the field in the module's form.
  • Default Value: A field for the desired value to be charged by default in the module's form.
  • Help: A field for the desired string for additional field info. If set, it's going to appear near the field containing this string.

Local components macros editor hidden.png

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.

Local components macros editor showed.png

1.4 Module Templates

Module templates are the ones which contain modules designed for network checking. Once they're created, these templates can be directly applied to agents, thereby avoiding the need to add modules individually, or be applied when conducting one Network Recon Task of the ones described within Chapter 9.

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


The Template Management Window is going to be displayed, which contains many default templates:


You may click on any template to see its details or on the trash icon on the right side to delete it, or create a new template by clicking on the 'Create' button. If you click on a template's name, its details are going to be displayed. The snapshot below shows the template's details for the basic network monitoring modules. In it, the template's name and description may be viewed in the first two fields of the form. A list of modules included in this particular template is shown below.

The final one is the form for to add modules, enabling you to filter by module group. Please select the module and add it.

Module template edit2.png
Module template edit3.png

In order to delete a module, please select it within the right column and click on the 'Delete' button. If you select the top cell of the right column, you're going to select them all.


1.4.1 Creating New Module Templates

In order to create a new module template, please go to the main management page and click on 'Administration' -> 'Manage Modules' -> 'Module Templates' and click on the 'Create' button located on the bottom-right side of the page.

A page containing the creation form for new local components is going to appear in this moment:


Please enter a name and description for the new template and click on the 'Create' button.

Subsequently, a page in which you're able to add modules to the template is going to be shown.


Please select the modules on the bottom, filter them by group if necessary and click on the 'Add' button.

Please keep in mind that you're able to delete the unwanted modules by selecting them and clicking on the 'Delete' button.

1.4.2 Applying a Module Template to an Agent

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.


Please select one of the agent's modules:


Once you see this window, please click on the 'Templates' tab on the top of the page.


On the following picture, modules which already contain an agent and existing module templates are displayed. Please select one and apply it to the agent.


Please select a template and click on the 'Assign' button. The modules contained in this template are going to be added automatically. Once applied, the template can delete some of the modules by clicking on the 'X' within the column on the right side, or you may edit them clicking on the tool icon which is also located on the right.

Template warning.png

The agent's applied templates are not going to be displayed, just the modules contained in there are.


1.5 Component Groups

In order to help in component sorting and classifying, we've created component groups. Components are associated to groups in the moment of their creation.

In order to see the existing component groups, please click on 'Resoruces' -> 'Component Groups':


The already existing groups and their description is shown on the picture below.


You may view the details on the groups by clicking on their name, delete them by clicking on the 'X' on the right side or create new ones by clicking on the 'Create' button on the bottom.

If you intend to create a new components group, please click on the 'Create' button and fill out the form fields.


You're required to provide a name for the group and determine whether it has a parent among the existing groups or not. Please click on the 'Create' button when you're done.

Please feel free to add as many new components to your newly created component group as you like.

Go back to Pandora FMS Documentation Index