View source for Pandora: Documentation en: Managing and Administration

[[Pandora:Documentation_en|Go back to Pandora FMS documentation index]]

{{WIP}}

= Pandora FMS  Management=

== Introduction ==

This chapter deals with several aspects of Pandora FMS daily management such as: group administration, user creation, backups, workspace, etc.

==  Profiles, users, groups and ACL ==

Pandora FMS is a Web management tool. Thanks to its 100% multitenant permission system, multiple users can work with different permissions accessing Pandora FMS setup without seeing each other's information.

To add users, it is important to have groups and profiles properly defined, and know exactly which data you want each user to see and/or modify.

<center>
[[image:Standard-user-profile.jpg]]
</center><br>

=== Users in Pandora FMS ===

Users are managed from ''Profiles > Users management'', where you may see the list of defined users.

<center><br><br>
[[image:user_list_new.png]]
</center><br><br>

User definition consists of the following fields:

<center><br><br>
[[image:detalle_usuario_2018.png]]
</center><br><br>

Here are the relevant user fields:

*'''User ID''': Identifier to be used by the user for authentication in the application. This is a value that is used as an identifier, so it should not have rare characters or spaces. 
*'''Full Display Name''': Field where the complete name is, this is a descriptive field and it may contain spaces and non-standard characters.
* '''Timezone''': Field containing the timezone of the console for visualizing different elements (General agent view, Module view...).
*''' Global Profile''': An Administrator user will not abide by the internal ACL system, but rather will have access to everything. The standard user will abide by the Pandora FMS ACL permissions it is assigned.
*'''Skin''': Field where a custom skin may be chosen.
*'''Interactive charts''': Field where you may choose whether the user sees dynamic or static graphs. This setting allows overwriting the one defined by the system.
*'''Block size for pagination''': Pagination default size for that user.
*'''Not login'': If this field is checked, the user will only be able to access the API but not interactively through the console.
*'''Home screen''': It changes the default screen to that of the user's choosing after logging into the console, for example, the event viewer, or a visual console defined by the administrator.
*'''Default event filter''': To define the default filter that the user will have when entering the event view. Then it can be changed, but this will be the one applied "by default".
*'''Session time''': Time the user can be logged in with no activity before the session expires and the user must go through the authentication process again.

==== User Edition by the User itself ====

All users can modify certain parameters of their own settings in ''Workspace > Edit my User''.

The user creation form will appear, where you can configure some sections, except for group permissions.

<center><br><br>
[[image:gestusuario.png|800px]]
</center><br><br>

===== Notification setup =====

To customize logged-in user’s notifications, the administrator must have previously granted him notification edition permissions. In case of having said permissions, as well as all options activated, notifications and their forwarding by email can be enabled/disabled.

<center>
[[image:Notificaciones1.PNG]]
</center><br>

Notifications allow to see warning messages related to the following sections on screen: 

* <b>System status</b>. Where the following notifications are generated:
** Expired or nearly expired license warning (~15 days or less).
** Too many files attached warning. 
** Piled-up .data files in data_in warning (> 1000 files and increasing). 
** Piled-up BADXML files in data_in warning (> 150 files).
** Overall module queuing (increasing) by server warning. 
** PHP setup warning. 
** Review whether pandora_db is running on the main database. 
** Review whether pandora_db is running on the history database. 
** History database update status (MR correct). 
** Status warnings, component down or uninitiated => Any of the Pandora FMS servers with status=1 and ''keepalive - now()'' may be higher than ''server_keepalive * 2''.
** Tentacle service down. 
** No master-mode server warning. 
** In the case of activated logs, Elastic/Logstash connectivity status.
** In case of using Pandora FMS HA, error in DB replication. 
** Connection error with GIS map servers GIS (WMS). 
** Log size. 
** Mounting point/disk/almost full volume warning (data_in/mysql/tmp...)(> 90%). 
** History database connection failure. 
** Metaconsole synchronization failure. 
** Next scheduled shutdowns (in less than 15 days). 
** Metaconsole: Synchronization status: 
*** Node synchronization failures. 
*** Event replication failures.
*** Agent cache.

* <b>Message</b>:
** Messages received by the user yet to be read. 
 
* <b>Pending task</b>:
** Policies yet to be applied.
** Queued policies running/complete, and acknowledged once completed.
** Pending re-creation policies. 
** Defined server plugins whose executable does not exist. 
** Metaconsole:
*** Pending synchronization tasks. 
*** Completed synchronization tasks.
*** Pending notifications by node. 
*** Policy queue status. 
 
* <b>Advertisement</b>.
** Enterprise version not installed reminder.
** Do you know our Enterprise version?
** Do you know the module library?
** Discover eHorus.
** Discover Integria IMS. 

* <b>Official communication</b>:
** Update notifications.
** Messages generated from Ártica ST headquarters (update to PHP7, phantomjs, etc.)

* <b>Suggestion</b>:
** Did you know Pandora FMS can be integrated with Telegram?
** Did you know alerts can be scaled?
** Monitor your complete applications using services.

The options found in notification setup are these: 

* <b>Notified users</b>: Users that will receive the activated notifications.
* <b>Notified groups</b>: Groups that will receive the activated notifications. 
* <b>Notify all users</b>: Option that will allow to notify all users. 
* <b>Also email users with notification content</b>: To enable sending emails for each notification. 
* <b>Users can modify notification preferences</b>: To allow users to modify notification preferences (the system administrator can restrict this option).
* <b>Users can postpone notifications up to</b>: It allows to postpone notifications so that they are not received more than once in a certain interval (which can be chosen in the drop-down).

=== Groups in Pandora FMS ===
====Introduction====
The concept of group in Pandora FMS is fundamental. The groups are sets of elements with their own rules whose purpose is to help to control user access to certain elements inside Pandora FMS. 

It is important to know that an agent can only belong to one group, but that a user can have access to one or several of these groups. 

When configuring the groups, it will be necessary to take into account that the group All is a special group that cannot be eliminated, and all the groups are its subgroups. Any element that is associated to the All group can be seen/administered by a user that has permissions in any group. 

====Group all====

Pandora FMS has a group system, which are entities into which agents are classified and which are used to grant permissions. That way users are granted some permissions assigned to one or several groups, and thus they will be able to interact with agentes and other elements in their context.

To make group assigning and filtering easier, there is a tool called group "All". Group "All", depending on the context, means ALL groups or ANY of them. From version 3.1 is exclusive identifier is ID 0. But it is totally controlled by the code, ther is no group with that ID in the DB.

====Group creation====

Groups are defined in the section  ''Profiles > Manage agent groups''.

<center><br><br>
[[image:gest5.png|800px]]
</center><br><br>

Inside group creation / modification, there is the following form:

<center><br><br>
[[image:gestion_grupo.png]]
</center><br><br>

These are the relevant user fields:

* '''Name''': Group name. This group can be used in the automatic agent provisioning, so it is not recommended that it contains spaces or rare characters (although it is supported).
* '''Icon''': Combo where the icon for the group can be chosen.
* '''Parent''': Combo where another group can be defined as the parent of the group being created.
* '''Password''': Optional. It allows restricting automatic agent creation (automatic software or satellite agent provision) so that only agents with the same password as the one defined in this field can be created.
* '''Alerts''': If checked, the agents belonging to the group will be able to send alerts. If not checked, alerts will not be sent. You can use this property to quickly disable alert generation for a certain group of agents.
* '''Propagate ACL''': If enabled, the child groups will have the same ACL permissions as the group.
* '''Custom ID''': Groups have an ID in the database. In this field it is possible to set another custom ID that can be used from an external program to perform an integration (e.g. CMDBs).
* '''Contact''': Contact information accessible through _groupcontact_ macro.
* '''Skin''': A skin can be assigned to the group.

====Importing groups from CSV====
<br>
{{Metaconsole}}

This is an Enterprise feature. The extension allows to import a file separated by some separating character in Pandora FMS server.

Access the extension from ''Admin tools > Extensions manager > CSV import group''.

<center>
[[image:ex17.png|800px]]
</center><br>

The file to be imported is chosen by clicking on “Select file” and the combo is chosen from a combo. Once the previous fields are filled out, click “Go”.

The CSV file must contain the following fields in the following order: Group name, icon, parent id and propagation (1 or 0).

===  Profiles in Pandora FMS ===

Pandora FMS profiles allow to define which permissions a user is granted. The combination of profiles and a group associated to a user allows to define which permissions a user has on a group of agents, so that he can have different profiles in different groups. Profiles are managed from ''Profiles'' > ''Profile management''. 

<center><br><br>
[[image:gest1.png|800px]]
</center><br><br>

====Profile List====

This list defines what each profile enables:

<table cellpadding=1 cellspacing=1 style='background-color: #f0f0f0; border: 1px solid #acacac'>
<tr><th style='background-color: #cacaca'>Operation<Th  style='background-color: #cacaca'>Access Bit
<tr><td>See agent data (all views)	<td>AR
<tr><td>Tactical view	<td>AR
<tr><td>Group view	<td>AR
<tr><td>Create a visual console	<td>RW
<tr><td>Create a report	<td>RW
<tr><td>Create a combined graph	<td>RW
<tr><td>See report, graph, etc.	<td>RR
<tr><td>Apply report template<td>RR
<tr><td>Create report template<td>RM
<tr><td>See event	<td>ER
<tr><td>Validate/Comment event	<td>EW
<tr><td>Delete event	<td>EM
<tr><td>Execute responses<td>EW
<tr><td>Create an incidence through the event (Response)	<td>EW&IW
<tr><td>Manage responses<td>PM
<tr><td>Manage filters<td>EW
<tr><td>Customize event columns<td>PM
<tr><td>Change owner/Re-open event	<td>EM
<tr><td>See users	<td>AR
<tr><td>See Console SNMP	<td>AR
<tr><td>Validate traps 	<td>IW
<tr><td>Messages	<td>IW
<tr><td>Cron jobs	<td>PM
<tr><td>Tree view	<td>AR
<tr><td>Update manager (Operation and Management)	<td>PM
<tr><td>Extension Module Group<td>AR
<tr><td>Agent management view	<td>AW
<tr><td>Editing the agent and its .conf	<td>AW
<tr><td>Assigning already created Alerts	<td>LW
<tr><td>Define, modify templates, commands and actions	<td>LM
<tr><td>Group management	<td>PM
<tr><td>Create inventory modules <td>PM
<tr><td>Manage modules (Including all sub-options)<td>PM
<tr><td>Massive operations	<td>AW
<tr><td>Create agent	<td>AW
<tr><td>Duplicate remote configuration <td>AW
<tr><td>Downtime management<td>AD
<tr><td>Alert management	<td>LW
<tr><td>User management	<td>UM
<tr><td>SNMP Console management <td>PM
<tr><td>Profile management<td>PM
<tr><td>Server management<td>PM
<tr><td>System audit (editing and visualization)<td>PM
<tr><td>Setup (all lower flaps incl)	<td>PM
<tr><td>DB maintenance	<td>DM
<tr><td>Extension management	<td>PM
<tr><td>Search bar	<td>AR
<tr><td>Policy management<td>AW
<tr><td>Deactivate agent/module/alert<td>AD
<tr><td>Validate alerts<td>LM&AR o AW&LW
<tr><td>Network map view<td>MR
<tr><td>Network map editing<td>MW
<tr><td>Deleting own network maps<td>MW
<tr><td>Deleting any network map <td>MM
<tr><td>Visual console view<td>VR
<tr><td>Visual console editing<td>VW
<tr><td>Deleting own visual consoles<td>VW
<tr><td>Deleting any visual console<td>VM

</table>

=== Permission granting ===
From user editing, you may grant a user access to a group with a certain profile:

<center>
[[Image:acl_groups.png|center]]
</center>

In this example, the user has access by means of the operator profile to the "eHorus" and "hosting" group.

If you do not assign any group or profile to the user, when the user tries to log in, there will be a login error like the one below:

<center>
[[Image:Fallo_login.png|center]]
</center>

==== Permission system extended by tags ==== 

In the Enterprise version, individual access to the modules of an agent can be configured by a Tag system. Some tags are configured in the system, they are assigned to the modules you wish, and additionally, access may be restricted to a user only to the modules that have those tags defined. 

<br>
{{Tip|Access by Tags does not replace access by groups, it only complements it.}}

Tags are defined in ''Profiles'' > ''Module Tags''.

<center><br><br>
[[image:gesttags5.png|800px]]
</center><br><br>

In module configuration, one or more tags can (optionally) can assigned:

<center>
[[Image:tags_1.png|center]]
</center>

You may assign specific access to a tag through the user editor, in profile and group assigning, by adding a tag:

<center>
[[Image:acl_tags.png|center]]
</center>

In this example, the user has access by means of the operator profile to the "eHorus" and "hosting" group and also to the "Infrastructure" group, but only to modules labeled with the "Security" tag.

{{Warning|This system, which is called Tag-based security mode allows restricting access to all agent content, but it has performance impact, so it is designed exclusively to give access to small portions of information, that is, it should not be used with more than two or three tags per user/profile/group combination.}}

{{Tip|In some global views (tactical view, group view, general tree counts) the totals show all the modules, not just the ones "visible" by the tag. }}

==== Hierarchy ====

In previous sections, we explained that the permissions of a group can be extended to the children by means of the configuration option ''Propagate ACL''. However, from user configuration, you may limit this feature and prevent the ACL from propagating by checking ''No hierarchy''.

As a reference for the examples, here we propose a configuration with the two parent groups "Applications" and "Databases" with two children each, "Development_Apps" and "Management_Apps" for the first one and "Databases_America" and "Databases_Asia" for the second one. Both parent groups are set for ACL to be spread.

<center>
[[Image:Acl_hierarchy_groups.png|center]]
</center>

In the user edit view, the following profiles are added:

<center>
[[Image:Acl_hierarchy_1.png|center]]
</center>

The user will have access to the groups named "Applications", "Development_Apps", "Management_Apps" and "Databases".

However, if a child of "Databases" is added:

<center>
[[Image:Acl_hierarchy_2.png|center]]
</center>

The user will have access to the groups named "Applications", "Development_Apps", "Management_Apps", "Databases" and "Databases_Asia", but not to "Databases_America".

==== Secondary groups ====

From update package 721 agents may have secondary groups. Unlike the primary group, these secondary groups are optional.

<center>
[[File:Secondary agent.png|center]]
</center>

An agent belonging to a secondary group means that it actually belongs to several groups at the same time. With this feature, two users with different permissions may have access to the same agent by just adding the appropriate secondary groups.

For example, if an agent called "Portal" has "Infrastructures" as main group and "Hosting" as secondary group, any user that has access to "Infrastructures" and/or a "Hosting" may access it.

Some views, such as ''Tree View'', may show repeated agents. That is the usual performance when using secondary groups.

=== ACL Enterprise System ===
====Introduction====
The ACL Open Source model is based on "unix style" role/action/group/user (4 items). 

The ACL Enterprise system allows you to define -according to profile- which pages (defined one by one or by "groups") users have access to. This will allow you to redefine which sections of the interface a user can see. For example, to allow a user to see only the "Group" view and the "Detailed" agent view, skipping pages such as "Alert view" or "Monitor view", already grouped in the classic Pandora FMS ACL system as "AR" (Agent Read Privileges).

This feature allows you to restrict the administration per page. It is very useful to allow some specific low-level operations.

{{Tip|Both models are "parallel" and compatible. The classic ACL system is complementary and it is evaluated prior to the ACL Enterprise system.}} 

====Configuration====

In order to be able to use the new ACL system, the first step is to activate it in the configuration tab. This option is only visible if you use the Enterprise version. 

<br><br><center>
[[Image:Enterprise_acl_setup.png]]
</center><br><br>

To configure the Enterprise ACL system, go to the specific option for ACL Enterprise in ''Administration'' > ''Setup''. On this screen you may add new items in the new ACL System and see the items defined by profile. You can also delete items from the Enterprise ACL system. 

<br>
<br>
<center>
[[Image:Acl_setup1.png|850px]]
</center>
<br>
<br>

{{warning|If the Enterprise ACL system is enabled, it restricts ALL pages to ALL groups (including the Administrator!) to all defined (allowed) pages in the Enterprise ACL system. If a user with the "Administrator" profile does not have pages included in the Enterprise ACL system, they will not be able to see anything.}} 

{{warning|Please, be careful with this, because you may lose access to the console if you enable improper ACL Enterprise configuration for your user.}}

If you have mistakenly lost access to the console, you may disable the Enterprise ACL system from the command line:

 /usr/share/pandora_server/util/pandora_manage.pl /etc/pandora_server.conf --disable_eacl

You can define "page by page", "complete sections", set "any" rule or add "custom pages" that are not accessible from the menu.

There are two ways to add pages to a profile: with the'' wizard'' (default) or with ''custom edit''.  Above the button to add a rule, there is a button to change this mode.

=====Wizard=====

In the wizard we will choose the sections and pages of some combo controls.

{{warning|The pages that appear in these combos are only those accessible from the menu. To give access to pages that can be accessed in another way (e. g. the agent main view) use the custom editor.}}

To include a Pandora FMS page in the "allowed pages", you must select the profile to which the rule will be applied, then select in "Section" control the section that contains the desired page. You can then select any of your pages in the "Page" control.

<br>
<br>
<center>
[[Image:Acl_setup4.png|800px]]
</center>
<br>
<br>

Another option is to select a section and the value "All" in the "Page" control. This will allow the chosen profile to see "all" of the selected section. Also by selecting "All" in both controls, users of that profile will be allowed to view "all" of "all" sections, just as it would be without the Enterprise ACL System for that profile.

{{warning|For a section in the menu to be displayed, the user must have access to at least the first page of the section. For example, for the "Monitoring" section to be displayed they must have access to at least "Tactical View".}}

=====Custom editing=====

To add individual pages that are not accessible from the menu, you may manually enter your sec2. To that end, access the page you wish to add and copy the parameter sec2. 

For example, if you wish to add the main view of the agents, enter the view of any agent and find a URL similar to this one:

 http://localhost/pandora/index.php?sec=estado&sec2=operation/agentes/ver_agente&id_agente=7702

Enter the contents of parameter sec2 (operation/agents/see_agent) in the text box.

<br>
<br>
<center>
[[Image:Acl_setup5.png|850px]]
</center>
<br>
<br>

====Security====

Any page that is not "allowed" will not be displayed in the menu, and its use will not be allowed, even when the user enters the URL in "manual" mode. Any page that isn't allowed by the "Classic" Pandora FMS ACL system will not be allowed by the Enterprise ACL system (this is valid for the classic ACL system). This would be a specific example of several filters:

<br>
<br>
<center>
[[Image:Acl_example.png|800px]]
</center>
<br>
<br>

In addition, there is a control that checks whether a page belongs to a section, which reinforces security against manual URL modifications. This check will be skipped for pages added with the custom editor, as well as the access to each pages belonging to a full section whose access is granted, thus optimizing the load.
== Servers ==

The detailed view of the servers is used to know, besides the general state of the Pandora FMS servers, their load level and delay. Let us see a screenshot of a server status screen that is reached through the operation menu > Pandora Servers.

<center>
[[image:Server_explained_2017.png]]
</center>

Some icons have special relevance, as seen in the above caption:

* Poll request: It asks the remote test server to run all the checks it has, forcing it to run them again. Valid for all network servers, e. g. Network server, WMI server, Plugin server, WEB server, etc.
* Editing Discovery server tasks.
* Edit remote server configuration. Valid for Pandora FMS servers or satellite servers .

In addition, in this view you may see several important data, each column shows the following information:

*Server name, usually the hostname of the machine.
*Status (green = active, grey = stopped or down).
*Server type: data server, network server, etc.
*Progress bar indicating the total module load percentage for that type of server. In this case, all servers are at 100% except for recon server, which has no associated tasks so it is at 0%.
*Number of such modules executed by the server with respect to the total number of such modules.
*Server Lag: Highest amount of time spent by the oldest module waiting to receive data / Nº of modules out of their lifetime. In this example, there are approx. 3000 modules out of their lifespan, with a lag time of 10 minutes 13 seconds. This indicator is useful to know if you have many modules and to know if the server is at load capacity limit, as it is this case. Although it does not have an excessive delay (10 minutes 13 sec, for modules that have a lifespan average of 5 min), the number of modules out of time is considerable. In the case of the network server, this figure is much lower, being only 19 modules with a lag (10 minutes) of a total of almost 1500 modules.
*Total number of threads configured on the server: Total number of modules in queue waiting to be attended. These parameters reflect excessive load status. There should almost never be queued modules. This reflects the server's inability to process the data.
*Number of seconds since the server updated its data. Each server has a "Keepalive" that updates its status, to make sure it is active and updating its statistics.

==Credential store==


Pandora FMS features a credential store. This repository manages the IDs used in sections such as Discovery Cloud or agent automatic deployment.

<center>
[[File:Cred_store.png]]
</center>

Next, the "Credential store" tab is displayed.

<center>
[[File:Cred_store1.png]]
</center>


There are three different login information types to register:

# Amazon Web Services (AWS) login information
# Microsoft Azure login information
# Custom login information


[[File:Cred_store2.png]]


To add a new entry, press the "add" button and fill out the pop-up form. 


The group assigned to the password controls its '''visibility'''. That means that if the password 'test' is assigned to the group named 'All', '''all''' Pandora FMS console users will be able to see said password.

In a similar way, if 'test' is allocated to the group named 'Applications', only users with permissions on 'Applications' will have access to the password.


[[File:Cred_store3.png]]



Once added, it can be checked, filtered etc.

[[File:Cred_store5.png]]


Within password customization, the only thing that cannot be modified is the type of login information:


[[File:Cred_store6.png]]

== Scheduled downtimes ==
===Introduction===
Pandora FMS has a small scheduled downtime management system. This system allows you to disable alerts at intervals when there is a downtime, disabling the agent. When an agent is disabled it does not collect information either, so that in a downtime, for most metrics or report types, the intervals where there is a downtime are not taken into account in the reports because there is no data in the agents during those intervals.

<center>
<br><br>
[[Image:Downtimegeneral.png|800px]]
<br><br>
</center>

=== Create a scheduled downtime ===

To create a downtime, go to the ''Tools > Scheduled downtime'' menu and press the button to create one:

<center>
<br><br>
[[Image:Downtime1.png|800px]]
<br><br>
</center>

You will find the following configurable parameters:

* '''Name:''' Name of the scheduled downtime.
* '''Group:''' The group you want it to belong to.
* '''Description'''.
* '''Type:''' You may set the following types of downtimes:
** ''Quiet:'' Check as "quiet" the indicated modules, so they will not generate alerts nor events.
** ''Disable Agents:'' It disables the selected agents. It is important to know that if an agent is manually disabled before the task is launched, it will become enabled once this task is completed.
** ''Disable Alerts:'' It disables alerts of selected agents.
* '''Execution:''' It allows to configure whether you want it to run once or periodically.
* '''Set time:''' Setting the day and time at which the scheduled downtime will start and end either once or periodically, depending on what has been previously configured in "Execution".


{{tip|If the Pandora FMS administrator enables it in the visual configuration section, it is possible to create scheduled downtimes in a past date. They will not be executed, but their existence will be reflected in different reports. This is particularly relevant since it affects, among others, availability reports and SLAs.}}

<center>
[[Image:Downtime2.png|800px]]
<br><br>
</center>

Finally, specify which specific agents you want to include in that downtime.

<center>
<br><br>
[[Image:Downtime5.png|800px]]
<br><br>
</center>

When a scheduled downtime is "active", it cannot be modified or deleted, but from version 5.0 onwards there is an option where you may stop the execution in "Stop downtime", so that all agents/modules/alarms that the scheduled downtime disabled temporarily may be re-enabled. This option does not support periodic scheduled downtimes. From version 6.0 onwards, non-periodic scheduled downtimes can be delayed even if they are 'active'. When this downtime is over, you may modify or delete it.

=== Alternatives to console downtime management ===

There are often certain "cyclical" situations to be taken into account and the method of downtime management is too specific: for example, you may want to be able to deactivate all agents quickly and on time or to plan a general downtime every week from time to time. For this type of operations, there are ways to do it from the command line.

There is a faster way to set all agents in service mode, through the use of Pandora FMS management CLI, ''pandora_manage. pl'' through the command line:

 ./pandora_manage.pl /etc/pandora/pandora_server.conf --enable_group 1
 
 Pandora FMS Manage tool 3.1 PS100519 Copyright (c) 2010 Artica ST
 This program is Free Software, licensed under the terms of GPL License v2
 You can download latest versions and documentation at http://www.pandorafms.org
 
 [*] Pandora FMS Enterprise module loaded.
 
 [INFO] Enabling group 1

Disabling them would be the following way:

 ./pandora_manage.pl /etc/pandora/pandora_server.conf --disable_group 1

== Audit Log ==

Pandora FMS keeps a log of all changes and important actions taken in Pandora FMS console. This log can be seen in ''Admin tools'' > ''System Audit Log''.

<center><br><br>
[[image:gest67.png]]
</center><br><br>

On this screen, you may see a series of entries related to console activity, user information, action type, date and a brief description of the events recorded.

<center>
[[image:audit_1.png]]
</center>

In the upper left corner, you may filter which entry will be displayed by different criteria including: actions, user and IP, you may even perform a text search and determine the maximum amount of hours.

The available filtering fields:

* '''Action''': The different possible filtering actions > ACL Violation, Agent management, Agent remote configuration, Alert management, Command management, Dashboard management, Event alert management, Event deleted, Extension DB inface, File collection, Logoff, Logon, Logon Failed, Massive management, Module management, No session, Policy management, Report management, Setup, System, Template alert management, User management, Visual console builder.
* '''User'''.
* '''Free text for search''': It will search in the fields ''User'', ''Action'' and ''Comments''.
* '''Max. Hours old''': Number of backward hours where to display events.
* '''IP''':  Source IP address.

It is also possible to export the information displayed on the screen to a CSV file by clicking on the button at the top right of the screen.

<center>
[[image:audit_02.png]]
<br>
Available filtering actions
<br>
</center>
<br>

With this tool, you may search, for example, for the task that a user performs on agent management in the last hour.

<center>
[[image:audit_03.png]]
</center>

Or the moment when a given user has logged in the console. You may retrieve all information about the actions performed by the entire user.
In addition, you may see the Pandora FMS server service start date or when the console configuration was changed.

<center>
[[image:audit_04.png]]
</center>

== Local server logs ==

In latest Pandora FMS console versions, log status can be checked through the menu <i>Extensions > Extension management > System logs</i>.


<center>
[[image:System_logs_menu.png]]
</center>

From this extension you may see the logs of both the console and the local server:

<center>
[[image:System_logs_main.png]]
</center>


If you cannot see the content, check your log file permissions:

 chown -R pandora:apache /var/log/pandora/


You may change the rotator options to keep these settings by modifying the /etc/logrotate.d/pandora_server file.

<pre>
/var/log/pandora/pandora_server.log
/var/log/pandora/websocket.log 
/var/log/pandora/pandora_server.error {
	weekly
	missingok
	size 300000
	rotate 3
	maxage 90
	compress
	notifempty
        copytruncate
	create 660 pandora apache
}
/var/log/pandora/pandora_snmptrap.log {
	weekly
	missingok
	size 500000
	rotate 1
	maxage 30
	notifempty
	copytruncate
	create 660 pandora apache
}
</pre>

On the other hand, there is also a specific configuration for the console log rotation in <b>/etc/logrotate.d/pandora_console</b>:

<pre>
/var/www/html/pandora_console/log/audit.log
/var/www/html/pandora_console/log/console.log {
        weekly
        missingok
        size 100000
        rotate 3
        maxage 15
        compress
        notifempty
        create 644 apache root
}
</pre>


Note: If your system is SuSE, replace apache with www-data. In case of using a different system, check the users corresponding to the Apache service. 
(httpd)
<br>

== Cron Job ==

This Pandora FMS Enterprise extension allows to schedule task execution from Pandora FMS server.

The extension can be accessed from ''Servers'' > ''Cron jobs''.

<center><br><br>
[[File:Cron_jobs.jpg|800px]]
</center><br><br>

To add a task, the following fields must be filled in:
* '''Task''': Combo where the task to perform can be chosen.
**Send custom report via e-mail
** Run custom script
** Pandora FMS BD Backup
** Save custom report in disk 
* '''Schedule''':  Field where task frequency can be chosen.
** Without schedule: These tasks will be executed only once and at the specified time..
** Hourly
** Daily
** Weekly
** Monthly
** Yearly
* '''First run''': Field where the date and time of the first task execution is chosen. It will be executed periodically, taking this date and time as a reference.
* '''Parameters''': Field that allows entering parameters in the task to be performed. It varies by task. 
** ''Pandora FMS BD Backup'': Description and path where the backup will be stored.
** ''Send report via e-mail'': Report to be sent and recipient's e-mail address.
** ''Run script'': Script command to run.
** ''Save report to disk'': Report to be saved and the path to store it.

Once the data has been filled in, click on create and the task will appear in the scheduled tasks list.

<center><br><br>
[[File:Cron_jobs_list.jpg|800px]]
</center><br><br>

Once the scheduled task has been created, it is possible to force its execution by clicking on the green circle to the right of the task or delete it by clicking on the red cross on the left.


{{tip|If the cron job is "non scheduled", it will be deleted automatically when executed.}}


== DB management from the console ==

The core of Pandora FMS system is its database. It stores all data collected by monitored systems, agent configuration, alerts, events, audit data, different users and their data. That is, all system data.

Efficiency and reliability are vital for Pandora FMS to work properly, so database maintenance is essential. 

To perform regular database maintenance, administrators can use standard MySQL commands from the command line or manage the database from the console although they may not have extensive Mysql knowledge.

Pandora FMS has multiple extensions that can be used from the console to see information from the database.

=== Diagnostic tool ===

This section shows general information about Pandora FMS installation. It is necessary to emphasize the high amount of information that is obtained from the database, where the recommended parameters can be seen, as well as warnings about existing values that need to be changed.

<center><br><br>
[[File:Captura de pantalla de 2017-10-09 13-37-10.png]]
</center><br><br>

<center>
[[File:Diagnostic_info1.png]]
</center>
<center>
[[File:Diagnostic_info2.png]]
</center>
<center>
[[File:Diagnostic_info3_new.png]]
</center>
<center>
[[File:Diagnostic_info4.png]]
</center>

=== DB Interface ===

This is an extension that allows you to execute commands in the database and see the result. It is an advanced tool that should only be used by people who have a certain amount of knowledge about SQL and the Pandora FMS database schema. 

{{warning|If misused, this  tool may "destroy" data or permanently render the application inoperative.}}

It is accessed from ''Admin tools > DB interface''.

<center><br><br>
[[image:ex10.png|800px]]
</center><br><br>

Write the command in the blank field and click on "Execute SQL".

=== DB Schema Check ===

This is an extension that allows to check the structural differences between the database set in your Pandora FMS and a pattern scheme to compare possible errors. 

It works like this:
* A temporary database is created with the structure that the installation database should have (different depending on the installed version).
* The database created is compared with the database referenced in the installation.
* The temporary database is deleted.


<center><br><br>
[[image:Captura de pantalla de 2017-10-09 13-47-04.png|800px]]
</center><br><br>

Enter the data to access your database and click on "Run test".

{{Tip|It is recommended to use this extension to check whether a database migration has been correctly performed.}}

{{Warning|This check can only be done in MySQL Databases.}}

== Network Tools ==

*<b>Traceroute path</b>: If empty, Pandora FMS will search the traceroute system. 
*<b>Ping path</b>: If empty, Pandora FMS will search the ping system. 
*<b>Nmap path</b>: If empty, Pandora FMS will search the nmap system.  
*<b>Dig path</b>: If empty, Pandora FMS will search the dig system.  
*<b>Snmpget path</b>: If empty, Pandora FMS will search the snmpget system.

== Backup ==

Extension that allows backing up the DB and restoring it. 

To make a backup, first select the destination folder where the data will be stored. Once chosen, write a backup description.

<center><br><br>
[[image:ex12.png|800px]]
</center><br><br>

When the backup is done, it will appear in the Backup list with the running icon.

<center>
[[image:ex13.png|800px]]
</center>

Once the Backup has been created, it is possible to:
* Download it by clicking on this icon:

<center>
[[image:ex14.png]]
</center>

*Do a rollback by clicking on this icon:.

<center>
[[image:ex15.png]]
</center>

The rollback applies a previously created backup and restores it. This will destroy all existing data in the console and apply the data that exists in the backup on which the rollback is made.

{{Warning|By means of this tool it is possible to recover the database backup made through this feature. It is not possible to load a manual backup.}}

* Delete it by clicking on this icon:

<center>
[[image:ex16.png]]
</center>






== Plugin log ==

Extension that allows you to easily register server plugins.

The extension can be accessed through ''Servers'' > ''Register plug-in''.

<center><br><br>
[[image:ex9.png|800px]]
</center><br><br>

To register a plugin choose the file by clicking on "Browse" and "Upload".

More information about server plugins can be found in the development and extension chapter.

You may see in section [[https://wiki.pandorafms.com/index.php?title=Pandora:Documentation_en:Anexo_Agent_Plugins|Server Plugin Development]] the format of the .pspz files.

== Insert data ==

Extension that allows to import data in a comma separated file (CSV) to an agent module. This extension is accessed from ''Resources > Insert Data''.

<center><br><br>
[[image:Insert_data1.png]]
</center><br><br>

The format of the CSV file must be date;value per line. The date must be given in Y/m/d H:i:s format:

 2011/08/06 12:20:00;77.0
 2011/08/06 12:20:50;68.8


== Resource registration ==
This extension allows you to import .prt files containing the definition of network component, smnp component, local component or wmi component. You may also add all of them (except for the local component) to a template.

<center><br><br>
[[File:Resource registration screenshot.png|800px]]
</center><br><br>

===.prt file format===
<pre>
<?xml version="1.0"?>
<pandora_export version="1.0" date="yyyy-mm-dd" time="hh:mm">
	<component>
		<name></name>
		<description></description>
		<module_source></module_source>
		<id_os></id_os>
		<os_version></os_version>
		<data></data>
		<type></type>
		<max></max>
		<min></min>
		<max_cri></max_cri>
		<min_cri></min_cri>
		<max_war></max_war>
		<min_war></min_war>
		<historical_data></historical_data>
		<ff_treshold></ff_treshold>
		<module_interval></module_interval>
		<id_module_group></id_module_group>
		<group></group>
		<tcp_port></tcp_port>
		<tcp_send></tcp_send>
		<tcp_rcv_text></tcp_rcv_text>
		<snmp_community></snmp_community>
		<snmp_oid></snmp_oid>
		<snmp_version></snmp_version>
		<auth_user></auth_user>
		<auth_password></auth_password>
		<privacy_method></privacy_method>
		<privacy_pass></privacy_pass>
		<auth_method></auth_method>
		<security_level></security_level>
		<plugin></plugin>
		<plugin_username></plugin_username>
		<plugin_password></plugin_password>
		<plugin_parameters></plugin_parameters>
		<wmi_query></wmi_query>
		<key_string></key_string>
		<field_number></field_number>
		<namespace></namespace>
		<wmi_user></wmi_user>
		<wmi_password></wmi_password>
		<max_timeout></max_timeout>
		<post_process></post_process>
	</component>
	<component>...</component>
	<component>...</component>
	<template>
		<name></name>
		<description></description>
	</template>
</pandora_export>
</pre>

==Text string translator==

This extension belongs to the menu ''Setup > Translate string'' and allows translating Pandora FMS interface text strings to customize it.

<center><br><br>
[[image:Translate_string.png|800px]]
</center><br><br>

The fields to be filled in are detailed below:

* '''Language''': It allows to filter strings by language.
* '''Free text for search (*)''': Content of the string you wish to customize.

Three columns will appear: the first one will show the original string, the second one the current translation and in the third one the custom translation you wish to add.

== Workspace ==

This section allows interacting with Pandora FMS users, or edit the user's details, as well as several actions, such as access to the issue system (to open tickets), chatting with other users connected to Pandora FMS, etc.

=== Chat ===

It allows to interact with other users connected to that Pandora FMS console through a chat. It is useful in case you want to say something to another operator for example.

===Issues===

Pandora FMS allows managing issues from the console thanks to its integration with Integria IMS.

For more information about this tool, check issue management with Integria IMS.

=== Messages ===

Pandora FMS has a tool that allows different users to send messages among themselves.

==== See messages ====

When a user has a message, an envelope icon appears at the top right of the console.

<center><br><br>
[[image:gest20.png|600px]]
</center><br><br>

User messages can be seen in ''Workspace > Messages > Messages list'', and from there you may read, delete or write a message to a specific group or user.

=== Connected users ===

This extension shows other users connected to the Pandora FMS Console other than their own. This feature is important because Pandora FMS console allows multiple user connections.

The extension is accessed from ''Workspace > Connected users''.

<center><br><br>
[[image:ex4b.png|800px]]
</center><br><br>

==Software agent repository==

Software agent repository is part of the deployment center, which controls agent installer available versions (programs) to be deployed.

You may access it through this menu:

<center>
[[File:Agent_repo1.png]]
</center>


To add a new installer to the repository, click "Add agent".

[[File:Agent_repo2.png]]


Fill out the information related to the target OS type, the architecture, the installing file, etc.

<center>
[[File:Agent_repo3.png]]
</center>


'''Note:''' Installers for Linux (and all Unix and BSD range) are shared by all architectures. Both x64, x86, ARM, etc share the same installer.



Make sure the upload was successful:

<center>
[[File:Agent_repo4.png]]
</center>


The uploaded agent installer will appear on the list together with the information about its version, by whom and when it was uploaded etc.:

<center>
[[File:Agent_repo5.png]]
</center>

== Custom themes ==

Pandora FMS offers the possibility of uploading CSS files, in order to set custom themes in the visual console.

To that end, include the following comment in the CSS file:

 /*
 Name: My custom Theme
 */

Then, import the CSS file to the following path:

 pandorafms/pandora_console/include/styles/CustomTheme.css

Once the desired themes are uploaded, go to ''Setup > Setup > Visual styles'' and select the appropriate theme from the ''Style template'' drop-down.

<center>
[[File:CustomTheme1.png]]
</center><br>


[[Pandora:Documentation_en|Go back to Pandora FMS Documentation Index]]

[[Category:Pandora FMS]]
[[Category:Documentation]]