Console Configuration

In this section, you can modify and adjust operational parameters of the Pandora FMS Web Console, which will affect its overall functioning.

The main and densest section is divided into five subsections:

1. Basic: Languages, date and time, etc.
2. Security: Points related to securing the Web Console and API.
3. Behavior: Behaviors of the report console, agents, and modules, events, and miscellaneous items like mass operations, collections, IPAM, and NCM.
4. Features: Enabling or disabling important PFMS functionalities.
5. Network: Critical for accessing the Web Console.
6. Directories: The most important and essential absolute paths for PFMS functionalities (attachments, RMM, etc.).
7. Mail configuration: Email is still a valid tool for keeping people connected, here are instructions to configure PFMS as a one-way email client.

• Language code: By default, English (English (UK)) is used and sets the language for users who have the default language set. Each user can choose their own language and this general value will be ignored for that user.
• Time source: A list where you can choose the source of the date and time to use. It can be the local system (System by default) or the database (Database). The first is typically used when the database is on a different system with a different timezone than the Web Console.
• Server timezone setup: Defines the timezone for the Web Console. Unlike country codes and abbreviations (ISO 3166 standard), the list of time zones follows complex rules (IANA Time Zone Database), so an initial list with continents and countries is included, and selecting an option updates the second list where you can choose a specific country, city, or region. From version 785, the Change timezone button has no effect; you will only need to use both lists and save the changes.
• Enable update manager: Enables or disables the option for the Warp Update Manager.
• Automatically check for updates: Enable or disable automatic checking for updates in the Warp Update. This causes the Web Console to contact Pandora FMS’s update provider every time you log in, sending anonymous information about Pandora FMS usage (number of agents).
• Enable console log: Due to the large amount of debugging data generated, it is recommended to keep this log disabled as it is by default. If enabled, the Console event logs will be stored in the following file:

/var/log/php-fpm/error.log

/etc/php-fpm.d/www.conf

;php_admin_value[error_log] = /var/log/php-fpm/www-error.log

• Tutorial mode: By default, in full assistance mode, it allows displaying messages and help links in different sections and/or functionalities of the Web Console.
• Enable Feedback: Active by default, it allows direct access in the header of the Web Console to notify the Pandora FMS team of an error, including installation data in a PDF file.
• SSH server port for reverse SSH tunnels: Used for reverse SSH tunnels, this is the port number where the SSH server listens on the PFMS Server.

• Enable audit log: When enabled, the file …/pandora_console/log/audit.log will also be used to log auditing activities.
• Use SSL certificate: Allows specifying a digital certificate to encrypt communication between the Web Console and users. Each PFMS Server must use a unique certificate, and the default path suggests the directory where to store it, with the filename being merely a suggestion.
• Enforce https: Forces the redirection to HTTPS. If enabled, Pandora FMS will be required to use HTTPS on the web server.

UPDATE tconfig  SET `value` = 0 WHERE `token` = 'https';

• Referer security: When enabled, for security reasons, it verifies that the user comes from a Pandora FMS URL and that the link is not external, thus preventing suspicious links. By default, this is disabled. Verified sites include:

1. DB manager extension.
2. User configuration.
3. Configuration of Recon Server scripts.

• API password: Authentication method to access the Pandora FMS API 1.0.
• IP list with API access: List of IP addresses that will have access to Pandora FMS's web service API (by default, 127.0.0.1, local access only). The asterisk can be used as a wildcard, so * will grant access to all IP addresses, or for example, 125.56.24.* will grant access to the entire 125.56.24 subnet.

This section controls behaviors related to the report console and connectivity, details of agents and modules (including API and SNMP traps), PFMS events, and miscellaneous items like mass operations, collections, IPAM, and NCM.

• Enable console dedicated to report generation: The dedicated reporting console has the critical mission of preparing, converting into useful information, generating, saving, and sending reports for hundreds of agents and EndPoints. For this, it has special configurations for both software and hardware:

1. The memory (RAM, virtual or real) for PHP must be able to use, if necessary, the maximum amount available on the system. If not, a warning will be triggered. Refer to installation for configuration details.
2. Only administrator users can log in to the dedicated reporting console.
3. Menu options are limited to essential functions, especially for PFMS software updates. All other settings should be configured through another web console connected to the same databases. See the section for email configuration.
4. To use the dedicated reporting console, the respective config.php file must include the following parameter:

$config["reporting_console_node"] = true;

• Check connection interval: Time interval (in seconds) to check the connection with the database server. Default is 180, minimum is 60.

• Set alias as name by default in agent creation: Enabling this option for agent creation via Web Console automatically enables Use alias as name, allowing the agent's name and alias to be the same value. Disabled by default.
• Unique IP: Enabling this option automatically activates the Unique IP button during agent creation and editing to detect if the IP addresses assigned to an agent are available or if they are being used by the same or another agent. Disabled by default.
• Forward SNMP traps to an agent (if it exists): Configuration that allows associating SNMP traps with agents. Enabling this option will create a module for an agent named SNMPTrap and type async_string when a trap is received with the same IP address as an agent. The module value will be the last received OID, updated as new traps arrive. If Yes, and change status is selected, the module status will change to CRITICAL upon receiving a trap. To return to NORMAL status, all traps associated with the agent must be validated or deleted from the SNMP console. If Yes, but do not change status is selected, only the module value changes. By default, SNMP traps are not forwarded (button No, do not forward).
• Include manually disabled agents: Allows enabling or disabling the display of manually disabled agents in certain views of the Web Console.
• Enable module custom ID read-only: Enabling this option locks the editing of an agent's module custom ID from the Console but allows editing from CLI and the API. Useful for third-party automated integrations without allowing the user to modify this value.
• Command line snapshot: Chain modules that return multiple lines will display their content as formatted text in command line style.
• Change remote config encoding: Enabling this option changes the character encoding (encoding) of module writes in remote configuration files from the default UTF-8 to the encoding configured in the configuration files.
• Number of modules in queue: Sets the maximum number of modules in queue (default 500). If this value is exceeded, a warning icon will be shown for each item in the server management.
• API interval for module (seconds): Default value is 300 seconds, minimum 60.

• Event storm protection: If enabled, data will continue to be received without generating events or alerts.
• Keep in process status for new events with extra ID: If enabled and there is an “In process” event (In process) with a specific extra identifier (ID Extra), and a new event with that ID Extra is received, it will be created as In process. New events will also inherit the ID Extra from the event.

Max. hours old events comments: When events are shown grouped, the comments of identical grouped events will be limited to the last specified number of hours.

• Inventory change blacklist: Inventory modules in the deny list will not generate events when changed. By default, for both Linux® and MS Windows®, the following are included: CPU,Process,Security.

• Allow create scheduled downtimes in the past: Enables or disables the ability to create scheduled downtimes in the past. The purpose is to modify information for SLA reports.
• Limit for bulk operations: Limit of items that can be modified via bulk operations at once, default is 500 (minimum 100), to prevent memory bottlenecks.
• Log size limit in system logs viewer extension: Sets a maximum size, in kilobytes, for log files.
• Collection size (Bytes): This is the maximum size, in bytes, for Collections.
• IPAM critical threshold for occupied addresses: Threshold for the IPAM supernetwork map extension, indicating a critical range for occupied addresses.
• IPAM warning threshold for occupied addresses: Threshold for the IPAM supernetwork map extension indicating a warning range for occupied addresses.
• NCM configuration FTP server IP: FTP server IP address for Network Equipment Templates. This value will be used by the macro TFTP_SERVER_IP in NCM scripts.

Upon PFMS installation, these features are disabled by default (except for vulnerability scanning):

• Show experimental features: The Pandora FMS team is working on continuous development and may place new improvements here, which users can get an initial preview of.
• Use Advanced ACL System: This will enable the Advanced ACL System which is more flexible than the standard ACL system.
• Enable GIS features: Enable or disable the GIS features for the Pandora FMS Web Console.
• Enable NetFlow: Enable or disable NetFlow monitoring®.
• Enable IOT Server: The Pandora IOT integration is designed to monitor messages received from an MQTT broker server.
• Enable agent vulnerability scanning: The Pandora FMS EndPoints and the remote discovery engine will look for information about the installed software on the system to detect potential vulnerabilities. This applies only to agents that have vulnerability scanning configured with the Use global settings option selected.

• Public URL: A public URL can be stored here. It is useful to fill this field when you have an inverse proxy or, for example, with the mod_proxy mode in the Apache web server.

The following two tokens will only be taken into account if a URL has been set in the previous field.

• Force use Public URL: Only the Public URL will be used to navigate to the web console (all links and references will be built based on the public URL).

UPDATE tconfig  SET `value` = 0 WHERE `token` = 'force_public_url';

• Public URL host exclusions: The IP addresses added here will use their own IP address to build their links and references, even if the token Force use Public URL is enabled. They can be separated by commas and/or on different lines. To add comments in a line, it should start with the symbol #.

• Attachment directory: Pandora FMS Console file directory. Used to host collections, incident attachments and other series of files. It must have write permissions for the web server and is located by default at:
  

  /var/www/html/pandora_console/attachment

  If the default path is changed to another custom location, you must contact the operating system administrator (root) where the PFMS Server is running since no hosted directory or file will be moved automatically. It is recommended, after backing up data and downloading the stored elements (collections, incident attachments, and file repository), to delete said contents via the web Console, change the path, save the changes, and upload everything again to the new location.

  
  

• Remote configuration directory: Field where the directory storing the remote configuration for the RMM feature is identified, by default located at:

/var/spool/pandora/rmm_server

• RMM remote config directory: Field where the directory storing the remote configuration for the agents is identified, by default located at:

/var/spool/pandora/data_in

• General network path: Directory where the netflow and sflow directories for the corresponding data will also be stored. Default value:

/var/spool/pandora/data_in/

• Chromium path: Chromium is a special component used to generate dynamic graphs in PDF format. You must enter the path or PATH where this component is installed, by default:

/usr/bin/chromium-browser

• Server log directory: Directory where the server log files are stored.

The default values when installing Pandora FMS are merely illustrative and should be changed based on the email provider used. Pandora FMS uses Postfix for routing and sending email, as it is included in many GNU/Linux®, macOS®, and BSD® distributions.

Pandora FMS supports the use of OAuth 2.0.

In the fields From address and From name, you must configure the sender's email account and the sender's name that will be displayed to the recipient.

Today, to avoid spam attacks on third parties, email servers generally require a user (which may differ from From address) and the respective password, which should be specified in the E-mail user and E-mail password fields.

It is recommended to encrypt the traffic when sending email to avoid man-in-the-middle (MITM) attacks. To do this, use the Encryption field with the protocol used by the email server. A summary of available encryption methods in PFMS:

• STARTTLS (Start Transport Layer Security): (recommended option) This protocol starts with an unencrypted SMTP connection on the standard port and then requests an upgrade to a secure connection using TLS. Port 587 is the most commonly used by most email providers. Port 25 is the standard SMTP port and is often blocked by many ISPs to prevent spam and is usually used only for private traffic between servers.
• SMTPS (SMTP Secure): The connection starts directly using SSL/TLS. No unencrypted connection is allowed. Port 465 is used for secure SMTP connections using SSL/TLS from the start. Although it was deprecated at some point, it is still supported by many email providers and remains a valid option for encrypted connections.

SMTP Server and SMTP Port: These store the domain (or IP address) and port number of the email server.

Configuration for some email hosting providers:

• Aruba (aruba.it)®.
• Amazon Simple Email Service (AWS SES)®.
• easyDNS (outbound mail)®.
• Gmail®.
• Mailgun®.
• Postmark®.
• Proton Mail®.
• Microsoft 365 Exchange® (OAuth 2.0).
• Google (OAuth 2.0).

Once the email configuration is saved, and after clicking the Email test option, you can check if the configuration is correct by sending an email generated by Pandora FMS to the specified email address. Only if the selected configuration is correct, you will see the message in the inbox of the specified email address.

• SMTP Server: smtps.aruba.it.
• SMTP Port: 465.
• Encryption: SSL.

• SMTP Server: email-smtp.< region >.amazonaws.com where < region > should be replaced with the server's location (in Spain, it is email-smtp.eu-south-2.amazonaws.com; AWS may change these values at any time).
• SMTP Port: 587.
• Encryption: STARTTLS.

• SMTP Server: mailout.easydns.com.
• SMTP Port: 587.
• Encryption: STARTTLS.

• SMTP Server: smtp.gmail.com.
• SMTP Port: 587.
• Encryption: STARTTLS.

If authentication errors are encountered, check that:

• Less secure apps are allowed to access the account.
• Or try enabling two-step verification and using an app password.

• SMTP Server: smtp.mailgun.org.
• SMTP Port: 587.
• Encryption: STARTTLS.

• SMTP Server: smtp.postmarkapp.com.
• SMTP Port: 587.
• Encryption: STARTTLS.

• SMTP Server: smtp.protonmail.ch.
• SMTP Port: 587.
• Encryption: STARTTLS.

• In Microsoft Azure® the application to be used must be registered:

• After registering the application, take note of the Client ID and Tenant ID:

• Create a Client secret and properly note the value:

• Grant API permissions to obtain users and send emails:

• Verify that the Office 365 Exchange application is registered:

• Then, activate the Office 365 Exchange application:

• Finally, configure OAuth2 in Pandora FMS with the obtained data:

Menu Management → Settings → System settings → General Setup → Mail configuration and activate OAuth2 to make the fields appear for configuration.

When activating the OAuth 2.0 option, select Google as the OAuth 2.0 Mail server and obtain the necessary data from Google Cloud®. To do this, create a new project:

Once created, go to the Gmail® library, API Library, select Gmail API:

Activate this option:

In the Data Access section, grant permissions for sending emails:

Under Service accounts, create a new item to obtain the CLIENT ID:

Once everything above is activated and configured, the next step is to configure OAuth2 credentials with the domain administrator to obtain the various keys for configuration.

With the superadmin account having the CLIENT ID copied, the following steps must be performed:

• Go to the Google® Admin Console: admin.google.com.
• Go to Security → Access and data control → API controls.
• Click on Manage Domain-Wide Delegation.
• Click on Add new.
• Create the record with the Service account ID and its scope:

https://www.googleapis.com/auth/gmail.send

This section allows integrating a standalone PFMS Server into a Command center and making it one of its nodes. The different fields include the location, type of database (MySQL always by default), database name, etc., including the necessary communication encryption options (token Enable SSL).

In Command center link status, you can always know the status of this connection, including help messages for each case.

To activate the password policy, you must have an administrator profile (Pandora administrator) or be a superadmin.

This feature allows you to store data older than a configured threshold in a different database from the main one to speed up the operation of the latter.

In the connection configuration (Configure connection target), you need to configure the basic data (address and port, database name, and credentials). Starting from version 782, MySQL can connect securely (SSL) by setting the following parameters:

• Enable SSL: Enables or disables the use of SSL for the database connection.
• SSL server key: Path or location of the file, in PEM format, that contains the MySQL server key.
• SSL server cert: Path or location of the file, in PEM format, that contains the MySQL server certificate of the SSL key.
• SSL CA cert: Path or location of the file, in PEM format, that contains a list of SSL certificates issued by a Certification Authority.
• SSL CA path: Path or location of the directory or folder that holds SSL certificates issued by a Certification Authority. Certificates must be in PEM format.
• SSL verify server cert: If enabled, it verifies the connection to MySQL (CN of the SSL certificate), if they do not match, the connection will not be made.

After successfully connecting to the historical database, you can configure the custom parameters (Customize settings):

Configurations for active to historical data:

• Advanced options: Enables advanced options:

1. String data days old to keep in active database: The age of string data to keep in the active database. String data will remain in the active database for the specified time and days. Older data will be sent to the historical database. Data will be purged from the active database after 0 days (default value).

• Data days old to keep in active database: After how many days data will be transferred to the historical database. Default value: fifteen 15 days.
• Transference block size (Step): Mechanism for transferring data (similar to a buffer) to the historical database. The lower the number of records, the less impact it will have on the performance of the main database. Default value is one thousand five hundred 1500 records, recommended value is one thousand. See the next point for configuring the time period.
• Delay between transferences (seconds): Waiting time -in seconds- between data transfers from the main database to the historical database. Default value: one 1, recommended value: two 2.

Configurations for historical data:

• Maximum historical data age (days): Maximum number of days to retain numeric data. Default value: one hundred eighty 180.
• Maximum historical string data age (days): Maximum number of days to retain string data. Default value: one hundred eighty 180.
• Automatic partition of big tables: To automatically create monthly partitions in IDB files of specific databases (tagente_datos, tagente_datos_string, ttrap).

Configurations for historical events:

• By clicking Enable historical events, the following tokens are activated:

1. Events days old to keep in active database: Number of days to keep events in the historical database. Default value: ninety 90 days. Note that events are deleted (purged) from the main database after seven days.
2. Maximum historical events age (days): Number of days to keep events in the historical database before deletion. Default value: one hundred eighty 180 days.

Configurations for historical SNMP traps:

• When enabling the Enable historical traps option, it allows storing SNMP traps in the historical database:

1. Days old to keep in active database: Number of days to retain traps in the active database. Default value: six 6 days.
2. Maximum historical traps age (days): Number of days to retain traps in the historical database. Default value: one hundred eighty 180 days.

It should be configured as explained in “Log collection and monitoring”.

To begin performing SIEM monitoring, you must have an OpenSearch server to establish the proper connection with Pandora FMS. Once the server is set up, enter its IP address or URL (it is recommended to use HTTPS) and the port number (default 9200) and test the connection, showing the success or failure in the SIEM status section:

It is important that in Basic authentication, the credentials of the user to be used on the OpenSearch server are set.

For the values of Index configuration, see the section “Log collection and monitoring”.

Authentication method: Local Pandora FMS by default, indicates that it will use the internal Pandora FMS database for authentication. Superadmin type users are always authenticated this way for security reasons, while other authentication types have the local option as a fallback. See also “Authentication with third parties”.

The following fields are common to all previous options:

Double authentication: Users can choose whether to enable two-step authentication on their accounts. This functionality requires the server and the mobile devices to have synchronized and as precise date and time as possible.

Session timeout based on: By default, this is enabled, and it checks if there has been no activity from the user (or based on the date and time of the last login) within the time period set in Session timeout (mins) to log out the user. Values for this last token:

• The default value is 90 minutes.
• When set to 0 for a user, Pandora FMS will use the value saved in the General Settings, authentication section.
• To keep the session without expiration, set it to -1. A user logged into the Web Console with an active screen will have auto-refresh and will not be considered inactive.

The performance of Pandora FMS is affected by various factors, which should be refined in the following sections.

Shows the status of database maintenance:

• Pandora_db running in active database: If pandora_db runs for more than 12 hours without executing, it will mark a critical status.
• Pandora_db running in historical database: This will only appear if a historical database is configured. Similarly, if pandora_db runs for more than 12 hours without executing on the historical database, it will mark a critical status.

• Max. days before events are deleted: Maximum number of days before deleting events, default is seven.
• Max. days before traps are deleted: Maximum number of days before deleting SNMP traps, default is seven.
• Max. days before audited events are deleted: Maximum number of days before deleting audited events, default value is fifteen.
• Max. days before string data is deleted: Maximum number of days before deleting string data, default value is seven.
• Max. days before GIS data is deleted: Maximum number of days before deleting GIS data, default value is seven.
• Max. days before purge: Maximum number of days before deleting data, default value is forty-five. This also specifies the maximum number of days to keep historical inventory data.
• Compact data before moving it to history: Data can be compressed by performing a number of samples per hour (Compaction samples per hour) before moving them to the historical database.
• Max. days before unknown modules are deleted: Maximum number of days before deleting unknown modules except if they are in a policy.
• Max. days before delete not initialized modules: Maximum number of days before deleting uninitialized modules.
• Max. days before autodisabled agents are deleted: Number of days (default 30) after which auto-disabled agents will be deleted.
• Retention period of past special days: Number of days after which special days that have already passed will be deleted.
• Max. macro data fields: Number of fields that can be used for alert commands.
• Max. days before delete old messages: Number of days after which received messages will be deleted.
• Max. days before inventory data is deleted: Number of days after which inventory data will be deleted.
• Max. days before disabled agents are deleted: Number of days after which disabled agents will be deleted (default 0, never).
• Max. days before policy queue is purged: Applies to the monitoring policy queue already applied and will be deleted once the specified number of days is reached.

• Max. days before purge: Maximum number of days (180 by default) before deleting historical data.
• Max. days before events are deleted: Maximum number of days (180 by default) before deleting historical events.
• Max. days before string data is deleted: Maximum number of days (180 by default) before deleting historical string data.

• Item limit for real-time reports: Field where the maximum number of data that the real-time graph will represent is defined, default value: 100.
• Limit of events per query: To set a maximum limit for the number of events returned in a query, default value: 5000.
• Default hours for event view: Field where the hour field of the default filter is defined for the event view. This field also affects the display, count, and graphs of events in the tactical view, and the default value is eight hours.
• Use real-time statistics: Enable or disable the use of real-time statistics. If real-time statistics are disabled, the refresh time for the statistics will be set in Batch statistics period (secs) (default is 60 seconds).
• Disable unknown status control on software agents modules by default: By default, modules created by PFMS Endpoints are deactivated for detecting unknown states in unknown.
• Max. recommended number of files in attachment directory: Maximum number of files stored in the attachment directory (attachment).
• Delete not initialized modules: Enable or disable the deletion of uninitialized modules.
• Big Operation Step to purge old data: Number of blocks in which the script pandora_manage divides a time interval. A higher value implies larger time blocks, which means more operations but lighter ones. In overloaded systems and very large databases, it may be advisable to increase this value, even though data purging will take longer.
  • 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 time block 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 larger value implies bigger queries, which means fewer but heavier operations. In overloaded systems, it may be advisable to reduce this value, even though the data purging will take longer. The default and recommended value is 1000.
• Graph container - Max. Items: Field where the maximum number of items in the graph container view is defined.
• Events response max. execution: Field where the maximum number of events that can perform the bulk operation of Event Responses is defined.
• Row limit in csv log: Row limit for the log in CSV format.
• SNMP walk binary and SNMP walk binary (fallback): When SNMP bulk walk cannot request V1 SNMP, this option will be used instead (default is snmpwalk, slower).
• WMI binary: Executable file to use in WMI queries, default is pandorawmic.
• Rows limit for SQL report item PDF: By default, it is limited to a maximum of five thousand lines to avoid overloading the hardware capabilities where the PFMS server is running. If set to zero, it is unlimited, use with caution. In the case of the Command Center, the sum of the configured value in each node will be shown.

To complete the SNMP configuration from the previous section, default values can be set for the various modules in the SNMP interface wizard.

In this section, you can configure all the visual elements of Pandora FMS.

Style configuration for graphic elements:

Important notes:

• Style template: To add new themes, a CSS file should be added to the directory:

…/pandora_console/include/styles

• Edit custom css: Pandora FMS is installed without the custom.css file, which (if it exists) is the last to load of all CSS files. To change the CSS classes (default in the PFMS Web Console), this file will be automatically created by an administrator user (by clicking the button) if it doesn't already exist, and will remain unchanged during each PFMS version upgrade. A practical use is to redefine each CSS class:

.message-welcome {
     font-size: 40px;
     font-weight: bold;
     color: #4CAF50;
     text-transform: uppercase;
     font-family: Arial, sans-serif;
}

Will produce the following change in the welcome message:

• Status icon set: In the case of users with color blindness, these can be replaced with other conceptual icons that allow the states to be differentiated in another way.
• Custom favicon: Must be in .ico format and its dimensions should be 16 by 16 pixels for it to work correctly. Icons can be added to choose from in the folder:

…/pandora_console/images/custom_favicon

• Custom documentation logo and Custom support logo: Icon for the link to the documentation and support on the login screen. If left blank, no icon will be displayed. The path to upload more icons is:

…/pandora_console/enterprise/images/custom_general_logos/

• Product name and Copyright notice: By default, the product name is Pandora FMS, however, the user is given the option to perform a rebranding and change it to another string of text to have a customized version.
• Background opacity % (login): Allows specifying an opacity percentage (default 30%) on the login screen.
• Disable helps: Disables the help icons (links to this documentation). Quick tips (quick help) are always kept.
• Fixed header: The header is always shown, i.e., it does not hide when scrolling (vertical window movement).
• Automatically hide submenu: When this option is enabled, the sidebar menu is minimized.
• Random background (login): If there is no background configured for the login screen (see Custom background logo), enabling this option will randomly choose one of several graphic files stored in:

…/pandora_console/images/backgrounds/random_backgrounds

The following tokens for alternative configuration for rebranding are stored as comments (commented) in the config.php file to preserve the configuration in case of a database failure:

//
 ----------Rebranding--------------------
// Uncomment this lines and add your customs text and paths.
// $config["custom_logo_login_alt"] ="login_logo.png";
// $config["custom_splash_login_alt"] = "splash_image_default.png";
// $config["custom_title1_login_alt"] = "WELCOME TO Pandora FMS";
// $config["custom_title2_login_alt"] = "NEXT GENERATION";
// $config["rb_product_name_alt"] = "Pandora FMS";
// $config["custom_docs_url_alt"] = "http://pandorafms.com/manual/";
// $config["custom_support_url_alt"] = "https://support.pandorafms.com";

• Block size for pagination: Field where the pagination size for items (events, alerts, etc.) is chosen. Default value: 20.
• Click to display lateral menus: This parameter configures whether the sidebar menu is displayed when clicked (main mouse button) or when the mouse is hovered over it.
• Paginated module view: Enables pagination in the module list.
• Display data of proc modules in other format: Proc type data represents binary states of a module. In the database, it is collected as a number, but it could also be represented descriptively with an identifier for each of the two states. Enabling this option uses the second form of representation.

1. Display text when proc modules are in OK status: When the Display data of proc modules in other format option is enabled, this text will appear instead of the number when the module has an OK status.
2. Display text when proc modules are in critical status: When the Display data of proc modules in other format option is enabled, this text will appear instead of the number when the module has a critical status.

• Service label font size: Default font size for services.
• Space between items in Service maps: Distance (in pixels) between two elements in service maps. To avoid overlap, this value should be greater than 80 pixels.
• Tabs menu: By default, it shows icons and the context menu for the main agent view in the Web Console. The other two options (icons only or context menu only) combine both options if there is not enough screen space.
• Keyboard shortcut filter menu: Allows changing the keyboard shortcut for the side filters in views, if applicable. Works only with lowercase letters.

• GIS Labels: Enable the labels with the agent's name in the GIS maps. It is recommended to disable this option when there are many agents on a map, as it makes the map more readable.
• Default icon in GIS: Default set of icons for agents in GIS maps.

Graph configuration:

Important notes:

• Value to interface graphics: Name of the units for the interface graphics, default Bytes.
• Data precision: Number of decimals to display in reports and visual consoles. It should be between 0 and 5.
• Data precision in graphs: Number of decimals to display in graphs. It should be between 0 and 20.
• Number of elements in custom graph: To limit the number of legends in combined graphs. Consider also reducing the width of the legends, making them concise and as short as possible. The combined graphs that respond to this token are of the type:

1. Line.
2. Area.
3. Vertical bars.
4. Horizontal bars.
5. Stacked.

• Chart fit to content: Some graphs have percentage values, and the chart’s maximum value exceeds one hundred. You can configure the graphs to stop adding a proportional upper margin by enabling this option.
• Percentile: Displays a line with the specified percentile in the graphs. The default value is 95.
• The Graph TIP view parameter indicates whether TIP graphs will be displayed:

1. None: The TIP option for the graph setup will be disabled (default option).
2. All: The TIP option in the graph menu will be enabled.
3. On Boolean graphs: The TIP option will only be enabled in the menu for Boolean graphs (true/false type graphs).

Font and text settings:

• Graphs font size: Field to choose the font size used by PFMS for graphs.
• Show unit along with value in reports: Shows the units along with the module value in reports.
• Truncate agent text at end and Truncate module text at end: When enabled, it truncates the names of agents and modules at the end and adds ellipsis (the default behavior is to truncate at the middle) for the section Operation → Monitoring → Views.
• Agent text size: When the agent's name is too long, in some sections of Pandora FMS the text is truncated showing only the first characters (default values: 18 characters when the font is small, and 50 characters when the size is normal).
• Module text size: When the module name is too long, in some sections of Pandora FMS the text is truncated showing only the first characters (default values: 25 characters when the font is small, and 50 characters when the size is normal).
• Description text size: When the description is too long, in some sections of Pandora FMS the text is truncated showing only the first characters (default value: 60 characters).
• Item title text size: When the title is too long, in some sections of Pandora FMS the text is truncated showing only the first characters (default value: 45 characters).

Visual consoles settings:

• Default cache expiration: This section indicates how often the cache of the item states is cleared, and therefore how often the status of these items is recalculated individually.
• Default interval for Visual Console to refresh: This interval will only affect the pages of the visual consoles, determining how often they will be automatically refreshed.
• Type of view of visual consoles: Dropdown to indicate whether you want the favorite visual consoles to be shown in the menu.
• Number of favourite visual consoles to show in the menu: To avoid overlapping and help the performance of the Web Console, this token limits the number of favorite consoles to show in the sidebar menu.
• Default line width for the Visual Console: Line width in visual consoles. Although this option can be changed individually within the visual console for each line, the default value is 2.
• Visual console default text margin (em): By default 1 em, allows increasing or decreasing the text margin for labels in Visual Console items that use it (Static image, etc.).
• Lock screen orientation when viewing on mobile devices: In the mobile console, prevents the screen from rotating according to the motion sensor.
• Display item frame on alert triggered: Allows hiding an orange box when an alert is triggered on elements Static image, Simple value, Icon, Group in the Visual Consoles. Enabled by default.

Reports configuration:

• Show report info with description: Description of custom report information. Applies to all reports and default templates.
• Front page for custom reports: Front page for custom reports. Applies to all reports and default templates.
• PDF font size (px): Font size in pixels for PDF files.
• HTML font size for SLA (em): Font size for SLA reports (HTML only). It uses a relative unit called em, which is the number of times the chosen font size in pixels.
• Graph image height for HTML reports: Height in pixels of module graphs or custom graphs in reports (HTML only).
• Interval description: Shows the time interval description in either long or short form. A long description (Long) is “10 hours, 20 minutes, 33 seconds”; a short description (Short) is “10h 20m 33s”.

The remaining fields allow you to choose a custom logo and modify the header, footer, and front page (macros can be included) as well.

• Number of favorite services to show in the menu: Maximum number (between 1 and 25) of favorite services to show in the respective submenu.

Other settings:

• Show only the name of the group: Will show only the group's name instead of its icon.
• Date format string: Field where the date and time format as defined by PHP is specified; to add the timezone you must place T.
• Show empty groups in group view: Allows displaying empty groups in the group view.
• Visible time of successful notifications: Time to display, in seconds, for notifications.
• Decimal separator: Decimal separator to use in reports.
• Interval values: Here you can customize the time values (seconds, minutes, etc.) for the Interval field in Pandora FMS forms (except for the event comment view).
• Timestamp, time comparison, or compact mode: Defines which date and time to use, the system's timestamp (Timestamp in rollover), a comparison with the database (Rollover comparison) or in compact mode (Compact mode). This is useful when the database is on a different system than where the Web console is located.
• Custom value post processing: Custom conversion values for post-processing. Updates a database table to have custom conversions from one unit to another. If a numeric value is mistakenly added incorrectly, select it from the Delete custom values list and delete it with the Delete button below, then re-add the custom conversion value.
• Module units: This option allows you to define the unit of data that the modules will collect.
• CSV divider: Character or set of characters to separate data when exporting to CSV.
• CSV decimal separator: Symbol to use as the decimal separator when exporting to CSV.
• Data multiplier to use in graphs/data: Value by which to multiply the data shown to represent it in graphs. This is useful when the unit of value is bytes; for other conversions, use Custom value post processing.
• Hide general stats for non admin users in tactical view: In the Tactical View, by default, all available information is shown. When this option is enabled, only users of type superadmin will have access to all information, and for other users, it will be shown in a filtered manner.

This functionality must be enabled through the token Enable NetFlow.

For more information, see the topic “Network Monitoring with NetFlow®”.

This functionality must be enabled through the token Enable IOT Server.

The Pandora IOT integration aims to monitor messages received from an MQTT broker server.

This functionality must be enabled through the token Enable NetFlow and then go to that tab to enable sFlow®.

For more information, see the topic “Network Monitoring with sFlow®”.

Enables the connection and communication between Pandora FMS and Pandora ITSM. By enabling the Enable Pandora ITSM button, you can configure it to be used for all users (default enabled option) or allow each user to configure their own connection.

Both the incoming connection for Pandora ITSM and the incoming connection for Pandora FMS must be configured to ensure bidirectional communication.

• URL to Pandora ITSM setup: Web address or IP address to connect to the Pandora ITSM API in a format similar to:

http://192.168.1.20/XXX/api/v2

• URL connect to API Pandora FMS: URL to connect to the Pandora FMS API. By default, it takes the one set in the token Public URL, and if it is not set, it will use the one in config.php.
• Test buttons: Each will test the connection from Pandora FMS to Pandora ITSM and vice versa.
• If the connection tests are successful, Pandora ITSM will take the PFMS agents and convert them into inventory objects, and incident management in PITSM will be available from PFMS.

By enabling the configuration with the Enable Pandora RC button, you will have access to the integration with Pandora RC.

Pandora FMS has a notification and monitoring system for the console state and the overall system. You can enable notifications by following the instructions detailed in the section “Console Management”.

For QuickShell to work properly, it is necessary to have the pandora_gotty binary installed in /usr/bin/. This functionality is installed by default, and the only additional configuration will be to allow the connection through the firewall and add port number 8080.

You must enter the IP address or just the URL (without http) of the PFMS Web Console and the port number to use, 8080 by default (connection through the relevant firewall must be allowed).

You can enable the connection via SSH (Enable SSH method) and/or Telnet (Enable telnet method). You can then test and verify the connection using the corresponding Test buttons.

When you save the values with the Update button, QuickShell will be triggered.

If you have SSL certificates, it is recommended to encrypt the connection transmissions to strengthen computer security.

First, the basic settings and normal connections must be configured and verified without any encryption.

Then, to encrypt communications (Use SSL for SSH and/or Telnet), the following configurations must be made:

• You must have SSL certificates on the Pandora FMS Web Console.
• The certificates must have read permissions for the Apache web server.
• Add the following TLS/SSL options in the /etc/pandora_gotty/pandora_gotty.conf file (replace the path and filename for each parameter with the values to be used):

/etc/pandora_gotty/pandora_gotty.conf

//Pandora GoTTY config file

(…)

// [bool] Enable TLS/SSL
enable_tls = true

// [string] Default TLS certificate file path
tls_crt_file = "/path/.cert.crt"

// [string] Default TLS key file path
tls_key_file = "/path/key.key"

// [bool] Enable cliente certificate authentication
enable_tls_client_auth = false

// [string] Certificate file of CA for client certificates
tls_ca_crt_file = "/path/ca_cert.ca.crt"

(…)

Once everything is ready, you must enable Use SSL for SSH and/or Telnet, save with the Update button, and verify the connection again using the corresponding Test buttons.

In the external tools section, you can configure alarm sounds and paths for the following executable files:

• Graphviz.
• Snmpget.
• Traceroute.
• Ping.
• Nmap.
• Dig.

These utilities are generally already installed with the operating systems, but if needed, they should be installed additionally (Dig is installed with apt install dnsutils in Ubuntu and dnf install bind-utils in RHEL and Rocky Linux environments). By default, the system uses the operating system's default paths (even if not displayed), and these can be changed in this section of PFMS general settings.

Additionally, you can define custom commands using macros to interact with Pandora FMS agents. When adding the macro _address_, the agent's IP address will be used when executing the command.

Tips are short messages, optionally accompanied by a web link for more details about the displayed tip when logging into the PFMS Web Console. You can set the language for each tip, and to edit them, there is a filter that allows you to search by keyword in the title of each tip. Each user can set their own user configuration with the token Show usage tips at startup.

By using the Profile classification established in PFMS, you can configure the welcome tips in the Profile list, depending on the profile allowed for each user, they may or may not be able to see them.

This functionality must be enabled via the token Enable GIS features.

All documentation on GIS maps can be found in the topic “Pandora FMS GIS”.

Once you have installed Pandora FMS, you can apply a license. Then, in this section, you can check its status, request a validation (button Validate) in case of reinstalling a Pandora FMS instance, or request a new license (button Request new license). With the Show agent usage detail button, you can see the total number of agents (with the option to filter by enabled agents), as well as subtotals classified into three main categories.

You can make custom translations (column Customize translation), even with macro variables; this extension is fully described in the section Translate string.

Pandora FMS keeps a log of all important changes and actions made in the Pandora FMS Console. You can find more information in the section Audit Log.

Menu Management → Admin tools → Demo data.

This option allows you to generate at least 30 agents with demonstration data and default values assigned. You may need to increase the plugin_timeout parameter in the server configuration to ensure all agent data is updated.

By clicking on advanced options (Advanced options), you can adjust the following parameters:

• Agents interval: Five minutes, default value.
• Generate historical data for all agents: When enabled, historical data will be generated for the agents being created, for the number of days specified in the field Days of historical data to insert in the agent data (15 days by default).
• Create services: Allows creating services.
• Create network maps: Allows creating network maps.
• Create GIS maps: Allows creating geographical location maps.
• Create custom graphs: Allows creating custom graphs.
• Create reports: Allows creating reports.
• Create visual consoles: Allows creating visual consoles.
• Create dashboards: Allows creating dashboards.
• Traps target IP: IP address for SNMP traps (127.0.0.1 by default). All demo SNMP traps are generated with version 1.
• Traps community: Community for SNMP traps (public by default).
• Tentacle target IP: IP address for sending data via Tentacle protocol (127.0.0.1 by default).
• Tentacle port: Port number for the Tentacle protocol (41121 by default).
• Tentacle extra options: Tentacle protocol parameters.

By clicking the Create demo data button, all selected options will be applied. While the demo environment is being generated, you can see a progress bar and the status of the creation of each type of element once completed. Depending on the number of agents selected, it may take more or less time.

You can later delete all this data with the Delete all demo data button.

From Management → Admin tools → Links, you can access the web link management page of the Pandora FMS console.

The process is almost the same for creating a new web link or updating an existing one. Once you have edited and/or added all the necessary web links, they will always be available in the left sidebar menu.

Access the visual tool that shows the current status of the Pandora FMS server and console through Management → Admin tools → Diagnostic info. If you want to get this information via command line, check Optimization and troubleshooting of Pandora FMS. There is an option to export all information to PDF.

With the IPAM extension, you can manage the IP addresses of networks. You can find more information in the section IPAM: IP Address Management.

From Management → Admin tools → Site news, you can add news items that appear on the homepage when a user enters the console.

To create a news item, click Add, type the subject or title in Subject, select the group that will receive the announcement, and the deadline for displaying it. If you select Modal window, the news will be shown in a popup window that the user must read and close.

A useful tool for uploading content to Pandora FMS, menu Manage → Admin tools → File Manager. It will display all the content in the images folder within the Pandora FMS installation.

• Download files by clicking on each file name.
• Navigate through directories, which are identified with the icon . You can also create subdirectories within them.
• Upload files by clicking on the icon , these image files will be identified with the icon (only GIF, PNG, and JPG formats are allowed).
• You can also delete some files that have the icon , as the rest are system files used by the PFMS Console.
• A directory can only be deleted if it is empty.
• If you want to customize the images in Visual Consoles, four distinct images are required, one for each state, using a special naming convention for these images: <image_name>_<state>.png where the state can be:
  • <image_name>_bad.png
  • <image_name>_ok.png
  • <image_name>_warning.png
  • <image_name>.png (no state)

This extension allows checking for structural differences between the established Pandora FMS database and a standard schema to compare potential errors. Refer to the section “Console Management and Administration”.

This extension allows you to run commands in the database and view the results. It is an advanced tool that should only be used by people who are familiar with SQL and the Pandora FMS database schema in sufficient detail.

Allows managing scheduled database backups through a Console task (“Console Task”).

• In the Filter section, you can select from the dropdown in Path backups the location of the available backups. Press the Filter button to refresh the backup list.
• You can download the backups to your local machine via the corresponding button .
• You can delete backups using the corresponding button .
• To restore a backup, click the corresponding button.

To activate the OpenSearch interface, enable the token Activate Log Collector in Management → Settings → System Settings → Log collector.

Allows configuring the default sounds for the various event alarms.

The API checker allows calling and checking the external Pandora FMS API. See the External API section.

Extensions are a way to develop new functionality for the Pandora FMS console, as well as plugins. See the topic Console Extensions Development for more information.

From the Admin tools → Extension manager → Extension manager view menu, you can disable an extension by clicking the icon corresponding to each extension.

You can also delete an extension with the button. The management of visible type extensions adds or removes elements from the left sidebar menu.

From the Management → Admin tools → Extension manager → Extension uploader view menu, you can upload an extension. The file must be compressed in .zip format. If the extension uses the component gpolicies, check the option Upload Enterprise extension. Once you have selected the file, click the Upload button.

In this section, you can view, limited to the size of the token Log size limit in system logs viewer extension, the content of the following files:

/var/www/html/pandora_console/log/console.log
/var/log/pandora/pandora_server.log
/var/log/pandora/pandora_server.error

Refer to the section Import groups from CSV in “Console Management and Administration”.

In this section, you can edit or create new types of Operating Systems (OS), Management → Resources → Operating systems. These groups are important for the automatic provisioning of agents.

Starting from version 774, PFMS has the scheduled obsolescence functionality, which works with inventory to generate reports with filters for the monitored devices.

In case you have a new operating system, you can add it to the default list installed with PFMS. To do so, click the Create OS button, enter the corresponding name, and choose an icon from the list. If you have a new icon in JPG, JPEG, PNG, or SVG format, use the Upload icon button, store it in PFMS, and then search and select it by name. Complete the process by clicking Create.

The menu Management → Tools → Export data allows you to choose an agent (which can be filtered by group) by its name and then select one or more modules from it. By default, the time period is set to the last 24 hours, and the available export formats are:

• Data Table: A special PHP language format that displays on the screen the agent name, module name, data value, and the date and time of data collection.
• Average per hour/day: If the data is numeric and can have an average calculated, it will be displayed on the screen in a similar format to the Data table option.
• CSV: Comma-separated values file format.
• MS Excel: Spreadsheet file format for Microsoft Excel.

The file repository manager allows you to place the resources that need to be downloaded by the monitored devices when deemed necessary. It can be accessed from Management → Admin tools → Extension manager → File repository or from Management → Tools → File repository, then click the Management view icon.

Select the group or groups that will download this resource and browse your local disk to upload the file. If you need the resource to be public, check the Public link box. Click the Add button and wait for the upload process to finish.

• To share the public link of each file, click the icon, copy, and paste the web link.
• If another operator of the same PFMS Console is on a different machine, they will be able to download it by clicking the button.
• If the file is no longer needed, delete it using the button.

Return to the Pandora FMS documentation index