Pandora:Documentation en:Data Presentation/Network Maps
From Pandora FMS Wiki
- 1 Network Map (Open-Source Version)
- 2 The Enterprise Network Console
- 2.1 Mini Map
- 2.2 Control Panel
- 2.3 Holding Area
- 2.4 Detailed View Window
- 2.5 Creating a Network Map
- 2.6 Editing a Network Map
- 2.7 Duplication of a Network Map
- 2.8 Interaction with the Network Map
- 2.8.1 Actions on the Map
- 18.104.22.168 Moving through the Map
- 22.214.171.124 Forcing the Map to Refresh
- 126.96.36.199 Centering the Map
- 188.8.131.52 Editing the Nodes
- 184.108.40.206 Massive Editing of Nodes
- 220.127.116.11 Reviewing the Node's Information
- 18.104.22.168 Creating Agent Nodes
- 22.214.171.124 Creating fictitious Nodes
- 126.96.36.199 Modifying the Zoom Level
- 2.8.1 Actions on the Map
Network Map (Open-Source Version)
There is also an open-source version of the network map. This functionality allows to graphically display the nodes and relationships, agents, modules and groups available to the user. There are three types of network maps:
- Topology Map
- Group Map
- Policy Map
In order to access the network map, please click on 'Topology Maps' -> 'Network Map' and 'Network Map'.
Creating a new network map is really easy. In order to e.g. create a topology map, please follow the below mentioned steps:
Please click on 'Add Map'.
A window like the one shown below is going to appear.
Please click on the green arrow. Subsequently, you're able to modify names, filter by groups, show or hide interfaces, modify the network map's shape, to configure whether names are displayed in overlapping mode or not, to show simple nodes (without images and names), to regenerate the map every time the page is reloaded and to change the font size. Please click on 'update' when you're done.
In order to finish the process, please click on the 'Save Map' button.
All other maps are also created in the same way.
The Topology Map shows the agents according to the network topology. It also shows relationships between father and child nodes. This display mode is very useful in combination with a Recon Script. This combination allows to graphically display the entire network topology. Each agent is going to be colored according to its associated state.
The Group Map shows agents and modules categorized by their group. The filter options pertaining to the group map are the following:
- Filter by agents
- Filter by module groups
- Filter by the network map's shape (e.g. radial, flat, circular)
- Filter by depth (agent or modules),
- Filter by overlapping names
- Filter by whether modules containing alerts are shown or not
- Filter by whether policy modules are hidden or not
- Filter by whether nodes are simple
- Filter by font size
The Policy Map shows agents and modules of policies. It's possible to filter by the agent's group and module groups. It's also possible to modify the network map's shape (radial, flat, circular, etc.), the depth (from agents or modules), whether names are overlapped, whether modules containing alerts are shown and whether the modules are of the simple type or not. It's also possible to determine whether it's desired to regenerate the network map each time the page is reloaded or not and to change the font size.
It's also possible to display the network map in a full-screen mode by clicking on the button shown on the picture below.
The Enterprise Network Console
By using Pandora FMS Enterprise, you have the opportunity of creating editable network maps which are a lot more interactive compared to the ones of the open-source edition. You can find them by clicking on 'Operation' -> 'Network View' and 'Network Map'.
Contrary to the open-source version, the Enterprise Network Map provides you a lot more features, such as:
- Much bigger network maps, capable of monitoring more than a 1000 agents.
- Real-time monitoring of your system's entire network topology.
- Numerous different views of its network topology, either manually defined or automatically generated by using the agent's groups.
- The possibility to link different topology views by means of inserting fictitious points.
- The opportunity to manipulate the current topology within the view:
- The insertion of new nodes, either single or in groups.
- The function of editing the node's features.
- The possibility to organize them within the view along with the node's position and the relationships between them.
It's possible to gain access to the Enterprise Network Map by the menu on the left. Please click on 'Topology Maps' and 'Network Maps'.
The network maps are capable of containing the following:
- Real nodes, which uniquely represent the agents added to the map. These nodes have an icon which represents the agent's operating system and a circle by default. It's also possible to pick another shape. The agent's states are the following:
- Green: It's the 'OK' status.
- Red: At least one module has moved to a 'critical' state.
- Yellow: At least one module has moved to a 'warning' state.
- Orange: Some of the alarms have been fired within the agent.
- Grey: The agent is in 'unknown' state.
- Fictitious Nodes: They either represent a link to other network maps or a sole point on the map intended for personal use. It's able to have any available shape (e.g. circle, rhombus, square) and any text size. If it consists of link to another map, the color follows the below mentioned rules if it can't be customized by the user.
- Green: It's used if any the nodes on the linked map are in 'OK' state.
- Red: It's used if any of the nodes on the linked map are in 'critical' state.
- Yellow: It's used if any of the nodes on the linked map is in 'warning' status and anyone in 'critical' status.
- Orange: It follows just the same rules as the other colors.
- Grey: It's used for the relationship lines between nodes.
Lines link/relationship between the nodes.
The lines link/relationship can be a relationship between the nodes or the network interfaces of this nodes. If there are a relations across the interfaces, the line between the nodes have a arrow end and arrow start with the circle shape, the color of the circle is the status of the network interface and the line have a name of interface.
This mini map provides you with a global view that shows all the map's extensions, but in a smaller view. In contrast to the map's view, all the nodes are shown without their states and relationships to each other, except the Pandora fictitious point which is shown in green. A red box is also shown in the displayed part of the map which indicates your position.
It's in the upper left corner and can be hidden by clicking on the arrow-shaped icon as shown below.
From the Control Panel, you may perform more complex tasks than on the Network Map.
It's hidden on the upper right corner. Same as with the mini map, it can be shown by clicking on the arrow-shaped icon. The available options are the following:
- To change the refresh frequency of the node's state.
- To force a refresh.
- To add the agent by an intelligent control which allows you to quickly search for the agent and add it. The new node is shown on the upper left (coordinates '0,0') on the map.
- To add several agents and filtering them by group, which is going to show the group's agents which aren't in a list of multiple selection on the map yet.
- To produce a screen shot of the map's visible part.
- To add a fictitious point, where you can select the text as name of this point, the size defined by the range, the point shape, color by default, and, if you want that the fictitious point would be a link to a map.
- To search the agent by an intelligent control. Once selected, the map is automatically going display the point on which the agent's node is located.
- To change the network map's zoom level.
The holding area is the place where the new nodes appears, avoid the messy networks with new nodes in your networkmaps and of course you can see the changes and the updates in your monitored system.
The new nodes in the holding area appears only when you choose the refresh holding area in the context menu.
Also the new nodes are filtered by the creation options of networkmap, by example by the group, or network mask or the new agents found by the recon task.
The nodes and the links are dashed the line or the shape.
The nodes into the holding area are in this place until that they are drag and drop out the holding area.
Detailed View Window
The detailed view window is a visual representation of one agent. To open this window, you're required to right click on the node's agent displayed on the map and select 'View Details'. It's going to be refreshed within the same period as the map which is currently open. The windows are completely independent, so you may have several windows opened simultaneously.
- It shows a box which rim will be of the same color as the agent's status.
- The agent's name is a link to the Pandora FMS agent page.
- Within the box, all the modules which aren't in unknown status are going to be displayed, which depends on whether the module's status is green or red.
- It's possible to click on these modules. If you do, they're going to show a tool tip containing the module's main data.
- Within the box rim, the modules of the 'SNMP Proc' type are displayed. They're intended for network interfaces if a network systems-related agent is monitored.
Palette of Fictitious Points
If you select 'See Details' on a fictitious point, it's going to show you a pop-up window, containing a palette of options to modify the fictitious point.
The available options are the following:
- The name of the fictitious point.
- The shape of the fictitious point.
- The map which links to the fictitious point.
Creating a Network Map
If you intend to create a Network Map, you have two options:
- To show all the agents contained in one group.
- The creation of an empty network map.
Now we're going to explain the available fields within the creation form:
- Name: The name of the network map.
- Group: The group for the ACL and the group's map we intend to generate, containing the agents which are members of this group.
- Source: filter of source of the agents how is generated the networkmap or the new nodes are searched for to add into the holding area.
- Size of the network map: It's the location intended to define the network-map's size. The default value is '3000 x 3000' pixels.
- Method for creation of the network map: The method of the node's distribution which is going to generate the network map's layout.
It has a radial shape by default, but there are some additional options to choose from:
- Radial: The displaying method in which all the nodes are going to be arranged around the fictitious node.
- Circular: The displaying method in which the nodes are going to be arranged in concentric circles.
- Flat: The displaying method in which the nodes are going to be arranged in a tree-like shape.
- spring1, spring2: These are variations of the 'flat' arrangement method.
- Network-map Refresh: It's the refresh cycle of the node's status contained within the network map. The default value is '5 minutes'.
The rest of the fields (e.g. 'resizing map') are disabled, because they're unnecessary. Only active nodes are going to be shown within the newly created map anyway.
Source of networkmap
Since the version of Pandora 5.1, the networkmap have diferent filters for to obtain the new nodes (for the holding area) or for to generate a new map.
The filters are:
- Group: the new nodes (in a new networkmap or into the holding area) are the agents that are in the group or children groups of the setted group.
- Recon task: the new nodes (in a new networkmap or into the holding area) are the agents discovered by a setted recon task, the recon task must be a recon task for the networkmap level 2.
- Network mask: the new nodes (in a new networkmap or into the holding area) are the agents that the main IP of these agents pass the the network mask setted.
Editing a Network Map
In order to edit a map, you're required to have ACL permissions of the 'IW' type. You may access the editing form by using the wrench-shaped icon as shown in the image above.
The network map edition form is exactly the same as the one intended for creation, except for two things:
- Generating the Network Map from: You're not going to need it, because the map is already generated.
- Generation Method: Because of the exact same reason stated above, you're not going to need this one either.
However, we have some other active fields:
- Resize of the network map: It's a feature which sends an asynchronous request to the server to analyze the network map already generated and to determine the best way to render the map as small as possible. If there are e.g. any empty parts without nodes within a minimum framing, it's going to reduce the map dimensions to a minimum.
Duplication of a Network Map
You may duplicate a network map along with all its content and configurations from the network map's list by possessing the proper ACL 'IW' permissions. The name of the duplicated network map is going to be 'Copy of [network map's name]' by default. If there is e.g. more than one copy, the name of the network map is going to be 'Copy of [network map's name] [number]'.
Interaction with the Network Map
The network map interaction could be conducted by the following:
- The mouse, accepting actions like drag and drop, double click, left and right mouse button and the mouse wheel.
- By using the keyboard's 'CTRL' keys it's also possible to modify multiple selections.
Actions on the Map
Moving through the Map
- By holding down the left mouse button on an empty area of the map, it's possible to drag the network map to a desired position.
- On the mini map, please hold down the left mouse button to drag the map to the desired position or just click on the zone you intend to visualize.
- Once the agent is introduced, you have a search box within the dashboard. The map automatically moves to the point on which this node's agent is located.
Forcing the Map to Refresh
By clicking on the right mouse button over an empty space, a context menu is shown. Within it, you're able to select the 'Refresh' option which forces the map to refresh the node's status.
Centering the Map
By clicking on an empty link by the left mouse button, a context menu is shown. If you select the option 'Center here' it's going to fix the network map's center on the clicked point. From this moment on, it's going to open this particular map with this point as its new center. If you e.g. don't select any center, the center is going to be the fictitious node by default.
Editing the Nodes
Changing the Position
It's possible to change its position by simply dragging and dropping a map's node to its desired position.
Linking one Node to another
By clicking on a node by the right mouse button, a context menu is going to open. Please select the option 'Select as Child' to link one node to another.
Please start the link operation of one node to another. In order to do this, you're required to click on another node (it's not important whether it's fictitious or not) by the right mouse button which is going to open a context menu which shows the two options named 'Set Parent' and 'Cancel action set parent'.
When you're done, the node is going to be displayed as linked to the other and the node's marks are going to disappear.
If you click on a node by the right mouse button, a context menu will be shown. Please pick the option 'Delete' in order to delete a node.
Changing the Shape of the Status Ring
If you click on a node by the right mouse button, a context menu is going to appear. Subsequently, you're going to see a pop-up list in the shape of the ring. You may pick the appropriate shape of the ring by it.
Deleting Relationships between Nodes
If you click on a node by the right mouse button, a context menu is going to appear. On the bottom of it, you're going to see a relationship list. It's a list of the relationships the node could have. You may delete them pressing on the x-shaped button.
Massive Editing of Nodes
By holding down the 'CTRL' key, a semi-translucent square is going to appear. It enables you to select several nodes simultaneously. Once several of them have been selected, you have the following options:
- By using the left mouse button, you may drag and drop all of them simultaneously.
- By using the right mouse button, a menu containing the following options will become available: Linking to another node by relationship, rendering it into the foreground, deleting, opening the detailed view and changing the way of the status ring - and if it's a fictitious node: Changing the shape of it.
Reviewing the Node's Information
There are two ways of accessing the node's information:
- By double clicking on the node.
- By clicking on a node by the right mouse button, a context menu is going to appear. Please select the option named 'Show details'. This feature is going to show a detailed view of the agent within a pop-up window. If it's a fictitious node, it's going to open a pop up window which displays a palette of options to edit this type of node.
Creating Agent Nodes
You may create agent nodes from the initial load if you select some from the group during map creation. You may add new agent nodes once the map has been created. This operation is required to be conducted from within the control panel and there are two ways of doing so:
Single Creation of a Node
In the control panel within the area to add agents, there is an intelligent control which filters and displays a list of possible agents.
Once it has been selected, please click on the button 'add agent' within the panel. It's going to display a new node of this agent in the center of the map in this moment.
Massive Creation of a Node
Within the pop-up list which is called 'Filter Group' in the control panel, you may select the group from which you intend lo load the agents to add to the list shown above. In this list, the agents of the group which aren't shown on the map are going to be displayed here.
Once they're selected (after clicking on the button 'add') they will be shown on the coordinates '0,0' of the map, which is the left upper corner.
Creating fictitious Nodes
It's possible to create fictitious nodes from the control panel. Within the form, it's possible to define the shape (e.g. circle, square, rhombus), to color it, name it, to assign a size to it and even to pick a map with which to link it within the network-map's list.
Modifying the Zoom Level
The mouse wheel is able change the zoom level of the map, which always starts by the maximum zoom level by default. On maximum zoom level, the system icon which is displayed on higher levels isn't going to be shown. There are 5 zoom levels.