Search <book_title>...

NetBackup IT Analytics System Administrator Guide

Last Published: 2025-01-03

Product(s): NetBackup IT Analytics (11.4)

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. 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)
15. Veritas NetBackup utilities
16. Automate NetBackup utilities
  1. Scheduling a NetBackup Utility Job to Run Automatically
17. Organize clients into groups by management server
18. Set up an inactive clients group
19. Set up a host group for clients in inactive policies
20. Set up clients by policy
21. Set up clients by policy type
22. IBM Tivoli storage manager utilities
23. Set up clients by policy domain
24. Set up clients by IBM Tivoli storage manager instance
25. Scheduling utilities to run automatically
  1. Sample .sql file (setup_ora_job.sql) to set up an automatic job
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)
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
3. Standard OIDs
4. Data in an alerting trap
  1. Example of policy based alert
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

Import the Oracle database

Caution:

The following process deletes your existing NetBackup IT Analytics database. Before you try to import the Oracle Database, verify you have no other recovery options and you have a valid database export. Contact Veritas Support.

Some common problems include:

Importing unsuccessful backups. Ensure that your backups were successful before you accidentally import old data.
Importing more than what you need. Do not restore the entire database or import all database tables if you only need to restore one database table. Import only what you need.

Note:

Before restoring user objects, stop the Tomcat and Portal processes.

See Starting and stopping portal server software.

Database Import (Linux)

Prerequisites:

To import the latest successful export of the Oracle database, the database user Aptare user must have access to the export files stored in the /opt/aptare/database/tools directory.
The Oracle user must have read and execute privileges on these files before starting the database export.

Log into the Linux database server and switch to user Aptare.
Place the export file aptare_scdb.exp in the /tmp directory.
If you have a different preferred directory (for example, /new_directory_path), then place aptare_scdb.exp in your preferred directory (/new_directory_path). Subsequently, change the path for the creation of directory from /tmp to the new directory (new_directory_path) in the /opt/aptare/database/tools/drop_users_linux.sql file.
Note:
You can also use /opt/aptare/ or /opt/aptare/oracle/rdbms/log/ directories.
Place the aptare.ks file in the /tmp directory.
Note:
This step is required only if database is exported from an NetBackup IT Analytics version of 10.5 or above.
Place the aptare_external_password.properties file in the /tmp directory.
Note:
This step is required only if database is exported from an NetBackup IT Analytics version 11.0 or above.
Stop all Oracle and APTARE services as a root user:
```
/opt/aptare/bin/aptare stop
```
Start Oracle services as the root user:
```
/opt/aptare/bin/oracle start
```
Verify the Oracle Listener is running.
```
/opt/aptare/bin/aptare status
```

Run the following command:

chmod +x /opt/aptare/database/tools/import_database_template.sh

Run the script import_database_template.sh as Aptare user.
```
/opt/aptare/database/tools/import_database_template.sh
```
After successful completion, the data pump export file aptare_scdb.exp is saved on the Linux database server in the /tmp directory.

The import_database_template.sh script, unlocks Portal user, grants privileges, and validates the packages after the completion of the import, so they are not required to be run manually. The scripts also address the compilation warnings for the packages that follow.

The import log - import_scdb.log is located in the /tmp directory.

Check the log file for compilation warnings for the packages:
- view apt_v_solution_history_log
- cmv_adaptor_pkg
- avm_common_pkg
- sdk_common_pkg
- load_package
- common_package
- util
These compilation warnings are addressed by the script itself and no action is required from the user.
Note:
If you are importing a database from version 10.4, upgrade the portal after the import to a 10.5 build.
This step is required only if you are exporting the database from NetBackup IT Analytics version 10.5 or above. Run the following commands to copy the aptare.ks file to datarcvrconf folder.
```
cp /tmp/aptare.ks /opt/aptare/datarcvrconf/
chown aptare:tomcat /opt/aptare/datarcvrconf/aptare.ks
chmod 660 /opt/aptare/datarcvrconf/aptare.ks
```
The encrypted information in portal.properties and datararcvrproperties.xml files must be replaced after the aptare.ks file has been copied to the portal. The information is re-encrypted when the portal services are restarted. The following modifications are required for both the files.
Modification required for portal.properties file
- Edit /opt/aptare/portalconf/portal.properties file
- Remove all the characters following the first "=" on the lines containing db.password.encrypted and db.ro_user_password.encrypted
- Specify the passwords for both users in the relevant lines
  Note:
  The db.user and db.ro_user information shown is below is for a default installation. Adjust the blank entries to match your environment. These will be re-encrypted when the portal services are restarted.
```
#Database connection
db.driver=oracle.jdbc.driver.OracleDriver
db.url=jdbc:oracle:thin:@//localhost:1521/scdb
db.user=portal
db.password=portal
db.password.encrypted=
db.connection.max=75
db.connection.min=25
db.connection.expiration=30
db.ro_user=aptare_ro
db.ro_user_password=aptaresoftware123
db.ro_user_password.encrypted=
```
Modification required for datararcvrproperties.xml file
- Edit the datasource section of /opt/aptare/datarcvrconf/datrarcvrproperties.xml file
- Clear the encrypted values for UserId, Password, ro_user, and ro_password
  Note:
  The UserId and ro_user information shown is for a default installation. Clear the text entries to match your environment. These will be re-encrypted when the portal services are restarted.
```
<dataSource>
        <Driver>oracle.jdbc.driver.OracleDriver</Driver>
        <URL>jdbc:oracle:thin:@//localhost:1521/scdb</URL>
        <UserId>portal<=/UserId>
        <Password>portal</Password>
        <oracle_service_name>scdb</oracle_service_name>
        <ro_user>aptare_ro</ro_user>
        <ro_password>aptaresoftware123</ro_password>
        <MaxConnections>150</MaxConnections>
        <MinConnections>5</MinConnections>
        <ConnExpirationTime>5</ConnExpirationTime>
    </dataSource>
```

This step is required only if you are exporting the database from NetBackup IT Analytics version 11.0 or above. Execute the following commands to copy the file aptare_external_password.properties to datarcvrconf directory.

cp /tmp/aptare_external_password.properties /opt/aptare/datarcvrconf/
chown aptare:tomcat /opt/aptare/datarcvrconf/aptare_external_password.properties
chmod 660 /opt/aptare/datarcvrconf/aptare_external_password.properties

Run updateUser.sh to change the password of the application account. For example, to change the password for the admin123 application user, run updateUser.sh admin123 <newPassword>
Restart all Oracle and APTARE services by running them from the root user:
```
/opt/aptare/bin/aptare restart
```
If the Portal is deployed at a custom path (other than the default path : /opt/aptare), update the system parameter as follows:
- Login to the Portal host as root user and run:
```
su - aptare
cd /customPath/aptare/database/tools
```
- Login to SQL Plus as a Portal user and substitute pwd with your password
```
sqlplus portal/pwd@<ServiceName>
@update_system_parameter.sql
```
- Enter the custom installation path of the Portal, when you prompted as:
```
"Enter value for input_path:"
```
  Example: If you have the Portal deployed under /<CustomPath>/aptare/ directory, provide the input path as /<CustomPath>/ while importing the database on the same host where the Portal is installed.
Log into the Portal using the application account.

Database Import (Windows)

To import the latest successful export of the Oracle database, the database user Aptare user must have access to the export files stored in the directory:

c:\opt\oracle\database\tools

Verify the Oracle user has read and execute privileges on these files before starting the database export.

Log into the Windows database server as a user who is a member of the ORA_DBA group.
Place the export file aptare_scdb.exp in the directory:
C:\opt\oracle\logs
The encrypted information in portal.properties and datararcvrproperties.xml files must be replaced after the aptare.ks file has been copied to the portal. The information is re-encrypted when the portal services are restarted. The following modifications are required for both the files.
Modification required for portal.properties file
- Edit c:\opt\aptare\portalconf\portal.properties file
- Remove all the characters following the first "=" on the lines containing db.password.encrypted and db.ro_user_password.encrypted
- Specify the passwords for both users in the relevant lines
  Note:
  The db.user and db.ro_user information shown is below is for a default installation. Adjust the blank entries to match your environment. These will be re-encrypted when the portal services are restarted.
```
#Database connection
db.driver=oracle.jdbc.driver.OracleDriver
db.url=jdbc:oracle:thin:@//localhost:1521/scdb
db.user=portal
db.password=portal
db.password.encrypted=
db.connection.max=75
db.connection.min=25
db.connection.expiration=30
db.ro_user=aptare_ro
db.ro_user_password=aptaresoftware123
db.ro_user_password.encrypted=
```
Modification required for datararcvrproperties.xml file
- Edit the datasource section of c:\opt\aptare\datarcvrconf\datrarcvrproperties.xml file
- Clear the encrypted values for UserId, Password, ro_user, and ro_password
  Note:
  The UserId and ro_user information shown is for a default installation. Clear the text entries to match your environment. These will be re-encrypted when the portal services are restarted.
```
<dataSource>
        <Driver>oracle.jdbc.driver.OracleDriver</Driver>
        <URL>jdbc:oracle:thin:@//localhost:1521/scdb</URL>
        <UserId>portal<=/UserId>
        <Password>portal</Password>
        <oracle_service_name>scdb</oracle_service_name>
        <ro_user>aptare_ro</ro_user>
        <ro_password>aptaresoftware123</ro_password>
        <MaxConnections>150</MaxConnections>
        <MinConnections>5</MinConnections>
        <ConnExpirationTime>5</ConnExpirationTime>
    </dataSource>
```
Place the aptare.ks file in the C:\opt\oracle\logs folder.
Note:
This step is required only if database is exported from an NetBackup IT Analytics version of 10.5 or above.
Place the aptare_external_password.properties file in the c:\opt\oracle\logs folder.
Note:
This step is required only if database is exported from an NetBackup IT Analytics version 11.0 or above.
Stop all Oracle and Aptare services using stopAllServices from the Windows Services tab.
Verify the Oracle TNS Listener is running and start OracleServicescdb from the Windows Services tab.
From the command prompt, run the script import_database_template.bat by executing the command:
```
c:\opt\oracle\database\tools\import_database_template.bat
```
After successful completion of the import, run Startallservices from the Windows Services tab.

The import_database_template.bat script, unlocks Portal user, grants privileges, and validates the packages after the completion of import, so they are not required to be run manually. The scripts also address compilation warnings for the packages that follow.

The import log import_scdb.log is located c:\opt\aptare\oracle\logs.

Check the log file for compilation warnings for the packages:
- view apt_v_solution_history_log
- cmv_adaptor_pkg
- avm_common_pkg
- sdk_common_pkg
- load_package
- common_package
- util
These compilation warnings are addressed by the script itself and no action is required from the user.
Note:
If you are importing a database from version 10.4, upgrade the portal after the import to a 10.5 build.
Copy the saved file c:\opt\oracle\logs\aptare.ks to c:\opt\aptare\datarcvrconf folder. Ensure that the file is owned by NetBackup IT Analytics user and has appropriate Read and Write access to the copied file.
Note:
This step is required only if database is exported from an NetBackup IT Analytics version of 10.5 or above.
Copy the saved file c:\opt\oracle\logs\aptare_external_password.properties to c:\opt\aptare\datarcvrconf folder. Ensure that the file is owned by NetBackup IT Analytics user and has appropriate Read and Write access to the copied file.
Note:
This step is required only if database is exported from an NetBackup IT Analytics version 11.0 or above.
Run startAllServices using the Windows Services tab.
Run updateuser.bat to change the password of the application account. For example, to change the password for the admin123 application user, run: updateuser.bat admin123 newPassword
Log into the portal Application using the application account.

Restoring When a Cold Backup is Not Available

If you do not have a successful cold backup of your Oracle database, take the following steps to recover your NetBackup IT Analytics Oracle database. Refer to the Installation and Upgrade Guides for complete details about re-installing the binaries and the database schema. Contact Support for assistance.

Re-install the Oracle binaries.
Re-install the database schema.
Import the latest successful export of your Oracle database to restore the Portal user objects.
See Import the Oracle database.