NetBackup IT Analytics Data Collector Installation and Configuration Guide
- Section I. Introduction
- Introduction
- Install and configure a Data Collector
- Overview
- Step-1: Choose operating system and complete prerequisites
- Step-2: HTTPS requirement
- Step-3: Add Data Collector on NetBackup IT Analytics Portal
- Step-4: Install the Data Collector
- Step-5: Verify the Data Collector is online from the Portal
- Step-6: Confirm that the Data Collector is updated
- Step-7: Configure the data collection policy
- Step-8: Confirm that the data collection policy is collecting data
- Installing the Data Collector software
- Introduction
- Considerations to install Data Collector on non-English systems
- Install Data Collector Software on Windows
- Install Data Collector software on Linux
- Configure Data Collector manually for Cohesity NetBackup
- Install Data Collector binaries on Windows (without configuration)
- Install Data Collector binaries on Linux host (without configuration)
- Configure SSL
- SSL/TLS certificate configuration
- SSL implementation overview
- Obtain an SSL certificate
- Update the web server configuration to enable SSL on the Portal server
- Enable / Disable SSL for a Data Collector
- Enable / Disable SSL for emailed reports
- Test and troubleshoot SSL configurations
- Keystore file locations on the Data Collector server
- Import a certificate into the Data Collector Java keystore
- Keystore on the portal server
- Add a virtual interface to a Linux server
- Add a virtual / secondary IP address on Windows
- Section II. Data Protection
- Configuration for Veritas Backup Exec
- Introduction
- Architecture overview (Veritas Backup Exec)
- Backup Exec terminology
- Prerequisites for adding data collectors (Veritas Backup Exec)
- Installation overview (Veritas Backup Exec)
- Enable TCP/IP for the SQL server
- Configure a Windows user
- Add Backup Exec servers
- Importing Backup Exec Server information
- Add a Veritas Backup Exec Data Collector policy
- Configuration for Cohesity DataProtect
- Configuration for Commvault Simpana
- Introduction
- Architecture overview (Commvault Simpana)
- Prerequisites for adding Data Collectors (Commvault Simpana)
- Upgrade troubleshooting: Microsoft SQL Server and Java 11
- Installation overview (Commvault Simpana)
- Open TCP/IP access to the Commvault database
- Set up a read-only user in the CommServe server
- Load historical data prior to initial data collection
- Add Commvault Simpana servers
- Add a Commvault Simpana Data Collector policy
- Configuration for EMC Avamar
- Introduction
- Architecture overview (EMC Avamar)
- Prerequisites for adding Data Collectors (EMC Avamar)
- Installation overview (EMC Avamar)
- Add EMC Avamar servers
- Adding an EMC Avamar Data Collector policy
- Testing the collection
- Add/Configure an Avamar Server within the Data Collector policy window
- Import EMC Avamar server information
- Export EMC Avamar server information
- Configuration for EMC Data Domain backup
- Architecture overview (EMC Data Domain Backup)
- Prerequisites for adding Data Collectors (EMC Data Domain Backup)
- Installation overview (EMC data domain Backup)
- Add EMC data domain servers
- Add an EMC data domain backup Data Collector policy
- Adding/Configuring an EMC data domain server within the Data Collector policy window
- Configure a data domain server for file-level compression collection
- Configuration for Dell EMC NetWorker backup & recovery
- Configuration of Dell EMC PowerProtect Data Manager (PPDM)
- Importing generic backup data
- Configuration for generic backup
- Introduction
- Generic backup data collection
- Prerequisites for adding Data Collectors (Generic Backup)
- Installation overview (generic backup)
- Add generic backup servers
- Add a generic backup Data Collector policy
- Adding/Editing a generic backup server within the Data Collector policy
- Manually load the CSV file (generic backup)
- CSV format specification
- Configuration for HP Data Protector
- Introduction
- Architecture overview (HP Data Protector)
- Prerequisites for adding Data Collectors (HP Data Protector)
- Installation overview (HP Data Protector)
- Identify HP Data Protector collection requirements
- Cell Manager commands for data collection
- Preparing for centralized data collection on a remote Cell Manager
- Configure the Data Collector server in Cell Manager (HP Data Protector)
- Configure an HP Data Protector admin user
- Validate HP Data Protector setup
- Add HP Cell Manager servers to NetBackup IT Analytics
- Add an HP Data Protector Data Collector policy
- Add/Edit a HP Data Protector server within the Data Collector policy
- Tune the configuration
- Configuration for IBM Spectrum Protect (TSM)
- Introduction
- Architecture overview (IBM Spectrum Protect -TSM)
- Prerequisites for adding data collectors (IBM Spectrum Protect - TSM)
- Installation overview (IBM Spectrum Protect - TSM)
- Add IBM Spectrum Protect (TSM) servers
- Adding an IBM Spectrum Protect (TSM) Data Collector policy
- Add/Configure an IBM Spectrum Protect (TSM) server within the Data Collector policy
- Import IBM Spectrum Protect (TSM) information
- Export IBM Spectrum Protect (TSM) server information
- Configuration for NAKIVO Backup & Replication
- Configuration for Oracle Recovery Manager (RMAN)
- Configuration for Rubrik Cloud Data Management
- Configuration for Veeam Backup & Replication
- Introduction
- Prerequisites for adding data collectors (Veeam Backup & Replication)
- Verifying Data Collector servers can connect to Veeam servers
- Known issues and limitations (Veeam Backup & Replication)
- Installation overview (Veeam Backup & Replication)
- Add a Veeam Backup & Replication Data Collector policy
- Configuration for Veritas Backup Exec
- Section III. Storage (Capacity)
- Configuration for Compute Resources
- Configuration for DELL EMC Elastic Cloud Storage (ECS)
- Configuration for Dell EMC Unity
- Pre-installation setup for Dell PowerStore
- Configuration for EMC data domain storage
- Configuration for EMC Isilon
- Configuration for EMC Symmetrix
- Configuration for EMC VNX Celerra
- Configuration for EMC VNX CLARiiON
- Configuration for EMC VPLEX
- Configuration for EMC XtremIO
- Configuration for FUJITSU ETERNUS Data Collector
- Configuration for Hitachi Block
- Pre-Installation setup for Hitachi Block
- Prerequisites for adding Data Collectors (Hitachi Block)
- Installation overview (Hitachi Block Storage)
- Adding a Hitachi Block Storage Data Collector policy
- Configuring a Hitachi Device manager user
- Configuring a Collector for Hitachi NAS block storage
- Adding an HP command view advanced Data Collector policy
- Configuration for Hitachi Content Platform (HCP)
- Pre-Installation setup for Hitachi Content Platform (HCP)
- Prerequisites for adding Data Collectors (Hitachi Content Platform)
- Installation overview (Hitachi Content Platform)
- Add a Hitachi Content Platform (HCP) Data Collector policy
- Setting up permissions for an HCP local user or active directory user
- Hitachi content platform system management console
- Hitachi content platform tenant management console
- Configuration for Hitachi NAS
- Configuration for Hitachi Vantara All-Flash and Hybrid Flash Storage
- Configuration of Host inventory
- Host Access Privileges, Sudo Commands, Ports, and WMI Proxy Requirements
- Host Inventory pre-installation setup
- Plan host Data Collection
- WMI Proxy requirements for Windows host Data Collection
- Host access requirements
- Verify command paths
- Host Inventory configuration steps
- Host Inventory setup overview
- Host Inventory maintenance overview
- Before discovering hosts
- Configure / Search the host Inventory
- Manage credentials
- Manage WMI proxy
- Manage paths
- Manage access control
- Host Inventory management
- Configure host Discovery policies to populate the host Inventory
- Execute and monitor host Discovery
- Validate host connectivity
- Show errors
- Filter the host Inventory - hide / un-hide, remove
- Host Inventory search and host Inventory export
- Export the host Inventory
- Configure and edit host probes
- Propagate Probe Settings: Copy Probes, Paste Probes
- Configuration for HP 3PAR
- Configuration for HP EVA
- Configuration for HPE Nimble Storage
- Configuration for HPE StoreOnce
- Configuration for IBM Enterprise
- Configuration for IBM COS
- Configuration for IBM SVC
- Configuration for IBM XIV
- Configuration for Microsoft Windows server
- Configuration for NetApp-7
- Configuration for NetApp StorageGRID
- Configuration for NetApp Cluster
- Configuration for NetApp E-Series
- Configuration for NEC HYDRAstor
- Configuration for Pure Storage FlashArray
- Section IV. Compute (Virtualization and Host Collection)
- Configuration for VMware
- Configuration for IBM VIO
- Pre-Installation setup for IBM VIO
- Prerequisites for adding data collectors (IBM VIO)
- Installation overview (IBM VIO)
- Adding servers for the IBM VIO Data Collector policy
- VIO servers (IBM Virtual I/O Servers)
- LPAR clients (IBM Logical Partitioning Clients) managed by VIO servers
- HMC (IBM Hardware Management Console)
- Add an IBM VIO Data Collector policy
- Configuration for Microsoft Hyper-V
- Section V. Cloud
- Configuration for Amazon Web Services (AWS)
- Pre-Installation setup for Amazon Web services (AWS)
- Prerequisites for adding Data Collectors (Amazon Web services)
- Prerequisite Amazon Web services (AWS) configurations
- Configure an S3 bucket to receive billing reports
- Select cost allocation tags
- Create an AWS IAM user
- Mandatory probe user privileges
- Link AWS accounts for Collection of consolidated billing data
- Installation overview (Amazon Web Services - AWS)
- Add an Amazon Web Services (AWS) policy
- Configuration for Google Cloud Platform
- Configuration for OpenStack Ceilometer
- Configuration for OpenStack Swift
- Configuration for Microsoft Azure
- Pre-Installation setup for Microsoft Azure
- Setting up credentials for Microsoft Azure Data Collection
- Install the Azure PowerShell client on a Windows computer
- Find your tenant and subscription ID
- Register a new application for the Data Collector
- Create a principal and assign role to the application
- Prerequisites for Adding Data Collectors (Microsoft Azure)
- Installation overview (Microsoft Azure)
- Add a Microsoft Azure Data Collector policy
- Configuration for Amazon Web Services (AWS)
- Section VI. Fabric
- Configuration for Brocade switch
- Pre-Installation setup for Brocade switch
- Prerequisites for adding Data Collectors (Brocade switch)
- Upgrade troubleshooting: Brocade BNA SMI-S (CIM) server and Java 11
- Supported switches
- Brocade switches: Default ports and firewall considerations
- Installation overview (Brocade switch)
- Brocade switch Data Collector policy
- Configuration for Cisco switch
- Pre-Installation setup for Cisco switch
- Prerequisites for adding Data Collectors (Cisco switch)
- Upgrade troubleshooting: Cisco DCNM SMI-S (CIM) server and Java 11
- Cisco switches: Default ports and firewall considerations
- Installation overview (Cisco switch)
- Cisco switch Data Collection policy
- Before you start Cisco switch Data Collection
- Configuration for Brocade Zone alias
- Configuration for Cisco Zone alias
- Configuration for Brocade switch
- Section VII. File Analytics
- Configuration for File Analytics
- Pre-Installation setup for File Analytics
- File Analytics Data Collection overview
- File Analytics Data Collection architecture
- File Analytics Data Collector policies
- Prerequisites for adding Data Collectors (File Analytics)
- CIFS shares
- Host Discovery and Collection File Analytics probe
- Adding a File Analytics Data Collector policy
- Set up FIPS compliant Data Collector for File Analytics
- File Analytics Export Folder Size and Folder Depth
- Configuration for File Analytics
- Section VIII. Data Collection Validation and Troubleshooting
- Validate data collection
- Data Collector Troubleshooting
- Resolving Data Collectors connections issues - Linux specific
- Resolving Data Collectors connections issues - Windows specific
- Portal upgrade performance issues
- Verify the Data Collector configuration
- Verify Connectivity
- Configuring web proxy updates
- Collecting missed events for Veritas Backup Exec
- Substituting ODBC for JDBC to connect to SQL server for Veritas Backup Exec
- Useful Data Collection scripts for capacity
- Host resources troubleshooting
- Host resources: Check the status of the WMI proxy server
- Host resources: Post-Installation verification
- Host resources: Check host connectivity using standard SSH
- Host resources: Check host connectivity
- Host resources: Check host connectivity using Host Resource Configuration file
- Host resources: Generating host resource configuration files
- Host resources: Check the execution of a command on a remote server
- Host resources Data Collection
- Host resources: Collection in stand-alone mode
- Configuring parameters for SSH
- Identifying Windows file system access errors (File Analytics)
- Collect from remote shares (File Analytics)
- Adding a certificate to the Java keystore
- Uninstalling the Data Collector
- Appendix A. Firewall Configuration: Default Ports
- Appendix B. Load historic events
- Introduction
- Load Commvault Simpana events
- Load Dell PowerProtect Data Manager jobs
- Load EMC Avamar events
- Load EMC NetWorker events
- Load HP Data Protector events
- Load IBM Spectrum Protect (TSM) events
- Load Oracle Recovery Manager (RMAN) events
- Load Veeam Backup & Replication events
- Load Veritas NetBackup events
- Load Veritas Backup Exec events
- Corrections in duplication of clients
- Cohesity
- Dell EMC NetWorker Backup & Recovery
- Appendix C. CRON Expressions for Policy and Report Schedules
- Appendix D. Maintenance Scenarios for Message Relay Server Certificate Generation
Update the web server configuration to enable SSL on the Portal server
These instructions apply to Apache version 2.4.xx and the steps should be taken on the designated Web server (the Portal server). the path mentioned in the sample commands assumes default installation path on Linux and Windows.
Create the directory where the certificate and private key files will be located on the portal. Use the chmod command to ensure that only the root account can make changes to this folder as both the key file and certificate will be installed in this folder.
On Linux: Use the chmod command to ensure that only the root account can make changes to this folder as both the key file and certificate will be installed in this folder.
Example:
# cd /opt/apache/conf/ # mkdir ssl_cert # chmod 744 ssl_cert/
On Windows: Create folder
ssl_certinsideC:\opt\apache\conf\.
Copy the certificate files, typically generated via a certificate authority (CA), to a folder in the Web server's Apache configuration folder.
Linux:
cp -p server.* /opt/apache/conf/ssl_cert/
Windows:
C:\opt\apache\conf\ssl_cert
Note:
Configuration files shipped with NetBackup IT Analytics licensed modules may use path names with recommended folder names. To use folders with different names, be sure to update all references to the recommended name in the default configuration files.
Stop the Apache and Tomcat services. From a terminal console, enter the following commands.
Linux
/opt/aptare/bin/tomcat-agent stop /opt/aptare/bin/tomcat-portal stop /opt/aptare/bin/apache stop
Windows
C:\opt\aptare\utils\stopagent.bat C:\opt\aptare\utils\stopportal.bat C:\opt\aptare\utils\stopapache.bat
Make a copy of the
httpd.conffile.Linux:
cp -p /opt/apache/conf/httpd.conf /opt/apache/conf/original-httpd.conf
Windows:
Copy C:\opt\apache\conf\httpd.conf as C:\opt\apache\conf\original-httpd.conf
Update the Apache configuration file
httpd.confto enable SSL.Linux:
/opt/apache/conf/httpd.confWindows:
C:\opt\apache\conf\httpd.confUn-comment the following lines by removing the highlighted # character.
#LoadModule ssl_module modules/mod_ssl.so #Include conf/extra/httpd-ssl.conf
When configuring SSL on a Portal server, it is recommended to either disable http or redirect http protocol traffic to https.
To disable all http protocol connections, edit
httpd.conffile and remove the VirtualHost sections.To redirect all connection attempts on the http protocol to the Portal user interface, edit
httpd.conffile, remove all entries of VirtualHost section of portal configuration and add following lines in same VirtualHost section:ServerName itanalyticsportal.<domainname> Redirect permanent / https://itanalyticsportal.<domainname>/ IF WILLING TO HAVE INITIAL CONNECTIONS BE ANSWERED using HTTP, but redirecting that traffic to HTTPS: ServerName itanalyticsagent.<domainname> Redirect permanent / https://itanalyticsagent.<domainname>/
Make a copy of the
http-ssl.conffile.Linux:
cp -p /opt/apache/conf/extra/httpd-ssl.conf /opt/apache/conf/extra/original-httpd-ssl.conf
Windows:
Copy C:\opt\apache\conf\extra\httpd-ssl.conf as C:\opt\apache\conf\extra\original-httpd-ssl.conf
Update the Apache SSL configuration file.
Linux: /opt/apache/conf/extra/httpd-ssl.conf
Windows: C:\opt\apache\conf\extra\httpd-ssl.conf
For each active virtual host section in the Apache SSL configuration file (
httpd-ssl.conf), ensure that declaration lines beginning with the following are un-commented (they do not have a # at the beginning of the line), and adjust the SSLCertificateFile and SSLCertificateKeyFile sections to point to the respective certificate and private key files referenced in Step 2.SSLCertificateFile <Provide the path of SSL certificate file> SSLCertificateKeyFile <Provide the path of SSL key file>
Example:
SSLCertificateFile /opt/apache/conf/ssl_cert/server.crt
SSLCertificateKeyFile <Provide the path of SSL key file> /opt/apache/conf/ssl_cert/server.key
Note:
If you have a CA issued certificate, ensure you add the SSLCertificateChainFile < Provide the path of Certificate chain file > entry uncommented in
httpd-ssl.conf.Run the deployCert utility as root user on the Portal server to save the SSL certificates configured with Apache in java keystore
itanalytics.jks.Use this as a prerequisite to configure single sign-on and syslog over SSL.
Linux portal command location: /opt/aptare/utils/deployCert.sh update
Windows portal command location: C:\opt\aptare\utils>deployCert.bat update
Linux only: Verify the Apache configuration is valid.
# export LD_LIBRARY_PATH=/opt/apache/ssl/lib:$LD_LIBRARY_PATH # /opt/apache/bin/apachectl -t
If this message occurs:
httpd: Syntax error on line 23 of /opt/apache/conf/httpd.conf: Cannot load modules/mod_ssl.so into server: libssl.so.1.0.0: cannot open shared object file: No such file or directory.
Resolve Syntax Error by linking libraries:
cd /usr/lib # ln -s /opt/apache/ssl/lib/libssl.so.1.0.0 libssl.so.1.0.0 # ln -s /opt/apache/ssl/lib/libcrypto.so.1.0.0 libcrypto.so.1.0.0
Change the application URL in
portal.propertiesto https instead of http. Theportal.propertiesfile is located here:Linux:
/opt/aptare/portalconf/portal.propertiesWindows:
C:\opt\aptare\portalconf\portal.propertiesStart Apache and both Tomcat (Portal and Data Collector) services.
Linux
/opt/aptare/bin/apache start /opt/aptare/bin/tomcat-portal start /opt/aptare/bin/tomcat-agent start
Windows
C:\opt\aptare\utils\startapache.bat C:\opt\aptare\utils\startagent.bat C:\opt\aptare\utils\startportal.bat
Refer to the following sections in the NetBackup IT Analytics Administrator Guide that are relevant for your environment. The instructions above accomplish SSL Implementation for Both the Portal and Data Collection.
SSL Implementation for the Portal only
SSL Implementation for data collection only
SSL Implementation for both portal and data collection