Difference between revisions of "Pandora: Documentation en: Interface"

From Pandora FMS Wiki
Jump to: navigation, search
(The Administration Menu)
 
(14 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 
[[Pandora:Documentation_en|Go back to Pandora FMS documentation index]]
 
[[Pandora:Documentation_en|Go back to Pandora FMS documentation index]]
  
= The Pandora FMS Interface =
+
 
 +
 
 +
= Pandora FMS Interface =
  
 
== Introduction ==
 
== Introduction ==
  
In this section, we're going to show you the basic menus of the Pandora FMS Interface along with all icons and features required to start learning how to use Pandora FMS.
+
This section shows Pandora FMS Interface basic menus along with all icons and features required to start learning how to use Pandora FMS.
  
== Pandora FMS Start Session Screen ==
+
== Pandora FMS login screen ==
  
On the image below, we see the default Pandora FMS start session screen:
+
On the image below, you may see the default Pandora FMS login screen:
  
 
<br><br>
 
<br><br>
Line 16: Line 18:
 
</center>
 
</center>
  
At the bottom of the screen, we can see the version of Pandora FMS we're currently using.
+
At the bottom of the screen, there is the version of Pandora FMS currently used.
  
There are text entry boxes in the center to enter the username and password with the button to start the session (login).
+
There are text entry boxes at the center to enter the username and password with the button to log in.
  
Introduce credentials to start. The defaults are:
+
Enter the login credentials to start. The default ones are:
  
 
* '''User''': admin
 
* '''User''': admin
 
* '''Password''': pandora
 
* '''Password''': pandora
  
The console displays the default Pandora FMS main welcome page. Pandora FMS start session screens can be customized. This will be explained in the '''Custom welcome screen''' section.
+
The console displays the default Pandora FMS main welcome page. Pandora FMS login screens can be customized. This will be explained in the '''Custom welcome screen''' section.
  
== Pandora FMS Main Page ==
+
== Pandora FMS main page ==
  
 
The Pandora FMS default main page shows basic and general information about the status of the systems and the number and type of checks that Pandora FMS performs.
 
The Pandora FMS default main page shows basic and general information about the status of the systems and the number and type of checks that Pandora FMS performs.
Line 40: Line 42:
  
  
The static elements which do ''not'' change in different screens of the interface are:
+
The static elements, which do ''not'' change in different screens of the interface are:
  
* Operation Menu
+
* Operation menu
* Administration Menu
+
* Administration menu
* Defined Links
+
* Defined links
 
* Headers
 
* Headers
  
Line 50: Line 52:
  
 
* Header information
 
* Header information
** User information, pending messages, system notifications, etc. (this will be explained in the '''header subsection ''' below).
+
** User information, pending messages, system notifications, etc. (this will be explained in the '''header sub-section ''' below).
 
* Site news
 
* Site news
* Last activity of the Web Console
+
* Web console's last activity
 
* General basic information  
 
* General basic information  
* Checking main view in Pandora FMS
+
* Pandora FMS Overview:
 +
** <b>Server health</b>: Server general status.
 +
** <b>Monitor health</b>: Monitor general status.
 +
** <b>Module sanity</b>: General status of the modules that collect data, compared to the non-started ones.
 +
** <b>Alert level</b>: Alert general status.
  
 
This is the default home page, but the user can customize it.
 
This is the default home page, but the user can customize it.
  
 
=== Pandora FMS Customized Page ===
 
=== Pandora FMS Customized Page ===
In the Workspace-> Edit my user view you can choose the Pandora home screen.  
+
In the ''Workspace-> Edit my user'' view you can choose the Pandora FMS home screen.  
  
  
Line 66: Line 72:
 
</center><br><br>
 
</center><br><br>
  
''Note: Shortcut bar functionality is implemented from Pandora FMS 5.0 onwards''
+
''Note: Shortcut bar feature is implemented from Pandora FMS 5.0 onwards''
  
 
Available Options:
 
Available Options:
  
* '''Default:''' Pandora FMS main page as shown by default.
+
* '''Default:''' Pandora FMS main page as shown above by default.
* '''Dashboard:''' You can choose a user dashboard.
+
* '''Dashboard:''' You may choose a user dashboard.
 
* '''Visual Console:''' You can pick the user's visual console.
 
* '''Visual Console:''' You can pick the user's visual console.
 
* '''Event List'''
 
* '''Event List'''
Line 77: Line 83:
 
* '''Tactical View'''
 
* '''Tactical View'''
 
* '''Alert Detail'''
 
* '''Alert Detail'''
* '''Other:''' Users are able to customize their home page. It's going to display the default view by default. Example: Select 'Other' and type 'sec=estado&sec2=operation/agentes/estado_agente' to show a detailed agent view.
+
* '''Other:''' Users are able to customize their home page by entering the url. An example would be 'sec=estado&sec2=operation/agentes/estado_agente' to show a detailed agent view.
  
=== The Operation Menu ===
+
=== The operation menu ===
  
The Operation menu allows you to view all checking done by Pandora FMS agents, the visual maps, network maps, inventory, see and manage the incidents (if you have permissions), see the SNMP console, see the messages and use the extensions.
+
The operation menu allows you to view all checking done by Pandora FMS agents, visual maps, network maps, inventory, see and manage the incidents (if you have the according permissions), see the SNMP console, see the messages and use the extensions.
  
 
<CENTER>
 
<CENTER>
Line 89: Line 95:
 
From the Operation menu down to any submenu, there could be other elements that will be displayed.
 
From the Operation menu down to any submenu, there could be other elements that will be displayed.
  
All of these elements link to other pages containing information and all of them will be explained in the chapters dealing with Operations in Pandora FMS in great detail.
+
Each of these elements links to other pages containing information and all of them will be explained in the chapters dealing with operation in Pandora FMS in more detail.
  
=== The Administration Menu ===
+
=== The administration menu ===
  
The Administration menu allows you to visualize and manage the checks carried out by Pandora FMS agents, the modules and components of said checks, the alerts that these modules and agents can launch and how these alerts work, the existing policies, the users, the user profiles, the Pandora FMS servers and their assigned tasks, the system audit log, the general behavior of the Pandora FMS web console.
+
The administration menu allows you to view and manage the checks carried out by Pandora FMS agents, the modules and components of said checks, the alerts that these modules and agents can launch and how these alerts work, the existing policies, the users, the user profiles, the Pandora FMS servers and their assigned tasks, the system audit log, the general performance of Pandora FMS web console, the database maintenance and console's extentions.
  
 
<br><br>
 
<br><br>
Line 101: Line 107:
 
<br><br>
 
<br><br>
  
There could be other elements which will be displayed when selecting menus in any submenu down from  Administration.
+
There could be other elements which will be displayed when selecting menus in any Administration drop-down submenu.
  
 
Each of these elements provides another page with information. All of them will be explained in detail in the chapters of operation and management with Pandora FMS.
 
Each of these elements provides another page with information. All of them will be explained in detail in the chapters of operation and management with Pandora FMS.
  
=== Links Menu ===
+
=== Links menu ===
  
 
The links menu simply displays a link to preconfigured sites. These can be added, modified and deleted from the Pandora FMS Administration menu. These links allow you to link Pandora FMS with other WEB applications of your organization and make Pandora FMS a central management point.
 
The links menu simply displays a link to preconfigured sites. These can be added, modified and deleted from the Pandora FMS Administration menu. These links allow you to link Pandora FMS with other WEB applications of your organization and make Pandora FMS a central management point.
Line 115: Line 121:
 
=== The Header ===
 
=== The Header ===
  
The Pandora FMS header offers several quick links or   direct access to important features of the system and a search bar:
+
Pandora FMS header offers several quick links or direct access to important features of the system and a search bar:
  
 
<br><br>
 
<br><br>
Line 124: Line 130:
  
 
From left to right, the header provides the following:
 
From left to right, the header provides the following:
 
+
* The search bar which allows to run a search in several elements: agents, reports, alerts, maps, combined graphs, users and / or policies in Pandora FMS database.
* A link to the system status which shows the Pandora FMS server status.
+
* The auto-refresh button which, apart from updating the screen, can be configured to auto-refresh in a certain time interval. This allows you to  configure it to be refreshed every X time on any page. By doing this, the session or the information in it will not get lost. It also displays the updated data.
* The auto-refresh button which, apart from updating the screen, it can be configured to auto-refresh in a determined time interval. This allows you to  configure it to be refreshed every X time on any page. By doing this, the session or the information in it won't get lost. It also displays the updated data.
+
*  If there are pending system notifications, an alert icon will be displayed and by clicking on it, a modal window with the current alerts will be displayed.
*  If there are pending system notifications, an alert icon will be displayed and clicking on it will display a modal window with the current alerts.  
+
* A link to the system status, which shows Pandora FMS server status.
 +
* A link to the general support of Pandora FMS.
 +
* A link to the general contextual help content of Pandora FMS.
 +
* A button to log out.  
  
 
<br><br>
 
<br><br>
Line 135: Line 144:
 
<br><br>
 
<br><br>
  
* A link to the general contextual help content of Pandora FMS.
+
* If the user has messages yet to read, a letter icon will be shown. If you click on it, a modal window with the current messages will appear.
* A button to close the session.
 
* The user which is currently connected. A direct link to his user page (in brackets).
 
* If the user has pending messages to read, a letter icon will be shown. If you click on it, a modal window with the current messages will appear.
 
* The search bar which allows to run a search in several elements: Agents, reports, alerts, maps, combined graphs and / or users in the Pandora FMS database.
 
  
 
The link to the system status also alerts you when a service is down, changing icon:
 
The link to the system status also alerts you when a service is down, changing icon:
Line 149: Line 154:
 
<br><br>
 
<br><br>
  
By clicking on the link, it takes you directly to the  server status, reporting various details about them:
+
By clicking on the link, it takes you directly to the  server status, reporting different details about them:
  
 
<br><br>
 
<br><br>
Line 157: Line 162:
 
<br><br>
 
<br><br>
  
In the user editing section we can configure the auto-refresh for certain sections. If enabled in the section where we are, the auto refresh button allows you to update the page by clicking on it, or select an update frequency:
+
In the user editing section, you may configure the auto-refresh for certain sections. If enabled in this section, the auto refresh button allows you to update the page by clicking on it, or select an update frequency:
  
 
<br><br>
 
<br><br>
Line 171: Line 176:
 
</center>
 
</center>
  
Auto refresh is only shown on some pages. It's disabled on other pages by default to avoid conflicts and losing data e.g. if you fill out a form in this moment. The list of pages containing auto refresh are:
+
Auto refresh is only shown on some pages. It is disabled on other pages by default to avoid conflicts and losing data when editing forms. The pages where it is allowed are:
  
* '''Tactical View'''
+
* '''Tactical view'''
* '''Group View'''
+
* '''Group detail'''
* '''Agent Detail'''
+
* '''Agent detail'''
* '''Alert Detail'''
+
* '''Alert detail'''
* '''Monitor Detail'''
+
* '''Monitor detail'''
* '''Service View'''
+
* '''Service view'''
 
* '''Dashboard'''
 
* '''Dashboard'''
* '''View Events'''
+
* '''Event view'''
* '''SNMP Console'''  
+
* '''SNMP trap console'''  
* '''Network Map'''
+
* '''Network map'''
 +
* '''Cluster view'''
 +
* '''Graph view'''
 +
* '''Visual consoles'''
  
 
<br><br>
 
<br><br>
  
The search bar allows you to look for entries in maps, reports, graphs, alerts, users and agents. It shows a  summary of what has been found. The information is arranged in tabs for each kind of data, the agent tab is selected in advance:
+
The search bar allows you to look for entries in maps, reports, graphs, alerts, users, agents and policies. It shows a  summary of what has been found. The information is arranged in tabs for each kind of data, the agent tab is selected in advance:
  
 
<br><br>
 
<br><br>
 
<center>
 
<center>
[[image:Searchbar_agent.png|center|800px]]
+
[[image:newsearch2.JPG|center|800px]]
 
</center>
 
</center>
 
<br><br>
 
<br><br>
  
The direct link to events is the same as the one shwn by  the Operation menu. This shows events which occur in the system and allows their management if there are sufficient permissions to do that. The event management will be explained in the chapter "Management of the application".
+
The direct link to events is the same as the one shown by  the Operation menu. This shows events that take place in the system and allows their management if there are enough permissions to do it. Event management will be explained in the chapter "Application management".
  
 
== Icons within the Pandora FMS Interface ==
 
== Icons within the Pandora FMS Interface ==
  
In Pandora FMS, there are several text-side icons, which include other icons. We're going to explain the most important ones in this section.
+
In Pandora FMS, there are several text-side icons, which include other icons. Here you have the most important ones explained.
  
 
=== Contextual Help Icon ===
 
=== Contextual Help Icon ===
  
The Contextual Help Icon gives you general help on the field it comes with or in the application form or page where it is located. It opens a pop up window (you're required to have pop-up windows activated in your browser). It provides all information you might require. You're required to click on the icon to display this kind of help.
+
The Contextual Help Icon gives you general help on the field it comes with or in the application form or page where it is located. It opens a pop up window (pop-up windows must be enabled in your browser) and provides full help.
 
 
It's a round-shaped icon in form of an interrogation mark on green background.
 
  
 
<center>
 
<center>
Line 212: Line 218:
 
=== Suggestion / Advice Icon ===
 
=== Suggestion / Advice Icon ===
  
The suggestion and advice icon provide you with some help on the field it comes with. It's shown by moving your cursor over it.
+
The suggestion and advice icon provide you with some help on the field it comes with. It is shown by moving the cursor over it.
  
 
<br><br>
 
<br><br>
Line 222: Line 228:
 
=== Management Icon ===
 
=== Management Icon ===
  
The management icon comes with some lines in some tables. It represents a direct link to the element's configuration. To have access to the linked page, you just have to click on it.
+
The management icon comes with some lines in some tables. It represents a direct link to the element's configuration. To have access to the linked page, click on it.
  
 
<br><br>
 
<br><br>
Line 242: Line 248:
 
=== Magic Wand Icon (Wizard) ===
 
=== Magic Wand Icon (Wizard) ===
  
The magic wand icon indicates that the functionality will be useful to easily apply (via an assistant) to a large number of items an action.
+
The magic wand icon indicates that this feature will be useful to easily apply (via an assistant) to a large number of items an action.
  
 
<br><br>
 
<br><br>
Line 260: Line 266:
 
<br><br>
 
<br><br>
  
=== Update Icon (forced Version) ===
+
=== Force Action Icon ===
  
Pandora FMS remote checking has an update interval - but this could be forced by clicking on a button.  
+
Pandora FMS remote checking has an update interval, but this could be forced by clicking on the button.  
 
<br><br>
 
<br><br>
 
<center>
 
<center>
Line 271: Line 277:
 
=== Refresh Icon (after a forced-update Action) ===
 
=== Refresh Icon (after a forced-update Action) ===
  
Once the force update icon has been clicked, it's appearance changes to show that it's been activated.
+
Once the force update icon has been clicked, it changes to show that it has been activated.
  
 
<center>
 
<center>
Line 277: Line 283:
 
</center>
 
</center>
  
It returns to its usual appearance once the checking has been updated.
+
It returns to its usual state once the checking has been updated.
  
 
=== Alternative Texts on Icons and Images when hovering the Mouse over it ===
 
=== Alternative Texts on Icons and Images when hovering the Mouse over it ===
  
Almost all Pandora FMS images have an alternative text which is shown when you're hovering with the mouse pointer over it. You can obtain alternative textual information as well as the information the images are able to offer in this way.
+
Almost all Pandora FMS images have an alternative text which is shown when hovering over it with the mouse pointer. You can obtain alternative textual information as well as the image information.
  
 
<center>
 
<center>
Line 289: Line 295:
 
== Server management ==
 
== Server management ==
  
The detailed view of the servers is used to know, besides the general status of the Pandora FMS servers, their load level and delay in the executions.
+
Server detailed view is used to know, besides the general status of the Pandora FMS servers, their load level and execution delay.
  
 
Some icons have special relevance, as you can see in the screenshot above:  
 
Some icons have special relevance, as you can see in the screenshot above:  
 
   
 
   
* Poll request Requests the remote test server to execute all the checks it has, forcing it to execute them again. Valid for all network servers, e.g. Network server, WMI server, Plugin server, WEB Server, etc.   
+
* Poll request: It requests the remote test server to execute all the checks it has, forcing it to execute them again. Valid for all network servers, e.g. Network server, WMI server, Plugin server, WEB Server, etc.   
 
* Edit recon server tasks.   
 
* Edit recon server tasks.   
* Edit remote server configuration. Valid for pandora or satellite server servers.  
+
* Edit remote server configuration: Valid for Pandora FMS or Satellite server servers.  
  
In this view we can see different informationin each column:   
+
In this view, you may see different information on each column:   
  
 
* '''Server name:''' Generally the hostname of the machine is used.   
 
* '''Server name:''' Generally the hostname of the machine is used.   
 
* '''Status:''' (green = active, gray = stopped or down).
 
* '''Status:''' (green = active, gray = stopped or down).
* '''Type of server:''' Data server, network server, etc.   
+
* '''Server type:''' Data server, network server, etc.   
* '''Version:''' Shows the current version of our Pandora FMS server.   
+
* '''Version:''' It shows the current version of Pandora FMS server.   
* '''Modules:''' Number of modules of this type executed by the server with respect to the total number of modules of this type.   
+
* '''Modules:''' Number of modules of this type executed by the server regarding the total number of modules of this type.   
* '''Server Lag / Delayed Modules:''' Highest time that the oldest module is waiting to receive data / Number of modules that are out of their life time. This indicator is used to know if we have too many modules and to know if the server is at the limit of its load capacity. Delayed modules indicates the number of modules that have not reported to the server.   
+
* '''Server Lag / Delayed Modules:''' Highest time that the oldest module is waiting to receive data / Number of modules that are out of their life time. This indicator is used to know if there are too many modules and to know if the server is at the limit of its load capacity. Delayed modules indicates the number of modules that have not reported to the server.   
* '''T/Q (Current threads/queued modules currently):''' Shows the number of threads currently active on each server. Total number of modules in queue waiting to be attended. These parameters reflect status of excessive load. There should almost never be modules queued, this reflects the inability of the server to process the data.   
+
* '''T/Q (Current threads/queued modules currently):''' It shows the number of threads currently active on each server. Total number of modules in queue waiting to be attended. These parameters reflect status of excessive load. There should almost never be modules queued, this reflects the inability of the server to process data.   
* '''Data update:''' Each server has a Keepalive that updates its status, to make sure it is active, also updating its statistics.
+
* '''Data update:''' Each server has a "Keepalive" that updates its status, to make sure it is active, also updating its statistics.
  
 +
== Status and possible values of agents, modules and groups ==
  
== Status and possible values of Agents, Modules and Groups ==
+
Agents contain modules with the different checks that are carried out. Their status could be:
  
If an agent has any data to show, this data could be in several status:
+
* '''OK:''' Green.
 
+
* '''Warning / Notice:''' Yellow.
* '''OK:''' Green
+
* '''Critical:''' Red.
* '''Warning / Notice:''' Yellow
 
* '''Critical:''' Red
 
 
* '''Unknown:''' Grey.  
 
* '''Unknown:''' Grey.  
* '''Not started:''' They can't be seen. They only appear in blue in the management view.
+
* '''Not started:''' They cannot be seen. They only appear in blue in the management view.
  
This would be the data view of one agent which are called 'Modules' in Pandora FMS. It shows the module name, its status (in a colored box) and its numeric or alphanumeric value.
+
This would be the data view of one agent, which are called 'Modules' in Pandora FMS. It shows the module name, its status (in a colored box) and its numeric or alphanumeric value.
  
 
<br>
 
<br>
Line 334: Line 339:
 
[[image:If5.JPG|center|850px]]
 
[[image:If5.JPG|center|850px]]
 
</center>
 
</center>
<center>''Agents view''</center>
+
<center>''Agent view''</center>
 
<br>
 
<br>
  
In this view, the agent called 'Database Server' has one configured module and one module in 'critical' state. Having an agent with at least one module in 'critical' state is displayed as a red box.  
+
IAgents will portrait in their status the worst situation of its modules, so it there is only one in critical state, the agent will be red.  
 
<br>
 
<br>
 
<br>
 
<br>
 
'''Group View'''
 
'''Group View'''
  
As before, the group view summarizes the status of all agents for each group.
+
As before, the group view summarizes the status of all agents. A group could have one of the following states:
 
 
In this group view, we can see the following status:
 
  
* '''OK:''' All agents are working appropriately (green).
+
* '''OK:''' All agents are working properly (green).
 
* '''Warning / Notice:''' At least one agent of this group is in a 'warning' status (yellow).
 
* '''Warning / Notice:''' At least one agent of this group is in a 'warning' status (yellow).
 
* '''Critical:''' At least one agent is in a 'critical' status (red).
 
* '''Critical:''' At least one agent is in a 'critical' status (red).
* '''Unknown:''' All agents of this group have an 'unknown' status (grey).
+
* '''Unknown:''' All agents of this group are in 'unknown' status (grey).
* '''Without Modules:''' When the agents of a group don't have modules or if they are not initialized (white).
+
* '''Without Modules:''' When the agents of a group do not have modules or if they are not initialized (white).
  
 
'''Module View'''
 
'''Module View'''
Line 358: Line 361:
 
This view is very useful for comparing module information from different agents thanks to its filtering options.
 
This view is very useful for comparing module information from different agents thanks to its filtering options.
  
== The Widget's Auto-complete Agent ==
+
== The widget's auto-complete agent ==
 
On some pages under Pandora FMS, you may see something like this:
 
On some pages under Pandora FMS, you may see something like this:
  
Line 365: Line 368:
 
</center>
 
</center>
  
This widget starts searching as you are typing and displays the agents which correspond to the characters you've typed in. The color coding of the results are:
+
This widget starts searching as you are typing and displays the agents which correspond to the characters you typed in. The color coding of the results are:
 
* '''First block in green''': The agents matching by name.
 
* '''First block in green''': The agents matching by name.
 
* '''Second block in yellow''': The agents matching by description.
 
* '''Second block in yellow''': The agents matching by description.
Line 371: Line 374:
  
  
{{Tip|Please keep in mind that the widget starts working after you've typed at least two characters.}}
+
{{Tip|Bear in mind that the widget starts working after you have typed at least two characters.}}
  
== Network interfaces table ==
+
== Network interface table ==
  
 
This table can appear in places such as an agent overview, the detail view of an agent in the tree view, certain report types, etc. As its name indicates, it displays information about the network interfaces of a given agent.
 
This table can appear in places such as an agent overview, the detail view of an agent in the tree view, certain report types, etc. As its name indicates, it displays information about the network interfaces of a given agent.
Line 381: Line 384:
 
</center>
 
</center>
  
There are some ways to show the table:
+
There are some ways this table might be shown:
 
* '''Recon script''': [[Pandora:Documentation en:Recon Server#SNMP L2 Recon Script|More information]]. This script will create agents and modules prepared to properly show the information in case of being network interface modules.
 
* '''Recon script''': [[Pandora:Documentation en:Recon Server#SNMP L2 Recon Script|More information]]. This script will create agents and modules prepared to properly show the information in case of being network interface modules.
  
* '''SNMP interfaces wizard''': Through a simple setup, this assistant, which is located in the agent's setup view, will show the found interfaces and the only thing to do is choose the modules to be created. The module '''ifOperStatus''' is required to see the interface in the table. To view the input and output traffic graph, the modules '''ifInOctets''' and '''ifOutOctets''' are also required.
+
* '''SNMP interfaces wizard''': Through a simple setup, this assistant, which is located in the agent's setup view, will show the found interfaces and the only thing left to do is choosing the modules to be created. The module '''ifOperStatus''' is required to see the interface in the table. To view the input and output traffic graph, the modules '''ifInOctets''' and '''ifOutOctets''' are also required.
  
* '''Manual creation''': To display the interface on the table, a module should be created following certain naming conventions. This module should be called '''''<interface name>''_ifOperStatus''' and should be of one of these types: ''remote_snmp_proc'', ''remote_icmp_proc'', ''remote_tcp_proc'', ''generic_proc''. It's recommended to use the ''remote_snmp_proc'' type and attack to the ''ifOperStatus'' ''OID'' of the interface (.1.3.6.1.2.1.2.2.1.8.<index>) to get its real status. To view the input and output traffic graph, two modules of ''remote_snmp_inc'' type and called '''''<interface name>''_ifInOctects_''' and '''''<interface name>''_ifOutOctets_''' should be created. These modules should attack the ''OID'' .1.3.6.1.2.1.2.2.1.10.<index> and .1.3.6.1.2.1.2.2.1.16.<index>, respectively. To show the IP and the MAC of the interface on the table, it's necessary to add this data to the above mentioned ''ifOperStatus'' module's description .
+
* '''Manual creation''': To display the interface on the table, a module should be created following certain naming conventions. This module should be called '''''<interface name>''_ifOperStatus''' and should be of one of these types: ''remote_snmp_proc'', ''remote_icmp_proc'', ''remote_tcp_proc'', ''generic_proc''. It is recommended to use the ''remote_snmp_proc'' type and attack the ''ifOperStatus'' ''OID'' of the interface (.1.3.6.1.2.1.2.2.1.8.<index>) to get its real status. To view the input and output traffic graph, two modules of ''remote_snmp_inc'' type and called '''''<interface name>''_ifInOctects_''' and '''''<interface name>''_ifOutOctets_''' should be created. These modules should attack the ''OID'' .1.3.6.1.2.1.2.2.1.10.<index> and .1.3.6.1.2.1.2.2.1.16.<index>, respectively. To show the IP and the MAC of the interface on the table, it is necessary to add this data to the above mentioned ''ifOperStatus'' module's description.
  
 
[[Pandora:Documentation_en|Go back to Pandora FMS Documentation Index]]
 
[[Pandora:Documentation_en|Go back to Pandora FMS Documentation Index]]

Latest revision as of 10:35, 27 October 2020

Go back to Pandora FMS documentation index


1 Pandora FMS Interface

1.1 Introduction

This section shows Pandora FMS Interface basic menus along with all icons and features required to start learning how to use Pandora FMS.

1.2 Pandora FMS login screen

On the image below, you may see the default Pandora FMS login screen:



If1.JPG

At the bottom of the screen, there is the version of Pandora FMS currently used.

There are text entry boxes at the center to enter the username and password with the button to log in.

Enter the login credentials to start. The default ones are:

  • User: admin
  • Password: pandora

The console displays the default Pandora FMS main welcome page. Pandora FMS login screens can be customized. This will be explained in the Custom welcome screen section.

1.3 Pandora FMS main page

The Pandora FMS default main page shows basic and general information about the status of the systems and the number and type of checks that Pandora FMS performs.

This default screen of Pandora FMS and its elements looks like this:



If2.JPG




The static elements, which do not change in different screens of the interface are:

  • Operation menu
  • Administration menu
  • Defined links
  • Headers

The dynamic elements which do change in different screens are:

  • Header information
    • User information, pending messages, system notifications, etc. (this will be explained in the header sub-section below).
  • Site news
  • Web console's last activity
  • General basic information
  • Pandora FMS Overview:
    • Server health: Server general status.
    • Monitor health: Monitor general status.
    • Module sanity: General status of the modules that collect data, compared to the non-started ones.
    • Alert level: Alert general status.

This is the default home page, but the user can customize it.

1.3.1 Pandora FMS Customized Page

In the Workspace-> Edit my user view you can choose the Pandora FMS home screen.




If3.JPG


Note: Shortcut bar feature is implemented from Pandora FMS 5.0 onwards

Available Options:

  • Default: Pandora FMS main page as shown above by default.
  • Dashboard: You may choose a user dashboard.
  • Visual Console: You can pick the user's visual console.
  • Event List
  • Group View
  • Tactical View
  • Alert Detail
  • Other: Users are able to customize their home page by entering the url. An example would be 'sec=estado&sec2=operation/agentes/estado_agente' to show a detailed agent view.

1.3.2 The operation menu

The operation menu allows you to view all checking done by Pandora FMS agents, visual maps, network maps, inventory, see and manage the incidents (if you have the according permissions), see the SNMP console, see the messages and use the extensions.

Menuope.jpg

From the Operation menu down to any submenu, there could be other elements that will be displayed.

Each of these elements links to other pages containing information and all of them will be explained in the chapters dealing with operation in Pandora FMS in more detail.

1.3.3 The administration menu

The administration menu allows you to view and manage the checks carried out by Pandora FMS agents, the modules and components of said checks, the alerts that these modules and agents can launch and how these alerts work, the existing policies, the users, the user profiles, the Pandora FMS servers and their assigned tasks, the system audit log, the general performance of Pandora FMS web console, the database maintenance and console's extentions.



Extension.jpg



There could be other elements which will be displayed when selecting menus in any Administration drop-down submenu.

Each of these elements provides another page with information. All of them will be explained in detail in the chapters of operation and management with Pandora FMS.

1.3.4 Links menu

The links menu simply displays a link to preconfigured sites. These can be added, modified and deleted from the Pandora FMS Administration menu. These links allow you to link Pandora FMS with other WEB applications of your organization and make Pandora FMS a central management point.

Enlaces.jpg

1.3.5 The Header

Pandora FMS header offers several quick links or direct access to important features of the system and a search bar:



If4.JPG



From left to right, the header provides the following:

  • The search bar which allows to run a search in several elements: agents, reports, alerts, maps, combined graphs, users and / or policies in Pandora FMS database.
  • The auto-refresh button which, apart from updating the screen, can be configured to auto-refresh in a certain time interval. This allows you to configure it to be refreshed every X time on any page. By doing this, the session or the information in it will not get lost. It also displays the updated data.
  • If there are pending system notifications, an alert icon will be displayed and by clicking on it, a modal window with the current alerts will be displayed.
  • A link to the system status, which shows Pandora FMS server status.
  • A link to the general support of Pandora FMS.
  • A link to the general contextual help content of Pandora FMS.
  • A button to log out.



System advises.jpeg



  • If the user has messages yet to read, a letter icon will be shown. If you click on it, a modal window with the current messages will appear.

The link to the system status also alerts you when a service is down, changing icon:



Servers.jpg



By clicking on the link, it takes you directly to the server status, reporting different details about them:



Config.jpg



In the user editing section, you may configure the auto-refresh for certain sections. If enabled in this section, the auto refresh button allows you to update the page by clicking on it, or select an update frequency:



Autorefresh select time pandora v5.png



Once this has been activated, the remaining time until the next update will be shown next to the link name:

Autorefresh count down pandora v5.png

Auto refresh is only shown on some pages. It is disabled on other pages by default to avoid conflicts and losing data when editing forms. The pages where it is allowed are:

  • Tactical view
  • Group detail
  • Agent detail
  • Alert detail
  • Monitor detail
  • Service view
  • Dashboard
  • Event view
  • SNMP trap console
  • Network map
  • Cluster view
  • Graph view
  • Visual consoles



The search bar allows you to look for entries in maps, reports, graphs, alerts, users, agents and policies. It shows a summary of what has been found. The information is arranged in tabs for each kind of data, the agent tab is selected in advance:



Newsearch2.JPG



The direct link to events is the same as the one shown by the Operation menu. This shows events that take place in the system and allows their management if there are enough permissions to do it. Event management will be explained in the chapter "Application management".

1.4 Icons within the Pandora FMS Interface

In Pandora FMS, there are several text-side icons, which include other icons. Here you have the most important ones explained.

1.4.1 Contextual Help Icon

The Contextual Help Icon gives you general help on the field it comes with or in the application form or page where it is located. It opens a pop up window (pop-up windows must be enabled in your browser) and provides full help.

Icono.jpg

1.4.2 Suggestion / Advice Icon

The suggestion and advice icon provide you with some help on the field it comes with. It is shown by moving the cursor over it.



Estrella.jpg



1.4.3 Management Icon

The management icon comes with some lines in some tables. It represents a direct link to the element's configuration. To have access to the linked page, click on it.



Mango.jpg



1.4.4 Full Screen Icon

It is present in mainly visual sections to display information in full-screen mode by hiding the menus.



Flecha.jpg



1.4.5 Magic Wand Icon (Wizard)

The magic wand icon indicates that this feature will be useful to easily apply (via an assistant) to a large number of items an action.



Magica.jpg



1.4.6 Remote Configuration Edit Icon

It is used to remotely edit the configuration file of the software agents:



Oso.jpg



1.4.7 Force Action Icon

Pandora FMS remote checking has an update interval, but this could be forced by clicking on the button.

Force.JPG



1.4.8 Refresh Icon (after a forced-update Action)

Once the force update icon has been clicked, it changes to show that it has been activated.

Toner.jpg

It returns to its usual state once the checking has been updated.

1.4.9 Alternative Texts on Icons and Images when hovering the Mouse over it

Almost all Pandora FMS images have an alternative text which is shown when hovering over it with the mouse pointer. You can obtain alternative textual information as well as the image information.

Raton.jpg

1.5 Server management

Server detailed view is used to know, besides the general status of the Pandora FMS servers, their load level and execution delay.

Some icons have special relevance, as you can see in the screenshot above:

  • Poll request: It requests the remote test server to execute all the checks it has, forcing it to execute them again. Valid for all network servers, e.g. Network server, WMI server, Plugin server, WEB Server, etc.
  • Edit recon server tasks.
  • Edit remote server configuration: Valid for Pandora FMS or Satellite server servers.

In this view, you may see different information on each column:

  • Server name: Generally the hostname of the machine is used.
  • Status: (green = active, gray = stopped or down).
  • Server type: Data server, network server, etc.
  • Version: It shows the current version of Pandora FMS server.
  • Modules: Number of modules of this type executed by the server regarding the total number of modules of this type.
  • Server Lag / Delayed Modules: Highest time that the oldest module is waiting to receive data / Number of modules that are out of their life time. This indicator is used to know if there are too many modules and to know if the server is at the limit of its load capacity. Delayed modules indicates the number of modules that have not reported to the server.
  • T/Q (Current threads/queued modules currently): It shows the number of threads currently active on each server. Total number of modules in queue waiting to be attended. These parameters reflect status of excessive load. There should almost never be modules queued, this reflects the inability of the server to process data.
  • Data update: Each server has a "Keepalive" that updates its status, to make sure it is active, also updating its statistics.

1.6 Status and possible values of agents, modules and groups

Agents contain modules with the different checks that are carried out. Their status could be:

  • OK: Green.
  • Warning / Notice: Yellow.
  • Critical: Red.
  • Unknown: Grey.
  • Not started: They cannot be seen. They only appear in blue in the management view.

This would be the data view of one agent, which are called 'Modules' in Pandora FMS. It shows the module name, its status (in a colored box) and its numeric or alphanumeric value.


Modulos descr.jpg
Agent's data view


There is also the detailed agent view. This view quickly summarizes the agent's overall status and the summarized status of the modules. We can see several agents in different states in this view:


If5.JPG
Agent view


IAgents will portrait in their status the worst situation of its modules, so it there is only one in critical state, the agent will be red.

Group View

As before, the group view summarizes the status of all agents. A group could have one of the following states:

  • OK: All agents are working properly (green).
  • Warning / Notice: At least one agent of this group is in a 'warning' status (yellow).
  • Critical: At least one agent is in a 'critical' status (red).
  • Unknown: All agents of this group are in 'unknown' status (grey).
  • Without Modules: When the agents of a group do not have modules or if they are not initialized (white).

Module View

This view provides a list which contains all modules of all agents. The list shows the status of all modules using the same color coding as described above.

This view is very useful for comparing module information from different agents thanks to its filtering options.

1.7 The widget's auto-complete agent

On some pages under Pandora FMS, you may see something like this:

Agent autocomplete.png

This widget starts searching as you are typing and displays the agents which correspond to the characters you typed in. The color coding of the results are:

  • First block in green: The agents matching by name.
  • Second block in yellow: The agents matching by description.
  • Third block in purple: The agents matching by address.


Info.png

Bear in mind that the widget starts working after you have typed at least two characters.

 


1.8 Network interface table

This table can appear in places such as an agent overview, the detail view of an agent in the tree view, certain report types, etc. As its name indicates, it displays information about the network interfaces of a given agent.

Snmp-interface-table.png

There are some ways this table might be shown:

  • Recon script: More information. This script will create agents and modules prepared to properly show the information in case of being network interface modules.
  • SNMP interfaces wizard: Through a simple setup, this assistant, which is located in the agent's setup view, will show the found interfaces and the only thing left to do is choosing the modules to be created. The module ifOperStatus is required to see the interface in the table. To view the input and output traffic graph, the modules ifInOctets and ifOutOctets are also required.
  • Manual creation: To display the interface on the table, a module should be created following certain naming conventions. This module should be called <interface name>_ifOperStatus and should be of one of these types: remote_snmp_proc, remote_icmp_proc, remote_tcp_proc, generic_proc. It is recommended to use the remote_snmp_proc type and attack the ifOperStatus OID of the interface (.1.3.6.1.2.1.2.2.1.8.<index>) to get its real status. To view the input and output traffic graph, two modules of remote_snmp_inc type and called <interface name>_ifInOctects_ and <interface name>_ifOutOctets_ should be created. These modules should attack the OID .1.3.6.1.2.1.2.2.1.10.<index> and .1.3.6.1.2.1.2.2.1.16.<index>, respectively. To show the IP and the MAC of the interface on the table, it is necessary to add this data to the above mentioned ifOperStatus module's description.

Go back to Pandora FMS Documentation Index