APTARE IT Analytics System Administrator Guide

Last Published:
Product(s): APTARE IT Analytics (10.6)
  1. Introduction
    1.  
      APTARE IT Analytics Overview
    2.  
      Purpose of this document
  2. 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
  3. 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 APTARE IT Analytics system
    9.  
      Import the oracle database
    10.  
      Manual steps for database import / export using data pump
  4. Monitoring APTARE 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
  5. Accessing APTARE 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
  6. 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
  7. 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
  8. 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
  9. 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
  10. Backup job overrides
    1.  
      Overview
    2.  
      Configure a backup job override
  11. 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
  12. 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.  
      Data collection: Capacity chargeback
    6.  
      Database administration: database
    7.  
      Host discovery: EMC Avamar
    8.  
      Host discovery: Host
    9.  
      Custom parameters
    10.  
      Adding/editing a custom parameter
    11.  
      Portal customizations
    12.  
      Configuring global default inventory object selection
    13.  
      Restricting user IDs to single sessions
    14.  
      Customizing date format in the report scope selector
    15.  
      Customizing the maximum number of lines for exported reports
    16.  
      Customizing the total label display in tabular reports
    17.  
      Customizing the host management page size
    18.  
      Customizing the path and directory for File Analytics database
    19.  
      Configuring badge expiration
    20.  
      Configuring the maximum cache size in memory
    21.  
      Configuring the cache time for reports
  13. Performance profile schedule customization
    1.  
      Overview
    2.  
      Customize the performance profile schedule
  14. Configuring AD/LDAP
    1.  
      About user authentication
    2.  
      AD/LDAP Configuration Properties
    3.  
      AD/LDAP Configuration for authentication and authorization
    4. Support LDAP over SSL
      1.  
        Sample portal.properties configurations for AD/LDAP
    5.  
      Creating portal super users
    6.  
      Active directory tools
    7.  
      Using LDP to find the base DN
    8.  
      Using LDP to search active directory
  15. Configuring single sign-on (SSO) using security assertion markup language (SAML)
    1.  
      Overview
    2.  
      Single sign-on (SSO) prerequisites
    3. Setting up the external Identity Provider (IDP) server
      1.  
        Users and groups in the external LDAP directory
      2.  
        Registering with the IDP server
    4.  
      Activating single Sign-on (SSO) in the portal
    5.  
      SSO troubleshooting and maintenance
  16. Change Oracle database user passwords
    1.  
      Overview
    2.  
      Database connection properties
    3.  
      Modify the Oracle database user passwords
    4.  
      Configure Oracle passwords in system configuration files
    5.  
      Determine if Oracle is using the default login password
  17. Integrate with CyberArk
    1.  
      Introduction
    2.  
      CyberArk setup prerequisites
    3.  
      Setting up the portal to integrate with CyberArk
  18. Tuning APTARE 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
  19. Working with log files
    1.  
      About debugging APTARE 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
      1.  
        Sample Vendor.Product Naming Convention
      2.  
        Log File Names Based on Data Collector Generation
      3.  
        Checkinstall Log
      4.  
        Test Connection Log
      5.  
        Log file naming convention by collected system
    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
  20. Defining report metrics
    1.  
      Changing backup success percentage
    2.  
      Changing job status
  21. SNMP trap alerting
    1.  
      Overview
    2.  
      SNMP configurations
    3.  
      Standard OIDs
    4.  
      Data in an alerting trap
  22. 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
      1.  
        SSL Implementation for the Portal Only
      2.  
        SSL Implementation for Data Collection Only
      3.  
        SSL Implementation for Both the Portal and Data Collection
    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
      1.  
        Features that Require the SSL Certificate
      2.  
        Add a Certificate into the Portal Keystore
      3.  
        Update a Certificate in the Portal Keystore
      4.  
        Download a Certificate from the Portal Keystore
    14.  
      Add a virtual interface to a Linux server
    15.  
      Add a virtual / secondary IP address on Windows
  23. 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
  24. Advanced configuration for NetBackup discovery
    1.  
      Discovery module overview
    2.  
      Activate a Discovery license
    3.  
      Modify Discovery system parameters
    4.  
      About SNMP probes
    5.  
      Why enable SNMP?
    6.  
      Enabling SNMP for Windows (NT/2000/XP)
    7.  
      Enabling SNMP for Red Hat Linux
    8.  
      Enabling SNMP for HP-UX
    9.  
      Example--Installing Net-SNMP
    10.  
      Troubleshooting Net-SNMP installations
  25. Data retention periods for SDK database objects
    1.  
      Data retention periods for SDK database objects
    2.  
      Find the domain ID and database table names
    3.  
      Retention period update for SDK user-defined objects example
    4.  
      SDK user-defined database objects
    5.  
      Capacity: default retention for basic database tables
    6.  
      Capacity: default retention for EMC Symmetrix enhanced performance
    7.  
      Capacity: Default retention for EMC XtremIO
    8.  
      Capacity: Default retention for Dell EMC Elastic Cloud Storage (ECS)
    9.  
      Capacity: Default retention for Windows file server
    10.  
      Capacity: Default retention for Pure Storage FlashArray
    11.  
      Cloud: Default retention for Amazon Web Services (AWS)
    12.  
      Cloud: Default retention for Microsoft Azure
    13.  
      Cloud: Default retention for OpenStack Ceilometer
    14.  
      Configure multi-tenancy data purging retention periods
  26. Troubleshooting
    1.  
      Troubleshooting user login problems
    2.  
      Forgotten password procedure
    3.  
      Login issues
    4.  
      Connectivity issues
    5. Data Collector and database issues
      1.  
        Insufficient Privileges
      2.  
        Remove an Inactive Hitachi Array from the Database
      3. Report Emails are not Being Sent
        1.  
          Additional Email Troubleshooting Recommendations
      4.  
        General Reporting Issues
      5.  
        Performance Issues

System configuration in the portal

Configure a number of the components in your system directly from the Portal. Using the System Configuration feature available to Super Users, you can modify default values established during installation for everything from data retention period to how email is setup.

Functional Areas

Functional areas are divided into separate tabs as follows:

  • Data Collection - Set values for all collection, product-based collection and vendor-based.

  • Data Retention - Modify default retention periods for systems that are collected by traditional Data Collectors to determine when data is purged from the database. Purging is required to maintain reasonable table sizes. Data types include historical and performance data. Fields are displayed based on what has been installed and collected.

    For systems collected by Data Collectors deployed via the SDK, use the procedure described in:

    See Data retention periods for SDK database objects.

  • Database Administration - Set values to configure the structure of the database.

  • Host Discovery - Enable rules for host matching when the system is discovering new hosts/clients.

  • Inventory - Modify the database polling frequency for Inventory objects.

  • Portal - Modify default values for a variety of portal properties including host attribute import parameters, maximum number of open tabs, and security settings such as time out values and allowed login attempts.

  • Custom Parameters - Add, edit and delete custom system parameters, portal properties and their associated values. This area allows free form entry for name/value pairs.