NetBackup IT Analytics Data Collector Installation and Configuration Guide for Veritas NetBackup

Last Published:
Product(s): NetBackup IT Analytics (11.5)
  1. Introduction
    1.  
      Overview
    2.  
      Distributed Data Collector (recommended for NetBackup)
    3.  
      Centralized Data Collector
    4.  
      Collection of backup and restore data
    5.  
      Data Collection Policies
  2. Configure a NetBackup IT Analytics Distributed Data Collector on a NetBackup Primary Server
    1.  
      Overview
    2. Configure Data Collector on non-clustered NetBackup 10.4 and later primary server
      1.  
        Manage Data Collector installation on NetBackup primary server
    3.  
      Configuration workflow for NetBackup 10.1.1, 10.2, 10.2.01, 10.3 or 10.3.0.1 on a non-clustered NetBackup primary server
    4. Configure Data Collector on non-clustered NetBackup 10.1.1, 10.2, 10.2.01, 10.3 or 10.3.0.1 primary server
      1.  
        Manage Data Collector installation on NetBackup (install/remove)
    5.  
      Configuration workflow for NetBackup versions lower than 10.1.1
    6.  
      Configure Data Collector on NetBackup primary with version lower than 10.1.1
  3. Configure a Veritas NetBackup Data Collector Policy
    1.  
      Veritas NetBackup Data Collector policy configuration prerequisites
    2.  
      Create NetBackup Data Collector Role, Service Account, and API Key
    3.  
      Add a Veritas NetBackup Data Collector policy
    4.  
      Add/Edit NetBackup Primary Servers within the Data Collector policy
    5. 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
  4. Installing the Data Collector software
    1.  
      Introduction
    2.  
      Considerations to install Data Collector on non-English systems
    3.  
      Install Data Collector Software on Windows
    4.  
      Install Data Collector software on Linux
    5.  
      Deploy Data Collector in native Kubernetes environment
    6.  
      Configure Data Collector manually for Veritas NetBackup
    7.  
      Install Data Collector binaries on Windows (without configuration)
    8.  
      Install Data Collector binaries on Linux host (without configuration)
    9.  
      Override default Java Heap memory (XMX) value for Data Collector utilities
  5. Configure SSL
    1.  
      SSL/TLS certificate configuration
    2.  
      SSL implementation overview
    3.  
      Obtain an SSL certificate
    4.  
      Update the web server configuration to enable SSL on the Portal server
    5.  
      Enable / Disable SSL for a Data Collector
    6.  
      Enable / Disable SSL for emailed reports
    7.  
      Test and troubleshoot SSL configurations
    8.  
      Keystore file locations on the Data Collector server
    9.  
      Import a certificate into the Data Collector Java keystore
    10.  
      Keystore on the portal server
    11.  
      Add a virtual interface to a Linux server
    12.  
      Add a virtual / secondary IP address on Windows
  6. Centralized Data Collector for NetBackup - Prerequisites, Installation, and Configuration
    1.  
      Overview
    2. Step-1: Choose operating system and complete prerequisites
      1.  
        Factors impacting Data Collector performance and memory requirements
      2.  
        Data Collector supported operating systems
      3.  
        Data Collector server memory and CPU guidelines
      4.  
        Additional prerequisites
      5.  
        Linux Data Collector Prerequisites: Changing the Linux Temporary Directory for Collection
    3.  
      Step-2: HTTPS requirement
    4.  
      Step-3: Add Data Collector on NetBackup IT Analytics Portal
    5.  
      Step-4: Create NetBackup Data Collector Role, Service Account, and API Key
    6. Step-5: SSH/WMI
      1.  
        Linux Centralized Data Collector: SSH
      2. Windows Data Collector: WMI Connectivity
        1.  
          Testing WMI connectivity
        2.  
          Installing the WMI Proxy Service (Windows Host Resources only)
    7.  
      Step-6: Install the Data Collector
    8.  
      Step-7: Configure Data Collector
    9.  
      Step-8: Verify the Data Collector is online from the Portal
    10.  
      Step-9: Confirm that the Data Collector is updated
    11.  
      Step-10: Configure the data collection policy
    12.  
      Step-11: Confirm that the NetBackup data collection policy is collecting data
  7. Upgrading Data Collector Locally
    1.  
      Overview
    2.  
      Verification of upgrade bundle available on Data Collector server
    3.  
      Upgrade the Upgrade Manager component
    4.  
      Upgrade the Data Collector component which is the aptare.jar file
    5.  
      Upgrade the Upgrade Manager and Data Collector components together
    6.  
      Upgrade logs and upgrade related database views
    7.  
      Resolve file lock issue on Windows host during Data Collector upgrade
  8. Clustering Data Collectors with VCS and Veritas NetBackup (RHEL)
    1.  
      Clustering Data Collectors with VCS and Veritas NetBackup (RHEL)
    2.  
      Prerequisites
    3.  
      Getting started with Data Collector clustering
    4.  
      Configuring the Data Collector
    5.  
      Upgrading a clustered Data Collector
    6.  
      Considerations when Data Collector is pointing to Alta Domain Management
  9. Clustering Data Collectors with VCS and Veritas NetBackup (Windows)
    1.  
      Clustering Data Collectors with VCS and Veritas NetBackup (Windows)
    2.  
      Prerequisites
    3.  
      Getting Started with Data Collector Clustering
    4.  
      Main.cf
    5.  
      Upgrading a Clustered Data Collector
    6.  
      Manage cluster configuration during NetBackup upgrade (Windows)
    7.  
      Uninstall cluster Data Collector
  10. Install and configure NetBackup IT Analytics Data Collector on MSCS environment
    1.  
      Cluster Data Collectors with MSCS on Windows
    2.  
      Perform cluster configurations
    3.  
      Upgrade NetBackup IT Analytics Data Collector in MSCS
    4.  
      Uninstall NetBackup IT Analytics Data Collector
    5.  
      Steps to perform before and after NetBackup upgrade
  11. Data Collector Policy Migration
    1.  
      Migrate NetBackup data collection policy from centralized to distributed Data Collector
  12. Pre-Installation setup for Veritas NetBackup appliance
    1.  
      Overview
    2.  
      Prerequisites for adding Data Collectors (Veritas NetBackup appliance)
    3.  
      Installation Overview (Veritas NetBackup Appliance)
    4.  
      Adding a Veritas NetBackup Appliance Data Collector policy
  13. Pre-installation setup for Veritas Flex Appliance
    1.  
      Pre-Installation setup for Veritas Flex Appliance
    2.  
      Prerequisites for adding Data Collectors (Veritas Flex Appliance)
    3.  
      Installation overview (Veritas Flex Appliance)
    4.  
      Add a Veritas Flex Appliance policy
    5.  
      Troubleshoot Veritas Flex Appliance policy configuration
  14. Data Collector Troubleshooting
    1.  
      Resolving Data Collectors connections issues - Linux specific
    2.  
      Resolving Data Collectors connections issues - Windows specific
    3.  
      Portal upgrade performance issues
    4.  
      Configuring web proxy updates
    5.  
      Host resources troubleshooting
    6.  
      Host resources: Check the status of the WMI proxy server
    7.  
      Host resources: Post-Installation verification
    8. Host resources: Check host connectivity using standard SSH
      1.  
        Checking Paths for SSH
      2.  
        Environment setting for bash users
    9.  
      Host resources: Check host connectivity
    10.  
      Host resources: Check host connectivity using Host Resource Configuration file
    11. Host resources: Generating host resource configuration files
      1.  
        Sample lines in an input file
    12.  
      Host resources: Check the execution of a command on a remote server
    13.  
      Host resources Data Collection
    14.  
      Host resources: Collection in stand-alone mode
    15. Configuring parameters for SSH
      1.  
        Configure channelWaitTime
      2.  
        Configure singleChannelSession
      3.  
        Configure sudoWithPassword
    16.  
      Identifying Windows file system access errors (File Analytics)
    17.  
      Collect from remote shares (File Analytics)
    18.  
      Adding a certificate to the Java keystore
    19.  
      Override default Java Heap memory (XMX) value for Data Collector utilities
  15. Appendix A. Configure Appliances
    1.  
      Configure NetBackup Appliances for Data Collection
    2.  
      Configure NetBackup Flex Appliances for Data Collection
  16. Appendix B. 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
  17. Appendix C. Firewall configuration: Default ports
    1.  
      Firewall configuration: Default ports
  18. Appendix D. CRON Expressions for Policy and Report Schedules
    1.  
      CRON expressions for policy probe schedules
    2.  
      CRON expressions for scheduling reports
  19. Appendix E. Maintenance Scenarios for Message Relay Server Certificate Generation
    1.  
      Regenerate authentication certificate nearing expiry (or already expired)
    2.  
      Recover inadvertently deleted aptare.ks file
    3.  
      Authenticate new database with existing SSL certificates
    4.  
      SSL certificate authentication for a new data collector

Add a Veritas Flex Appliance policy

  • Before adding the policy: A Data Collector must exist in the Portal, to which you will add Data Collector Policies.

    For specific prerequisites and supported configurations for a specific vendor, see the NetBackup IT Analytics Certified Configurations Guide.

  • After adding the policy: For some policies, collections can be run on-demand using the Run button on the Collector Administration page action bar. The Run button is only displayed if the policy vendor is supported.

    On-demand collection allows you to select which probes and devices to run collection against. This action collects data the same as a scheduled run, plus logging information for troubleshooting purposes. For probe descriptions, refer to the policy.

The data collection form the appliances depends on the availability of the components that expose the appliance stats to the policy probes. The data collection supported for each Flex Appliance version is as indicated below. You need to create an RTD report to view the data. Collection is performed via REST APIs exposed by the Flex Appliance.

Table: Data collection based on appliance version

Policy probe

Collection type

Supported Veritas Flex Appliance version

Appliance Details

Hardware details of appliance and its nodes

2.0, 2.1, 3.0 , 3.2, 4.0

Performance Statistics

Node and container details

2.0, 2.1, 3.0, 3.2, 4.0

Storage Statistics

Storage consumption details

2.0.1, 2.1, 3.0, 3.2, 4.0

Note:

The Data Collector installed with the on-premise installation of NetBackup supports data collection from Veritas Flex Appliance. You can configure the Veritas Flex Appliance policy.

To add the policy

  1. Select Admin > Data Collection > Collector Administration. Currently configured Portal Data Collectors are displayed.
  2. Search for a collector if required or select a Data Collector from the list.
  3. Click Add Policy, and then select Veritas Flex Appliance entry in the menu.
  4. Enter or select the parameters. Mandatory parameters are denoted by an asterisk (*):

    Field

    Description

    Collector Domain

    The domain of the collector to which the collector backup policy is being added. This is a read-only field. By default, the domain for a new policy will be the same as the domain for the collector. This field is set when you add a collector.

    Policy Domain

    The domain of the policy that is being configured for the Data Collector. The Policy Domain must be set to the same value as the Collector Domain. The domain identifies the top level of your host group hierarchy. All newly discovered hosts are added to the root host group associated with the Policy Domain.

    Typically, only one Policy Domain will be available in the drop-down list. If you are a Managed Services Provider, each of your customers will have a unique domain with its own host group hierarchy.

    To find your Domain name, click your login name and select My Profile from the menu. Your Domain name is displayed in your profile settings.

    Add

    Click to add a Veritas Flex Appliance to the policy. Provide valid Appliance Address, User ID, and Password for a successful connection.

    Appliance Address*

    Fully qualified domain name (FQDN) of the Veritas Flex Appliance. This FQDN enables the policy to collect from all the appliance nodes that are up-and-running. The data persisted is distinguished by the node ID as registered on the appliance.

    Note:

    Flex appliance connector supports only FQDN in Appliance Address.

    Username*

    Username required to access the Flex Appliance.

    Provide the user credentials of the admin user of the Flex Appliance. This user is the default user for the Flex Appliance Console. Use this user to sign in to the console for the first time and for operations that require elevated privileges.

    Password*

    Password required to access the Flex Appliance.

    Secret Key (If MFA is enabled)

    Secret key associated with the credentials entered in the Username and Password fields. Secret key is required only of the target Veritas Flex Appliance is MFA-enabled and it is crucial for the policy to get an authorized access to the appliance.

    Note:

    In a MFA-enabled Veritas Flex Appliance, a new secret key is generated every time its user profile is edited. Ensure the NetBackup IT Analytics Veritas Flex Appliance policy is configured with the latest secret key associated with the user configured in the policy.

    Appliance Details

    Collects hardware and software details of Flex Appliance added in the policy. The collected details include:

    • For appliance: appliance name, UUID, appliance type, and more.

    • For node: Node name, serial number, firmware version, Flex version and so on.

    The probe is selected by default and has a default schedule and its data collection is independent of other probes, irrespective of the data and the execution order.

    Performance Statistics

    Collects resource utilization and performance statistics from each appliance node and the containers running on the Flex Appliance. The data is collected for each container and is segregated on the basis of appliance and host node on which the container is running. You must create custom reports to view the collection from the nodes and containers.

    Note:

    Flex v3.0 supports per user active session limited to 10 sessions. Veritas recommends to create a dedicated user for ITA Flex Appliances policy and utilize those credentials for data collection.

    Note:

    In Flex v3.0, container metrics are restricted due to vulnerabilities in cAdvisor exporter. For this reason, Performance Probe will only collect node metrics from flex appliance with flex version 3.0. No data will be available for container metrics

    Storage statistics

    Collects storage utilization specific to the entire Flex Appliance, irrespective of its nodes. Collection is performed via REST APIs exposed by the Flex Appliance.

    Schedules

    By default, collection for Performance Statistics is run performed every 5 minutes and for Storage Statistics, collection is performed daily at 03:33 hours.

    Click the clock icon to create a schedule.

    Every Minute, Hourly, Daily, Weekly, and Monthly schedules may be created. Advanced use of native CRON strings is also available.

    Examples of CRON expressions:

    */30 * * * * means every 30 minutes

    */20 9-18 * * * means every 20 minutes between the hours of 9am and 6pm

    */10 * * * 1-5 means every 10 minutes Mon - Fri.

    Note:

    Explicit schedules set for a Collector policy are relative to the time on the Collector server. Schedules with frequencies are relative to the time that the Data Collector was restarted.

    Notes

    Enter or edit notes for your data collector policy. The maximum number of characters is 1024. Policy notes are retained along with the policy information for the specific vendor and displayed on the Collector Administration page as a column making them searchable as well.

    Test Connection

    Test Connection initiates a Data Collector process that attempts to connect to all the appliances added to the policy using the FQDN and credentials supplied in the policy. Agent Services must be running for the Test Connection to succeed.

    Several factors affect the response time of the validation request, causing some requests to take longer than others. For example, there could be a delay when connecting to the subsystem. Likewise, there could be a delay when getting the response, due to other processing threads running on the Data Collector.

    You can also test the collection of data using the Run functionality available in Admin > Data Collection > Collector Administration. This On-Demand data collection run initiates a high-level check of the installation at the individual policy level, including a check for the domain, host group, URL, Data Collector policy and database connectivity. You can also select individual probes to test the collection run.

  5. Click OK to save the policy configuration.

    Note:

    Do not delete the swap directory (<APTARE_HOME>\mbs\swap\veritas\flexappliance) from the data collector server as it is used by the Veritas Flex Appliance policy.

The data collected from Flex Appliances is visible in the Host CPU Utilization, Host Memory Utilization, and Host Network Packets Sent/Received reports. See NetBackup IT Analytics Report Reference Guide for more information on the reports.