Difference between revisions of "Pandora: Documentation en: Managing and Administration"

From Pandora FMS Wiki
Jump to: navigation, search
(Adding a User)
(Pandora FMS Groups)
Line 109: Line 109:
  
 
The accesses are related with the groups that are used to group agents. An user could have different permissions in each of the groups to which it has access. The agents could only belong to one group.
 
The accesses are related with the groups that are used to group agents. An user could have different permissions in each of the groups to which it has access. The agents could only belong to one group.
 +
 +
{{Warning|The group ''All'' is a special group that cannot be deleted. All the gruops are subgroups of the group ''All''. Any element (Report, Graph, Event...) that is associated with the group ''All'' can be viewed/managed by a user that has permissions in any group.}
  
 
The groups are defined at Adminitration>Manage Agents>Manage Groups.
 
The groups are defined at Adminitration>Manage Agents>Manage Groups.

Revision as of 11:14, 15 February 2013

Go back to Pandora FMS documentation index

Contents

1 Management of Pandora FMS

1.1 Introduction

In this chapter are discussed several topics on daily management of Pandora FMS, such as: group administration, user creation, etc.

1.2 Profiles, Users, Groups and ACL

Pandora FMS is a Web management tool that allows multiple users to work with different permissions in multiple defined agent groups. Before adding users, groups and profiles must be well defined, as well as the data visibility we want each user to have.

1.2.1 Profiles in Pandora FMS

The permissions an user can have are defined in profiles. Profiles are managed at Administration>Manage Profiles



Gest1.png



The following list defines what ACL control allows in each feature at the console:

FeatureACL Control
View agent data (all tabs)AR
Tactical viewAR
Network map viewAR
Group viewAR
Visual console editionIW (RW from 5.0)
Create reportIW (RW from 5.0)
Create user custom-defined graphIW (RW from 5.0)
View report, visual map and/or custom graphIR (RR from 5.0)
Apply report template (>=5.0)RW
Create report template (>=5.0)RM
Create incidentIW
Read incidentIR
Delete IncidentIW
Become owner of another incidentIM
Delete incident of another userIM
View eventAR (ER from 5.0)
Validate/Comment eventIW (EW from 5.0)
Delete eventIW (EW from 5.0)
Execute response (>=5.0) EW
Create incident from event (From 5.0 is a response)IW
Change owner/Re-open event (>=5.0) EM
View userAR
SNMP Console viewAR
Validate trapsIW
MessageIW
Cron jobs PM
Tree view AR
Update manager (Operation & Admin) PM
Extension Module GroupAR
Agent managementAW
Remote agent configuration management AW
Assign alerts to agentsLW
Define, alter and delete alert templates, actions and commandsLM
Group managementPM
Create inventory modulesPM
Module management (includes all suboptions)PM
Massive management operations AW
Create agentAW
Duplicate remote configurationsAW
Downtime managementAW
Alert managementAM
User managementUM
SNMP Console management (alerts and MIB load)PM
Profile managementPM
Server managementPM
System auditPM
SetupPM
Database maintanceDM
Administrator extension menuPM
Search barAR
Policy managementAW
Disable agent/module/alert (>=5.0)AD

1.2.1.1 Adding a Profile

To add a profile, go to Administration>Manage Profiles and click on “Create”. The following form will be displayed:



Gest2.png



To create a profile, give it a name, choose the permissions it will have and click on “Create”.

1.2.1.2 Editing a Profile

To edit a profile, go to Administration>Manage Profiles and click on the name of the profile to be edited.



Gest3.png



1.2.1.3 Deleting a Profile

To delete a profile go to Administration>Manage Profiles and then click on the red "x" at the right hand side of the name of the profile to be deleted.



Gest4.png



1.2.2 Pandora FMS Groups

The accesses are related with the groups that are used to group agents. An user could have different permissions in each of the groups to which it has access. The agents could only belong to one group.

{{Warning|The group All is a special group that cannot be deleted. All the gruops are subgroups of the group All. Any element (Report, Graph, Event...) that is associated with the group All can be viewed/managed by a user that has permissions in any group.}

The groups are defined at Adminitration>Manage Agents>Manage Groups.



Gest5.png



1.2.2.1 Adding a Group

To add a group go to Administration>Manage Agents>Manage Groups and click on “Create Group”.

Following form is displayed:



Gest6.png



Next, form fields are discussed.

  • Name: Group name
  • Icon: Combo box to choose the icon the group will have.
  • Parent: Combo box to assign another group as parent of the group under creation.
  • Alerts: If enabled, agents belonging to the group will be able to send alerts, if not marked they won't be able to do so.
  • Custom ID: Groups have an ID in the Database, in this field you can input another customized ID to be used by an external program in an integration (e.g.: CMDB's).

Once the fields have been filled in click on the “Create” button.

1.2.2.2 Editing a Group

To edit a group got o Administration > Manage Agents > Manage Groups and click on the name of the group you want to edit.



Gest7.png



1.2.2.3 Deleting a Group

To delete a group go to Administration > Manage Agents > Manage Groups and click on the red x at the right hand side of the name of the group to be deleted.



Gest8.png



1.2.3 Tags in Pandora FMS (>=5.0)

The access to the modules can be configurated with a Tags system. A tags are configurated on the system, and be assigned to the choosed modules. In this way the access of the user can be limited to the modules with certain tags.

Info.png

The Tags access doesnt replace the group access. Just complement it

 


The tags are managed at Adminitration>Manage Modules>Manage Tags.



Gesttags5.png



1.2.3.1 Adding a Tag

To add a tag go to Administration>Manage Modules>Manage Tags and click on “Create Tag”.

The following form is displayed:



Gesttags6.png



Next, form fields are discussed:

  • Name: Tag name
  • Description: Tag description
  • Url: Extern link to add more extra information to the tag
  • Email: Email address used in alerts associated to the tag

Once the form is complete, click on “Create”

1.2.3.2 Editing Tag

To edit a tag go to Administration > Manage Modules > Manage Tags and click on the tag name that you want to edit or on the edition icon in the actions column.



Gesttag7.png



1.2.3.3 Deleting a Tag

To delete a tag go to Administration > Manage Modules > Manage Tags and click on the red X of the actions column.



Gestag8.png



1.2.4 Users in Pandora FMS

Once the profiles and groups that are going to be used in Pandora FMS have been defined, it's time to define users.

Users are managed at Administration > Manage users, where one can see the list of defined users, as well as the created profiles.



Gest9.png



1.2.4.1 Adding a User

To add a user go to Administration>Manage users and click on “Create User”.

The following form is displayed:



Gest11.png



Next, form fields are discussed:

  • User ID: Identifier the user will use to log into the application.
  • Full Display Name: Field to store the full name.
  • First Name: Field to store the person name.
  • Last Name: Field to store the family name.
  • Password: Field to input the password.
  • Password confirmation: Field to input the password again for confirmation.
  • Global Profile: Choose among Administrator or Standar User. An administrator will have absolute permissions on the application for the assigned groups. An standard user will have the permissions defined in the assigned profile.
  • E-mail: Field to store the user's e-mail.
  • Phone Number: Field to store the user's phone number.
  • Comments: Field to store comments on the user.

Once the form is complete, click on “Create”. The created user appears, as a new section does, to input the groups the user will have access to, and the applicable profile.



Gest12.png



A user can be given access to as much groups as you want. Select a profile and the group and click on the blue + symbol.

From the version 5.0 to each association User-Profile-Group is possible add Tags to limit this access to the modules with these tags. If no tags are assigned, the user will have access to all the modules on the agents of this groups.



Gest13.png



In case you want to remove access to a group, click on the red "x" at the right hand side of the access to be removed.



Gest14.png



In addition, the user can be given access to foreign political groups. This allows him to access all the content of these policies regardless of which group they belong to.



700px



To know more about this setup visit Extra access to policies

1.2.4.2 Displaying a User

On top of the option at Administration>Manage users it is also possible to see the users at Operation>View Users.



600px



1.2.4.3 Editing the Own User Settings

If the user has administrator permissions, he can modify certain parameters of her configuration at Operation>View Users>Edit my User.

The user creation form is displayed, where everything can be edited except group permissions.



Gest16.png



In case of lacking administrator permissions, following page will be displayed:



File:Gest17.png



1.2.4.4 User Edition by the Administrator

To edit a user completely, including the permissions and groups part, go to Administration>Manage users and click on the user's name.



Gest18.png



1.2.4.5 Removing an User

To completely remove an user, go to Administration>Manage users and click on the red "x" at the right hand side of the user's name.



Gest19.png



1.3 The "All" Group

Pandora FMS has a system of groups that are entities in which the agents will be classified and that are used to disperse privileges. In that way, it gives the users some permissions framed into one or several groups, and they will have then, the possibility of seeing and interact with the agents and the others objects from its environment.

To make easier the assignation and filtering of the groups, we have a tool named "All" group. The "All" group means, depending on the context, ALL groups , or ANY of them. Theoretically speaking, it's the same in version 3.1, but its implementation has changed.

In version 3.0 the "All" group is an special group contained in the database with Identifier 1. This one was booked, in this way, to this group. So, throughout the console code, the group with id 1, was managed as an exception, with the necessity of the subsequent control when the groups where listed, and where it was necessary to omit this group sometimes.

In version 3.1 the "All" group has disappear from the Database, so the identifier 1 has been released for the use of any normal group. Now, the identifier reserved for the "All" group is the 0, with the difference, that it is completely controlled through code, and there doesn't exist this group as before. Simply, now it's controlled that the objects associated with the 0 group will be associated to all groups, without needing to control if a group token out from the database is special or not.

When we take out the agents from a group or vice versa, there isn't any problem, so an agent belongs only to a group. But, for example, when extracting the groups to which an user belongs to or the users that belong to one group, you should consider that when we list the users that belongs to a group, we should show the ones that belong to all of them (group 0) and if we show the groups of an user, then we should show all of them in case that this user belongs to the "All" group (group 0)


1.4 Enterprise ACL System

The Open Source ACL model is based on “unix style” role/action/group/user (4 items).

The Enterprise ACL system, implemented in version 3.1, will allow to define per profile, which pages (defined one by one or by “groups”) has user access. This will allow for example, to let a user view only “Group” view, and “Detailed” agent view, skipping pages as “Alert view” or “Monitor view”, grouped already in Pandora FMS classic ACL system as “AR” (Agent Read privileges).

This even allow to restrict administration per page. Very useful to let specific low-level operations allowed.

Both models are “paralel” and compatible, and this is an Enteprise feature only. Classic ACL system will continue to exist, and provides as now, a very easy ACL system for Pandora FMS.

In order to use the new ACL system, first this should be activated in setup. This option is only visible if you're running the enterprise version




Acl setup2.png



To use the Enterprise ACL system, go to the specific option for ACL Enterprise at Administration -> Setup. In this screen you can 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.



Acl setup1.png



Enterprise ACL systems, if activated, restrict ALL pages to ALL groups (even the Administrator!) to pages defined (allowed) in the Enterprise ACL system. If a user with "Administrator" profile, has no pages included in the Enterprise ACL system, he cannot see anything.


Template warning.png

Please be careful with this because you can loose console access if you set incorrect Enterprise ACL configuration to your running user!

 


To disable enterprise ACL system from command line, execute:

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

You can define "page by page", "whole sections", set a "any" rule or add "custom pages" no accessibles from menu.

There are two modes to add pages to a profile: With the wizard (by default) or with the custom edition. Over the add rules button there is a button to change this mode.

1.4.1 Wizard

With the wizard, we choose the sections and pages from a combo controls.

Template warning.png

The pages of this combos there are the accessibles from menu. To give access to pages that are accesible by another way (For example, the main view of the agents) we must use the custom editor

 


To include a Pandora FMS page into "allowed pages" you must select the profile to which the acl will be applied to and then choose the section allowed from the "Section" control. At this moment, you will can select from "Page" control, whatever of the section pages.



Acl setup4.png



Another option is to select a section and set the value "All" for "Page". This will allow the selected profile to see "everything", just as would be without the Enterprise ACL system for that profile. In the same way if you select "All" in both controls this profile could se "all" of "all" sections, as this sections without Enterprise ACL system.

Template warning.png

To do section visible in the menu, the user must has access to at least the first page of this section. For example, to show section "Monitoring", the user must has access to al least the "Tactical View" page

 


1.4.2 Custom edition

To add single pages that are not accessibles from the menu, we can interoduce their sec2 manually. For this, we will access to the page that we want to add and copy the sec2 parameter.

For example if we want add the main view of the agents, we go to any agent main view where the URL will be like this:

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

We write the sec2 parameter (operation/agentes/ver_agente) into the text box.



Acl setup5.png



1.4.3 Security

Any page not "allowed" will not be shown in the menu, and will not allowed to be used, even if the user enter the URL "manually". Any page not allowed by "Classic" Pandora FMS ACL system, will not be allowed by the enterprise ACL system (this runs over the classic ACL system). This is an example with several filters:



Acl example.png



Also, there is a control that checks if a page belongs to a section, improving the security against manually modifications of the URL. This check will be avoided with pages added with the custom editor and when the user has access to all the pages of a section, to optimize the performance.

1.5 Workspace

1.5.1 Chat

This tool allows to interact with other pandora users connected to the console in realtime. This is helpful to share comments or issues about the service with other operators/administrators.

1.5.2 Users connected

This extension shows other users connected to Pandora FMS console different that our own user. This functionality have importance because Pandora FMS Console allows conections from different users.

Go to the extension from Operation>Extansions>Users connected.



Ex4b.png



1.5.3 Messages

Pandora FMS has a tool that allows that the different users could send messages between them. Pending messages has a blinking icon in the header.

1.5.3.1 See Messages

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



Gest20.png



You can see the messages that have an user at Operation> Messages



Gest21.png





Gest22.png



Clicking on the envelope you can read the message that is over the messages list.

Clicking on "Reply" you can answer the message.



Gest23.png



Once answered, send by clicking on "Send Message".

1.5.3.1.1 Sending Messages

To send a message, go to Operation> Messages> New Message



Gest25.png



Once you have written the message, send it clicking on "Send Message".

1.5.3.1.2 Deleting Messages

To delete the messages that have an user, go to Operation> Messages, and press on the red "X" that is on the right of the message.



Gest24.png



1.6 Incidents

In the system monitoring process, besides receiving and processing data to monitor systems or applications, you need also to monitor the possible incidents that could take place in these systems.

For it, Pandora FMS has an incident manager where any user could open incidents explaining what has happened in the network and updating them with comments and files any time that there would be any new.

This system allows a work team, with different roles and «workflow» systems that allows that an incident could go from one group to another, and that members from different groups and different people could work on the same incident, sharing information and files.


1.6.1 Seeing all Incidents

To see all the created incidents go to Operación> Manage Incidents



Gest26.png



There is a list with all the incidents, classified by update order

In the list of incidents, each of them is with information distributed in the following columns:

ID Incident identifier.

State

State of the incident with the following icons:



Gest27.png



Incident name

Name for the incident

Priority

Shows the priority that the incident has assigned through the priority icons.



Gest28.png



Group

Defines the group the incident has been assigned to. An incident only could belong to one group.

Updated the Last time that there was an incident update.

Origin

Tab that is applied to assign an origin to the incident. It could be selected from a list that is kept on the database. Though the origin list is fixed and predefined, it could be modified by the administrator in the database.


Owner

User that has assigned the incident at present. Do not confuse it with the incident creator, so the incident could have changed of owner. The owner can always assign the incident to another user. Other any user could also do the same thing, as long as it has incident privileges management on the group the incident belongs to.

1.6.2 Incident Tracking

To see an specific incident, click on the incident Id or on the incident name.



Gest29.png



The incident is shown at an screen with three sections:

  • Incident Data


Gest30.png



In this section is shown the incident basic data

You can update the fields: Incident, Owner,State, Origin,Group,Priority, and the description.

Once they have been updated, click on "Update Manager".

  • Notes that the users write


Gest31.png



In this section are the notes from the different users that have participated on the incident.

To add notes to the incident, click on «Insert Note». It will show a page that has a text area. Write the note and click on «Add».



Gest32.png



Any user with permission for reading an incident could add a note. Only the incident or the note owners could delete them.


  • Attached Files


Gest33.png



In this field are the attached files that the different users who have take part add.

To add a file click on " Add file".



Gest34.png



Two entry fields will be shown. Look for the file in the local system and, if you want, write a description. When you have finished click «Upload» to start the file upload to the server.

To see the file click on the file name.

Any user that has permission for reading an incident could add a file. Only the incident or file owners could delete them.

1.6.3 Searching Incidents

There are some fields for searching incidents that could be combined.



Gest35.png



It is possible to filter by the following fields:

  • Filter by incident state.Where you can filter by incident state between the following values:
    • All incidents
    • Active incidents
    • Closed incidents
    • Rejected incidents
    • Expired incidents
  • Filter by priority. Where you can filter by incident priority between the following values:
    • By all Priority
    • By informative priority
    • By low priority
    • By medium priority
    • By serious priority
    • By very serious priority
    • By maintenance
  • Filter by user: it is possible to filter by user owner of the incident.
  • Free text: where it is possible to filter by searching a text.
  • Filter by groups. Where it is possible to filter by incidents associated to each of the groups that are in Pandora FMS.

1.6.4 Opening a New Incident

To open a new incident, go to Operación> Manage Incidents and click on "Create Incident".



Gest36.png



It shows the page to create it.



Gest37.png



1.6.5 Changing the Owner of an Incident

To change the owner of an incident, go to Operación> Manage Incidents, select the chosen incident in the last column and click on "Become Owner".



Gest38.png



This way, the user that does the operation will be the incident owner.

1.6.6 Deleting an Incident

To delete an incident, go to Operación> Manage Incidents. Select the chosen incident in the last column and click on “Delete Incident”.

1.6.7 Incident Statistic

At Operation>Manage Incident>Statistic you can have access to five kinds of the incidents graphic statistics:

  • Incidents state
  • Priorities assigned to the incidents.
  • Users that have an incident opened.
  • Incidents by groups.
  • Incidents Origin.

1.6.8 Self generated Incidents (servidor recon)

With the recon server integration we have also added the incidents self-generated from the events processed by the recon server, such as the detection of new systems in the network we are working with. This incidents are exactly the same to the rest of them and they also are listed in the «Managing Incidents» section from the «Operation» menu.

1.7 Manage incidents (Pandora FMS and Integria integration)

Integration between Pandora FMS and Integria allows to share all information that have these applications and work on it in a syncronized way.

First, it is necesary to enable integration between Pandora FMS and Integria. To see configuration about this parameters see Setup (Integria URL, API password and Integria inventory).

In Operation > Manage Incidents section will appear Integria incidents:



Incidents1.png



Incidents search is similar to Pandora FMS incidents (previouly described).

You can see on Integria all incidents created in Pandora FMS:



Incidents2.png



You can see details like group, severity, source, resolution, state (new, unconfirmed, assigned, etc.), description, etc.



Incidents3.png



You can add workunits that keep communication between incident source and the resolutor. Also you can see time used by entry, if it is public or has cost.



Incidents4.png



You can upload files associated to incidents:



Incidents5.png



Last, you can keep track of all interactions between users by each incident:



Incidents6.png



1.8 Servers

The servers detailed view is used to know, besides the Pandora FMS servers general state, its load level and its delay. We are going to show one snapshot with the servers state. To get it go to the Operation menu -> Pandora Servers.



Server info.png



In this view we could see several important data. In each column is showed the following information:

  • Server name, usually uses the system hostname.
  • State (green = right, red = not fired, stopped or down.)
  • Kind of server: data server, network server, etc.
  • progressing bar: that shows the load percentage of the total of modules to this kind of server. In this case all servers are to 100% except recon, that has no associated tasks, so it is at 0%
  • Nº of modules of this kind executed by the server regarding to the total nº of modules of this kind.
  • Server Lag: Higher time that the oldest module has been waiting for data/Nº of modules that are out of its life time.In this example there are near 3000 modules out of its life time, whit a lag time (lag) of 10 minutes, 13 seconds. This indicator is useful to know if we have al lot of modules and to know if the server is at the limit of its load capacity, such it is at this case, that thought it is not an excessive delay (10 minutes, 13 seconds) for modules that have an average life time lower, being only 19 modules with lag (of 10 minutes) from a total of almost 1500 modules.
  • Total nº of threads configured at the server: total nº of modules in queue waiting for be attended. These parameters show

states of excessive load.There should not be hardly ever modules in queue. This shows the incapacity of the server to process data.

  • Nº of seconds since the server updated its data. Each server has a "Keepalive" that updates its state in order to make sure that it is active, updating its statistics too.

1.9 Backup

Extension that allows to do a DDBB Backup and restore it. Go to the extension from Administration>Extensions> Backup To do the Backup write the backup description and click on "Create":



Ex12.png



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



Ex13.png



Once the Backup has been created it is possible:

  • Download it clicking on the image icon.


Ex14.png



Doing a rollback clicking on the image icon.



Ex15.png



The rollback applies a backup that have been created before and restore it. This will destroy all existing data in the console and will apply data that already exist in the backup where the rollback is done.

  • Delete it clicking on the image icon.


Ex16.png



1.10 Cron Job

(Only for Enterprise version)

Extension that allows to schedule the fulfilment of tasks from Pandora FMS server.

Go to the extension from Operation>Extensions>Cron jobs



Cron jobs.jpg



To add a task, you should fill in the following fields:

  • Task: Combo to choose the task that is going to be done.
    • Send custom report by e-mail
    • Execute custom script
    • Backup Pandora database
    • Save custom report to disk
  • Scheduled: Field to choose how often the task will be executed.
    • Not Scheduled: These tasks will be executed only once, at the specified time
    • Hourly
    • Daily
    • Weekly
    • Monthly
    • Yearly
  • First Execution: Field to choose the date and hour of the task first execution.It will be executed periodically taking the date and hour established as the reference.
  • Parameter: Field that allows to introduce parameters in the task to fulfill. It is changeable depending on the task to fulfill.
    • Backup Pandora database: Description.
    • Send custom report by e-mail: report to send and destination e-mail.
    • Execute custom script: script to execute.
    • Save custom report to disk report to save and destination folder.

Once you have filled all data, click on create and the task will be shown in the Scheduled task list.



Cron jobs list.jpg



Once you have created the scheduled task, it is possible to force its execution by clicking on the green circle that there is on the right of the task or deleting it clicking on the red cross that is on the left.

1.11 Planned Downtime

Pandora FMS has an small scheduled downtime management system. This system allows to deactivate the alerts in the intervals where there is down time by deactivating the agent. When an agent is deactivated, it doesn't collect information either, so in a down time, for most of the metrics or kinds of reports, the intervals where there is a down time are not taken into account in the reports because there aren't data in those intervals in the agents.

In order to create a downtime, we should go to the Agent's management -> Downtimes and click on the button to create one:



Downtime1.png



Downtime2.png



When we create a downtime, we should specify the group and the date hour intervals where it start working



Downtime2.png



Finally, we specify the specific agents that we want to include in this downtime.



Downtime5.png

When an scheduled downtime is "working", it couldn't be neither modified nor deleted.



680px

When this downtime ends, we can modify or delete it again.



680px

1.11.1 Alternatives to the Service Downtime Management in the Console

There are often some "cyclical" situations that we should take into account and the service downtime management method is too specific. For example, we want to deactivate all agents in a quick and precise way or to schedule a general downtime each week in a precise range of hours. For this kind of operations, there are ways to do it from the command line.

There are two ways more "fast" of putting all agents in service mode

1. Through the Pandora management tool pandora_manage.plthrough 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

This activate all agents. To deactivate them it would be the same, but:

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

2. This can also be done through the MYSQL interface by modifying the data directly:

echo "UPDATE tagente SET disabled = 1" | mysql -u pandora -ppassword pandora

Obviously, where "password" is written, you should write the access password to the DDBB. Using the SQL method, you could do a more granular operation, for example to specify by name of agent:

echo "UPDATE tagente SET disabled = 1 WHERE nombre LIKE '%_XXXX%'" | mysql -u pandora -ppassword pandora

1.12 Audit Log

Pandora FMS keeps a log of all important changes and actions that take place in Pandora FMS console. This log could be seen at Administration > System Audit Log.



Gest67.png



1.12.1 See the System Logs

At Administration>System Audit Log you could go to the system logs.



Gest68.png



In the logs list, each of them has the information distributed in the following columns:

  • User: User that caused the log.
  • Action: Action that causes the log.
  • Date: Date when the log takes place.
  • Source IP:Origin IP of the machine that causes the log.
  • Comments: Log comments.

1.12.2 Filtering the System Logs

From the log view at Administration>System Audit Log it is possible to filter the logs by the field "action".



500px



The filter fields show all the fields that there are at the moment of executing the filter. If the TESTING agent has been deleted, it will be an action “Agent TESTING Deleted” to filter.

In the image you can see an example of actions you can filter with.



500px



1.13 Managing the Database from the Console.

Pandora FMS core is its Database. It it are kept all data collected from the monitored systems, the agents configuration, the alarms, the events, the audit data, the different users and his data. This is, all system data.

The efficiency and reliability of this module is vital to Pandora FMS right working. The maintenance of Pandora FMS Database in good state is critical for it could work well.

To do a regular maintenance of the Database, the administrators could use MySQL standard commands from the command line or could manage the Database from the console without being an expert on Mysql.

The Database management is done from Administration>DB Maintenance, where there are the following options:



Gest71.png



1.13.1 Getting Information from the Database

To manage correctly the database is essential to know well the data that it has and the time these data has been in the database. From Pandora FMS database it is possible to obtain information from the database of different kinds:

1.13.1.1 Obtaining General Information

By clicking on Administration>DB Maintenance you could get a page with general data of the database. This page shows the time that the system takes to compact and the time that the system are kept in the system.

Packing consist on reducing the amount of kept data, without losing important information. As time goes by, not all data will be obtained, but statistic interpolations that allow to do graphs with the processed data.



Gest71.png



By putting the mouse over the graph you could obtain data from any piece of the cake.

1.13.1.2 Getting Information about Agents and Modules

To obtain information about the number of modules and the data from each agent of Pandora FMS, click on Administration>DB Maintenance> DB Information.

It will show two bar charts, one that shows the modules by agent, and another that shows the packets by agent.



Gest72.png





File:Gest73.png



In the graphs is showed general information. If you want to get more specific information in text mode, click on “Press here to get database information as text”.



Gest74.png



You will get the information by text with the agent name, the number of assigned modules and the data amount of this agent. The list is classified by agent data and it has all agents configured in Pandora FMS.

1.13.1.3 Getting Information about Data by Date

From Administration>DB Maintenance> Database Purge you could obtain the number of packets of less of three months, one month, two weeks,one week, three days or one day.



Gest75.png



You could obtain data from all agents or of one specific agent.

To obtain data from an specific agent, choose the agent you want in the combo and, automatically, you will obtain the agent data.



Gest76.png



1.13.1.4 Getting Data from the Audit Log

From Administration>DB Maintenance> Database Audit you could get the total number of audit logs, and also the data of the first and last log.



Gest77.png



1.13.1.5 Getting Data about Events

From Administration>DB Maintenance> Database Event you could obtain the total number of events, and also the first log data and the last log data.



Gest78.png



1.13.2 Purging the Database

Pandora FMS gives tools for the data purge. It will be done, in a general way, by dates of the data, when is detected that a system is too slow or, in an specific way, when a wrong data is detected and you want to delete it from a module.

1.13.2.1 Agent Data Purge by Date

To purge agent data by date in the Database, click on Administration>DB Maintenance> Database Purge Select in the combo the data that is gone to be deleted and click on the "delete" button.



Gest79.png



Is possible to purge data of more than three months, one month, two weeks, one week, three days or one day. The time the system spend purging the selected data will depend on the amount of them.

1.13.2.2 Purging Specific Data from a Module

When you detect that there are modules with wrong data, it is possible to standardize them from Administration>DB Maintenance> DataBase Debug.

Select the Agent and the Module. Fix the maximum and minimum limits and click on "Delete".



Gest80.png



All data that is out o the interval [minimum,maximum] will be deleted.

1.13.2.3 Purging Audit Data

To purge audit data in the Database, click on Administration>DB Maintenance> DataBase Audit. Select the data that you want delete in the combo and click on "Do it"



Gest81.png



It is possible to purge data of more than ninety days, thirty days, fourteen days, seven days, three days or all data.The time that the system spend purging the selected data will depend on the amount of them.

1.13.2.4 Purging Event Data

To purge event data in the Database, click on Administration>DB Maintenance> DataBase Event.

Select in the combo the data that you are going to delete and click on “Do it”.



Gest82.png



It is possible to purge data of more than ninety days, thirty days, fourteen days, seven days, three days or all data.The time that the system spend purging the selected data will depend on the amount of them.

1.13.3 DDBB Maintenance

Pandora FMS infrastructure does not need external maintenance, but it is very important to purge the old data and to keep compacted the database and also to delete modules that have never been started, this is, that are in the agents but have never received data. To do this, you should execute a Pandora FMS internal script that does the regular maintenance (daily) of the DDBB. For more information, see the chapter Management and Administration of the server.

Nevertheless, you can do some of the task that this script does from the console, as we are going to see in this subsection.



Gest83.png



To execute these tasks, click on Administration>DB Maintenance> DataBase Sanity.

1.13.3.1 Sanitizing

This tool allows to "sanitize" the modules and delete those unfinished structures and/or bad performed( by a pending deleting, e.g)that, in some cases, could do that Pandora FMS works more slow that usual.



Gest84.png



1.13.3.2 Purging Non Initialized Modules

Many times modules are created and assigned to agents that are not initialized, due to they never receive data. It would be advisable to get the non initialized modules out from time to time.

To execute this task from the console, click on “Delete non-initialized modules now” at Administration>DB Maintenance> DataBase Sanity.



Gest85.png



Do not forget that these two operations are done in an automatic way with the database maintenance tool described in Server Management and Administration chapter.

1.13.4 DB Interface

Extension that allows to execute commands in the DDBB and to see the result. It is an advanced tool that should only be used by people who know SQL and the Pandora DDBB structure in detail.


Template warning.png

If this tool is used in a wrong way, it could destroy data or could make the application useless in a permanent way.

 



Go to the extension from Administration>Extensions> DB interface.



Ex10.png



Writte this command in the blank field and click on Administration>Extensions> DB interface.

1.14 Plugin Register

Section that allows to log server plugins in an easy way. Go to the extension from Administration > Server > Plugin register.



Ex9.png



To log one plugin, choose the file clicking on Examine and click on "Upload".

You can find more information about the server plugins in the Developing and Extension chapter.

You can see in Server plugin development section which is the .pspz format.

1.15 Insert data

This extension allow to import data in an comma-separeted file (CSV) to a agent module. You can access to this extension from Administration > Manage Agents > Insert Data.



Insert data1.png



CSV file format must be date;value by each line. Date format will be Y/m/d H:i:s format. For example:

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

1.16 CSV Import

(Enterprise feature)

Extension that allows to import a file separated by any divider at the Pandora FMS server.

Go to the extension from Administration > Server > CSV import.



Ex17.png



Choose the field to import clicking on "Examine". Choose the server where the export will be done and select the divider from a combo. Once the fields before mentioned are completed, click on "Go".

The CSV file should contain the following fields in this order:Agent name, Ip Adress, Operative System id, Interval and Group id the agent should belong to.

1.17 Resource registration

With this extension you can inport .prt files which contains the definition of network components, smnp components, local components or wmi components. Also you can add these components (not local components) to a template.



Resource registration screenshot.png



1.17.1 File definition for .prt

<?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>

1.18 Translate string

This extension it's in godmode menu and allows to translate strings on Pandora FMS interface in order to personalize it.



Translate string.png



Here are the fields to fill in:

  • Language: Allows to filter string by language.
  • Free text for search (*): String content to personalize.

Three columns will be displayed: the first one will show the original string, the second one will show the current translate string and the third one will contain the custom translate that you want to add.


Go back to Pandora FMS documentation index