NetBackup IT Analytics Help
- Section I. Introducing NetBackup IT Analytics
- Section II. What's New
- Enhancements in NetBackup IT Analytics
- Enhancements in NetBackup IT Analytics
- 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
- Configuration of Dell EMC PowerProtect Data Manager (PPDM)
- 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
System Methods
The following methods are packaged with the system, for use in the Dynamic Template Designer.
System Method | Vendor Product | Description |
---|---|---|
Methods: Job Enterprise Object | ||
Backup Window | All Supported Backup Products | Returns the start and finish dates in a backup window. |
Client Last Backup Job Info | All Supported Backup Products | Returns the finish date and the corresponding job IDs of the most recent full or incremental backup jobs that are in a successful or partial state. The data returned is per client. This is a stand-alone function and cannot be used in combination with other objects or functions. |
CommVault Backup Copy Info | CommVault Simpana | Returns the minimum Backup Copy Identifier for a given CommVault Simpana job. |
Commvault Job Attempts | CommVault Simpana | Returns Simpana backup jobs and try count for a client list for CommVault Simpana jobs. |
CommVault Running and Queued Job Count | CommVault Simpana | Returns the count of CommVault Simpana backup jobs that are in the running state in the last 90 days. The counts returned are per server. |
Data Domain Last Backup Job Info | Data Domain | Returns the details for Data Domain backup jobs. The data returned is per client and logical storage unit. |
Disk and Tape Usage Summary | All Supported Backup Products | For the most recent successful or partial job, this method returns the finish date, corresponding job ID, number of kilobytes saved in tape media, number of kilobytes saved in disk media, number of files saved in tape media and number of files saved in disk media. The data returned is per server, client, product type and job type. |
Failed Backup Job Detail | All Supported Backup Products | For the failed backup jobs within the selected, required time period, this method returns the following data on a per-client basis: client ID, along with its corresponding job ID, the count of failed backups, and the date of the last failed backup job. |
Failed Full Backup Job Detail | All Supported Backup Products | For the failed full backup jobs within the selected, required time period, this method returns the following data on a per-client basis: client ID, along with its corresponding job ID, the count of failed full backups and the last failed full backup date. |
HP DP Session Tape Media List | HP Data Protector | For any HP Data Protector (HP DP) session, this method returns a comma-separated list of the tape media associated with the job. The data will be returned in the following format: id1,name1|id2|name2. The IDs can be used for report drilldowns. |
Job Tape Media List | All Supported Backup Products | For any successful or partial job, this method returns a comma-separated list of the tape media associated with the job. This method returns the tape media list if the job's status is success or warning. |
NetBackup Job Error Msg | Veritas NetBackup | Relevant only for NetBackup. It returns the error message if either the job or its parent job is in an error state. |
NetBackup Job Tape Media List | Veritas NetBackup | Relevant only for NetBackup. For any successful or partial NetBackup job, this method returns a comma-separated list of the tape media associated with the job. This method returns the tape media list if the job or its parent job's status is success or warning. |
NetBackup Running and Queued Job Count | Veritas NetBackup | Relevant only for NetBackup. The method returns the number of jobs that are in the running state and the number of jobs in the queued state. The counts returned are per backup server. |
NetBackup Running Job Info | Veritas NetBackup | Relevant only for NetBackup. The method returns a value of 1 if a NetBackup job is long-running, slow-running, or stalled, based on the policies that are configured for a host group. |
NetWorker Running Job Count | EMC NetWorker | Relevant only for EMC NetWorker. The method returns the number of backup jobs in a running state. The data returned is per NetWorker server. |
NetWorker Running Job Info | EMC NetWorker | Relevant only for EMC NetWorker. The method returns a value of 1 if a NetWorker job is long-running, slow-running, or stalled, based on the policies that are configured for a host group. |
Restore Successful Job Detail | All Supported Backup Products | For successful restore jobs within the selected, required time period, this method returns the following data on a per-client basis: client ID, along with its corresponding job ID, the count of successful restore jobs, the number of files restored, and the last successful restore date. |
Successful Backup Job Detail | All Supported Backup Products | For the successful full and partial backup jobs within the selected, required time period, this method returns the following data on a per-client basis: client ID along with its corresponding job ID, the count of the number of successful backups, the last successful backup date, amount of data (in MB) saved to tape media, and the amount of data (in MB) saved to disk media. |
Successful Full Backup Job Detail | All Supported Backup Products | For the successful full backup jobs within the selected, required time period, this method returns the following data on a per-client basis: client ID along with its corresponding job ID, the count of the number of successful full backups, the last successful full backup date, amount of data (in MB) saved to tape media, and the amount of data (in MB) saved to disk media. |
Methods: Data Domain Enterprise Object | ||
Data Domain Filesystem Capacity | Data Domain | This method returns total and used filesystem capacities at the Data Domain system level. Requirement: When using this method in a template, the Scope Selector must have the Filesystem Names component selected. |
Data Domain Raw Capacity | Data Domain | Returns raw capacities at the Data Domain system level. Use this method to include the total raw capacity in a report template. |
Data Domain Tape Capacity | Data Domain | Returns tape capacities at the Data Domain system level. Use this method in a report template to display the total tape capacity, as well as the total used tape capacity. |
Data Domain VTL Count | Data Domain | Returns the number of virtual tape libraries (VTLs) at the Data Domain system level. Use this method to include a VTL count in a Data Domain report template. |
Methods: Array Enterprise Object | ||
Array Site Disk Info | IBM | Relevant only for IBM Arrays. For each Array Site, the method returns aggregated information from the physical disk. |
Data Mover CPU and Memory Usage | EMC VNX (Celerra) | Returns data only for EMC VNX (Celerra) arrays: Peak CPU Usage Percentage and Peak Memory Usage Percentage for the Movers for the specified arrays. |
LUN Array Group List | All Arrays | Returns a comma-separated Array Group list for each logical unit. |
LUN Array Port WWN List | All Arrays | Returns a comma-separated Array Port WWN list of all logical units. |
Top 10 Tiers Chargeback Capacity | All Arrays | Lists the chargeback capacity per array in kilobytes and the policy name for the top 10 chargeback policies defined in the system. |
Methods: Host Enterprise Object | ||
Analytics Host Summary | File Analytics | Lists a capacity summary for hosts from which file data has been collected. Use this method to get an overview of how devices and volumes are being used, including an indicator of how much is duplicated. |
Methods: Host Enterprise Object | ||
VM CPU Performance Detail | This method returns details about VM CPU Performance, based on the time period or dates selected in the report's scope selector. The VM CPU Performance Summary enables a Storage Administrator to have an at-a-glance look at CPU I/O performance statistics. | |
VM Disk Performance Detail | This method returns details about VM Disk Performance, based on the time period or dates selected in the report's scope selector. The VM Disk Performance details enable a Storage Administrator to have an at-a-glance look at I/O performance statistics for disks. | |
VM Guest Detail | This method returns details about VM Guests. Use this report to find the largest Virtual Machines. This report lists virtual guests/hosts with usage and status information. NOTE: VMTools must be installed to enable collection of the IP address, Host name, mount points, and guest operating system of the VM. | |
VM Memory Performance Detail | This method returns details about VM Memory Performance, based on the time period or dates selected in the report's scope selector. The VM Memory Performance Summary enables a Storage Administrator to have an at-a-glance look at memory I/O performance statistics, | |
VM Server Detail | Use this report to view the list of Virtual Machine Servers, with access to reports that provide details to help you determine what is using the space on a datastore. This report lists ESX servers, one line item for each physical server, with usage and status information. | |
Methods: Host Enterprise Object | ||
Host Zones and Hops Details | Returns the total number of zones and hops for each host within a fabric. | |
Switch and Fabric Name List Details | Returns a comma-separated list of the switch and fabric names associated with a host. | |
Methods: Host Enterprise Object | ||
Filesystem Summary | Use this method to list file system capacity and the most/least used file systems. | |
Hosts At Risk Details | Identifies hosts that require your immediate attention. Hosts at risk are determined by evaluating current and projected usage. | |
Host Utilization Details | Use this method to get an overview of host utilization to determine if there is contention for storage. | |
Over Provisioned Host Details | This method returns details about over-provisioned hosts, based on the time period or dates selected in the report's scope selector. |