NetBackup IT Analytics System Administrator Guide
- Introduction
- Preparing for updates
- Backing up and restoring data
- Best practices for disaster recovery
- Oracle database backups
- File system backups
- Oracle database: Cold backup
- Oracle database: Export backups
- Scheduling the oracle database export
- Oracle database: On demand backup
- Restoring the NetBackup IT Analytics system
- Import the Oracle database
- Manual steps for database import / export using data pump
- Monitoring NetBackup IT Analytics
- Accessing NetBackup IT Analytics reports with the REST API
- Defining NetBackup estimated tape capacity
- Automating host group management
- About automating host group management
- Task overview: managing host groups in bulk
- Preparing to use PL/SQL utilities
- General utilities
- Categorize host operating systems by platform and version
- Identifying a host group ID
- Move or copy clients
- Organize clients by attribute
- Move host group
- Delete host group
- Move hosts and remove host groups
- Organize clients into groups by backup server
- Merge duplicate backup clients
- Merge duplicate hosts
- Bulk load utilities
- Veritas NetBackup utilities
- Automate NetBackup utilities
- Organize clients into groups by management server
- Set up an inactive clients group
- Set up a host group for clients in inactive policies
- Set up clients by policy
- Set up clients by policy type
- IBM Tivoli storage manager utilities
- Set up clients by policy domain
- Set up clients by IBM Tivoli storage manager instance
- Scheduling utilities to run automatically
- Host matching identification for single-domain multi-customer environments
- Attribute management
- Attribute bulk load utilities
- Attribute naming rules
- Rename attributes before upgrading
- Load host attributes and values
- Load attributes and values and assign to hosts
- Load array attributes and values and assign to arrays
- Overview of application attributes and values
- Load application database attributes and values
- Load MS Exchange organization attributes and values
- Load LUN attributes and values
- Load switch attributes and values
- Load port attributes and values
- Load Subscription attributes and values
- Importing generic backup data
- Backup job overrides
- Managing host data collection
- System configuration in the Portal
- System configuration in the Portal
- System configuration: functions
- Navigation overview
- System configuration parameter descriptions: Additional info
- Anomaly detection
- Data collection: Capacity chargeback
- Database administration: database
- Host discovery: EMC Avamar
- Host discovery: Host
- Events captured for audit
- Custom parameters
- Adding/editing a custom parameter
- Portal customizations
- Configuring global default inventory object selection
- Restricting user IDs to single sessions
- Customizing date format in the report scope selector
- Customizing the maximum number of lines for exported reports
- Customizing the total label display in tabular reports
- Customizing the host management page size
- Customizing the path and directory for File Analytics database
- Configuring badge expiration
- Configuring the maximum cache size in memory
- Configuring the cache time for reports
- Performance profile schedule customization
- LDAP and SSO authentication for Portal access
- Change Oracle database user passwords
- Integrate with CyberArk
- Tuning NetBackup IT Analytics
- Working with log files
- About debugging NetBackup IT Analytics
- Turn on debugging
- Database logging
- Portal and data collector log files - reduce logging
- Database SCON logging - reduce logging
- Refreshing the database SCON log
- Logging user activity in audit.log
- Logging only what a user deletes
- Logging all user activity
- Data collector log files
- Data collector log file organization
- Data collector log file naming conventions
- General data collector log files
- Find the event / meta collector ID
- Portal log files
- Database log files
- Installation / Upgrade log files
- Defining report metrics
- SNMP trap alerting
- SSL certificate configuration
- SSL certificate configuration
- SSL implementation overview
- Obtain an SSL certificate
- Update the web server configuration to enable SSL
- Configure virtual hosts for portal and / or data collection SSL
- Enable / Disable SSL for a Data Collector
- Enable / Disable SSL for emailed reports
- Test and troubleshoot SSL configurations
- Create a self-signed SSL certificate
- Configure the Data Collector to trust the certificate
- Keystore file locations on the Data Collector server
- Import a certificate into the Data Collector Java keystore
- Keystore on the portal server
- Add a virtual interface to a Linux server
- Add a virtual / secondary IP address on Windows
- Portal properties: Format and portal customizations
- Introduction
- Configuring global default inventory object selection
- Restricting user IDs to single sessions
- Customizing date format in the report scope selector
- Customizing the maximum number of lines for exported reports
- Customizing the total label display in tabular reports
- Customizing the host management page size
- Customizing the path and directory for file analytics database
- Configuring badge expiration
- Configuring the maximum cache size in memory
- Configuring the cache time for reports
- Configuring LDAP to use active directory (AD) for user group privileges
- Data retention periods for SDK database objects
- Data retention periods for SDK database objects
- Data aggregation
- Find the domain ID and database table names
- Retention period update for SDK user-defined objects example
- SDK user-defined database objects
- Capacity: default retention for basic database tables
- Capacity: default retention for EMC Symmetrix enhanced performance
- Capacity: Default retention for EMC XtremIO
- Capacity: Default retention for Dell EMC Elastic Cloud Storage (ECS)
- Capacity: Default retention for Windows file server
- Capacity: Default retention for Pure Storage FlashArray
- Cloud: Default retention for Amazon Web Services (AWS)
- Cloud: Default retention for Microsoft Azure
- Cloud: Default retention for OpenStack Ceilometer
- Configure multi-tenancy data purging retention periods
- Troubleshooting
- Appendix A. Kerberos based proxy user's authentication in Oracle
- Appendix B. Configure TLS-enabled Oracle database on NetBackup IT Analytics Portal and data receiver
- About Transport Layer Security (TLS)
- TLS in Oracle environment
- Configure TLS in Oracle with NetBackup IT Analytics on Linux in split architecture
- Configure TLS in Oracle with NetBackup IT Analytics on Linux in non-split architecture
- Configure TLS in Oracle with NetBackup IT Analytics on Windows in split architecture
- Configure TLS in Oracle with NetBackup IT Analytics on Windows in non-split architecture
- Configure TLS in user environment
- Appendix C. NetBackup IT Analytics for NetBackup on Kubernetes and appliances
Configure embedded NetBackup IT Analytics Data collector for NetBackup deployment on appliances (including Flex appliances)
You can configure a Data Collector on the primary server pod. Following are the steps for respective configurations.
Note:
From NetBackup version 10.3 Cloud Scale release, Data Collector on primary server pod is supported.
The below steps to configure the IT Analytics Data Collector on a primary server must be performed as a root user. On a Flex appliance, connect to the primary server pod first and then switch to the root user using sudo. On a NetBackup Appliance, access shell by creating NetBackup CLI user.
To configure NetBackup IT Analytics for NetBackup deployment
- Create a DNS server entry in such a way that IP of the NetBackup IT Analytics Portal must be resolvable to a single FQDN. IP of the NetBackup IT Analytics Portal must be resolved to:
itanalyticsagent.<yourdomain>
Note the following:
If the Portal URL is
itanalyticsportal.<yourdomain>, then ensure to add the DNS entries for the following hostnames:itanalyticsagent.<yourdomain>
If the Portal URL is
itanalyticsportal.<yourdomain>, then ensure to add the DNS entries for the following hostnames:aptareagent.<yourdomain>
- Collect the
<your-collector-name>.keyfile for the new Data Collector by accessing the Portal link and creating a collector and copy it to the host machine from where NetBackup primary is deployed.For more information, refer to the Data Collector Encryption section in NetBackup IT Analytics User Guide.
- Collect the
<your-collector-name>.jsonfile for the new Data Collector by accessing the Portal link and creating a collector and copy it to the host machine from where NetBackup primary is deployed.For more information, refer to the Data Collector Encryption section in NetBackup IT Analytics User Guide.
- Create a new folder analyticscollector at persisted location (for example,
/mnt/nbdata/) using the following commands:cd "/mnt/nbdata/" mkdir analyticscollector
- Copy the
<your-collector-name>.keyfile to/mnt/nbdata/analyticscollectorinside the NetBackup primary host or container as the case may be. - Exit from the container and copy the
<your-collector-name>.jsonfile to/mnt/nbdata/analyticscollectorinside the NetBackup primary host or container as the case may be. - In case if the data-receiver is configured with self-signed certificate (https), you must add the certificate in the data collector.
- Connect to the NetBackup primary host or the container.
- Navigate to
/usr/openv/analyticscollector/installer/location and perform the following:Open the
responsefile.sampleand add the following parameters:If the Portal version is lower than 11.3, create the response file with the following contents.
COLLECTOR_NAME=<your-collector-name> COLLECTOR_PASSCODE=<your-password> DR_URL=<http>/<https>://itanalyticsagent.<yourdomain> COLLECTOR_KEY_PATH=<path to your-collector-name.key> HTTP_PROXY_CONF=N HTTP_PROXY_ADDRESS= HTTP_PROXY_PORT= HTTPS_PROXY_ADDRESS= HTTPS_PROXY_PORT= PROXY_USERNAME= PROXY_PASSWORD= PROXY_EXCLUDE=
If the Portal version is 11.3 or later, create the response file with the following contents.
COLLECTOR_REGISTRATION_PATH=<keyfile path> HTTP_PROXY_CONF=N HTTP_PROXY_ADDRESS= HTTP_PROXY_PORT= HTTPS_PROXY_ADDRESS= HTTPS_PROXY_PORT= PROXY_USERNAME= PROXY_PASSWORD= PROXY_EXCLUDE=
- Configure the Data Collector with the NetBackup IT Analytics Portal as follows.
Note:
If the Data Collector installed is of a lower version than the NetBackup IT Analytics Portal, wait for the Data Collector auto-upgrade to finish before you proceed.
For NetBackup Appliance version 5.3 or later:
Run the following command as a NetBackup CLI user:
/usr/openv/analyticscollector/installer/dc_installer.sh -c /usr/openv/analyticscollector/installer/responsefile.sample
To verify the Data Collector integration with NetBackup IT Analytics Portal, run:
/usr/openv/analyticscollector/mbs/bin/checkinstall.sh
For NetBackup Appliance version 5.1.1:
Run the following command as a NetBackup CLI user:
sudo /usr/openv/analyticscollector/installer/dc_installer.sh -c /usr/openv/analyticscollector/installer/responsefile.sample
To verify the Data Collector integration with NetBackup IT Analytics Portal, run:
sudo /usr/openv/analyticscollector/mbs/bin/checkinstall.sh
If you are on Flex Appliance:
Connect to the primary server container and then switch to roo user using sudo and run:
/usr/openv/analyticscollector/installer/dc_installer.sh -c /usr/openv/analyticscollector/installer/responsefile.sample
To verify the Data Collector integration with NetBackup IT Analytics Portal, run:
/usr/openv/analyticscollector/mbs/bin/checkinstall.sh
If the Data Collector is configured with the Portal, it will display SUCCESSFUL.
Note:
If there is a version mismatch of
aptare.jarbetween Data Collector and Portal, execution of checkinstall.sh command will trigger an auto-update of the Data Collector. - Check the Data Collector services status by running the following command and ensure that the following Data Collector services are up and running:
/usr/openv/analyticscollector/mbs/bin/aptare_agent status
Output of the above command:
IT Analytics WatchDog is running (pid: 13312). IT Analytics MetaDataCollector is stopped. IT Analytics EventDataCollector is stopped. IT Analytics DataCollector process is running (pid: 13461). IT Analytics On-demand process is running (pid: 13463). IT Analytics Message Relay Server process is running (pid: 13471)
For more information about NetBackup IT Analytics Data Collector policy, see NetBackup IT Analytics User Guide.
IT Analytics Data Collector can be configured to use with NetBackup primary server in this environment. NetBackup IT Analytics can be configured at the time of primary server deployment or user can update the primary server custom resource to configure NetBackup IT Analytics.
Note:
Remote data collection from Netbackup primary server cannot be configured when multi-factor authentication is configured on Netbackup Appliance.
To configure NetBackup IT Analytics for NetBackup deployment:
- Using the ssh-keygen command, generates public key and private key on NetBackup IT Analytics data collector.
NetBackup IT Analytics Data Collector uses passwordless ssh login.
- Create and copy NetBackup API key from NetBackup web UI.
- On NetBackup IT Analytics Portal:
Navigate to Admin > Collector Administration > Select respective Data Collector > Add policy > Veritas NetBackup > Add.
Add required options, specify the NetBackup API in the API Key field, and then click OK.
Select newly added primary server from NetBackup Primary Servers and provide nbitanalyticsadmin as Primary Server User ID.
Provide privateKey=<path-of-private-key>|password=<passphrase> as Primary Server Password and Repeat Password whereas <path-of-private-key> is the private key created using ssh-keygen in earlier steps and <passphrase> is the passphrase used while creating private key via ssh-keygen.
Provide appropriate data to Data Collector policy fields and select collection method as SSH or WMI protocol to NetBackup Primary Server.
Configuring the primary server with NetBackup IT Analytics tools is supported only once from primary server custom resource.
For more information about NetBackup IT Analytics Data Collector policy, see Add a Veritas NetBackup Data Collector policy section.
For more information about adding NetBackup Primary Servers within the Data Collector policy, see Add/Edit NetBackup Primary Servers within the Data Collector policy section in NetBackup IT Analytics Data Collector Installation Guide for Backup Manager.
To change the already configured public key
- Connect to the NetBackup Primary host or container.
- Copy the new public keys in the
/home/nbitanalyticsadmin/.ssh/authorized_keysand/mnt/nbdata/.ssh/nbitanalyticsadmin_keysfiles. - Restart the sshd service using the systemctl restart sshd command.