Search <book_title>...

NetBackup IT Analytics System Administrator Guide

Last Published: 2025-09-11

Product(s): NetBackup IT Analytics (11.5)

Introduction
1. NetBackup IT Analytics Overview
2. Purpose of this document
Preparing for updates
1. About upgrades and updates
2. Determine the data collector version
3. Data collector updates with an aptare.jar file
4. Manual download of the aptare.jar file
5. Portal updates
Backing up and restoring data
1. Best practices for disaster recovery
2. Oracle database backups
3. File system backups
4. Oracle database: Cold backup
5. Oracle database: Export backups
6. Scheduling the oracle database export
7. Oracle database: On demand backup
8. Restoring the NetBackup IT Analytics system
9. Import the Oracle database
10. Manual steps for database import / export using data pump
Monitoring NetBackup IT Analytics
1. Starting and stopping portal server software
2. Starting and stopping the reporting database
3. Starting and stopping data collectors
4. Monitoring tablespaces
Accessing NetBackup IT Analytics reports with the REST API
1. Overview
2. Authentication for REST APIs
3. Extracting data from tabular reports (with pagination)
4. Exporting reports
5. Exporting custom dashboards
Defining NetBackup estimated tape capacity
1. NetBackup estimated tape capacity overview
2. Estimated capacity notes
3. Updating the estimated capacity table
4. Listing volume pool IDs and media types
Automating host group management
1. About automating host group management
2. Task overview: managing host groups in bulk
3. Preparing to use PL/SQL utilities
4. General utilities
5. Categorize host operating systems by platform and version
  1. Use Regular Expressions to Override or Modify Default Host OS Categorization
  2. Host OS Categorization Default Settings
  3. Utility to Update Host OS Categorizations
  4. Categorize Host Operating Systems On Demand
6. Identifying a host group ID
7. Move or copy clients
8. Organize clients by attribute
9. Move host group
10. Delete host group
11. Move hosts and remove host groups
12. Organize clients into groups by backup server
13. Merge duplicate backup clients
14. Merge duplicate hosts
15. Bulk load utilities
  1. Load host aliases
  2. Load details of new hosts or update existing hosts
  3. Load relationships between hosts and host group
    1. Sample Audit File (output from load_package.loadGroupMemberFile)
16. Veritas NetBackup utilities
17. Automate NetBackup utilities
  1. Scheduling a NetBackup Utility Job to Run Automatically
18. Organize clients into groups by management server
19. Set up an inactive clients group
20. Set up a host group for clients in inactive policies
21. Set up clients by policy
22. Set up clients by policy type
23. IBM Tivoli storage manager utilities
24. Set up clients by policy domain
25. Set up clients by IBM Tivoli storage manager instance
26. Scheduling utilities to run automatically
  1. Sample .sql file (setup_ora_job.sql) to set up an automatic job
27. Host matching identification for single-domain multi-customer environments
Attribute management
1. Attribute bulk load utilities
2. Attribute naming rules
3. Rename attributes before upgrading
4. Load host attributes and values
5. Load attributes and values and assign to hosts
6. Load array attributes and values and assign to arrays
7. Overview of application attributes and values
8. Load application database attributes and values
9. Load MS Exchange organization attributes and values
10. Load LUN attributes and values
11. Load switch attributes and values
12. Load port attributes and values
13. Load Subscription attributes and values
Importing generic backup data
1. About generic backup data collection
  1. Considerations
2. Configuring generic backup data collection
3. CSV Format Specification
  1. EXAMPLE: genericBackupJobs.csv
4. Manually loading the CSV file
Backup job overrides
1. Overview
2. Configure a backup job override
Managing host data collection
1. Identifying hosts by WWN to avoid duplicates
2. Setting a host's priority
3. Determining host ranking
4. Loading host and WWN relationships
5. Loading the host HBA port data
6. Create a CSV file
7. Execute the script
System configuration in the Portal
1. System configuration in the Portal
2. System configuration: functions
3. Navigation overview
4. System configuration parameter descriptions: Additional info
5. Anomaly detection
6. Data collection: Capacity chargeback
7. Database administration: database
8. Host discovery: EMC Avamar
9. Host discovery: Host
10. Events captured for audit
11. Custom parameters
Performance profile schedule customization
1. Overview
2. Customize the performance profile schedule
LDAP and SSO authentication for Portal access
1. Overview
2. Configure AD/LDAP
3. Configure single sign-on (SSO)
4. Enable local authentication
Change Oracle database user passwords
1. Overview
2. Database connection properties
3. Modify the Oracle database user passwords
4. Modify the Oracle database user passwords for split architecture
5. Determine if Oracle is using the default login password
Integrate with CyberArk
1. Introduction
2. CyberArk setup prerequisites
3. Setting up the portal to integrate with CyberArk
Tuning NetBackup IT Analytics
1. Before you begin tuning
2. Tuning the portal database
3. Performance recommendations
4. Reclaiming free space from Oracle
5. Portal / Data receiver Java memory settings
Working with log files
1. About debugging NetBackup IT Analytics
2. Turn on debugging
3. Database logging
4. Portal and data collector log files - reduce logging
  1. Portal Log Files
  2. Data Collector Log Files
5. Database SCON logging - reduce logging
6. Refreshing the database SCON log
7. Logging user activity in audit.log
8. Logging only what a user deletes
9. Logging all user activity
10. Data collector log files
11. Data collector log file organization
12. Data collector log file naming conventions
13. General data collector log files
14. Find the event / meta collector ID
15. Portal log files
  1. Managing Apache Log Files
16. Database log files
17. Installation / Upgrade log files
Defining report metrics
1. Changing backup success percentage
2. Changing job status
SNMP trap alerting
1. Overview
2. SNMP configurations
SSL certificate configuration
1. SSL certificate configuration
2. SSL implementation overview
3. Obtain an SSL certificate
4. Update the web server configuration to enable SSL
5. Configure virtual hosts for portal and / or data collection SSL
6. Enable / Disable SSL for a Data Collector
7. Enable / Disable SSL for emailed reports
8. Test and troubleshoot SSL configurations
9. Create a self-signed SSL certificate
10. Configure the Data Collector to trust the certificate
11. Keystore file locations on the Data Collector server
12. Import a certificate into the Data Collector Java keystore
13. Keystore on the portal server
14. Add a virtual interface to a Linux server
15. Add a virtual / secondary IP address on Windows
Portal properties: Format and portal customizations
1. Introduction
2. Configuring global default inventory object selection
3. Restricting user IDs to single sessions
4. Customizing date format in the report scope selector
5. Customizing the maximum number of lines for exported reports
6. Customizing the total label display in tabular reports
7. Customizing the host management page size
8. Customizing the path and directory for file analytics database
9. Configuring badge expiration
10. Configuring the maximum cache size in memory
11. Configuring the cache time for reports
12. Configuring LDAP to use active directory (AD) for user group privileges
Data retention periods for SDK database objects
1. Data retention periods for SDK database objects
2. Data aggregation
  1. Pre-requisites
  2. Data aggregation and retention levels
3. Find the domain ID and database table names
4. Retention period update for SDK user-defined objects example
5. SDK user-defined database objects
6. Capacity: default retention for basic database tables
7. Capacity: default retention for EMC Symmetrix enhanced performance
8. Capacity: Default retention for EMC XtremIO
9. Capacity: Default retention for Dell EMC Elastic Cloud Storage (ECS)
10. Capacity: Default retention for Windows file server
11. Capacity: Default retention for Pure Storage FlashArray
12. Cloud: Default retention for Amazon Web Services (AWS)
13. Cloud: Default retention for Microsoft Azure
14. Cloud: Default retention for OpenStack Ceilometer
15. Configure multi-tenancy data purging retention periods
Troubleshooting
1. Troubleshooting user login problems
2. Forgotten password procedure
3. Login issues
4. Connectivity issues
5. Data Collector and database issues
6. Portal upgrade performance issues
Appendix A. Kerberos based proxy user's authentication in Oracle
1. Overview
  1. Pre-requisite
2. Exporting service and user principal's to keytab file on KDC
3. Modifications for Oracle
4. Modifications for Portal
Appendix B. Configure TLS-enabled Oracle database on NetBackup IT Analytics Portal and data receiver
1. About Transport Layer Security (TLS)
2. TLS in Oracle environment
3. Configure TLS in Oracle with NetBackup IT Analytics on Linux in split architecture
4. Configure TLS in Oracle with NetBackup IT Analytics on Linux in non-split architecture
5. Configure TLS in Oracle with NetBackup IT Analytics on Windows in split architecture
6. Configure TLS in Oracle with NetBackup IT Analytics on Windows in non-split architecture
7. Configure TLS in user environment
Appendix C. NetBackup IT Analytics for NetBackup on Kubernetes and appliances
1. Configure embedded NetBackup IT Analytics Data collector for NetBackup deployment on appliances (including Flex appliances)
2. Configure NetBackup IT Analytics for NetBackup deployment on Kubernetes

Load port attributes and values

Function: The Load Port Attributes utility provides an efficient method of assigning attributes to a large number of ports. Please note Fabric Manager must be installed or the loading will fail.

To load port attributes and values:

Create a CSV file of Ports, Attributes and Values.
Execute the Load Port Attribute Utility.
Verify the Port Attributes Load.
Create a report template using the SQL Template Designer.

Once attribute values are assigned to application databases, a SQL Template Designer report can query the database to report on the application databases.

Create a CSV file of Ports, Attributes, and Values

The loadPortAttributeFile utility assigns attribute values to a list of switches. This utility takes as input a comma-separated values (CSV) file.

Note:

This CSV file becomes the master document of record for Port Attributes and therefore must be preserved in a working directory for future updates.

Create a spreadsheet table, in the format shown in the following example, and save it as a CSV file in a working directory. This file is specific to loading port attributes.

Columns:

The first column lists the Fabric Identifier.
The second column lists the Switch Identifier.
The third column lists the Port Element Name.
Each additional column lists attributes and values that will be applied to the port. Multiple attributes can be assigned to a single port object.

Rows:

First (Header) Row - Contains the fields that uniquely identify the Fabric Identifier Name, Switch Identifier, Port element name followed by Attribute names. The header row is information only and is not processed as a data row.
Subsequent rows list the Fabric Identifier, Switch Identifier, Port element name followed by the attribute values that you assign to each port.

Execute the Load Ports Attribute Utility

Before you begin, Bulk Load utility must be run in SQLPLUS as APTARE user.

The load_package utility is located in:

Linux: /opt/aptare/database/stored_procedures
Windows: \opt\oracle\database\stored_procedures

To assign attributes to application databases

Create a table in a spreadsheet.
Save the table as a comma-separated file (for example, PortAttributes.csv).
Log in to the portal server.
At the command line:
```
su -aptare
```

At the command line, launch sqlplus:

sqlplus <pwd>/<pwd>@//localhost:1521/scdb

Example:

sqlplus portal/portal@//localhost:1521/scdb

Execute the following at the SQL prompt:

SQL> Execute load_package.loadPortAttributeFile ('pathname_and_filename','domain_name',
Fabric_identifier_col_num, switch_identifier_col_num, port_ele_name_col_num,  'log_path_name', 'log_file_name','check_valid_value');

Example:

SQL> Execute load_package.loadPortAttributeFile('/tmp/portAttributes.csv', 'DomainEMEA', 1, 2,3,'/tmp/logs','portAttributes.log','Y');

Where:

pathname_and_filename	Full path + filename (enclosed in single straight quotes) of the CSV file. Windows example: '`c:\temp\PortAttributes.csv`' Linux example: '`/tmp/PortAttributes.csv`'
domain_name	Name (enclosed in single straight quotes) of the domain in which the ports reside. Example: 'DomainEMEA'
Fabric_identifier_col_num	Column number in the CSV file where the Fabric Identifier is listed; Example: 1
switch_identifier_col_num	Column number in the CSV file where the Switch Identifier is listed; Example: 2
port_ele_name_col_num	Column number in the CSV file where the Port Element Name is listed; Example: 3
log_path_name	Full path (enclosed in single straight quotes) where the log file will be created/updated; verify that you have write access to this directory. Optional: If a log path and filename are not specified, log records are written to scon.log and scon.err. To omit this parameter, enter: Example: 'c:\temp' or '/tmp'
log_file_name	Log file name enclosed in single straight quotes. Optional: If a log path and filename are not specified, entries are written to `scon.log` and `scon.err`. To omit this parameter, enter: '' Example: '`PortAttributes.log`'
check_valid_value	'Y' or 'N' - enclosed in single straight quotes. Y - Checks if the attribute value exists. If the utility determines that the attribute value is not valid, it skips this row and does not assign the attribute value to the switch object. N - Updates without checking that the attribute value exists. This option is seldom chosen, but it is available for certain customer environments where attributes may have been created without values (with scripts that bypass the user interface).

Check the log file for status and errors.
Restart the portal services so that the newly added attributes become available in the product.

Verify the Port Attributes Load

To verify that the attribute load was successful:

In the portal, go to Reports.
Select a blue user folder.
Select New SQL Template.
With the SQL Template Designer open, click the Query tab.
Enter the following query in the SQL Template Designer to verify Switch attributes:
```
select * from aps_v_swi_port_attribute
```