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

From Pandora FMS Wiki
Jump to: navigation, search
(The Pandora FMS Interface)
(Network interfaces table)
Line 411: Line 411:
 
* '''SNMP interfaces wizard''': Through a simple setup, this assistant, which is located into the agent's setup view, will show the found interfaces and the only thing to do will be 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''' also will be required.
 
* '''SNMP interfaces wizard''': Through a simple setup, this assistant, which is located into the agent's setup view, will show the found interfaces and the only thing to do will be 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''' also will be required.
  
* '''Manual creation''': To display the interface into the table, a module should be created following certain naming conventions. This module should be called '''ifOperStatus_''<interface name>''''' and should be of one of this types: ''remote_snmp_proc'', ''remote_icmp_proc'', ''remote_tcp_proc'', ''generic_proc''. It's recommended the use of 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 '''ifInOctects_''<interface name>''''' and '''ifOutOctets_''<interface name>''''' should be created. This 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 into the table, it's necessary to add this data to the ''ifOperStatus'' module's description.
+
* '''Manual creation''': To display the interface into 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 this types: ''remote_snmp_proc'', ''remote_icmp_proc'', ''remote_tcp_proc'', ''generic_proc''. It's recommended the use of 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. This 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 into the table, it's necessary to add this data to the ''ifOperStatus'' module's description.
  
 
[[Pandora:Documentation_en|Go back to Pandora FMS Documentation Index]]
 
[[Pandora:Documentation_en|Go back to Pandora FMS Documentation Index]]

Revision as of 11:26, 1 March 2017

Go back to Pandora FMS documentation index

1 The Pandora FMS Interface

1.1 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.

1.2 Pandora FMS Start Session Screen

On the image below, you see the Pandora FMS start session screen which is shown by default:


Interfaz1.jpg


On the bottom of the screen, you can see the version of Pandora FMS you're currently using.

There are text entry boxes in the center to enter the user's name and password with the session start button (login).

Once the right credentials to start are introduced. The defaults are:

  • User: admin
  • Password: pandora

In a predefined way, the console will show the Pandora FMS main welcome page. Pandora FMS start session screens can be customized. This will be explained in the Customized welcome screen section.

1.3 Pandora FMS Main Page

The Pandora FMS main page shows basic information about the system state and the number of checks it does.

The Pandora FMS main screen is shown here:



Pagipal.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 subsection header below).
  • Site news
  • Last activity of the Web Console
  • General basic information
  • Checking main view in Pandora FMS

1.3.1 Pandora FMS Customized Page

The Pandora FMS main page can be personalized under 'Operation' -> 'Workspace' and 'Edit my user'.



Home screen.jpg


Note: Shortcut bar functionality is implemented in Pandora 5.0

Available Options:

  • Default: Pandora FMS main page as it is shown by default.
  • Dashboard: You can 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. It's going to display the default view by default. Example: Select 'Other' and type 'sec=estado&sec2=operation/agentes/estado_agente' to show agent's detailed view.

1.3.2 The Operation Menu

The Operation menu allows you to visualize all checking done by Pandora FMS agents, the visual maps, network maps, server state, inventory, see and manage the incidents (if you have sufficient permissions), see the users, 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 which are going to be displayed by selecting the menu:



Image2.jpg



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.

1.3.3 The Administration Menu

The Administration Menu allows users to see and manage the monitoring that Pandora FMS agents execute. It also allows to visualize the modules and components of these checks, the alerts that these modules and agents can throw and how these alerts work, the existing policies, users, SNMP console, reports, user profiles, the Pandora FMS servers and their assigned tasks, the system audit register, the Pandora FMS web console, database maintenance and the console extensions.



Extension.jpg



There could be other elements present which will be displayed when selecting menus in any submenu down from the Administration menu.



Extension2.jpg



All of these elements are links to pages with information. All of them will be explained in 'Operation and Management' in the Pandora FMS chapters in great detail.

1.3.4 Links Menu

The links menu just shows a link to default sites. They can be added, modified or deleted from the Pandora FMS administration menu. These links allow to link Pandora FMS to other WEB applications from its organization and make sure that Pandora FMS becomes a nuclear management point.



Enlaces.jpg



1.3.5 The Headers

The Pandora FMS headers offer several quick links or a direct access to important features of the system and a search bar:



Cabecera.jpg


From left to right, the header provides the following:

  • A link to the system state which shows the Pandora FMS server state.
  • The auto-refresh button which, apart from updating the screen, could be configured to auto-refresh in a determined time interval. This allows you to define e.g. that it will 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 advices, an alert icon will be shown. When you click on it, a modal window will be displayed, containing the current system advices. In the center of this information window, you may find update manager updates, system security problems or value notifications (e.g. the default console password) by default.


System advises.jpeg



  • A link to the general contextual help content of Pandora FMS.
  • A button for closing 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 card will be shown. If you click on it, a modal window with the current messages will appear.
  • The search bar which allows to search in several elements: Agents, reports, alerts, maps, combined graphs and / or users in the Pandora FMS database.


Servers.jpg



By clicking on the link, this goes straight to the server state, informing you about the number of details about them:



Config.jpg


The auto-refresh button allows to update the page by klicking on it. It also allows to 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



The auto refresh is only shown on some of the pages. It's disabled on the rest of pages by default for the reason of avoiding conflicts and losing data e.g. if you fill out a form in this moment. The list of pages containing the auto refresh are:

  • Tactical View
  • Group View
  • Agent Detail
  • Alert Detail
  • Monitor Detail
  • Service View
  • Dashboard
  • View Events
  • SNMP Console
  • Network Map

The search tool allows you to look for entries in maps, reports, graphs, alerts, users and agents. The information is arranged in slides for each kind of data, the agent slide will be selected in a predetermined way:



Searchbar agent.jpg



The direct link to events is the same as the one which the Operation menu shows. 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".

1.4 Icons within the Pandora FMS Interface

In Pandora FMS, there are several icons next to text, which possess other icons by themselves. We're going to explain the most important ones in this section.

1.4.1 Contextual Help Icon

The Contextual Help Icon gives you a general help on the field it comes with or in the application form or page where it is. 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.

It's a round-shaped icon in form of an interrogation mark on green background.




Icono.jpg



1.4.2 Suggestion / Advice Icon

The suggestion and advice icons provide you with some help on the field it comes with. It's shown by clicking on the icon.

The icon is a yellow star.



Estrella.jpg



1.4.3 Management Icon

The management icon comes with some files of 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.



Mango.jpg



1.4.4 Full Screen Icon

It's usually shown next to the title of the pages you're on. It represents the possibility of the page to be shown as full screen. To use this functionality, you may click on the icon.

The icon is a square with four arrows - one in each corner.



Flecha.jpg



1.4.5 Magic Wand Icon (Wizard)

The magic wand icon shows the current functionality to be useful to apply a large amount of items the easy way by a unique action (with the help of an assistant), e.g. there are wizards in the reporting section (Enterprise Version) that allows you to create report items for a large number of modules by one click. In the Visual Console Wizard, it can also be useful to create a lot of items the easy way.

The Magic Wand Icon is shown below.



Magica.jpg



1.4.6 Remote Configuration Edit Icon

There is a configuration option for the Pandora FMS software agents which allows to edit its configuration remotely from the console (in the Enterprise version). This option comes in two different pages: The first one is the agent list and the management of them. You may access it through 'Administration' -> 'Manage Agents':



Oso.jpg


If you click the icon, the 'R' column on the right wants to indicate that the software agent could be configured from the console by remote.

The option is also shown if you try to edit the agent's features, after clicking on the 'edit' button below its name:



Save.jpg



On the following page, the agent details will be shown. Next to the name box, the agent remote configuration edit icon will appear:



Silva.jpg



1.4.7 Update Icon (forced Version)

Pandora FMS remote checking has an update interval - but this could be forced by clicking on a button. If it's forced, the module will be updated. This interval is going to start counting from zero.



Cero.jpg



1.4.8 Refresh Icon (after a forced-update Action)

Once the forced update icon has been clicked, it's appearance changes to show that it's been activated.



Toner.jpg



It returns to his usual appearance 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 you're hovering with the mouse pointer over it. You able to obtain alternative textual information as well as the information the images are able to offer in this way.



Raton.jpg



1.5 Images in Pandora FMS

The images in Pandora FMS can be graphs, generated by the Pandora FMS standard graph engine or Flash graphs, generated by the Flash engine. These can be defined by the administrator in the visual system configuration.

The current graphs (statics) provide less information as they aren't interactive. They don't show any text when hovering over them with the mouse pointer. The flash graphs can't be used in reports.


Rata.jpg

The Flash graphs give this information:


Verde.jpg


Pastel.jpg

In case there isn't any data to show in a graph, Pandora FMS displays an error message in the image:

Pastelito.jpg

1.6 Data missing on Agent's Data Lists

If the agent has no data to show, it displays a warning message instead:



Piña.jpg



The above is an example of an agent without any alerts.

1.7 States and possible values of Agents, Modules and Groups

If an agent has any data to show, this data could be in several states:

  • OK: Green
  • Warning / Notice: Yellow
  • Critical: Red
  • Unknown: Grey, with the information of the last contact in red.
  • Not started: They can't be seen. They only appear in blue in any management views.

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

Data view for one agent



Modulos descr.jpg


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

The agent's view



Agent detail2.png



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 visualized as a red box. The information of the agents as two '1' separated by ':' shows one defined module and one in 'critical' state (in dark red).

The agent called 'My Agent' has two modules in normal state.

The "vanesa-HP-630-Notebook-PC" agent has 20 modules. There are 3 in 'unknown state', represented as a 3 in light gray as it has all elements in 'unknown state'. It's visualized in blue. There are 2 modules in 'critical', 14 in 'normal' and 1 in 'warning' state.

Group View

As before, the group view summarizes the status of all agents for each group.

In this group view, we can see the following status:

  • OK: All agents are working appropriately (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 have an 'unknown' status (grey).
  • Without Modules: When the agents of a group don't 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 all states of all modules along with the same color coding as described above.

This view provides a lot of filtering options and could come in handy when comparing the module information of different agents.

1.8 The Widget's Auto-complete Agent

On some pages under Pandora FMS, you're maybe seeing some pages as this:

Agent autocomplete.png

This widget starts it's 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:

  • 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

Please keep in mind that the widget starts working after you've typed at least two characters.

 


1.9 Network interfaces table

This table can appear in places like the general agent view, the agent detail view of the tree view, certain report types, etc. It shows the information about the network interfaces of a determined agent.

Snmp-interface-table.png

There are some ways to show the table:

  • 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 into the agent's setup view, will show the found interfaces and the only thing to do will be 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 also will be required.
  • Manual creation: To display the interface into 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 this types: remote_snmp_proc, remote_icmp_proc, remote_tcp_proc, generic_proc. It's recommended the use of 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. This 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 into the table, it's necessary to add this data to the ifOperStatus module's description.

Go back to Pandora FMS Documentation Index