Presentation
In this document, we will take over the supervision tool.
We’ll see:
- the connection to the dashboard
- the installation of an agent
- the presentation of plugins and related alerts
- the communication plan
- setting up a network action
- the supervision of a hypervisor
- the activity report
- an overview of the data collected
the connection to the dashboard
The connection to your dashboard requires an email address and a password:
Once authenticated, you arrive on your dashboard (Obviously, your dashboard will be empty at first).
Take charge of your tree
On the left of the dashboard, you can see your main node.
You can perform several actions:
Show the menu
Right clicking on a node will bring up the node management menu.
Download agent
On your dashboard, at the bottom left of the menu, click on the “Download” menu and then choose your platform and format.
Install your first agent
Once the content is downloaded, start the installation.
Fill in your username (email address) and your password then click on “Login”
For each agent, you must inform:
- The node to which it will be attached by expanding the drop-down list.
- The name of the machine (changeable).
- The installation folder (editable).
- Option: “Install remote handshake” will install LogMeIn at the same time.
- Finally click on “Install & Save”.
A message tells you the success of the recording.
Appearance in the dashboard
Once your first agent is installed, you can see it in the node you selected.
If your agent does not appear, right-click on the node and then refresh.
The plugins
Plugins are modules that the agent will use to collect data from your machine.
Access to the plugins
Click on the “Configuration” menu then “Plugins”.
Presentation of plugins
You have several plugins at your disposal for your agent.
By activating a plugin, you allow the agent to collect data from your machine.
Set up plugins
A plugin can have 3 different states:
- Inherited, it will inherit the configuration of its parent node.
- Enabled, the inheritance is “broken”. It will remain active no matter what happens to its parent node.
- Off, the inheritance is “broken”. It will remain inactive no matter what happens to its parent node.
Plugins have a default state. You can change this configuration as you wish.
Alerts
The alerts are organized by plugin and for each of them, it is possible to refine the level of the object. As a reminder, an object is a part of the machine assigned to a plugin. For example, the disk “C:” is an object of type “Disk”.
Click on the “Configuration” menu then “Alerts”.
An alert is triggered if its conditions are reached then a ticket is created.
Depending on your communication plan, an email and / or text message will be sent.
Types of alerts
Alerts include one or more “Alert Type”. For example, the alert on the plugin “Antivirus” has 3 types of alert: “Antivirus expired”, “Antivirus deactivated” and “Virus detected” (The alert Virus detected is only available for RG Security)
For each type of alert, the following information is available and modifiable (depending on the alert, some will not be present):
- Criticality level: low (one yellow tile), medium (two orange tiles), high (three red tiles)
- Threshold: associated with the defined duration, level from which the alert will be triggered.
- Duration: associated with the threshold, the time beyond which the alert will be triggered.
- Escalation: once the number of stimulus (s) reached, the alert will change from low to medium criticality and / or from medium to high
The affected users will receive these alerts during a time slot defined in the communication plan.
Communication plan
The communication plan makes it possible to define the parameters and the persons authorized to receive the information by email and / or SMS that an incident has occurred.
Access to the communication plan
Click on the “Configuration” menu and then “Communication”.
Communication management
Everything is set at the level of a node and according to the level of criticality of the alerts.
For each level, you can:
- Define which users will be alerted by activating one or more mode (s) of communication.
NOTE: SMS can only be activated on alerts with high criticality (3 red tiles).
- Time Zone: The time range during which alerts will be sent.
- Weekend: activation of the communication on Saturday and / or Sunday.
- Frequency of sending: delay after which an alert email or SMS will be returned.
- Restarts: If escalation is enabled and the number of retries are reached, the criticality of the alert is increased.
Network actions
A network action allows data recovery when this is not possible with existing plugins or the agent can not be installed on the machine.
To apply network actions, you must first create an agent pool.
Agents pool
An agent pool is a set of agents that we choose to monitor devices without agents (switch, printer, router, …)
Creating an agent pool
-
Move to a node and click on the “Configuration” menu then “Agent pool”.
-
Enter the name and a comment (optional). Then click on “Add”.
Attach agents to our pool
- View the pool details by clicking the right arrow.
- Click the “Add Agents” button.
- The available agents appear on the right, click on the double arrow to add them.
NOTE: The heart icon indicates whether the agent is active or not.
Add a network action
- You can now add elements to the template. You can define by action:
* type: Ping, SNMPv1, SNMPv2c, HTTP, HTTPS, TCP
* the address (IP or URL to fill in if necessary)
* description (common to all device templates): Name of the network action for the template
- Depending on the type of action, the fields to be filled in change.
- Let’s set up a life test on a printer:
* You must select a node and then right click to display the menu.
* Then click on “New Device” to create a “virtual” agent representing the printer.
* Then select your device and click on “Configuration” then “Plugins”. You arrive on the network action page.
* Then add the network action indicating the IP address of the printer and giving a description to the action.
* Select the agent pool for this action and click “Add”.
! [adding ping] (https://raw.githubusercontent.com/rgsystemes/public-kb/master/Screenshots/General/DashboardAddNetworkTargetPing.png)
We have configured a first network action.
Monitoring a hypervisor
The hypervisor agent now specifically manages VMware ESXi hosts from version 5. For Microsoft Hyper-V, it will be sufficient to install the management agent directly on Windows.
It is not possible to install the management agent directly on the ESXi host, we will create a “virtual” agent in the tree and then an interrogating agent will retrieve the supervisory information through the VMware APIs.
On a node of your tree, right click then “New hypervisor”.
Now that it is created, we will fill in the authentication information. For it :
- click on the hypervisor in your tree, click Configuration / Hypervisor
- Fill in the authentication information as well as the agent that will query the hypervisor (the latter can be a VM hosted by this same hypervisor)
(1) User account, “root” in the majority of cases
(2) Password of the hypervisor
(3) IP address of the hypervisor
(4) Adding the polling agent (choose a server agent that will be switched on 24/7)
(5) Record the information
- Your hypervisor is now supervised
Reports
This type of document is intended for your users to provide them with a complete report of the state of their fleet.
Access reports
From a node in your tree, click on “Configuration” then “Reports”.
You can customize this report to your needs:
- Fill in the title of the report
- Add a description
- Choose optional content
- Select the details
- Automatic sending
You can choose to enable the automatic sending of reports. They will be sent at the chosen frequency.
If you choose not to do so, you will have to send your report by going to the report and clicking on the mail icon.
- Create the report
- The list of reports created on this node (Once your report is created, it appears in this list to the right of the interface.)
Edit / Send reports
In the detail view, you can send the report immediately, edit the report, or delete it.
Access to data
The “Data” menu provides a synthetic view of all the plugins for a selected agent. A click on the button will show the curves or possible lists for this agent and from there by clicking on the desired line you will have the detail.
Charts details :
Listings details :
View information
- On the page grouping all the curves (after clicking on the button “Charts” - All ). With the button on the right (1), these can be viewed on a daily or annual interval
- Positioned on the curve of a plugin referred to (as seen above, click on the plugin wanted), the view can be daily, weekly, monthly or annual (1)
On the right of each curve are information about the associated plugin. The following example shows us a network traffic curve. Pass the mouse pointer to reveal its legend (1). In a table, the minimum, average and maximum values (2) are displayed.