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
Prerequisites for adding Data Collectors (Brocade switch)
General prerequisites:
64-bit OS. See the Certified Configurations Guide for supported operating systems.
Verify the rpm fontconfig is installed. Fontconfig is a library designed to provide system-wide font configuration, customization and application access. If the rpm fontconfig is not installed, the installer will not be able to load User Interface Mode. This is a prerequisite for a new Data Collector installation.
Supports Amazon Corretto 17. Amazon Corretto is a no-cost, multi-platform, production-ready distribution of the Open Java Development Kit (OpenJDK).
For performance reasons, do not install Data Collectors on the same server as the NetBackup IT Analytics Portal. However, if you must have both on the same server, verify that the Portal and Data Collector software do not reside in the same directory.
Install only one Data Collector on a server (or OS instance).
While the general requirements to configure the policy are listed above, the prerequisites specific to the collection method are categorized below.
The following are the prerequisites for is is selected for Collection method:
A single Data Collector can include all supported switches--Brocade, and Cisco. In fact, this single Data Collector can be used for other enterprise objects, such as backup products and storage arrays.
The Data Collector accesses the SMI agent server to retrieve data, so the user ID and password for that server is required. This is true only when collection type in policy is SMI-S.
A single Data Collector can be installed for multiple backup, storage, and fabric products.
Verify that a host-based SMI agent is installed. The SMI agent must be installed on a host that can communicate with the Fabric. See the relevant switch vendor documentation for details.
The following are the prerequisites if option is selected for Collection method:
Same user ID and password should be configured on all the switches in the Fabric. Users with Read-Only access can login.
To collect the Simple Network Management Protocol (SNMP) responses, client must be registered on each Brocade switch from which traps are to be collected.
In Brocade REST API / Command Line Interface Server Address(es), in Brocade Switch Data Collector policy, configure switch IP address / fully qualified switch name.
Note:
For Configured Switch, Collector also collects Switch information from all other Switches in the Fabric. Collector uses the same User ID and Password, as configured in the Policy, to connect to other Switches.
Enable session-based connection. The REST API Collection Method uses session-based approach to connect to the switch. If the login session is successful, it utilizes the session to collect the required data and then logs out to release the session.
The following URIs should be accessible on Switches:
/rest/running/fabric/fabric-switch OR /rest/running/brocade-fabric/fabric-switch
/rest/running/switch/fibrechannel-switch OR /rest/running/brocade-fibrechannel-switch/fibrechannel-switch
/rest/running/brocade-interface/fibrechannel
/rest/running/brocade-chassis/chassis
/rest/running/brocade-fru/blade
/rest/running/brocade-fibrechannel-trunk/trunk
/rest/running/brocade-fru/fan
/rest/running/brocade-fru/power-supply
/rest/running/brocade-media/media-rdp
/rest/running/brocade-name-server/fibrechannel-name-server
/rest/running/zoning/defined-configuration OR /rest/running/brocade-zone/defined-configuration
/rest/running/zoning/effective-configuration OR /rest/running/brocade-zone/effective-configuration
/rest/running/brocade-fibrechannel-configuration/fabric
/rest/brocade-fru/sensor
/rest/running/brocade-interface/fibrechannel-statistics/
/rest/running/brocade-chassis/ha-status
/rest/running/logical-switch/fibrechannel-logical-switch OR /rest/running/brocade-fibrechannel-logical-switch/fibrechannel-logical-switch
Note:
The Status column of Collection Status page displays warning message if any of the following URLs is not accessible.
The following are the prerequisites for option of Collection method. This method is supported for Brocade Switch FOS version 7.4.2 and later.
The following are the prerequisites to collect for Switch Details probe: TCP port 22 (all SAN switches)
Use IP address of the principal switch only - one principal switch per policy while configuring the Brocade policy.
The following list of commands must be accessible:
fabricshow, lscfg --show -n, switchshow, dnsConfig -show, bannershow, uptime, portshow -i %min-index%-%max-index% -f, ipaddrshow, chassisshow, trunkshow, fanshow, psshow, sfpshow -all, nsshow -t, zoneshow, configure -show, fabricPrincipal --show, sensorshow, haShow, firmwareshow, islshow, errdump, agshow, ag -show, licenseshow, configshow, mapsdb -show, seccertmgmt show -cert https, ldapcfg -show, userconfig --show -a, seccertutil show, license -showMinimum role required is switchadmin with default permissions for all RBAC classes for the Home LF and Chassis Roles:
Home LF Role
Chassis Role
Remarks
Option-1
switchadmin (default RBAC)
switchadmin (default RBAC)
Works for most deployments, excluding AD and User config data collection (ldapcfg - show & userconfig --show -a will not work and data collection will end with warnings)
Option-2
switchadmin (default RBAC)
admin (default RBAC)
Required for deployments, excluding User config data collection (userconfig --show -a will not work and data collection will end with warnings).
Option-3
admin (default RBAC)
admin (default RBAC)
Covers complete data collection (all commands will be executed, without warnings)
If a physical switch chassis is shared between multiple fabrics, create a single NetBackup IT Analytics Data Collector policy (including single principal switch) to avoid overlap. For example, the usplsansw510 & usplsansw520 are considered "shared" physical chassis.
The following are the prerequisites to collect FC Port Statistics using SNMP: UDP port 161 must be accessible from the Data Collector:
This account must have a home Virtual Fabric and access to a list of Virtual Fabric IDs.
The minimum role required is switchadmin with default set of permissions for all RBAC classes.
It is possible to leverage the switchadmin or admin user configured for Switch details data collection as long as that user exists on all switches within the fabric (if shared, all fabrics), it has necessary SNMP privileges assigned and the username matches the SNMP v3 account.
This account name must match the SNMP V3 username (= SNMP v3 account mentioned in the below section) and comes in addition to the CLI/SSH account used by Switch details probe.
To retrieve FC Port Statistics from Brocade virtual fabrics / virtual switches:
Create a dedicated CLI user account with a role such that it has access to all virtual fabrics.
Add the user with the command:
userconfig --add <snmp_user> -r <role> -l <list_of_virtual_fabric_ids> -h <home_fabric> -c <chassis_role>If the user already exists, use:
userconfig --addlf <snmp_user> -l <list_of_virtual_fabrics_ids> -r <role>
Configure SNMP (Version 1, 2c or 3) on all the switches:
Set the IP address or Subnet in the SNMP access control on all the switches.
Configure SNMP v3 account on all the switches.
Security Level of v3 (AuthNoPriv, noAuthNoPriv)
The following OIDs must be accessible to the SNMP user:
OIDs for IF-MIB
ifIndex, ifHCOutOctets, ifHCInOctets
OIDs for FCMGMT-MID
connUnitPortIndex, connUnitPortStatIndex, connUnitPortNodeWwn, connUnitPortStatCountFBSYFrames, connUnitPortStatCountPBSYFrames, connUnitPortStatCountFRJTFrames, connUnitPortStatCountPRJTFrames, connUnitPortStatCountClass1RxFrames, connUnitPortStatCountClass2RxFrames, connUnitPortStatCountClass3RxFrames, connUnitPortStatCountClass3Discards, connUnitPortStatCountRxMulticastObjects, connUnitPortStatCountTxMulticastObjects, connUnitPortStatCountRxLinkResets, connUnitPortStatCountTxLinkResets, connUnitPortStatCountRxOfflineSequences, connUnitPortStatCountTxOfflineSequences, connUnitPortStatCountLinkFailures, connUnitPortStatCountTxObjects, connUnitPortStatCountInvalidCRC, connUnitPortStatCountInvalidTxWords, connUnitPortStatCountPrimitiveSequenceProtocolErrors, connUnitPortStatCountLossofSignal, connUnitPortStatCountLossofSynchronization, connUnitPortStatCountInvalidOrderedSets, connUnitPortStatCountFramesTooLong, connUnitPortStatCountFramesTruncated, connUnitPortStatCountAddressErrors, connUnitPortStatCountDelimiterErrors, connUnitPortStatCountRxObjects, connUnitPortStatCountEncodingDisparityErrors, connUnitPortStatCountBBCreditZero, connUnitPortStatCountInputBuffersFull
OIDs for SW-MIB
swFCPortIndex, swConnUnitBadEOF, swConnUnitLCRX, swFCPortTxWords, swFCPortRxWords, swFCPortTxFrames, swFCPortRxFrames, swFCPortTooManyRdys, swFCPortNoTxCredits, swFCPortRxEncInFrs, swFCPortRxCrcs, swFCPortRxTruncs, swFCPortRxTooLongs, swFCPortRxBadEofs, swFCPortRxEncOutFrs, swFCPortC3Discards, swFCPortMcastTimedOuts
Access to MIBs can be checked using snmpconfig --show mibcapability command as follows:
snmpconfig -snmpconfig --show snmpv3 shows the configured user with auth and priv protocol.
snmpconfig-show accesscontrol shows access list configuration.
snmpconfig --set accesscontrol asks prompts to update accesscontrol list and add collector IP or subnet.
snmpconfig -show mibcapability must show sw-mib, if-mib, and fcmgmt-mib as enabled.