Pandora: Metaconsole: Documentation en: Operation

From Pandora FMS Wiki
Revision as of 11:21, 27 October 2020 by Sliebana (talk | contribs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

Go back to Pandora FMS documentation index

1 Operation

This section will explain how to operate (create, edit, delete) data from the instances from the metaconsole, as well as creating programmed tasks with the Cron Jobs Extensions.

This operation is carried out from the same Wizard.

1.1 Assistant / Wizard

The monitoring Wizard is used to configure agents, modules and their alerts from the Metaconsole.

Issues to consider

  • The operation of modules will be implemented as both local and network components. This is not intended to create modules "from scratch"
  • Agents that can be created from scratch, with a simplified configuration, setting up the remaining fields by default.
  • Modules created in the instance cannot be edited in the Wizard.
  • Modules created in the Wizard will not be distinguished from those created in the agent by other means. These modules can be edited and deleted from both the Wizard and from the instance setup directly.


There is a metaconsole and two pandora instances, where you have full access (read and administration permissions).

The instances have two agents with three modules each one:

Wizard example1.png

The first time you enter the metaconsole wizard, you will see the agents, but not the modules:

Wizard example2.png

Create from the metaconsole a module to monitor the harddisk in each agent.

Wizard example5.png

Now, from the wizard, you can see and edit the created modules:

Wizard example3.png

And from each Pandora FMS instance you may see the modules and edit them.

Wizard example4.png


A different case is that of the Metaconsole three view, where all modules you have access to can be seen, regardless of the actions of the Wizard. You may also view and delete (but not edit) the modules created from the Instance, when editing an agent from the Wizard.


1.1.1 Access

There are two ways to access the wizard:

  • Direct access to the Wizard from the main page of the Metaconsole.

Metaconsole home new.png

  • From the top menu, in the monitoring section.

Wizard main new.png

All users with wizard access will be able to access to monitor and alert configuration. Agent configuration must be activated "per user", on demand.

1.1.2 Action Flow

The following graph shows the complete flow of actions that are possible to be carried out in the Metaconsole Wizard:

Wizard flow.png

1.1.3 Modules

In the module option, you may create a module or edit one that is already created.

Wizard modules.png Creation

In module creation the first step will be selecting one agent where to create it. It could be filtered by group or searched by name between the available agents.


The available agents will be those of each Instance where the new user has creation permissions (AW).


Wizard modules create1.png

After selecting the agent, click on Create module. Now select the type of module to create:

  • Monitor
  • Web Check Monitor Creation

Monitor creation is done using module templates/components.These components are classified by groups:

The nature of the module (local or remote) will be visible for the user, and in the selection combos, the components of both types will be mixed.

When selecting the component, its description will be shown.

Wizard modules create monitors new.png

To configure the monitor, click on Create.

The monitor configuration consists of in 4 steps:

  • General Configuration: Monitor general data (name,description,Ip,etc.).

Wizard modules create monitors general new.png

  • Advanced Configuration: Monitor advanced data (thresholds, interval, etc).

Wizard modules create monitors advanced.png

  • Alerts: An alert editor where to configure in the module alert template alerts you have permissions for.

Wizard modules create monitors alerts.png

  • Preview:' Data displayed in only one scree before finishing the process.

Wizard modules create monitors previous.png Creating web checks

For web check creation, the web check option must be enabled in “customize sections” from Metaconsole's Metasetup.

There are two different types of web checks:

  • Step by step: Web checks are configured with a wizard without the need to know its syntax.
  • Advanced: Web checks are raw configured in a box text. It is only available for users with advanced permissions.


If the user does not have advanced permissions, the advanced check option will not be available. It will lead you directly to configure a step by step check.


Wizard modules create webchecks new.png

The web check configuration will be done, same as with monitors in 4 steps:

  • General Configuration: Monitor general data (name, description, type, etc. As well as the check according to its modality).
  • Step by Step Modality:

Wizard modules create webchecks stepbystep new.png

  • Advanced Modality:

Wizard modules create webchecks avanzado new.png

This kind of check can be:
  • Latency: This check obtains the total time that went by from the first petition until that the last one is checked. If there are several checks the average will be shown.
  • Response: This check obtains 1 (OK) or 0 (failed) as result when checking the whole transaction. If there are several attempts and some of them fail, then it is considered that the whole test also fails.
  • Advanced Configuration:Monitor advanced data (thresholds, interval, proxy configuration, etc.).
  • Modality Step by Step:

Wizard modules create webchecks advanced conf.png

  • Advanced Modality:

Wizard modules create webchecksadvanced advanced conf.png

  • Alerts: An alert editor where to configure in the module alerts of the alert templates you have permissions on. Same as in monitor creation.
  • Preview:' Data shown on a single screen before finishing the process. Same as with monitor creation. Module Creation Flow

Wizard flow create module.png Administration

The modules created from the Metaconsole Wizard can be managed (edited and deleted).

Template warning.png

The modules created in the Instance will not be visible in the Wizard.


The first step is to select the module to manage. You may filter by group and search by agent to find it quickly.

Wizard modules manage new.png

Once it has been selected, click on Delete to delete it or on Edit to edit it.

When editing you will have access to a screen very similar to the creation one with the same 4 steps:

  • General Configuration: Monitor general data.
  • Advanced Configuration: Monitor advanced data.
  • Alerts: Monitor alert edition.
  • Preview:' The data modified in a single screen before finishing the process.


Local and remote module and web check management is visible for the user.The fields to edit change but the editing/deleting process is the same. Module administration flow

<a href="">Wizard flow manage module.png</a>

1.1.4 Alerts

The alert editor is a direct link to the alert step in module edition. This is done to make its access and management easier.

In the alert options you may create an alert or edit one that is already created. Alerts could be only added or created in modules to which you have access from the Wizard. Or those modules created from the Wizard and you have ACL permissions on.

Wizard alerts.png Creation

In alert creation, select a module where you wish to create the alert.

Wizard alerts creation.png

After selecting the alert, click on Create alert.

The following screen will be the edition of the module linked to the alert in the alert edition step.

Wizard modules create monitors alerts.png Alert Creation Flow

Wizard flow create alert.png Administration

The alerts created from the Metaconsole Wizard can be managed (edited and deleted).

Template warning.png

Alerts created in the Instance will not be visible in the Wizard.


The first step is to select the alert to manage. Filter by group and search by agent to find it faster.

Wizard alerts management new.png

Once selected, click on Delete to delete it or on Edit to edit it.

If you click on Edit you will be redirected, same as when creating an alert, to the edition of the associated module in the alert edition step. Alert management flow

Wizard flow manage alert.png

1.1.5 Agents

In agent option you can create an agent or edit an already created one.

Wizard agents.png Creation

Agent creation is done in one of the configured Instances.

Administrator users can select in which one to create it. However, the standard users will have an Instance assigned where they will create the agents in a transparent way.

This assignment is done at User management

Agent configuration will be done in three steps:

  • General Configuration: Monitor general data (name, description, IP, etc). And in case of being administrator, also the Instance where it will be created.

Wizard agents general.png

  • Modules: A module editor, where to select from a combo the available network components and add them to the agent.

Wizard agents modules.png

  • Preview: Data displayed in a single screen before finishing the process.

Wizard agents preview.png Agent Creation Workflow

Wizard flow create agent.png Administration

Those agents the user has access to through ACL configuration can be managed (edited and deleted).

The first step is selecting the agent to manage. Filter by group and/or search for a text substring, to find it easily.

Wizard agents manage.png

Once the agent is selected, click on Delete to remove it, or on Edit to edit it. The edition screen is similar to the creation screen, with the same three steps:

  • General configuration: General information about the agent.
  • Modules: Edit the agent modules
  • Previsualization:' Preview to make sure everything is ok.


Unlike module management, agent edition also shows the modules that have not been created with the Wizard Agent administration workflow

Wizard flow manage agent.png

1.2 Cron Jobs

To be able to acces this Metaconsole action, go to Extensions > Cron Jobs. First, configure correctly the “crontab file” like this:

Cron tab config.png

Once done, perform the desired execution tasks. There is more information in the following link

1.3 Differences depending on access level

The modules and alerts have configuration differences depending on the access level to the Wizard that the templates and components they were created with have and the access level of the user that configures them. Agent settings have fewer restrictions but also depends on the access level.

1.3.1 Monitors

Monitor configuration will change depending of the access level on the component used: basic or advanced.

When the access level is "Advanced", there will be some additional fields:

  • The name (at the "basic" level, it takes the name of the component).
  • Monitor units.
  • Macros (in local modules or remote plugin modules' cases). At the basic level, it will be crated with the default values.

1.3.2 WEB Checks

When setting up a "webcheck", user with "advanced" access can choose between the "step by step" or "advanced" configurations.

Advanced checks are manually configured and write the ceck with their syntax in a text box. In addition, created module units can be defined.

1.3.3 Alerts

In the alerts, the Basic or advanced levels of the associated template only affect its visibility. Basic level alerts can be seen by user that accesses the wizard, and the advanced level ones only by users whth advanced level access.

It is the component level the one that defines the alert settings in their module. A module can be associated with any of the alerts visible for the user.

If it is a basic component or a styep-by-step web check, the alerts will be created with a default action assigned, which cannot be changed.

If it is an advanced component or a complex/advanced WEB Check, when assigning an alert the default action will appear but any desired action can be assigned.

1.3.4 Agents

Agent management will give access to all agents accessible to the user, depending on its ACL configuration. Regardless of the user access level (advanced, basic), or whether the modules were created with the wizard or in the instance.

The only restriction about this, comes when adding modules in the edit/create view. This setup is done only by using only network components and with basic level. The reason for this behaviour is because this kind of modules do not have any configuration, and the advanced wizard level modules usually need extra configuration.

Go back to Pandora FMS documentation index