NetBackup IT Analytics Data Collector Installation Guide for Backup Manager

Last Published:
Product(s): NetBackup IT Analytics (11.0)
  1. Introduction
    1.  
      Overview
    2.  
      Backup Manager Collection of Backup and Restore Data
  2. Pre-Installation setup for Commvault Simpana
    1.  
      Introduction
    2.  
      Architecture overview (Commvault Simpana)
    3.  
      Prerequisites for adding Data Collectors (Commvault Simpana)
    4.  
      Upgrade troubleshooting: Microsoft SQL Server and Java 11
    5.  
      Installation overview (Commvault Simpana)
    6. Open TCP/IP access to the Commvault database
      1.  
        Additional Static Port Configuration Steps
    7. Set up a read-only user in the CommServe server
      1.  
        Option 1: Execute SQL commands in the CommServe database
      2.  
        Option 2: Use MSSQL Management Studio
    8.  
      Load historical data prior to initial data collection
    9.  
      Add Commvault Simpana servers
    10.  
      Add a Commvault Simpana Data Collector policy
  3. Pre-Installation setup for Cohesity DataProtect
    1.  
      Introduction
    2.  
      Prerequisites for adding Data Collectors (Cohesity DataProtect)
    3.  
      Installation overview (Cohesity DataProtect)
    4.  
      Add a Cohesity DataProtect Data Collector policy
  4. Pre-Installation setup for EMC Avamar
    1.  
      Introduction
    2.  
      Architecture overview (EMC Avamar)
    3.  
      Prerequisites for adding Data Collectors (EMC Avamar)
    4.  
      Installation overview (EMC Avamar)
    5.  
      Add EMC Avamar servers
    6.  
      Adding an EMC Avamar Data Collector policy
    7.  
      Testing the collection
    8.  
      Add/Configure an Avamar Server within the Data Collector policy window
    9. Import EMC Avamar server information
      1.  
        CSV Format Specifications
      2.  
        Import Notes
    10.  
      Export EMC Avamar server information
  5. Pre-Installation setup for EMC Data Domain backup
    1.  
      Architecture overview (EMC Data Domain Backup)
    2.  
      Prerequisites for adding Data Collectors (EMC Data Domain Backup)
    3.  
      Installation overview (EMC data domain Backup)
    4.  
      Add EMC data domain servers
    5.  
      Add an EMC data domain backup Data Collector policy
    6.  
      Adding/Configuring an EMC data domain server within the Data Collector policy window
    7.  
      Configure a data domain server for file-level compression collection
  6. Pre-Installation setup for EMC NetWorker
    1.  
      Introduction
    2. Architecture overview (EMC NetWorker)
      1.  
        EMC NetWorker Terminology
    3.  
      Prerequisites for adding Data Collectors (EMC NetWorker)
    4.  
      Installation overview (EMC NetWorker)
    5.  
      Add EMC NetWorker servers
    6.  
      Adding an EMC NetWorker Data Collector policy
    7.  
      Adding/Editing a EMC NetWorker server within the Data Collector policy
    8.  
      Configure a notification action in EMC NetWorker
  7. Pre-Installation setup for Dell EMC NetWorker backup & Recovery
    1.  
      Introduction
    2.  
      Prerequisites for adding data collectors (Dell EMC NetWorker Backup & Recovery)
    3.  
      Installation overview (Dell EMC Networker Backup & Recovery)
    4.  
      Adding a Dell EMC Networker Backup & Recovery Data Collector policy
  8. Pre-Installation setup for generic backup
    1.  
      Introduction
    2.  
      Generic backup data collection
    3.  
      Prerequisites for adding Data Collectors (Generic Backup)
    4.  
      Installation overview (generic backup)
    5.  
      Add generic backup servers
    6.  
      Add a generic backup Data Collector policy
    7.  
      Adding/Editing a generic backup server within the Data Collector policy
    8.  
      Manually load the CSV file (generic backup)
    9. CSV format specification
      1.  
        EXAMPLE: genericBackupJobs.csv
  9. Pre-Installation setup for HP Data Protector
    1.  
      Introduction
    2. Architecture overview (HP Data Protector)
      1.  
        Cell Manager
      2.  
        Disk agent (backup agent)
      3.  
        Media agent
      4.  
        Client systems
      5.  
        User interface (UI)
    3.  
      Prerequisites for adding Data Collectors (HP Data Protector)
    4.  
      Installation overview (HP Data Protector)
    5.  
      Identify HP Data Protector collection requirements
    6.  
      Cell Manager commands for data collection
    7.  
      Preparing for centralized data collection on a remote Cell Manager
    8. Configure the Data Collector server in Cell Manager (HP Data Protector)
      1.  
        Requirements for the Data Collector (Windows)
      2.  
        Steps to Configure the Data Collector Server in Cell Manager
    9.  
      Configure an HP Data Protector admin user
    10.  
      Validate HP Data Protector setup
    11.  
      Add HP Cell Manager servers to NetBackup IT Analytics
    12.  
      Add an HP Data Protector Data Collector policy
    13.  
      Add/Edit a HP Data Protector server within the Data Collector policy
    14.  
      Tune the configuration
  10. Pre-Installation setup for IBM Spectrum Protect (TSM)
    1.  
      Introduction
    2. Architecture overview (IBM Spectrum Protect -TSM)
      1.  
        IBM Spectrum Protect (TSM) - servers and instances defined
    3.  
      Prerequisites for adding data collectors (IBM Spectrum Protect - TSM)
    4.  
      Installation overview (IBM Spectrum Protect - TSM)
    5.  
      Add IBM Spectrum Protect (TSM) servers
    6.  
      Adding an IBM Spectrum Protect (TSM) Data Collector policy
    7.  
      Add/Configure an IBM Spectrum Protect (TSM) server within the Data Collector policy
    8. Import IBM Spectrum Protect (TSM) information
      1.  
        CSV format specifications
    9.  
      Export IBM Spectrum Protect (TSM) server information
  11. Pre-Installation setup for NAKIVO Backup & Replication
    1.  
      Introduction
    2.  
      Prerequisites for adding data collectors (NAKIVO Backup & Replication)
    3.  
      Installation overview (NAKIVO Backup & Replication)
    4.  
      Add a NAKIVO Backup & Replication Data Collector policy
  12. Pre-Installation setup for Veritas Backup Exec
    1.  
      Introduction
    2.  
      Architecture overview (Veritas Backup Exec)
    3.  
      Backup Exec terminology
    4.  
      Prerequisites for adding data collectors (Veritas Backup Exec)
    5.  
      Upgrade troubleshooting: Microsoft SQL Server and Java 10
    6.  
      Installation overview (Veritas Backup Exec)
    7.  
      Enable TCP/IP for the SQL server
    8.  
      Configure a Windows user
    9.  
      Add Veritas Backup Exec servers
    10.  
      Importing Backup Exec Server information
    11.  
      Add a Veritas Backup Exec Data Collector policy
  13. Pre-Installation setup for Veritas NetBackup
    1.  
      Introduction
    2.  
      General prerequisites for adding data collectors (Veritas NetBackup)
    3.  
      Centralized or distributed deployment (Veritas NetBackup)
    4.  
      Centralized NetBackup data collection (Recommended)
    5. Prerequisites to use SSH and WMI (Veritas NetBackup)
      1.  
        Configure NetBackup Access Control (NBAC) for NetBackup Data Collection
      2.  
        Configure NetBackup sudo access for NetBackup data collection
      3.  
        Configure NetBackup Appliances for Data Collection
      4.  
        Configure NetBackup Flex Appliances for Data Collection
      5.  
        Veritas NetBackup SSH: Changing the Linux Temporary Directory for Collection
    6. Prerequisites for NetBackup collection over SSH (Kerberos option)
      1.  
        Enable Kerberos authentication for NetBackup SSH collection
    7.  
      Prerequisites for centralized NetBackup data collection (using NetBackup software)
    8.  
      Prerequisites for collection from Veritas NetBackup deployed as a Docker image
    9. Veritas NetBackup 8.1 (or later) requirements for centralized collection
      1.  
        Required software
      2.  
        Overview of centralized Data Collector steps
      3.  
        Verify remote commands for centralized NetBackup data collection
    10.  
      Distributed NetBackup data collection
    11.  
      Enable access to the Veritas NetBackup Master Server
    12.  
      Before you install the Data Collector (Veritas NetBackup)
    13.  
      Collecting from NetBackup clusters
    14.  
      Clustered NetBackup upgrade procedure
    15.  
      Add a Veritas NetBackup Data Collector policy
    16.  
      Add/Edit NetBackup Master Servers within the Data Collector policy
    17. Configuring file analytics in NetBackup Data Collector policy
      1.  
        Prerequisites to configure File Analytics for NetBackup
      2.  
        Data Collector and Portal sizing guidelines for File Analytics
      3.  
        Configure File Analytics
      4.  
        Export File Analytics data
  14. Pre-Installation setup for Veritas SaaS backup
    1.  
      Introduction
    2.  
      Prerequisites for adding data collectors (Veritas SaaS Backup)
    3.  
      Installation overview (Veritas SaaS Backup)
    4.  
      Add a generic backup Data Collector policy
  15. Pre-Installation setup for Oracle Recovery Manager (RMAN)
    1.  
      Introduction
    2.  
      Prerequisites for adding data collectors (Oracle Recovery Manager - RMAN)
    3.  
      Installation overview (Oracle Recovery Manager - RMAN)
    4.  
      Add an Oracle Recovery Manager (RMAN) Data Collector policy
  16. Pre-Installation setup for Rubrik Cloud Data Management
    1.  
      Introduction
    2.  
      Prerequisites for adding Data Collectors (Rubrik Cloud Data Management)
    3.  
      Installation overview (Rubrik Cloud Data Management)
    4.  
      Add a Rubrik Cloud Data Management Data Collector policy
  17. Pre-Installation setup for Veeam Backup & Replication
    1.  
      Introduction
    2.  
      Prerequisites for adding data collectors (Veeam Backup & Replication)
    3.  
      Verifying Data Collector servers can connect to Veeam servers
    4.  
      Known issues and limitations (Veeam Backup & Replication)
    5.  
      Installation overview (Veeam Backup & Replication)
    6.  
      Add a Veeam Backup & Replication Data Collector policy
  18. Discovery policies for Veritas NetBackup
    1.  
      Task overview: Configure and monitor discovery policies
    2.  
      Discovery policies overview
    3. About Discovery types
      1.  
        Client drive discovery
      2.  
        Media server disk discovery
      3.  
        Backup policy coverage
    4.  
      Activate a Discovery license
    5.  
      Exclude devices from Discovery policies
    6.  
      Activate Discovery probes in the NetBackup Data Collector policy
    7.  
      Monitor Discovery processes
    8.  
      View client protection status
    9.  
      Reset Discovery data
    10.  
      Why enable SNMP?
    11. About SNMP probes
      1.  
        First probe (sysObjectOID)
      2.  
        Second probe (sysDescr OID)
    12.  
      Example--Installing Net-SNMP
    13.  
      Troubleshoot Net-SNMP installations
  19. Installing the Data Collector software
    1.  
      Introduction
    2.  
      Installing the WMI Proxy service (Windows host resources only)
    3.  
      Testing WMI connectivity
    4.  
      Considerations to install Data Collector on non-English systems
    5.  
      Install Data Collector Software on Windows
    6.  
      Install Data Collector software on Linux
    7.  
      Install Data Collector in containerized environment
  20. Validate data collection
    1.  
      Validation methods
    2.  
      Data Collectors: Vendor-Specific validation methods
    3. Working with on-demand Data Collection
      1.  
        View real-time logging during an on-demand collection
      2.  
        Generating debug level logs during an on-demand collection
    4.  
      Collect historic data on-demand
    5.  
      Using the CLI check install utility
    6.  
      List Data Collector configurations
  21. Manually start the Data Collector
    1.  
      Introduction
  22. Uninstall the Data Collector
    1.  
      Uninstall the Data Collector on Linux
    2.  
      Uninstall the Data Collector on Windows
  23. Appendix A. Load historic events
    1.  
      Introduction
    2.  
      Load Commvault Simpana events
    3.  
      Load EMC Avamar events
    4.  
      Load EMC NetWorker events
    5.  
      Load HP Data Protector events
    6.  
      Load IBM Spectrum Protect (TSM) events
    7.  
      Load Oracle Recovery Manager (RMAN) events
    8.  
      Load Veeam Backup & Replication events
    9. Load Veritas NetBackup events
      1.  
        Load events for individual NetBackup clients
      2.  
        Load events for a group of NetBackup clients
    10.  
      Load Veritas Backup Exec events
    11.  
      Corrections in duplication of clients
    12.  
      Cohesity
    13.  
      Dell EMC NetWorker Backup & Recovery
  24. Appendix B. Firewall configuration: Default ports
    1.  
      Firewall configuration: Default ports

Prerequisites for collection from Veritas NetBackup deployed as a Docker image

This section describes the portal configurations required, before adding a Veritas NetBackup policy, when Veritas NetBackup is deployed as a Docker image in the cloud and it is using the cloud resources to perform backups.

SSH key-based authentication

Since Veritas NetBackup is deployed as a Docker image, it must communicate with the Data Collector using SSH key-based authentication.

  1. Generate an SSH public/private key pair. This key will be required later during configuration. To generate this key pair, run the ssh-keygen command on a Linux system or an equivalent command on Windows.

    Save the public and private key pair along with the passphrase used while generating the key, as you will need to provide the private key path and the passphrase while creating the NetBackup Collection policy in NetBackup IT Analytics Portal.

  2. Copy the public key to the itAnalyticsPublicKey spec of the Environment Custom Resource environment.yaml. You can find this file on the jumpserver that was used to create the initial NetBackup setup on Kubernetes cluster.
  3. Apply the update to itAnalyticsPublicKey spec using kubectl apply -f environment.yaml. The environment.yaml file is available on the jumpserver used to create the NetBackup primary server setup on Kubernetes cluster.

    Alternatively, if the jumpserver is not accessible, use kubectl edit environment <environment_name> -n <namespace> command to edit the environment to add the public key to the itAnalyticsPublicKey sec

  4. On a successful deployment, describe the Environment Custom Resource using kubectl describe PrimaryServer <primary-server-name> -n <namespace>.
Get Veritas NetBackup API key

This API key is required when you add or edit a Veritas NetBackup primary server for the Veritas NetBackup policy configuration. This API key is essential especially when NetBackup IT Analytics has to collect metrics from NetBackup deployed as a Docker image in the cloud.

See the Manage API keys section from the NetBackup Web UI Security Administrator's Guide for steps to get the API key.

Firewall consideration

If the Firewall of the NetBackup primary server is turn on, follow these steps to communicate through the Firewall port:

  1. Open and edit the file /etc/firewalld/zones/public.xml.
  2. Add the following lines in the file:
    <service-name="https"/> 
    
    <port protocol = "tcp" port="1556">
  3. Save the file.