Pandora: Documentation en: Interface

From Pandora FMS Wiki
Revision as of 15:53, 14 June 2012 by Slerena (talk | contribs) (States and possible values of agents, modules and groups)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

Go back to Pandora FMS documentation index

1 Pandora FMS Interface

1.1 Introduction

In this section we are going to provide you with the Pandora FMS interface base menus, and also with all icons and required features to start to learn how to use Pandora FMS.

1.2 Pandora FMS start session screen

In the following image the Pandora FMS start session screen that is shown by default:


Interfaz1.jpg


On it the Pandora FMS version number and build is shown in the lower right corner. The build nº can be very useful to identify the date of the console version that is being executed, it translates to (YEARMONTHDAY).

On the right side are the text entry boxes for the user and also their 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 screen 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 that it does.

Next, the Pandora FMS main screen is shown:



Pagipal.jpg


The static elements -that do not change in different screens-of the interface are:

  • Operation menu
  • Administration menu
  • Defined links
  • Header

The dynamic elements-that 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
  • Web console last activity
  • General basic information
  • Checking main view in Pandora FMS

1.3.1 Pandora FMS Customized Page

In Operation -> Edit my user, Pandora FMS main page can be personalized.



Home screen.jpg


Note: Shortcut bar functionality is implemented in Pandora 5.0

Available options:

  • Default. Pandora FMS main page by default.
  • Dashboard. You can choose a user dashboard.
  • Visual console. You can choose a user visual console.
  • Event list.
  • Group view.
  • Tactical view.
  • Alert detail.
  • Other. Users can customize the home page. By default, it will display Default view. Example: Select \'Other\' and type sec=estado&sec2=operation/agentes/estado_agente to show agent detail view.

1.3.2 The Operation Menu

The Operation menu allows to visualize all checking done by Pandora FMS agents, the visual maps, the network maps, the server state, the inventory, see and manage the incidents (if you have enough permissions), see the users, see the SNMP console, see the messages and use the extensions.



Menuope.jpg



In any submenu from the Operation menu could be other elements that will be displayed by selecting the menu:



Image2.jpg



Any of these elements link to other pages with information. All of them will be explained in great detail in the chapters about Operation with Pandora FMS.

1.3.3 The Administration Menu

The Administration menu allows users to see and manage the checking that Pandora FMS agents do. 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, the users. the SNMP console, the reports, the user's profiles, the Pandora FMS servers and their assigned tasks, the system audit register. the Pandora FMS web console, the database maintenance and the console extensions.



Extension.jpg



In any submenu from the Administration menu could be other elements that will be displayed when selecting the menu:



Extension2.jpg



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

1.3.4 Links Menu

The link menu just shows a link to default sites. These could be added, modified or deleted from the Pandora FMS administration menu. These links allow to link Pandora FMS with other WEB applications from its organization and make that Pandora FMS become a nuclear 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 also a search bar:



Cabecera.jpg


From left to right and from top to down, the header gives:

  • The user who is connected. A direct link to his user page( in brackets).
  • If the user has pending messages to read then a card will be shown and when you click it then a modal window with the current messages will be shown.
  • If there are pending system advises an alert icon will be shown, if you click it then a modal window will be displayed with the current system advised. Between this information you can find Update manager updates, system security problems or "by default" values notifications (for example default console password).


System advises.jpeg



  • A button for closing session.
  • Link to contextual general help of Pandora FMS.
  • Link to the system state, that shows the Pandora FMS servers state.
  • The auto-refresh button that apart from updating the screen could be configured to auto-refresh in a chosen time interval. This allows that in any page you could define that it be refreshed every X time, doing this the session does not get lost and it shows the updated data.
  • The search bar that allows to search in several elements: Agents, reports, alerts, maps, combined graphs and/or users in Pandora FMS database.
  • The link to the system event viewer. The link to the system state also notifies when a service is down, changing the icon and showing how many services are down.


Servers.jpg



By Pressing on the link, this goes straight to the servers state, informing of many details about them:



Config.jpg


The auto-refresh button allows to update the page by pressing on it or also selecting an update frequency:



File:Refresco.jpg



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



File:Refresco2.jpg



The search tool allows to look for entries in maps, reports, graphs, alerts, users and agents. The information is shown classified with flaps for each kind of data, the agent flap will be selected in a predetermined way:



Searchbar agent.jpg



The direct link to events is the same as the one that the Operation menu gives. This shows events in the system and allows their management if there are enough permissions. The event management will be explained in the chapter " Management of the application".

1.4 Icons in Pandora FMS Interface

In Pandora FMS there are several icons next to text, with other icons, by themselves. In this section we will explain the most important ones.

1.4.1 Help on line icon

The help on line icon gives 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 should have the pop up windows activated in the browser). It will give you full information. To show this help you have to click on the icon.

The icon is an interrogation mark on blue background and round shape:




Icono.jpg



1.4.2 Suggestion/Advise Icon

The suggestion, advise or contextual help icon gives some help on the field it comes with. This is 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 and it represents a direct link to the element configuration. To have access to the page that it links, you should click it.

The icon is a tool with a yellow handle:



Mango.jpg



1.4.4 Full Screen Icon

It is usually shown next to the title of the pages that has it and it represents the possibility of the page to be shown as full screen. To use this functionality you must 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 that the current functionality will be useful to apply in a easy way (with an assistant) a large amount of items with a unique action. For example, there are wizards in the reporting section (Enterprise version) that allow to create report items for a large number of modules with one click. Also in the Visual console wizard it can be useful to create a lot of items in a easy way.

The magic wand icon is:



Magica.jpg



1.4.6 Remote Configuration Edit Icon

There is a configuration option for the Pandora FMS software agents that 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 in the management of them. You can have access to it through Administration -> Manage agents:



Oso.jpg


The R column shows if you press the icon on it, that the software agent could be configured in a remote way from the console.

The option is also shown if you try to edit the agent features. After pressing on the edit link below its name:



Save.jpg



In the following page, the agent details will be shown, and next to the name box, the agent remote configuration edit icon will appear:



Silva.jpg



1.4.7 Update Icon (forced)

Pandora FMS remote checking has an update interval, but this could be forced by pressing on a button. If it is forced, then the module will be updated, this interval will start to count from zero.



Cero.jpg



1.4.8 Refresh Icon (after a forced update action)

Once the forced update icon has been pressed it will change to show that it has been activated.



Toner.jpg



It will return to his usual state once the checking has been updated.

1.4.9 Alternative Texts in the icons/images when putting the mouse over

Almost all Pandora FMS images have an alternative text that is shown when you put the mouse pointer over them.In this way you could obtain alternative textual information as well as the information that the images offer.



Raton.jpg



1.5 Images in Pandora FMS

The images in Pandora FMS could 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 system visual configuration.

The current graphs(statics) give less information as they aren't interactive and don't show any text under the mouse pointer. The flash graphs can't be used in the reports.


Rata.jpg

But the Flash graphs give this information


Verde.jpg


Pastel.jpg

When there isn't data to show in a graph, Pandora FMS shows an error message in the image:

Pastelito.jpg

1.6 Data missing for agent's data lists

When the agent has no data to show, it gives a warning message:



Piña.jpg



The above is an example of an agent without alerts.

1.7 States and possible values of agents, modules and groups

An agent has data, and this data could be in several states:

  • Right: green color
  • Warning/Notice: yellow color
  • Critical: red color
  • Unknown: grey color, with the information of the last contact in red.
  • Not started: it couldn't be seen. They only appear with blue color in management views.

This would be a data view of one agent, that in Pandora FMS is called modules. In it is shown the module name, its state (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 summarizes in a quick way the agent state " as a whole" and also the summarized state of the modules. In this view we can see several agents in different states:

Agent view



Agent detail2.png



In this view the agent that is called "Artica_Sancho" has a configured module and a module in a critical state. The agent, for having at least one module in a critical state is visualized as a red box. The information of the agents, as two "1" separated by ":" shows a defined module and a module in a critical state ( in dark red).

The "Sauron" agent has 7 modules and the 7 are in "unknown state ", represented as a 7 in light grey color. As it has all elements at "unknown state", it is visualized in purple color.

The "SAP XIQ [QUALITY-2]" agent has 11 defined modules, 9 in state OK, 1 in critical state. For this reason it visualizes "11 : 9 : 1 : 1",in black, green, yellow and red colors, respectively. The agent is visualized with a red box, because there is at least one element (module) in a critical state.

The "SAP_XID [DEVELOPMENT2]" agent, is similar to the one mentioned before, but without any elements in a critical state, so the visualized colour is yellow as it has one element in warning state.

The "global" visualization of the agent state depends on the most critical state of the module group that it contains. It will only be green if there are no elements in a Critical, Warning or Unknown state.

The "SAMSAGAN" agent, for example, has 10 modules and all of them are in correct 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:

  • Right: (green color) All agents are right.
  • Warning/Notice: (yellow color) At least one agent of this group has warning status.
  • Critical: (red color) At least one agent has critical status.
  • Unknown: (grey color) All agents of this group has unknown status.
  • Without modules: (white color) When the agents of the group don't have modules or they are not initialized.

Module view

This view shows list with all modules of all agents. The list shows the modules status with the same colors as above.

This view is very useful to compere information of a module between different agents, and has a lot of filtering options.

Go back to Pandora FMS documentation index