Search <book_title>...

NetBackup IT Analytics Help

Last Published: 2024-09-04

Product(s): NetBackup IT Analytics (11.3)

Configure embedded NetBackup IT Analytics Data collector for NetBackup deployment on appliances (including Flex appliances)

You can configure a Data Collector on the primary server pod. Following are the steps for respective configurations.

Note:

From NetBackup version 10.3 Cloud Scale release, Data Collector on primary server pod is supported.

Configure NetBackup IT Analytics for NetBackup deployment by configuring Data Collector on a primary server

The below steps to configure the IT Analytics Data Collector on a primary server must be performed as a root user. On a Flex appliance, connect to the primary server pod first and then switch to the root user using sudo. On a NetBackup Appliance, access shell by creating NetBackup CLI user.

To configure NetBackup IT Analytics for NetBackup deployment

Create a DNS server entry in such a way that IP of the NetBackup IT Analytics Portal must be resolvable to a single FQDN. IP of the NetBackup IT Analytics Portal must be resolved to:
```
itanalyticsagent.<yourdomain>
```
Note the following:
- If the Portal URL is itanalyticsportal.<yourdomain>, then ensure to add the DNS entries for the following hostnames:
```
itanalyticsagent.<yourdomain> 
```
- If the Portal URL is aptareportal.<yourdomain>, then ensure to add the DNS entries for the following hostnames:
```
aptareagent.<yourdomain>
```
Collect the <your-collector-name>.key file for the new Data Collector by accessing the Portal link and creating a collector and copy it to the host machine from where NetBackup primary is deployed.
For more information, refer to the Data Collector Encryption section in NetBackup IT Analytics User Guide.
Collect the <your-collector-name>.json file for the new Data Collector by accessing the Portal link and creating a collector and copy it to the host machine from where NetBackup primary is deployed.
For more information, refer to the Data Collector Encryption section in NetBackup IT Analytics User Guide.
Create a new folder analyticscollector at persisted location (for example, /mnt/nbdata/) using the following commands:
```
cd "/mnt/nbdata/"
mkdir analyticscollector
```
Copy the <your-collector-name>.key file to /mnt/nbdata/analyticscollector inside the NetBackup primary host or container as the case may be.
Exit from the container and copy the <your-collector-name>.json file to /mnt/nbdata/analyticscollector inside the NetBackup primary host or container as the case may be.
In case if the data-receiver is configured with self-signed certificate (https), you must add the certificate in the data collector.
See Configure the Data Collector to trust the certificate.
Connect to the NetBackup primary host or the container.

Navigate to /usr/openv/analyticscollector/installer/ location and perform the following:

Open the responsefile.sample and add the following parameters:

If the Portal version is lower than 11.3, create the response file with the following contents.

COLLECTOR_NAME=<your-collector-name>
COLLECTOR_PASSCODE=<your-password>
DR_URL=<http>/<https>://itanalyticsagent.<yourdomain>
COLLECTOR_KEY_PATH=<path to your-collector-name.key>
HTTP_PROXY_CONF=N
HTTP_PROXY_ADDRESS=
HTTP_PROXY_PORT=
HTTPS_PROXY_ADDRESS=
HTTPS_PROXY_PORT=
PROXY_USERNAME=
PROXY_PASSWORD=
PROXY_EXCLUDE=

If the Portal version is 11.3 or later, create the response file with the following contents.

COLLECTOR_REGISTRATION_PATH=<keyfile path>
HTTP_PROXY_CONF=N
HTTP_PROXY_ADDRESS=
HTTP_PROXY_PORT=
HTTPS_PROXY_ADDRESS=
HTTPS_PROXY_PORT=
PROXY_USERNAME=
PROXY_PASSWORD=
PROXY_EXCLUDE=

Configure the Data Collector with the NetBackup IT Analytics Portal as follows.
Note:
If the Data Collector installed is of a lower version than the NetBackup IT Analytics Portal, wait for the Data Collector auto-upgrade to finish before you proceed.
For NetBackup Appliance version 5.3 or later:
- Run the following command as a NetBackup CLI user:
```
/usr/openv/analyticscollector/installer/dc_installer.sh -c /usr/openv/analyticscollector/installer/responsefile.sample
```
- To verify the Data Collector integration with NetBackup IT Analytics Portal, run:
```
/usr/openv/analyticscollector/mbs/bin/checkinstall.sh
```
For NetBackup Appliance version 5.1.1:
- Run the following command as a NetBackup CLI user:
```
sudo /usr/openv/analyticscollector/installer/dc_installer.sh -c /usr/openv/analyticscollector/installer/responsefile.sample
```
- To verify the Data Collector integration with NetBackup IT Analytics Portal, run:
```
sudo /usr/openv/analyticscollector/mbs/bin/checkinstall.sh
```
If you are on Flex Appliance:
- Connect to the primary server container and then switch to roo user using sudo and run:
```
/usr/openv/analyticscollector/installer/dc_installer.sh -c /usr/openv/analyticscollector/installer/responsefile.sample
```
- To verify the Data Collector integration with NetBackup IT Analytics Portal, run:
```
/usr/openv/analyticscollector/mbs/bin/checkinstall.sh
```
  If the Data Collector is configured with the Portal, it will display SUCCESSFUL.
Note:
If there is a version mismatch of aptare.jar between Data Collector and Portal, execution of checkinstall.sh command will trigger an auto-update of the Data Collector.

Check the Data Collector services status by running the following command and ensure that the following Data Collector services are up and running:

/usr/openv/analyticscollector/mbs/bin/aptare_agent status

Output of the above command:

IT Analytics WatchDog is running (pid: 13312).
IT Analytics MetaDataCollector is stopped.
IT Analytics EventDataCollector is stopped.
IT Analytics DataCollector process is running (pid: 13461).
IT Analytics On-demand process is running (pid: 13463).
IT Analytics Message Relay Server process is running (pid: 13471)

For more information about NetBackup IT Analytics Data Collector policy, see NetBackup IT Analytics User Guide.

Configure NetBackup IT Analytics for NetBackup deployment by configuring Data Collector on a separate host machine

IT Analytics Data Collector can be configured to use with NetBackup primary server in this environment. NetBackup IT Analytics can be configured at the time of primary server deployment or user can update the primary server custom resource to configure NetBackup IT Analytics.

Note:

Remote data collection from Netbackup primary server cannot be configured when multi-factor authentication is configured on Netbackup Appliance.

To configure NetBackup IT Analytics for NetBackup deployment:

Using the ssh-keygen command, generates public key and private key on NetBackup IT Analytics data collector.
NetBackup IT Analytics Data Collector uses passwordless ssh login.
Create and copy NetBackup API key from NetBackup web UI.
On NetBackup IT Analytics Portal:
- Navigate to Admin > Collector Administration > Select respective Data Collector > Add policy > Veritas NetBackup > Add.
- Add required options, specify the NetBackup API in the API Key field, and then click OK.
- Select newly added primary server from NetBackup Primary Servers and provide nbitanalyticsadmin as Primary Server User ID.
- Provide privateKey=<path-of-private-key>|password=<passphrase> as Primary Server Password and Repeat Password whereas <path-of-private-key> is the private key created using ssh-keygen in earlier steps and <passphrase> is the passphrase used while creating private key via ssh-keygen.
- Provide appropriate data to Data Collector policy fields and select collection method as SSH or WMI protocol to NetBackup Primary Server.

Configuring the primary server with NetBackup IT Analytics tools is supported only once from primary server custom resource.

For more information about NetBackup IT Analytics Data Collector policy, see Add a Veritas NetBackup Data Collector policy section.

For more information about adding NetBackup Primary Servers within the Data Collector policy, see Add/Edit NetBackup Primary Servers within the Data Collector policy section in NetBackup IT Analytics Data Collector Installation Guide for Backup Manager.

To change the already configured public key

Connect to the NetBackup Primary host or container.
Copy the new public keys in the /home/nbitanalyticsadmin/.ssh/authorized_keys and /mnt/nbdata/.ssh/nbitanalyticsadmin_keys files.
Restart the sshd service using the systemctl restart sshd command.