Difference between revisions of "Pandora: Documentation en: Templates and components"

From Pandora FMS Wiki
Jump to: navigation, search
(Component groups)
(Create new network components)
Line 128: Line 128:
The same process applies to componets of type Plugin.
The same process applies to componets of type Plugin.
In this case, like the plug-in modules creation, when select the plug-in in the interface, will appear the fields defined of the plug-in macros.

Revision as of 08:34, 14 October 2013

Go back to Pandora FMS documentation index

1 Templates and Plugins

1.1 Introduction

Pandora FMS performs all checks through modules. These can belong to different types for the different data types Pandora FMS can process. The complete default module list for Pandora FMS can be seen in section Administration -> Manage modules:


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


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

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

Most of them can have several check types:

  • data: numeric data.
  • proc: boolean value. For web checks it means that if the value exists, returns 1 and 0 otherwise.
  • string: text string.
  • inc: incremental data (for example, the ammount of packets sent by an interface will always grow).

1.1.1 What is a component ?

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 exist two types of components, network components, which group all remote modules (wmi, tcp, snmp, icmp, plugin, web, etc), and local components, which are the definition of the modules defined in the software agents configuration, defined as text "snippets" ready to be cut and pasted in the agents configuration.

1.1.2 What are the Template Components?

A template is no more than a set of network components that can be directly applied on an agent, making easier the monitoring task, since we simultaneously create various modules by means of the components associated to a network template. The Recon server uses the network templates to automatically create a series of modules on a detected host, allowing thereby for a very fast and automatic deployment of the monitoring.

1.2 Network components

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's network components can be checked out and created from their managment page, at Administration -> Manage modules -> 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 see any module's properties, simply click on its name, it has a link that will take you to its page for details:

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

As plain to see in the figure, all details of network component Host Alive are shown. When applied to a module, it will get the network component's details, except the IP address field, where it will automatically store the main IP adress of the agent, the component is applied to. All parameters can be edited (e.g: change user/password of WMI modules) later.

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.

1.2.1 Create new network components

You can create three types of network components:

  • Network.
  • Plugin (server add on).
  • WMI.

In this version you still cannot yet create WEB components.

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.


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:


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.


The same process applies to componets of type Plugin.

In this case, like the plug-in modules creation, when select the plug-in in the interface, will appear the fields defined of the plug-in macros.


1.3 Local components

Local components are those that can be applied to software agents. If you have the Pandora FMS Enterprise version, these components are applied in an automatic and remote way through policies or in a manual way in the agent remote configuration editor. Please check the policy section in order to know how to apply local components to software agents in a remote way in your Pandora FMS Enterprise.

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. Pandora FMS's Enterprise version has tens of local modules to apply to the policies and to the agents in an automatic way, ordered by categories.

Local components work in a very similar way to network components, once gone to their management page, Administration -> Manage modules -> 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.

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

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

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.
  • OS: operating system, the component is for.
  • Group: the group, the module will be in. Useful to filter and sort on monitoring technologies.
  • Description: module description. There already exists a default description that can be changed.
  • 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.

1.3.1 Create new local components

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

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

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

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

1.3.2 Macros

Since version 5.0 is possible define macros in the local components. These macros will be placed into module_exec parameter and will have the structure _field1_ , _field2_ ... _fieldN_.

The macros will appear in the module edition form as normal fields, transparently to the user.

Local components macros.png

Each macro will have three fields: Description, Default value and Help.

  • Description: Will be the label near the field in the module form.
  • Default value: Optative value to be charged by default in the module form.
  • Help: Optative string to add additional info of the field. If is setted will appear a tip near the field with this string.

Local components macros editor hidden.png

If a module component has macros, the configuration data will appear hidden by default to simplify the view, but is possible show and modify it.

Local components macros editor showed.png

1.4 Module Templates

Module templates are those which contain network check modules. These templates, once created, can be directly applied to agents, avoiding thereby the need to add modules one by one, or be applied when performing one network recon task of the ones described in chapter 9.

To manage the module templates, click on Administration -> Manage modules -> Module templates.


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


You can click on any template to see its details, or you can click on the X in the right hand side column to delete it, or you can create a new template clicking on the Create button.

Clicking on a template's name its details will be displayed, for example, the shpshot below shows the details of the template for the Basic Network Monitoring modules.

In it, the template's name and description can be seen in the first two fields of the form.

Below, there's the list of modules included in this template.

Finally, there's the form for module addition, enabling you to filter by module group, then select the module, and add it.

Module template edit2.png
Module template edit3.png

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.


1.4.1 Create new module templates

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.

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.

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

1.4.2 Apply a module template to an agent

To apply one of the existing monitoring modules template or a recently created one, go to an agent's configuration at Administration -> Manage agents:


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.

Template warning.png

Templates applied to the agent are not displayed, just the modules contained in there are


1.5 Component groups

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

To see the existing component groups go to Administration -> Manage modules -> 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.

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.

Go back to Pandora FMS documentation index