Difference between revisions of "Pandora: Documentation en: Interface"
(→Pandora FMS Customized Page)
|Line 59:||Line 59:|
=== Pandora FMS Customized Page ===
=== Pandora FMS Customized Page ===
In the -> Edit my user view you can choose the Pandora home screen.
Revision as of 09:17, 24 June 2019
- 1 The Pandora FMS Interface
- 1.1 Introduction
- 1.2 Pandora FMS Start Session Screen
- 1.3 Pandora FMS Main Page
- 1.4 Icons within the Pandora FMS Interface
- 1.4.1 Contextual Help Icon
- 1.4.2 Suggestion / Advice Icon
- 1.4.3 Management Icon
- 1.4.4 Full Screen Icon
- 1.4.5 Magic Wand Icon (Wizard)
- 1.4.6 Remote Configuration Edit Icon
- 1.4.7 Update Icon (forced Version)
- 1.4.8 Refresh Icon (after a forced-update Action)
- 1.4.9 Alternative Texts on Icons and Images when hovering the Mouse over it
- 1.5 Server management
- 1.6 Status and possible values of Agents, Modules and Groups
- 1.7 The Widget's Auto-complete Agent
- 1.8 Network interfaces table
1 The Pandora FMS Interface
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, we see the default Pandora FMS start session screen:
At the bottom of the screen, we can see the version of Pandora FMS we're currently using.
There are text entry boxes in the center to enter the username and password with the button to start the session (login).
Introduce credentials to start. The defaults are:
- User: admin
- 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.
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:
The static elements which do not change in different screens of the interface are:
- Operation Menu
- Administration Menu
- Defined Links
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 subsection below).
- Site news
- Last activity of the Web Console
- General basic information
- Checking main view in Pandora FMS
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 home screen.
Note: Shortcut bar functionality is implemented from Pandora FMS 5.0 onwards
- Default: Pandora FMS main page as 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 a detailed agent view.
1.3.2 The Operation Menu
The Operation menu allows you to view all checking done by Pandora FMS agents, the visual maps, network maps, server status, inventory, see and manage the incidents (if you have permissions), see the users, see the SNMP console, see the messages and use the extensions.
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.
1.3.3 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 SNMP console, the reports, the user profiles, the Pandora FMS servers and their assigned tasks, the system audit log, the general behavior of the Pandora FMS web console.
There could be other elements which will be displayed when selecting menus in any submenu down from Administration.
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.
1.3.5 The Header
The Pandora FMS header offers several quick links or direct access to important features of the system and a search bar:
From left to right, the header provides the following:
- A link to the system status which shows the Pandora FMS server status.
- 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 clicking on it will display a modal window with the current alerts.
- A link to the general contextual help content of Pandora FMS.
- 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:
By clicking on the link, it takes you directly to the server status, reporting various details about them:
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:
Once this has been activated, the remaining time until the next update will be shown next to the link name:
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:
- Tactical View
- Group View
- Agent Detail
- Alert Detail
- Monitor Detail
- Service View
- View Events
- SNMP Console
- Network Map
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 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".
1.4 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.
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 (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.
1.4.2 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.
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, you just have to click on it.
1.4.4 Full Screen Icon
It is present in mainly visual sections to display information in full-screen mode by hiding the menus.
1.4.5 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.
1.4.6 Remote Configuration Edit Icon
It is used to remotely edit the configuration file of the software agents:
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.
1.4.8 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.
It returns to its 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 can obtain alternative textual information as well as the information the images are able to offer in this way.
1.5 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.
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.
- Edit recon server tasks.
- Edit remote server configuration. Valid for pandora or satellite server servers.
In this view we can see different informationin each column:
- Server name: Generally the hostname of the machine is used.
- Status: (green = active, gray = stopped or down).
- Type of server: Data server, network server, etc.
- Version: Shows the current version of our 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.
- 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.
- 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.
- 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
If an agent has any data to show, this data could be in several status:
- OK: Green
- Warning / Notice: Yellow
- Critical: Red
- Unknown: Grey.
- Not started: They can't 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.
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:
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.
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).
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:
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:
- 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.
1.8 Network interfaces 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.
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 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.
- 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 (.184.108.40.206.220.127.116.11.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 .18.104.22.168.22.214.171.124.1.10.<index> and .126.96.36.199.188.8.131.52.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 .