Chat now with support
Chat with Support

Foglight for NetVault 6.1.0 - User Guide

Getting Started

•
Creating a NetVault Agent
•
Managing certificates
•
Configuring data collection interval
•
Heat Map Analytics
•
Scatter Plot Analytics
•
Recommended additional reading

Creating a NetVault Agent

Each NetVault Agent monitors the assets inside the selected NetVault Backup environment. To enable the data collection for Foglight for NetVault, create a NetVault user with the “Monitor Presets” privilege, as well as grant this user with the access to the client groups and media groups that you want to monitor.

* 
NOTE: Make sure to assign the minimum required privilege to your NetVault agent and the agent user; otherwise this agent can not start data collection.

 

* 
NOTE: In FIPS-compliant mode, you need to import the CA certificate or the self-signed certificate to the KeyStore of FglAM to use HTTPs. For more information, see Managing certificates.
To create a NetVault agent:
1
Log in to the Foglight browser interface and make sure the left navigation panel is open.
2
On the navigation panel, under Homes, click NetVault Environment.
The NetVault Environment dashboard opens.
3
In the NetVault Environment dashboard, click Administration, and then click Create Agent.
The NetVault Agent Wizard dialog box opens.
4
Select Agent Host: Select the agent manager on which the new agent is to be deployed, and then click Next.
5
NetVault Properties: Specify the following values, and then click Finish.
•
Server Address: The IP address of the NetVault Server that hosts the agent instance.
•
Port: The port number used by the NetVault Server for listening to the connections from the agent instance (default: 8443).
•
Use Https: The option used to enable the agent connection using HTTPS (default: true).
•
Login Username: The name of the user that has the privileges required for connecting to the NetVault Server and retrieving information.
•
Login Password: The password of the user that has the privileges required for connecting to the NetVault Server and retrieving information.
•
Error Event Keywords: Keywords used to classify NetVault error events. Separate multiple keywords by comma.
•
Warning Event Keywords: Keywords used to classify NetVault warning events. Separate multiple keywords by comma.
•
Collected Event Classes: The option used to indicate which event classes will be collected by the agent instance. By default, all event classes available in the NetVault Server are checked.
•
Collect Log Level: The option used to indicate which logs will be collected by the agent instance. Warning and above is set by default.
The new NetVault Agent is created and its data will be shown on the Monitoring tab after a few minutes.

Managing certificates

Syntax Conventions

In order to successfully make use of the Foglight commands in your monitoring environment, review the syntax conventions before getting started. The syntax conventions are as follows:

•
Generic examples follow the UNIX path structure that uses forward slashes '/' to separate directories.
•
Platform-specific examples follow standard platform conventions. For example, UNIX-specific examples use forward slashes ‘/’ as directory delimiters, while Windows examples use backslashes ‘\’.
•
<foglight_home> is a placeholder that represents the path to the Foglight Management Server installation.
•
<foglight_agent_mgr_home> is a placeholder that represents the path to the Foglight Agent Manager installation. This can be the location of the Foglight Agent Manager installation on a monitored host, or the home directory of the Foglight Agent Manager that comes embedded with the Foglight Management Server. For example:
Path to the Foglight Agent Manager installation on a monitored host (Windows):
C:\Quest\Foglight_Agent_Manager
Path to the embedded Foglight Agent Manager installation (Windows):
C:\Quest\Foglight\fglam
•
Unless otherwise specified, Foglight commands are case-sensitive.
Managing certificates for FglAM

Foglight Evolve agents use Foglight Agent Manager (FglAM) to manage certificates for SSL encryption connection.

Prerequisite

All the certificate-related command line options require that FglAM be up and running.

Add a certificate

bin/fglam --add-certificate "user alias 1"=/path/to/certificate/file

•
Validate the certificate and ensure the following:
•
It is not expired.
•
It is an X.509 format.
•
FglAM requires the Base64 format. To verify if the certificate file is encoded with Base64, open the certificate with a notepad and the certificate should be similar to the following example:
-----BEGIN CERTIFICATE-----
XXXXXXXX=
-----END CERTIFICATE-----
* 
NOTE: If the certificate is not Base64 format, use openssl command to convert the certificate file into a Base64 file. Use either of the following commands depending on the source form:
openssl x509 -inform DER -in xxx.cer -out xxx.crt
or
openssl x509 -inform PEM -in xxx.cer -out xxx.crt
•
The alias is required and is used in the list and delete operations to refer to the certificate. It can be anything.
List installed certificates

bin/fglam --list-certificates

Print out a list of certificates and the aliases that refer to them.

Refer to the example output below:

List of installed certificates:
Alias Certificate Info
----- ----------------
user alias 1 XXXX
Delete a certificate

Remove a certificate referred to by an alias.

bin/fglam --delete-certificate "user alias 1"

A full example for managing certificate for FglAM
•
Add an example certificate into FglAM certificate store
C:\Quest\Foglight\fglam\bin>fglam.exe --add-certificate "Evolve-test"="D:/Evolve-test.crt"
…
2020-02-27 16:31:01.000 INFO [native] Certificate added: Certificate from
D:\Evolve-test.crt added as Evolve-test
•
List the example certificate in the FglAM certificate store
C:\Quest\Foglight\fglam\bin>fglam.exe --list-certificate
…
Alias Certificate
----- -----------
Evolve-test Issuer:
CN: XXX
•
Delete the example certificate from the FglAM certificate store
C:\Quest\Foglight\fglam\bin>fglam.exe --delete-certificate "Evolve-test"
…
2020-02-27 16:28:21.000 INFO [native] Certificate deleted: Certificate
Evolve-test deleted

Configuring data collection interval

The default data collection interval of NetVault agents is set to 10 minutes by default. Foglight for NetVault enables you to change this collection interval as needed.

* 
NOTE: Changing the data collection interval will take effect for all NetVault agents.
To configure the data collection interval:
1
On the navigation panel, under Dashboards, select Administration > Agents > Agent Status.
2
On the Agent Status dashboard, select the NetVault agent that you want to monitor, and then click Edit Properties.
3
In the Edit Properties dashboard, click Edit next to the Collector Config field.
* 
NOTE: Quest highly recommends setting the Collector Config (also knowns as Collection interval) to a value that is larger than 10 minutes and is multiples of 10 minutes; otherwise the NetVault agent might not collect metrics from the NetVault Server.
Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating