NetBackup IT Analytics Help
- Section I. Introducing NetBackup IT Analytics
- Section II. What's New
- Section III. Certified configurations
- Introduction
- Portal and database servers
- Data Collector server configurations
- Capacity Manager configurations
- Array/LUN performance Data Collection
- EMC Isilon array performance metrics
- NetApp Cluster-Mode performance metrics
- EMC Symmetrix enhanced performance metrics
- Host access privileges, sudo commands, ports, and WMI proxy requirements
- Cloud configurations
- Virtualization Manager configurations
- File Analytics configurations
- Fabric Manager configurations
- Backup Manager configurations
- ServiceNow configurations
- Internal TCP port requirements
- Section IV. End user
- Understand the portal
- About the Admin tab
- Explore your inventory
- Hierarchy toolbar to organize your data
- Show objects
- Use attributes to organize your data
- Pin reports - saving reports with inventory objects
- Assign attributes in the inventory list view
- Get acquainted with reports
- About badging
- Generate and maintain reports
- Select Report Scope
- Group hosts by attributes
- Search for hosts in the report Scope Selector
- Backup Manager advanced scope selector settings
- Solution reports scope selector settings
- Units of Measure in Reports
- Customize report filter logic
- Sort columns in reports
- Convert tabular report to chart
- Distribute, share, schedule, and alert
- Schedule export of reports and dashboards
- Organize reports
- Work with the dynamic template designer
- Dynamic Template Designer Quick Start
- Converting to a Homogeneous, Product-Specific Template
- Dynamic Template Function Configurations
- Create Fields with the Field Builder
- Scope Selector Component - Custom Filter
- Configure a Bar Chart Dynamic Template
- Steps to Create a Bar Chart Dynamic Template
- Configure an Area/Stacked Area Chart Dynamic Template
- Line Charts for Performance Metrics
- Line Chart Field Requirements
- One Object Per Line Chart, One or More Metrics Per Chart
- Multiple Objects Per Line Chart, One Metric Per Chart
- Example of a Stacked Bar Chart Dynamic Template
- Create a Sparkline Chart in a Tabular Dynamic Template
- Adding or Editing Methods
- Validate and Save a Method
- Work with the SQL template designer
- Configure SQL Template Scope Selector Components
- Sample SQL Queries
- Number, Size, Date, and Time Formatting
- Alignment, Aggregation, Bar Type, and Bar Type Color
- Pipelined functions for report query building
- APTlistOfDates
- aptStringConcat
- getServerAttributeValue
- getObjectAttributeValue
- getChildServerGroupContextById
- getServerGroupContextById
- secsToHoursMinSecs
- APTgetTapeDriveStatusName
- getFullPathname
- listJobSummaryAfterRestart
- listJobSummaryAfterRestartNBW
- listJobSummaryAfterRestart for NetWorker Backup Jobs
- listOfBackupWindowDates
- listChargebackCatByVOLSDetail
- listChargebackCatByNcVolDetail
- listChargebackCatByFSDetail (for HNAS)
- listChargebackCatByFSDetail (for EMC Isilon)
- listChargebackByLUNSummary
- listChargebackByLUNDetail
- listChargebackCatByLUNSummary
- listChargebackCatByLUNDetail
- Alert configuration
- Add/Edit an Alert Policy
- About using SNMP
- Manage hosts, backup servers, and host groups
- NetBackup Primary Servers
- Manage attributes and objects
- Provide Portal access and user privileges
- Setting / Resetting passwords
- Managing user group home pages (Administrator)
- Configure primary schedules and backup windows
- Add, edit, and move policies
- Solutions administration
- Manage and monitor data collection
- About data collection tasks
- Add/Edit Data Collectors
- Review collectors and collection status
- Upgrade Data Collectors
- Work with Capacity Manager host data collection
- Host access requirements
- Manage credentials
- Configure host discovery policies to populate the host discovery and collection view
- Validate host connectivity
- Search and export in host discovery and collection
- Propagate probe settings: Copy probes, paste probes
- Discovery policies for Veritas NetBackup
- View and manage system notifications
- Customize with advanced parameters
- Access control advanced parameters
- General Data Collection advanced parameters
- Cloud data collection advanced parameters
- Host discovery and collection advanced parameters
- Backup Manager advanced parameters
- Capacity Manager advanced parameters
- File Analytics advanced parameters
- Virtualization Manager advanced parameters
- Manage your Portal environment
- Manage ransomware scorecard
- Analyze files
- Troubleshoot the Portal
- Retrieving log files
- Debug
- Attribute inheritance overrides
- Understand report data caching
- Understand the portal
- Section V. Report Reference
- Introduction to NetBackup IT Analytics
- Alert Reports
- Ransomware reports
- Risk Mitigation Solution Reports
- Risk Mitigation Reports
- Storage Optimization Solution Reports
- System Administration Reports
- Oracle Job Overview
- Capacity Manager Reports
- Application Capacity Reports
- Array Capacity Utilization Reports
- Array Capacity & Utilization (Generic Data)
- Array Capacity & Utilization (IBM SVC View)
- Array Capacity and Utilization (IBM XIV View)
- Array Capacity and Utilization (NetApp View)
- Array Capacity and Utilization (NetApp Cluster)
- NetApp Storage System Detail
- Array Capacity and Utilization (OpenStack Swift)
- IBM Array Site Summary
- IBM Array Detail
- LUN Utilization Summary
- NetApp Aggregate Detail
- NetApp Cluster-Mode Aggregate Detail
- NetApp Plex Details
- NetApp Volume Details
- NetApp Cluster-Mode Volume Detail
- NetApp StorageGrid Tenant Summary
- Available/Reclaimable Capacity Reports
- Capacity at Risk Reports
- Capacity Chargeback Reports
- Host Capacity Utilization Reports
- SnapMirror Reports
- SnapVault Reports
- Capacity Forecasting Reports
- Storage Performance Reports
- Mission Control for Performance Analysis
- Thin Provisioning Reports
- Hitachi Dynamic Provisioning Pool Utilization
- File Analytics Reports
- Virtualization Manager Reports
- Understanding the Datastore
- VM Server Detail
- VM Snapshot Summary
- VM Detail
- Datastore Utilization Summary
- Datastore Detail
- Fabric Manager Reports
- Host to Storage Dashboard
- Backup Manager Management Reports
- Error Log Summary
- Job Duration Report
- Veeam Backup & Replication Job Summary Report (Homogeneous)
- Veeam and RMAN Job Details Report
- Adding a Note to a Job
- Job Volume Summary Report
- NetBackup deduplication to MSDP savings
- Backup Administration Reports
- Host Details
- IBM Spectrum Protect (TSM) Storage Pools Dashboard
- Job Histogram
- EEBs on Primary server, Media server and Clients reports
- Backup Media Management Reports
- TSM Tape Media Detail Table
- Backup Service Level Agreement (SLA) Reports
- Determining and Improving Backup Start Time Performance
- Determining and Improving Backup Success Performance
- Determining and Improving Backup Duration Performance
- Backup Storage Utilization Reports
- Backup Manager Forecasting Reports
- Backup Billing and Usage Reports
- Backup Policies Reports
- HP Data Protector Backup Specification Detail
- Public Cloud Reports
- AWS Reports
- Microsoft Azure Reports
- Section VI. NetBackup IT Analytics Exporter Installation and Configuration
- Section VII. Data Collector Installation and Troubleshooting
- Installing the Data Collector Software
- Validating Data Collection
- Uninstalling the Data Collector
- Manually Starting the Data Collector
- Data Collector Troubleshooting
- Host resources: Check host connectivity using standard SSH
- Host resources: Generating host resource configuration files
- Configuring parameters for SSH
- CRON Expressions for Policy and Report Schedules
- Clustering Data Collectors with VCS and Veritas NetBackup (RHEL 7)
- Clustering Data Collectors with VCS and Veritas NetBackup (Windows)
- Install and configure NetBackup IT Analytics Data Collector on MSCS environment
- Maintenance Scenarios for Message Relay Server Certificate Generation
- Installing the Data Collector Software
- Section VIII. Data Collector Installation and Configuration for Cohesity NetBackup
- Introduction
- Configure a NetBackup IT Analytics Distributed Data Collector on a NetBackup Primary Server
- Configure Data Collector on non-clustered NetBackup 10.4 and later primary server
- Configure Data Collector on non-clustered NetBackup 10.1.1, 10.2, 10.2.01, 10.3 or 10.3.0.1 primary server
- Configure a Veritas NetBackup Data Collector Policy
- Configuring file analytics in NetBackup Data Collector policy
- Installing the Data Collector software
- Configure SSL
- Centralized Data Collector for NetBackup - Prerequisites, Installation, and Configuration
- Step-1: Choose operating system and complete prerequisites
- Step-5: SSH/WMI
- Upgrading Data Collector Locally
- Clustering Data Collectors with VCS and Veritas NetBackup (RHEL)
- Clustering Data Collectors with VCS and Veritas NetBackup (Windows)
- Install and Configure NetBackup IT Analytics Data Collector on MSCS
- Data Collector Policy Migration
- Pre-Installation setup for Veritas NetBackup appliance
- Pre-installation setup for Veritas Flex Appliance
- Data Collector Troubleshooting
- Host resources: Check host connectivity using standard SSH
- Host resources: Generating host resource configuration files
- Configuring parameters for SSH
- Appendix B. Configure Appliances
- Appendix C. Firewall configuration: Default ports
- Appendix D. CRON Expressions for Policy and Report Schedules
- Appendix E. Maintenance Scenarios for Message Relay Server Certificate Generation
- Section IX. Data Collector Installation and Configuration
- Introduction
- Install and configure a Data Collector
- Step-1: Choose operating system and complete prerequisites
- Installing the Data Collector software
- Configure SSL
- Section X. Data Protection
- Configuration for Veritas Backup Exec
- Configuration for Cohesity DataProtect
- Configuration for Commvault Simpana
- Open TCP/IP access to the Commvault database
- Set up a read-only user in the CommServe server
- Configuration for EMC Avamar
- Import EMC Avamar server information
- Configuration for EMC Data Domain backup
- Configuration for Dell EMC NetWorker backup & recovery
- Importing generic backup data
- Configuration for generic backup
- CSV format specification
- Configuration for HP Data Protector
- Architecture overview (HP Data Protector)
- Configure the Data Collector server in Cell Manager (HP Data Protector)
- Configuration for IBM Spectrum Protect (TSM)
- Architecture overview (IBM Spectrum Protect -TSM)
- Import IBM Spectrum Protect (TSM) information
- Configuration for NAKIVO Backup & Replication
- Configuration for Oracle Recovery Manager (RMAN)
- Configuration for Rubrik Cloud Data Management
- Configuration for Veeam Backup & Replication
- Appendix F. Load historic events
- Load Veritas NetBackup events
- Configuration for Veritas Backup Exec
- Section XI. Storage (Capacity)
- Configuration for Compute Resources
- Configuration for DELL EMC Elastic Cloud Storage (ECS)
- Configuration for Dell EMC Unity
- 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
- Configuring a Hitachi Device manager user
- Configuration for Hitachi Content Platform (HCP)
- 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
- Configure host Discovery policies to populate the host Inventory
- Validate host connectivity
- Host Inventory search and host Inventory export
- 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 XII. Compute (Virtualization and Host Collection)
- Configuration for VMware
- Configuration for IBM VIO
- Configuration for Microsoft Hyper-V
- Section XIII. Cloud
- Configuration for Amazon Web Services (AWS)
- Mandatory probe user privileges
- Link AWS accounts for Collection of consolidated billing data
- Configuration for Google Cloud Platform
- Configuration for OpenStack Ceilometer
- Configuration for OpenStack Swift
- Configuration for Microsoft Azure
- Configuration for Amazon Web Services (AWS)
- Section XIV. Fabric
- Configuration for Brocade switch
- Configuration for Cisco switch
- Configuration for Brocade Zone alias
- Configuration for Cisco Zone alias
- Configuration for Brocade switch
- Section XV. File Analytics
- Configuration for File Analytics
- Host Discovery and Collection File Analytics probe
- Adding a File Analytics Data Collector policy
- File Analytics Export Folder Size and Folder Depth
- Configuration for File Analytics
- Section XVI. Data Collection Validation and Troubleshooting
- Validate data collection
- Data Collector Troubleshooting
- Host resources: Check host connectivity using standard SSH
- Host resources: Generating host resource configuration files
- Configuring parameters for SSH
- Uninstalling the Data Collector
- Section XVII. System Administration
- Preparing for Updates
- Backing Up and Restoring Data
- Monitoring NetBackup IT Analytics
- Accessing NetBackup IT Analytics Reports with the REST API
- Defining NetBackup Estimated Tape Capacity
- Automating Host Group Management
- Categorize host operating systems by platform and version
- Load relationships between hosts and host group
- Automate NetBackup utilities
- Scheduling utilities to run automatically
- Attribute Management
- Importing Generic Backup Data
- Backup Job Overrides
- Managing Host Data Collection
- System Configuration in the Portal
- Custom parameters
- Performance Profile Schedule Customization
- LDAP and SSO authentication for Portal access
- Changing Oracle Database User Passwords
- Integrating with CyberArk
- Tuning NetBackup IT Analytics
- Defining Report Metrics
- Working with Log Files
- Portal and data collector log files - reduce logging
- Data collector log file naming conventions
- Portal log files
- SNMP Trap Alerting
- SSL Certificate Configuration
- Configure virtual hosts for portal and / or data collection SSL
- Keystore on the portal server
- Portal Properties: Format and Portal Customizations
- Data Retention Periods for SDK Database Objects
- Data aggregation
- Troubleshooting
- Appendix G. Kerberos based proxy user's authentication in Oracle
- Appendix H. Configure TLS-enabled Oracle database on NetBackup IT Analytics Portal and data receiver
- Appendix I. NetBackup IT Analytics for NetBackup on Kubernetes and appliances
- Section XVIII. Licensing
- License installation and guidelines
- License overview
- Verify the current license configuration
- Storage suite
- Protection suite
- Backup Manager
- Backup Manager
- Complete suite
- Managing licenses
- Configure the Data Collector policy to exclude the object
- License management from the command line
- Troubleshooting
- License installation and guidelines
- Section XIX. Inventory reports and operations
- Section XX. OpsCenter Transition
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 Collection method:
is selected forA 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 Collection method:
option is selected forSame 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 Collection method. This method is supported for Brocade Switch FOS version 7.4.2 and later.
option ofThe 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 -show
Minimum 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.