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
- 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 Collection for Data Protection (Backup)
- Introduction
- Pre-installation setup for ExaGrid
- 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 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
- Appendix F. Load Historic Events
- Load Veritas NetBackup events
- Section X. 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 XI. Data Collection for Fabrics
- Section XII. 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 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
- Configuration 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 HPE StoreOnce
- 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
- 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 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
Modifications for Portal
Following are the steps to perform the portal related modifications:
Portal Modifications
- Create a copy of
/etc/krb5.conf
from KDC to Portal server/etc/krb5.conf
path. - Copy the
keytab
file from KDC to Portal at/etc/v5srvtab
.Note:
The exported keytab file can be removed from KDC once it has been copied to portal server.
For more information, see See Exporting service and user principal's to keytab file on KDC.
- Modify the owner and permission of above copied two files using the following commands:
chown <oracle user>:<oracle group> /etc/krb5.conf /etc/v5srvtab # chmod 444 /etc/krb5.conf /etc/v5srvtab
For example: # chown aptare:dba /etc/krb5.conf /etc/v5srvtab
- Add the following entries to
/opt/aptare/oracle/network/admin/sqlnet.ora
fileSQLNET.AUTHENTICATION_SERVICES=(BEQ,KERBEROS5)
SQLNET.AUTHENTICATION_KERBEROS5_SERVICE=scdb
SQLNET.KERBEROS5_CONF=/etc/krb5.conf
SQLNET.KERBEROS5_CONF_MIT=TRUE
SQLNET.KERBEROS5_REALMS=/etc/krb5.conf
SQLNET.KERBEROS5_KEYTAB=/etc/v5srvtab
SQLNET.FALLBACK_AUTHENTICATION=TRUE
SQLNET.KERBEROS5_CC_NAME=/tmp/kcache
SQLNET.KERBEROS5_CLOCKSKEW=300
- Modifications in the property file is required because when JDBC try to make multiple connections to Oracle DB, Oracle application treats this as a replay attack and errors out.
To avoid the error, ensure that the [libdefaults] section in the Kerberos configuration file /etc/krb5.conf on KDC and client machine is configured forwardable = false.
To update, restart kdc and admin service on KDC server using the following commands:
systemctl restart krb5kdc.service
systemctl restart kadmin.service
- Create cache file for portal user.
For example, the command to generate cache file: kinit -k -t <Key Tab File> <kerberos user@domain realm name> -c <cache file name>
kinit -k -t <Key Tab File> <kerberos user name>@<domain realm name> -c <cache file name> # su - aptare (login as oracle user) # kinit -k -t /etc/v5srvtab k1portal@EXAMPLE.COM -c /tmp/portal_kcache;
- Tomcat user must have read privileges to the cache file. To ensure that the Tomcat OS user is able to make a JDBC connection to Oracle DB, use the following commands:
. # chown <portal user>:<portal group> /tmp/portal_kcache; # chmod 444 /tmp/portal_kcache;
For example: chown aptare:aptare /tmp/portal_kcache;
- The following properties must be added or updated in
/opt/aptare/portalconf/portal.properties
db.url=jdbc:oracle:thin:@(DESCRIPTION=
(ADDRESS=(PROTOCOL=tcp)(HOST=localhost)
(PORT=1521))(CONNECT_DATA=(SERVICE_NAME=scdb)))
Host and Service name could be different here.
db.user=<kerberos user name>@<domain realm name>
For example: db.user=k1portal@EXAMPLE.COM Combination of kerberos portal user name and domain realm name
db.auth.scheme=kerberos
This property must be defined to enable kerberos authentication and is case-insensitive
db.kerberos.keytab.path=/etc/v5srvtab
This is absolute path of keytab file
db.driver=oracle.jdbc.OracleDriver
db.kerberos.portal_kcache.path=/tmp/portal_kcache
This is absolute path of portal user cache file
db.connection.max=25
db.connection.min=25
db.connection.expiration=5
- Similar changes are required in the Data-receiver property file
/opt/aptare/datarcvrconf/datrarcvrproperties.xml
.Add or updated the bold perperties.
<dataSource> <Driver> oracle.jdbc.driver.Oracle</Driver> <URL>jdbc:oracle:thin:@(DESCRIPTION=(ADDRESS=(PROTOCOL=tcp) (HOST=localhost)(PORT=1521))(CONNECT_DATA=(SERVICE_NAME=scdb)))</URL> <UserId><kerberos user name>@<> <domain realm name></UserId> For example: <UserId>k1portal@EXAMPLE.COM</UserId> <Password>Z0Q5W+lQD2jreQaLBoYsviYO21WGOq5iTEo0Ad2uUj/e0GtqPkOtXFblKxCse KXO4VhpIQwwfrSfe59nGy156DV8lYoa7HWmL0hF+kAZXOoXfIN5YRAGfqDbCwrKQdtPY7pQh uTkZMPLl0d9Kzy6sLGMb/33L4hKuEl0ZZN2FG5US26JZ/uSOBF7T69ppqxGqXMleZ19QBcv UElLwJTn52SurL+K3RjCY7Xi0VJb4wLkax07xCkpSK9dJ6NMFJS3ybWP4jNs3rC3roudZak8 wGqLNhAacyXgW4pMpgigVjGwNr0N8rJIgcGmXgAxSNs0qmQItuXPIyqGf+nWWEfScQ== </Password> <oracle_service_name>scdb</oracle_service_name> <ro_user>aptare_ro</ro_user> <ro_password>U9a7a+af94q0CUaIfzaVmYl1P1DhdQW96CQiYWgxUGSV5sfVVsxoWF5Riy V85MD8V0Ogy7UJo1sFmAL36KjDy8LA61pKeO4X39hRK/g8vvl/xNnG5bBYIF04/1LwD2FTz 0lJERWopKVZ6pd6TkT0mGeKrnu2oYi97GtlW4J73tPGTFRhHyVw7yZKMmaxbs/FBwrz5aIf je3rT0w85m7Obtrjf2nJ2HjsaHnmToh0Ua96xlshjrE75UbaLMu0QEcF3PYF3qufYVIegn 4VGSHcpsU/AFzurKpr0JTsU/6VqvdE4veBLv4FH5D05bRetaOA0SGKCazWA50 xiirwocvgyw== </ro_password> <MaxConnections>125</MaxConnections> <MinConnections>5</MinConnections> <ConnExpirationTime>5</ConnExpirationTime> <authScheme>kerberos</authScheme> <portalKcacheFile>/tmp/portal_kcache</portalKcacheFile> <kKeyTabFile>/etc/v5srvtab</kKeyTabFile> </dataSource>
The following are the steps to be performed before the upgrade.
Provide dba grant to Kerberos portal user.
# su - aptare ( login as Oracle service user)
# sqlplus / as sysdba SQL> alter session set container=scdb; SQL> GRANT DBA TO k1portal; SQL> GRANT EXECUTE ON SYS.DBMS_JOB TO k1portal; SQL> GRANT EXECUTE ON SYS.DBMS_LOB TO k1portal; SQL> GRANT EXECUTE ON SYS.DBMS_SCHEDULER TO k1portal; SQL> GRANT SELECT ON DBA_OBJECTS TO k1portal;
Ensure portal cache file is valid and Tomcat user must have read permission.
# chmod 444 /tmp/portal_kcache; chown <portal user>:<portal group> /tmp/portal_kcache
For example:# chown aptare:aptare /tmp/portal_kcache
The following are the steps to be performed after the upgrade.
Revoke DBA role and grant a specific list of privileges to Kerberos users after a successful upgrade. k1portal is the Kerberos username here. It can be varied from environment to environment.
Under sys user performs below revoke tasks:
# su - aptare (login as oracle user)
# sqlplus "/ as sysdba" SQL> alter session set container=scdb; Session altered. SQL> REVOKE DBA FROM k1portal; Revoke succeeded.
Again under sys user runs individual PLSQL scripts to grant a list of required privileges to Kerberos-enabled users for the normal functioning of ITA application.
Ensure that the correct Kerberos username is given as arguments to the script.
# su - aptare
sqlplus "/ as sysdba" SQL> alter session set container=scdb; SQL> @/opt/aptare/database/ora_scripts/kerberos_grants_portal.plb; Enter value for db_object_schema: portal Enter value for kerberos_schema: k1portal SQL> @/opt/aptare/database/ora_scripts/ metadata_grants_to_kerberos_user.plb Enter value for kerberos_user_name: k1portal SQL> exit;
Restart tomcat-portal and tomcat-agent and verify NBU ITA portal.
/opt/aptare/bin/tomcat-portal restart /opt/aptare/bin/tomcat-agent restart
Note:
Kerberos cache file should not be expired, Tomcat and Aptare users must have access to the cache file, for this add a script in crontab to re-generate cache file as below :
# cat krb_cache_refresh.sh su - aptare (login as oracle user) okinit -k -t /etc/v5srvtab k1portal kinit -k -t /etc/v5srvtab k1portal@EXAMPLE.COM -c /tmp/portal_kcache chmod 444 /tmp/portal_kcache; chown <portal user>:<portal group> /tmp/portal_kcache
For example: chown aptare:aptare /tmp/portal_kcache