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
- 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
- Scheduling Exported 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
- 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
- Add/Edit a threshold policy
- Capacity Chargeback policy types
- 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 and Probe 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 Collection for the Cloud
- Pre-Installation Setup for Amazon Web Services (AWS)
- Link AWS accounts for Collection of consolidated billing data
- Pre-Installation Setup for OpenStack Ceilometer
- Pre-Installation Setup for OpenStack Swift
- Pre-Installation Setup for Microsoft Azure
- Google Cloud Platform (GCP)
- Pre-Installation Setup for Amazon Web Services (AWS)
- Section IX. Data Collection for Data Protection (Backup)
- Introduction
- Pre-Installation setup for Commvault Simpana
- Open TCP/IP access to the Commvault database
- Set up a read-only user in the CommServe server
- Pre-Installation setup for Cohesity DataProtect
- Pre-Installation setup for EMC Avamar
- Import EMC Avamar server information
- Pre-Installation setup for EMC Data Domain Backup
- Pre-Installation setup for EMC NetWorker
- Architecture overview (EMC NetWorker)
- Pre-Installation setup for Dell EMC NetWorker Backup & Recovery
- Pre-Installation setup for generic backup
- CSV format specification
- Pre-Installation setup for HP Data Protector
- Architecture overview (HP Data Protector)
- Configure the Data Collector server in Cell Manager (HP Data Protector)
- Pre-Installation setup for IBM Spectrum Protect (TSM)
- Architecture overview (IBM Spectrum Protect -TSM)
- Import IBM Spectrum Protect (TSM) information
- Pre-Installation setup for IBM Spectrum Protect Plus
- Pre-Installation setup for NAKIVO Backup & Replication
- Pre-Installation setup for Veritas Backup Exec
- Pre-Installation setup for Veritas NetBackup
- Prerequisites to use SSH and WMI (Veritas NetBackup)
- Prerequisites for NetBackup collection over SSH (Kerberos option)
- Veritas NetBackup 8.1 (or later) requirements for centralized collection
- Configuring file analytics in NetBackup Data Collector policy
- Pre-Installation setup for Oracle Recovery Manager (RMAN)
- Pre-Installation setup for Rubrik Cloud Data Management
- Pre-Installation setup for Veeam Backup & Replication
- Discovery policies for Veritas NetBackup
- About Discovery types
- About SNMP probes
- Appendix B. Load Historic Events
- Load Veritas NetBackup events
- Section X. Data Collection for Fabrics
- Section XI. Data Collection for File Analytics
- Pre-Installation Setup 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
- Pre-Installation Setup for File Analytics
- Section XII. Data Collection for Replication
- Section XIII. Data Collection for Storage (Capacity)
- Data Collection for Capacity Overview
- Pre-Installation setup for Compute Resources
- Pre-Installation Setup for Dell Compellent
- Pre-Installation Setup for DELL EMC Elastic Cloud Storage (ECS)
- Pre-Installation Setup for EMC Data Domain Storage
- Pre-Installation Setup for EMC Isilon
- Pre-Installation Setup EMC Symmetrix
- Pre-Installation Setup for Dell EMC Unity
- Pre-Installation Setup for EMC VNX Celerra
- Pre-Installation Setup for EMC VNX CLARiiON
- Pre-Installation Setup for EMC VPLEX
- Pre-Installation Setup for EMC XtremIO
- Pre-Installation Setup for Hitachi Block
- Configuring a Hitachi Device manager user
- Pre-Installation Setup for Hitachi Content Platform (HCP)
- Hitachi content platform system management console
- Hitachi content platform tenant management console
- Pre-Installation Setup Hitachi NAS
- Pre-Installation Setup for Hitachi Vantara All-Flash and Hybrid Flash Storage
- Host Inventory Pre-Installation Setup
- 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
- Pre-Installation Setup for HP 3PAR
- Pre-Installation Setup for HP EVA
- Pre-Installation setup for HPE Nimble Storage
- Pre-Installation Setup for IBM COS
- Pre-Installation Setup for IBM Enterprise
- Pre-Installation Setup for NetApp E-Series
- Pre-Installation Setup for IBM SVC
- Pre-Installation Setup for IBM XIV
- Pre-installation setup for FUJITSU Data Collector
- Pre-Installation Setup for NetApp-7
- Pre-Installation setup for NetApp StorageGRID
- Pre-Installation Setup for Microsoft Windows Server
- Pre-Installation Setup for NetApp Cluster
- Pre-Installation Setup for Pure Storage FlashArray
- Pre-installation setup for Veritas Flex Appliance
- Pre-Installation Setup for Veritas NetBackup Appliance
- Pre-Installation setup for NEC HYDRAstor
- Section XIV. Data Collection for Virtualization
- Pre-Installation setup for VMware
- Pre-Installation setup for IBM VIO
- Pre-Installation setup for Microsoft Hyper-V
- Section XV. 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
- Configuring AD/LDAP
- Configuring Single Sign On (SSO) Using Security Assertion Markup Language (SAML)
- 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 C. Kerberos-based authentication for Oracle
- Appendix D. Configure TLS-enabled Oracle database on NetBackup IT Analytics Portal and data receiver
- Section XVI. 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 XVII. Inventory reports and operations
- Section XVIII. OpsCenter Transition
Add a Veritas Flex Appliance policy
Before adding the policy: A Data Collector must exist in the Portal, to which you will add Data Collector Policies.
For specific prerequisites and supported configurations for a specific vendor, see the NetBackup IT Analytics Certified Configurations Guide.
After adding the policy: For some policies, collections can be run on-demand using the Run button on the Collector Administration page action bar. The Run button is only displayed if the policy vendor is supported.
On-demand collection allows you to select which probes and devices to run collection against. This action collects data the same as a scheduled run, plus logging information for troubleshooting purposes. For probe descriptions, refer to the policy.
The data collection form the appliances depends on the availability of the components that expose the appliance stats to the policy probes. The data collection supported for each Flex Appliance version is as indicated below. You need to create an RTD report to view the data. Collection is performed via REST APIs exposed by the Flex Appliance.
To add the policy
- Select Admin > Data Collection > Collector Administration. Currently configured Portal Data Collectors are displayed.
- Search for a collector if required or select a Data Collector from the list.
- Click Add Policy, and then select Veritas Flex Appliance entry in the menu.
- Enter or select the parameters. Mandatory parameters are denoted by an asterisk (*):
Field
Description
Collector Domain
The domain of the collector to which the collector backup policy is being added. This is a read-only field. By default, the domain for a new policy will be the same as the domain for the collector. This field is set when you add a collector.
Policy Domain
The domain of the policy that is being configured for the Data Collector. The Policy Domain must be set to the same value as the Collector Domain. The domain identifies the top level of your host group hierarchy. All newly discovered hosts are added to the root host group associated with the Policy Domain.
Typically, only one Policy Domain will be available in the drop-down list. If you are a Managed Services Provider, each of your customers will have a unique domain with its own host group hierarchy.
To find your Domain name, click your login name and select My Profile from the menu. Your Domain name is displayed in your profile settings.
Add
Click to add a Veritas Flex Appliance to the policy. Provide valid Appliance Address, User ID, and Password for a successful connection.
Appliance Address*
Fully qualified domain name (FQDN) of the Veritas Flex Appliance. This FQDN enables the policy to collect from all the appliance nodes that are up-and-running. The data persisted is distinguished by the node ID as registered on the appliance.
Note:
Flex appliance connector supports only FQDN in Appliance Address.
Username*
Username required to access the Flex Appliance.
Password*
Password required to access the Flex Appliance.
Appliance Details
Collects hardware and software details of Flex Appliance added in the policy. The collected details include:
For appliance: appliance name, UUID, appliance type, and more.
For node: Node name, serial number, firmware version, Flex version and so on.
The probe is selected by default and has a default schedule and its data collection is independent of other probes, irrespective of the data and the execution order.
Performance Statistics
Collects resource utilization and performance statistics from each appliance node and the containers running on the Flex Appliance. The data is collected for each container and is segregated on the basis of appliance and host node on which the container is running. You must create custom reports to view the collection from the nodes and containers.
Note:
Flex v3.0 supports per user active session limited to 10 sessions. Veritas recommends to create a dedicated user for ITA Flex Appliances policy and utilize those credentials for data collection.
Note:
In Flex v3.0, container metrics are restricted due to vulnerabilities in cAdvisor exporter. For this reason, Performance Probe will only collect node metrics from flex appliance with flex version 3.0. No data will be available for container metrics
Storage statistics
Collects storage utilization specific to the entire Flex Appliance, irrespective of its nodes. Collection is performed via REST APIs exposed by the Flex Appliance.
Schedules
By default, collection for Performance Statistics is run performed every 5 minutes and for Storage Statistics, collection is performed daily at 03:33 hours.
Click the clock icon to create a schedule.
Every Minute, Hourly, Daily, Weekly, and Monthly schedules may be created. Advanced use of native CRON strings is also available.
Examples of CRON expressions:
*/30 * * * * means every 30 minutes
*/20 9-18 * * * means every 20 minutes between the hours of 9am and 6pm
*/10 * * * 1-5 means every 10 minutes Mon - Fri.
Note:
Explicit schedules set for a Collector policy are relative to the time on the Collector server. Schedules with frequencies are relative to the time that the Data Collector was restarted.
Notes
Enter or edit notes for your data collector policy. The maximum number of characters is 1024. Policy notes are retained along with the policy information for the specific vendor and displayed on the Collector Administration page as a column making them searchable as well.
Test Connection
Test Connection initiates a Data Collector process that attempts to connect to all the appliances added to the policy using the FQDN and credentials supplied in the policy. Agent Services must be running for the Test Connection to succeed.
Several factors affect the response time of the validation request, causing some requests to take longer than others. For example, there could be a delay when connecting to the subsystem. Likewise, there could be a delay when getting the response, due to other processing threads running on the Data Collector.
You can also test the collection of data using the Run functionality available in Admin > Data Collection > Collector Administration. This On-Demand data collection run initiates a high-level check of the installation at the individual policy level, including a check for the domain, host group, URL, Data Collector policy and database connectivity. You can also select individual probes to test the collection run.
- Click OK to save the policy configuration.
Note:
Do not delete the swap directory (
<APTARE_HOME>\mbs\swap\veritas\flexappliance
) from the data collector server as it is used by the Veritas Flex Appliance policy.
The data collected from Flex Appliances is visible in the Host CPU Utilization, Host Memory Utilization, and Host Network Packets Sent/Received reports. See NetBackup IT Analytics Report Reference Guide for more information on the reports.