Pandora: Documentation en: Console Setup

From Pandora FMS Wiki
Jump to: navigation, search

Go back to Pandora FMS documentation index

1 Setup by the Console

1.1 Introduction

The console configuration allows you to change and fine tune configuration parameters of the Pandora FMS Console. However, some general parameters are common for the whole application, including the Pandora FMS Servers and could affect the application's main performance.

By clicking on 'Setup' and 'Setup', you're able to configure several options of Pandora FMS, which are going to be explained below.

Setup menu expanded.png

1.2 Setup

By clicking on 'Setup' > 'Setup' and 'General Setup', you're able to invoke the configuration of the console's general parameters page.

Administration2.png

In this moment, the window shown below appears on the screen.



Pandora console 03.png


1.2.1 General Parameters


Pandora FMS Language settings:
It's the combo in which you're able to select the console's main language.

Remote Config Directory:
It's the field intended to identify the directory in which the remote configuration of the agents is stored. It's '/var/spool/pandora/data_in' by default. This feature is only available to Enterprise Versions of Pandora FMS.

Auto-Login (hash) Password:
It defines a static and symmetrical password which is used to create a hash value in order to render the automatic validation by URL possible. It's used to incorporate Pandora FMS into other web applications, provides a user name as a parameter, generated by the user's name by using a hash. This password allows an automated validation within Pandora FMS without the need of having to introduce a password. In order to see an example of this integration, please take a look into the file named '/extras/sample_login.php' from the Pandora FMS console.

Time Source:
The combo in which you're able to select the origin of the date and hour between the database and the system. The first one is used if the database is located on a system different from the console's.

Automatic Check for Updates:
The field in which the automatically conducted update check for the Open Update Manager is configured. This function causes the console to contact the Pandora FMS Update Server at Artica ST each time you start the session and sends anonymous information about your Pandora FMS usage (just your number of agents).

Enforce HTTPS:
The field which allows you to force a re-addressing to HTTPS. If you enable it, you're required to activate the use of Pandora FMS in conjunction with HTTPS within your web server. If you've enabled it and you haven't properly configured your Apache to use HTTPS before, you're unable to access the web console again. In this situation, you'll have to disable the HTTPS option again by going straight to the database, using MySQL and the following SQL syntax:

update tconfig  set `value` = 0 WHERE `token` = 'https';

Attachment directory:
The attachment directory is used as a temporary folder for Pandora FMS. All attached incident data are also stored in this folder. It's located under '/var/www/pandora_console/attachment' by default. You're required to have writing rights for the web server. The map's images and other temporary files are stored there, too.

IP list with API access:
This is a list of IP addresses (not FQN and one per line) which are going to have access to the Pandora FMS web-services API and other minor functions like the RSS event feed or the marquee view. You may use '*' as a wild card in order to define 'any' IP address and e.g. '125.56.24.*' in order to grant access to all hosts within the '125.56.24.*' subnet.

API Password:
It's the authentication method used to access the Pandora FMS API from the outside. Please read the section named Pandora FMS External API. in order to obtain more information about this topic.

Enable GIS features in Pandora Console:
The field intended to enable or disable GIS features within the Pandora FMS Console. Please read the section named GIS Console in order to obtain more information about this topic.

Enable Netflow:
The field intended to enable or disable the Netflow feature.

Timezone Setup:
It defines the timezone in the moment the Pandora FMS Console is located. It's also the combo in which it's possible to pick the zone and timezone.

Sound for Alert fired:
It's the combo which was designed to pick the sound for fired alerts.

Sound for Monitor critical:
The combo which was designed to pick the sounds in case a module is in 'critical' state.

Sound for Monitor warning:
The combo which was designed to pick the sounds in case a module is in 'warning' state.

Public URL:
Please define this value if your Pandora FMS works across an inverse proxy or is e.g. configured by Apache's 'mod_proxy' option.

Enforce URL security:
For security reasons, it's going to be verified whether the user has started from a Pandora FMS URL or not and the old link isn't an external or malicious link if activated. It's disabled by default. The locations which are considered high-security areas are the following:

  • Database Manager Extensions
  • User Configurations
  • Recon Script Configurations

Captura de pantalla de 2017-10-30 14 32 10.png

Event Storm Protection:
If set to 'yes', none of the events or alerts are going to be generated, but the agents continue to receive data.

Command Snapshot:
The string modules which contain several lines are going to be shown as a command output.

Server-Logs Directory:
It's the directory in which the server logs are going to be stored.

Log size limit in system logs viewer extension:
Maximun size to show in system log extension.

Tutorial mode

Level of presence of contextual help to the user.

Allows creating planned downtimes for past dates

Activate or deactivate the possibility of creating scheduled stops on past dates. The purpose of this is to modify information for SLA reports.

Limit parameters bulk

Limit of elements that can be modified by massive operations at once.

Include agents manually disabled

Allows to enable or disable the display of manually disabled agents in certain console views.

audit log directory

Complete path where the audit log of the console will be saved in text format.

Set alias as name by default in agent creation:
When enabling this parameter , the agent creation menu checkbox, which contains the alias entered in the form and also saves this as the agent name, is activated by default.

1.2.2 Features of the Enterprise Version

Now we're going to describe some fields which are exclusive to the Enterprise version of Pandora FMS.


Pandora enterprise1.png
Pandora enterprise2.png
Pandora enterprise3.png


Forward SNMP traps to Agent (if exist):
Configuration that allows to associate SNMP traps and agents. When this option is enabled, when a trap with the same IP as an agent is received, a module is created in the same agent with the name SNMPTrap and of the async_string type. The module value will be that of the last OID received, that is, it will be updated with the arrival of new traps.

If Yes and change status is selected, besides updating the value when receiving the trap, the module is set to CRITICAL status. To return to the NORMAL state, all traps associated with that agent must be validated or deleted from the SNMP console. In the case of Yes without changing status only the value of the module is changed.


Use Enterprise ACL System:
This option is going to activate the Enterprise version's ACL System which is much more flexible than the default one. Please read the section named Enterprise ACL System if you like to obtain more information about this topic.

Collection Size:
This field defines the maximum size of the collections. Please read the section named Monitoring by Policies if you like to obtain more information about this topic.

Event Replication:
If the event replication is activated, the received events are going to be copied into the meta console's remote database.

Activate log collector Activate the log.

Enable update manager Activate the Update Manager option.

Inventory Changes Blacklist:
The inventory modules included into the changes blacklist are not going to generate any events if a change occurs.

Mail configuration

Configure here a series of values such as the outgoing address, the SMTP server ID, SMTP port and, if necessary, the user and his email password.

Remember! This section substitutes the previous mail configuration located in the PHP configuration file (email_config.php).

Template wip.png

We are working on the translation of the Pandora FMS documentation. Sorry for any inconvenience.

 


1.2.3 Password Policy

1.2.3.1 Introduction

You're able to utilize the password policies from Pandora FMS Enterprise versions 5 and above. It's a group of rules which apply in the moment you're defining the Pandora FMS user passwords. This policy was designed to be applied to standard and administration users, as we're going to see below.

1.2.3.2 Configuration

You're required to have administrator permissions in order to enable the password policy. It's configured by clicking on 'Administration' and 'Setup' in a section called 'Enterprise Password Policy'.

Setup pass policy.jpg

The configuration parameters pertaining to this particular feature are the following:


Enable Password Policy:
It's intended to enable or disable the password policy activation. It's disabled by default.

Min. size Password:
It's the password's minimum size. The default value is '4 characters'.

Password must have Numbers:
The password is required to have numbers. It's disabled by default.

Password must have Symbols:
The password is required to have symbols. It's disabled by default.

Password Expiration:
The password's expiration period. The default value is '0', which means that it never expires. Force change password on first login: It forces a login by password in the moment of first login after the user's creation. It's disabled by default.

User blocked if login fails:
It's the feature intended to determine time the user is blocked if it exhausts the maximum number of failed log-in attempts. The default value is '5 minutes'.

Number of failed login Attempts:
It's the number of allowed failed login attempts in the moment of logging. The default value is '5 attempts'. Apply password policy to admin users: It's the feature to include the password policy also to administrator users. It's disabled by default.

Enable password history:
It's used to enable or disable the password history. It's disabled by default.

Compare previous Password:
It's the number of previous passwords which are considered inappropriate for a password change, because they've been used before. The default value is '3'.

1.2.4 The Log Collector

If you select this option, a window like the one shown on the picture below is going to appear.

Log collector.png

The configurable fields pertaining to this particular feature are the following:

Log Storage Directory:
The directory in which the log data is going to be stored.

Log max. Lifetime:
The log's maximum lifetime.

1.2.5 The History Database

This feature allows you to enable the Pandora FMS Database History options in order to save old data within an auxiliary database. This system accelerates all queries and accesses to the data.

History database.png

The options pertaining to this particular feature are the following:

  • Enable history database: It's intended to enable or disable the database's history feature.
  • Host: The host name of the history database.
  • Port:: The port of the history database.
  • Database Name: The name for the history database.
  • Database User: The user allowed to access the history database.
  • Database Password: The password to access the history database.
  • Days: The number of days for the data to be transferred to the history database.
  • Step: The buffer size for the data transfer (in number of items). The lower the value, the slower the data transfer, but it also lowers the performance reduction within the main database. An appropriate default value is '1000'.
  • Delay: The delay time (in seconds) for the data block transfer between main and history databases. An appropriate value is '2'.

1.2.6 Authentication

There are several options for authentication:

  • Active Directory
  • LDAP
  • Local Pandora FMS
  • Remote Integria IMS
  • Remote Pandora FMS
  • SAML

Template warning.png

Due to certain security reasons, the users with administrator privileges are always required to use the local authentication of Pandora FMS.

 


1.2.6.1 Active Directory

If we select this option, the window shown on the picture below will appear.

Setup Active Directory.png

The configuration parameters are the following:


Fallback to Local Authentication:

Enable this option if you want to fall back to a local authentication if the Active Directory remote authentication fails.

Autocreate remote users

Enables/disables the automatic creation of remote users. This option makes possible for Pandora FMS to create the users automatically once they log using their LDAP user. The three following fields will appear ONLY if autocreation is ENABLED.

Autocreate profile

If autocreation of users is enabled, this field makes possible to assign a particular profile type to the users automatically created. The default profiles are:

   Chief Operator
   Group Coordinator
   Operator (Read)
   Operator (Write)
   Pandora Administrator

You can check the different profiles on the section: Administration -> Manage Users -> Manage Profiles.

Autocreate profile group

Enabling the users autocreation, this field makes possible to assign them a group. The default groups are:

   Servers
   Firewalls
   Databases
   Network
   Unknown
   Workstations
   Applications
   Web

The different groups can be checked on the section Administration -> Manage Monitoring -> Manage Groups.

Autocreate blacklist

A comma separated list of users that won't be created automatically.

Advance Config AD

The Advance Permissions AD configuration will be used if this option is enabled.

Advance Permissions AD

To specify the profile, group and tags desired for one or several Active Directory groups. The configuration has to be like this:

   Profile,Group,[GrupoAD1-GrupoAD2-GrupoADn-...],[Tag1-Tag2-Tagn-...]

To add more than one, just add a new line. If the configuration isn't correct, the profile won't be added to the user.

Active directory server URI

Define here the LDAP path where the Active Directory server is. Usually: ldap://addc.midominio

Active directory port

Define here the Active Directory server port.

Start TLS

To use the Transport Layer Security (TLS) protocol between client and server.

Domain

Domain that the Active Directory will use.


Template warning.png

Every time a user logs in, his permissions will be checked to see if there has been any change. In that case, he will have to log in again.

 


1.2.6.1.1 Configuring support to Microsoft Active Directory with TLS

The next conditions must be accomplished:

- The Pandora server should be able to resolv the FQDN of the domain controller, and it must be listening to basic and SSL modes (default ports 389 and 636).

- The security certificate must be placed on the Pandora server.


1.2.6.1.1.1 Step 1: Configuring the server AC certificate

Paso 1.1: Generate certificates for the domain controller

Follow the next link to generate a self signed certificate for your domain controller, remember match the certificate's common name with the FQDN of the domain controller:

LDAP over SSL


Paso 1.2: Exporting the certificate

Launch de local certificate management console:

Exporta1.PNG


Select the certificate to export:

Exporta2.PNG


Open the certificate previously registered following the manual indicated in the previous section:

Exporta3.PNG


Follow the wizzard to export, choose x509 DER (.CER) configuration:

Exporta4.PNG


Select a destination for the file .CER:

Exporta5.PNG


Review the configuration and press FINISH to end the wizzard.

You must recevie a message: "The export was succesful." at the end of the wizzard.

At this point, we must copy the .cer file to our Pandora FMS server.



Step 1.3: Adding the certificate to the Pandora server

Copy the .CER file generated in the previous section to the openLDAP's common certificates folder:

cp micertificado.cer /etc/openldap/certs/


Configure openLDAP (file /etc/openldap/ldap.conf) as shown down (check to match de name of the .CER file with yours):

# ------------ FILE /etc/openldap/ldap.conf ------------ #

#
# LDAP Defaults
#

# See ldap.conf(5) for details
# This file should be world readable but not world writable.

#SIZELIMIT      12
#TIMELIMIT      15
#DEREF          never

#BASE    dc=artica,dc=lab
#URI     ldap://artica.lab

#TLS_REQCERT ALLOW
TLS_CACERT      /etc/openldap/certs/micertificado.cer
TLS_CACERTDIR   /etc/openldap/certs

# ------------------------ EOF ------------------------- #


Uncomment the line TLS_REQCERT ALLOW if your certificate is self signed.

1.2.6.1.1.2 Step 2: Checking communications and service availability

Launch nmap over the domain controller:

nmap domaincontroller.domain -p puerto_basico,puerto_ssl

It'll show an exit like next:

Addctls nmap scan.png

If the domain controller is not responding or have no ports in OPEN status, check any conectivity or name resolution issues.


1.2.6.1.1.3 Step 3: Configuring AD with SSL/TLS in Pandora Console

The next configuration will enable the login over Microsoft AD with SSL/TLS:

Pfms auth config.png


1.2.6.2 LDAP

If you select this option, a window like the one shown on the picture below is going to appear.

Ldap.png

The options pertaining to this particular feature are the following:

Fallback to local Authentication:
Please enable this option if you intend to fall back to a local authentication if the LDAP remote authentication happens to fail.

Auto-Create Remote Users:
It enables and disables the remote user creation automatically. This option allows Pandora FMS to create the users automatically, once logged in by using LDAP. If enabled, the three below mentioned fields are going to be available. If not, the fields are blocked.

Save Password

Enabling this option will save the LDAP password to the database.

LDAP function

When searching in LDAP, you can choose whether to use PHP's native function or use the local command ldapsearch. We recommend using the local command for environments that have an LDAP with many elements.


Login user attribute

When the user is created, we save in the database the name or email for login.

Advanced Config LDAP

  • If this option isn't enabled, the simple system for creating user profiles will be used (it uses Autocreate profile, Autocreate profile group, Autocreate profile tags).
  • If this option is enabled, a list of all saved advanced permissions will appear. We can add new permissions by selecting the profile, groups and tags next to the attribute filter. If the user meets any of these attributes (for example, an organizational unit or specific group) then the user will be created.



Ldap advanced.png



In the example image we can see that all LDAP users that are going to be created in Pandora and that have the attribute "group_id=16" or with the attribute "email" ending in "@artica. es" would receive the profile of "Operator (Read)" about the group "All" and all the tags.

NOTE Is very important when you put the attributes you must put them with the following format Attribute_name=Attribute_value as shown in the example of "group_id=16".

Auto-Create Profile:
If the automatic remote user creation is enabled, this feature was designed to assign a profile to the automatically created users. There are the following available default profiles:

  • Chief Operator
  • Group Coordinator
  • Operator (Read)
  • Operator (Write)
  • Pandora Administrator

You're also able to review all available profiles by clicking on 'Administration' -> 'Manage Users' and 'Manage Profiles'.

Auto-Create Profile Group:
If the automatic remote user creation is enabled, this field allows you to assign groups to automatically created users. There are the following available default groups:

  • Servers
  • Firewalls
  • Databases
  • Network
  • Unknown
  • Workstations
  • Applications
  • Web

You're also able to create new groups or to list all available groups by clicking on 'Administration' -> 'Manage Agents' and 'Manage Groups'.

Autocreate profile tags

While the automatic creation of remote users is active, this field makes it possible to assign a tag to these users that are created automatically.

LDAP Server:
The LDAP server's address.

LDAP Port:
The LDAP server's port.

LDAP Version:
The LDAP server's version.

Start TLS:
It's intended to switch the Transport Layer Security (TLS) protocol for communications between client and server on or off.

Base DN:
The Distinguished Name (DN) used by the LDAP server, e.g. 'ou=People,dc=edu,dc=example,dc=org'.

Login Attributes:
The login attributes used by the LDAP server during the authentication process, e.g. the UID.

Admin LDAP login

For LDAP systems that need to perform authentication prior to the user's search, you must specify in this field a user with permissions to perform the search.

Admin LDAP password

In this field we will indicate the password of the user of the previous field.

1.2.6.3 Local Pandora FMS

If you select this option, the configurable fields are going to disappear. This option conducts the authentication by using the internal database of Pandora FMS.

1.2.6.4 Remote Integria IMS

If you select this option, a window like the one shown on the picture below is going to appear.

Setup authentication integria.png

The parameters pertaining to this particular feature are the following:

Fallback to local Authentication:
Please enable this option if you intend to fall back to a local authentication if the Integria IMS remote authentication happens to fail.

Integria Host:
The Integria IMS server's address.

MySQL Port:
The MySQL port of the Integria IMS database.

Database Name:
The Integria IMS database's name.

User:
The user allowed to access the Integria IMS Database.

Password:
The password to access the Integria IMS Database.

1.2.6.5 Remote Pandora FMS

If you select this option, a window like the one shown on the picture below is going to appear.

Setup authentication remote pandora.png

The parameters pertaining to this particular feature are the following:

Fallback to local Authentication:
Please enable this option if you intend to fall back to a local authentication in case the Pandora FMS remote authentication happens to fail.

Pandora FMS Host:
The Pandora FMS server's address.

MySQL Port:
The MySQL port of the Pandora FMS database.

Database Name:
The name of the Pandora FMS database.

User:
The user allowed to access the Pandora FMS Database.

Password:
The password to access the Pandora FMS Database.

1.2.6.6 SAML

If you select this option, a window like the one shown on the picture below is going to appear.

Pandora console 13.png

For the configuration of SAML, you can read this section.

1.2.7 Double authentication

Since the 6.0 version, it will be possible to enable this option to allow the users to activate the two step authentication in their accounts. To know more about enabling the two step authentication in an user account, you could read this quick guide.


Template warning.png

This functionality requires the server and the mobile devices has the date and time the more synchronized and precise as possible.

 


1.2.8 Performance

If you select this option, a window like the one shown on the picture below is going to appear.

Setup performance main.png

The parameters pertaining to this particular feature are the following:

Max. days before delete Events:
The maximum number of days before the events are going to be deleted.

Max. days before delete Traps:
The maximum number of days before the traps are going to be deleted.

Max. days before delete Audit Events:
The maximum number of days before the audit events are going to be deleted.

Max. days before delete String Data:
The maximum number of days before the string data are going to be deleted.

Max. days before delete GIS Data:
The maximum number of days before the GIS data are going to be deleted.

Max. days before Purge:
The maximum number of days before purging the database. This parameter is also used to specify the maximum number of days before deleting the inventory data.

Max. days before compact Data:
The maximum number of days before compacting the data.

Compact interpolation in hours ('1' = ok '-20' = bad)
This is the length of the compacting interval in hours, e.g. a module with an interval of 5 minutes generates 288 values per day. If this interval is set to '2', the data is going to be grouped in 2 hour intervals and averaged, resulting in 12 values per day instead of 288. The higher this value, the less the resolution. A value close to '1' is recommended.

SLA Period (in seconds):
The default time to calculate the SLA within the agent's SLA tab in seconds. It calculates the SLA within the modules within an agent automatically. It's based on the defined 'critical' or 'normal' values.

Default hours for Event View:
It's default number of hours for event filtering. If the value is '24 hours', the event views are only going to display the events which occurred in the last 24 hours. This field also affects the display, counting and graphing of events in the tactical view.

Use real-time Statistics:
It enables or disables the real-time statistics.

Batch statistics Period (secs):
If real-time statistics are disabled, this is the parameter to define the refresh time for the batch statistics.

Use agent Access Graph:
The agent's access graph renders the number of agent contacts per hour in a graph on a scale of 24 hours. This feature is intended to learn the contact frequency for each agent. Under some circumstances, it could take quite a long time to process the data, so if you have slow hardware resources, it's recommended to disable it.

Max. days before delete unknown Modules:
It's the maximum number of days before the deletion of unknown modules.

Max. recommended number of files in attachment directory:
It's the maximum number of stored files in the attachment directory.

Delete not init modules
Enables or disables the deletion of uninitialized modules.

Big Operation Step to purge old data

Number of blocks in which "pandora_manage.pl" divides a time interval.

A larger value implies larger blocks of time, which means performing more operations, albeit lighter. On overloaded systems and very large databases it may be advisable to increase this value even if the purging of the data takes longer.

For example, in a database with 1 day of data to purge, the time interval would be divided into 100 blocks of 864 seconds (using the default value).

The default and recommended value is 100.

Small Operation Step to purge old data

Number of rows that "pandora_manage.pl" processes in a single SQL query.

This means that for each block of time defined by the "Big Operation Step to purge old data" parameter, a maximum of 1000 records will be purged with each query (using the default value).

A higher value involves larger queries, which means fewer operations, but heavier ones. On overloaded systems it may be advisable to reduce this value, even if the purging of the data takes longer.

The default and recommended value is 1000.

1.2.9 Visual Styles

Pandora console 15.png

Block Size for Pagination:

The block size for pagination.

Default interval for refresh on Visual Console:

This parameter determines the refresh interval for visual console pages.

Paginate Module View:

It activates the pagination within the module list.

Display data of proc modules in other format

Proc type data represent binary states of a module. In the database they are collected as a number, but could also be represented in a descriptive way with an identifier for each of the two states. If this option is enabled, this second form of representation is used.

Display text proc modules have state is ok

When the option Display data of proc modules in other format is activated, text that appears to replace the number when the module has a correct status.

Display text when proc modules

When the option Display data of proc modules in other format is activated, text that appears to replace the number when the module has a fault state.

Click to display lateral menus

This parameter will configure if the side menu drops down when we left click on it, or when we hover the cursor over it.

Service label font size

Font size of the services.

Space between items in Service maps

Distance (in pixels) between two elements of the service maps. This value cannot be less than 80px to avoid overlaps.

Classic menu mode

If enabled, the side menu will always display the names of the menu items instead of just the icons.

Pandora console 15 00 01.png

Style Template

It defines the Pandora FMS console's web style. You're able to add new skins or templates by including CSS files in the folder called 'include/styles'.

Status Icon Set

This combo was designed to select the icons used to visualize the module's states. By default the colors red, yellow and green are used. You may replace the colors by other conceptual icons which allow you to differentiate the module's status if you're e.g. required to adapt the system to users with color blindness.

Custom favicon

You can change Pandora's favicon as well as leave the default one. It must be inico format and its dimensions must be 16x16 for it to work properly. You can add icons to choose from in the images/custom_favicon folder.


Custom background logo:

You can place your custom images to the folder called 'images/background'.

Custom Logo

This feature is only available in the open-source version and allows you to display your logo in the Pandora FMS console header. You may use any PNG picture. The default size for a picture is 60x139 pixels. You may upload your logo to the directory called '/images/custom_logo' by using the file manager.

Custom logo (header white background)

In some parts of the tool there is a dark background and in other parts there is a white background. For this reason, Pandora FMS can be configured with an alternative icon for the pages that have a white background so that it can be displayed well in all views. The direction you go up is the same as the previous one.

Custom logo (login)

ICustom icon for the login section. To upload more icons, on the route /images/custom_logo.

Custom Splash (login)

Custom icon for the logo that appears just to the right of theinputs' of text on the login screen. The path to upload more icons isenterprise/images/custom_splash_login.

Custom documentation logo y Custom support logo

Icon for the link to the documentation and support of the login screen. If left blank, no icon will be displayed. The path to upload more icons isenterprise/images/custom_general_logos/.

Custom networkmap center logo

You can also customize the icon of the central node of the network maps. The path to upload more icons isenterprise/images/custom_general_logos/. You can use the Pandora icon by default.

Custom mobile console icon

Personalization of the icon of the mobile console. The path to upload more icons is enterprise/images/custom_general_logos/. By default it will put the pandora icon with a subtitle that indicates that it is the mobile console.

Pandora console 15 00 02.png

Title 1 (login) and Title 2 (login)

Title and subtitle of the login screen.

Docs URL (login)

URL address to which the "Docs" link in the top bar of the login screen leads.

Support URL (login)

URL address to which the "Support" link in the top bar of the login screen leads.

Product name

By default, the product name is Pandora FMS. However, in the enterprise version, the user is given the option to change it to another text string for a more customized version.

Copyright notice

By default, Pandora's author's name is Ártica ST. However, in the enterprise version, tthe user is given the option to perform a 'rebranding', that is, to change Ártica ST to another text string for a more customized version.

Disable logo in graphs

Remove the watermark from the charts.

Disable helps

Hide all Pandora's help. This configuration option affects both the modal windows and the wizard and other links to the Pandora documentation.

Fixed header

The header is always displayed, i.e. it is not hidden when scrolling.

Fixed menu

The side menu is always displayed, i.e. it is not hidden when scrolling.

Auto-hidden Menu

This option minimizes the side menu after a few seconds.

Visual effects and animation

Disable some Javascript effects.

Pandora console 15 01.png

GIS Labels

Please enable this option if you intend to obtain a label which contains the agent's name in GIS maps. However, if your maps contain a lot of agent names, they're very likely to be unreadable.

Default Icon in GIS

The agent's icon to be used on the GIS maps. If you set it to 'none', the group's icon is going to be used.

Font path

It's the main font's selector combo. This True-Type font is used in Pandora FMS graphs.

Font size

Font size of Pandora FMS graphics font.

Agent size text

If the agent's name consists of a lot of characters, it's required to truncate it into N characters in some sections within the Pandora FMS console.

Module size text

If the module's name consists of a lot of characters, it's required to truncate it into N characters in some sections within the Pandora FMS console.

Description size text If the description consists of a lot of characters, it's required to truncate it into N characters in some sections within the Pandora FMS console.

Item Title Size Text

If the item's title consists of a lot of characters, it's required to truncate it into N characters in some sections within the Pandora FMS Console.

Show unit along with value in reports

Muestra las unidades además del valor del módulo en los informes.

Pandora console 15 02.png

Graph Color (min)

It's the color for the minimum value in module graphs.

Graph Color (avg)

It's the color for the average value in module graphs.

Graph Color (max)

It's the color for the maximum value in module graphs.

Graph color #4 -> Graph color #10

These colors are used in Pandora FMS graphs.

Graphic Resolution

It defines the graphical resolution.('1' = low, '5' = high)

Value to interface graphics

Nombre de las unidades para los gráficos de interfaz.

Data precision

Number of decimals shown in reports and visual consoles. It must be a number between 0 and 5.

Data precision in graphs

Number of decimals shown in graphs. It must be a number between 0 and 5.

Default line width for the Custom Graphs

Ancho por defecto de la línea de las Custom Graphs.

Use round Corners

It's intended to switch the round corners of the progress bar and other Pandora FMS graphics on or off.

Interactive Charts

This option determines whether to use JavaScript or static PNG graphs.

Type of module charts

Type of representation for the module graphics. You can choose between area or line graphics.

Type of interface charts

Type of representation for the interface graphics. You can choose between area or line graphics.

Show only average

The graphs (with the exception of the TIPs) are an approximate representation of the data available. This approach involves splitting the period to be represented into several pieces and calculating values that indicate the state of the module in each of these sections. The values that are calculated are the average, minimum and maximum. To paint only the average and have cleaner but slightly less representative graphs, you must activate this option.

Percentile

Shows a line with the 95th percentile on the graphs.

Graph TIP view

This parameter indicates if TIP graphs will be displayed. There are three options:

None: the TIP option of the graphs setup will be deactivated (default option).

All: The TIP option of the graphs menu will be activated.

Boolean graphs: The TIP option will only be activated in the Boolean-type graphs.

Pandora console 15 03.png

Type of view of visual consoles

Drop-down to indicate whether you want your favorite visual consoles to be displayed in the menu.

Number of favorite visual consoles to show in the menu

Favorite visual consoles will appear in the side menu, but due to performance and overlap problems, they cannot all appear in the case of a high number. With this token, the number of visual consoles is limited.

Default line width for the Visual Console

Line width on visual consoles. This option can be changed within the visual console itself individually for each line, but the default value is detailed here.

Show report info with description

Displays the report information or only the data.

Front page for custom reports

The custom report's front page is going to be applied to all reports and templates by default.

Display the QR Code's icon on the header

It's intended to display QR Code within the header.

Custom Graphviz Directory

It's the custom directory in which the Graphviz binaries are stored in.

Networkmap max width

Maximum width of the network maps to avoid that an unfathomable screen is shown.

Show only the group's name

Show the group name instead of the group icon.

Date Format String

The date's format. You're going to find all available options within the console's help.

Timestamp or Time Comparison

It defines which date and hour is used. There are two available options: The 'Timestamp in rollover' system timestamp or the 'comparison in rollover' database timestamp. It's very useful in cases the database belongs to different system other than the console.

Custom value post processing

Custom values for post-processing. Updates a database table to have custom conversions from one unit to another.

Interval Values

This parameter determines the interval values.

CSV divider

Character or character set with which data is to be separated when exporting to CSV.

1.2.10 Netflow

If you select this option, a window like the one shown on the picture below is going to appear.

Setup netflow.png

The configurable fields pertaining to this particular feature are the following:


Data Storage Path:
The directory in which the Netflow data is stored.

Daemon Interval:
The time interval in seconds to update the Netflow data.

Daemon Binary Path:
The nfcapd path.

Nfdump Binary Path:
The nfdump path.

Nfexpire Binary Path:
The binary path for nfexpire.

Maximum Chart Resolution:
The maximum graph and chart resolution.

Disable custom live view filters:
The option to disable the custom live-view filters.

Netflow max. Lifetime:
The maximum lifetime of the Netflow data.

Name Resolution for the IP Address:
The feature intended to resolve IP addresses in order to obtain their host names.

1.3 The File Manager

The File Manager was designed to upload files to Pandora FMS. You're able to access the file manager's page by clicking on 'Admin Tools' -> 'File Manager'.

Setup file manager.png

If you invoke the above mentioned feature, a window like the one shown on the picture below is going to appear.

Set2.png

The content of the 'images' folder within your Pandora FMS installation is displayed in this section. In it, you're able to browse directories, create files and folders and upload and download files from your local hard disk.

You're required to use the buttons shown on the picture below in order to do that.

Setup file manager buttons.png

The buttons are the following: 'create folder', 'create text file' and 'upload file'.

1.3.1 Creating Folders

Setup file manager create folder.png

After clicking on the 'create folder' button, the field shown on the picture above is going to appear.

Just enter the name of the folder and click on the 'Create' button. If you click on the 'Close' button, the dialog is going to close.

1.3.2 Creating Text Files

Setup file manager create textfile.png

After clicking on the 'create file' button, the field above is going to appear.

Just enter the name of the file and click on the 'Create' button. If you click on the 'Close' button, the dialog is going to close.

1.3.3 Uploading Files

Setup file manager upload file.png

After clicking on the 'update file' button, the field on the picture above is going to appear.

Just click on the 'Browse' button, browse your local disk and select the file you want to upload.

It's also possible to upload several files at once by selecting a zipped file and selecting the 'Decompress' option. The file will be unzipped and all your compressed files inside is going to appear within the folder.

1.4 GIS Map Connection

Under Pandora FMS it's possible to obtain the agent's location by using interactive maps. You're able to configure all parameters related to the connection of the GIS map provider, e.g. OpenLayers of Google Maps within this section.

You're able to obtain further information about GIS in the section called GIS Console.

1.5 Links

By clicking on 'Admin Tools' -> 'Links', you're able to access the link-managing page of the Pandora FMS Console.

Setup links.png

If you invoke the above mentioned feature, a window like the one shown on the picture below is going to appear.

Setup links main.png

The process of creating or updating a link is very similar. Please click on the 'Add' button in order to create a new link. Please click on 'update a link' and click on the link's name. Both methods are displaying the same screen. In the first case, the screen is empty and in the second the screen displays the data of the link to be modified.

Setup links create new.png

The configurable options pertaining to this particular feature are the following:

Link Name:
The link's name.

Link:
The link's address.

Please click on the 'Create' or 'Update' button in order to create or modify the link, once all fields have been filled out appropriately.

In order to delete a link, please click on the red cross which is located in the same row as the link you intend to delete.

1.6 Site News

By clicking on 'Admin Tools' -> 'Site News' it's possible to add news which are going to appear in console's home page.

Set5.png

Please click on the 'Add' button in order to create news. Subsequently, the window shown on the picture below is going to appear.

Set6.png

Please insert an appropriate title and text and click on the 'Update' button. It's possible to delete a news by clicking on the red cross on its right or editing it by clicking on its name.

1.7 Edit OS

This feature was designed to edit or create new operating systems.

Edit os1.png

The feature shown on the picture below was designed to create or edit new operating systems.

Edit os2.png

The configurable fields pertaining to this particular feature are the following:

Name:
The operating system's name.

Description:
The description for the newly created operating system.

Icon:
Please select an appropriate icon for the OS here.

1.8 The Enterprise ACL Setup

This feature is explained in the section called Enterprise ACL System.

1.9 The Metaconsole

This feature is explained in the section called Metaconsole.

1.10 Skins

This feature was designed to customize the look of the Pandora FMS Console Interface. This feature was made by changing the CSS style files and the associated icons. In order to create a new skin you're required to replicate the folder structure of the console.


The folders pertaining to this particular feature are the following:


Images: This directory is intended to contain the skin's icons and images.
Include/styles: This folder is intended to contain the skin's CSS files.


The skin called 'Example' contains the following directory structure:

 Example/
 |
 |_______images/
 |
 |_______include/
            |
            |_________styles/
          

This structure can be found in '<pandora_root>/images/skin'. All file structures and the content are required to be compressed in a zip file. A skin could be applied to two levels:

User:
The field for the user's name.

Group:
The skin is going to be applied to all users which belong to the group mentioned here.

If a user has a skin for itself and the group it belongs to has another one, the user's skin has a higher priority. The window intended to access the available skins is shown on the picture below.

Skins 1.png

You're required to use the window shown on the picture below in order to create or to configure any skin.

Skins 2.png

The configurable fields pertaining to this particular feature are the following:

Name:
The skin's name.

Relative Path:
During the creation process, this field is going to ask you to upload the zip file. During any modification process, this field contains the name of the uploaded zip file.

Description:
The skin's description.

Group/s:
The groups assigned to this skin.

Disabled:
A field intended to disable skins which aren't applied to any user.

1.11 The Pandora FMS Diagnostic Tool

This tool was designed to detect an installation profile of Pandora FMS. It's going to display information e.g. like the Pandora FMS version, the PHP version and database volumetric information.

Diagnostic tool.png

1.12 Update Manager Settings

This feature is thoroughly explained in the section called Update Manager.

1.13 Translating Strings

This extension is thoroughly explained in the section called Translation of Strings.

2 Updating Languages

In order to update any language of the Pandora FMS console, you're required to invoke the Launchpad Translation Download Page, select the languages you intend to update (they're in *.mo file format), to click on the 'Request Download' button and to wait for an email which contains indicators and a location to download the files. Once the download is completed, please copy them into the folder called '/include/languages/' of the Pandora FMS console and your languages are updated instantly.


Info.png

You're required to create an account under Launchpad in order to be able to download the translation files.

 


Go back to Pandora FMS Documentation Index