APTARE IT Analytics
- Section I. Introducing APTARE IT Analytics
- Section II. Certified Configurations
- Portal and Database Servers
- Data Collector Server Configurations
- Capacity Manager Configurations
- Array/LUN Performance Data Collection
- Host Access Privileges, Sudo Commands, Ports, and WMI Proxy Requirements
- Cloud Configurations
- Virtualization Manager Configurations
- File Analytics Configurations
- Fabric Manager Configurations
- Backup Manager Configurations
- Internal TCP Port Requirements
- Section III. End User
- Understanding the Portal
- About the Admin Tab
- Exploring Your Inventory
- Using the Hierarchy Toolbar to Organize Your Data
- Show Objects
- Using Attributes to Organize Your Data
- Pinning Reports - Saving Reports with Inventory Objects
- Assigning Attributes in the Inventory List View
- Getting Acquainted With Reports
- About Badging
- Generating and Maintaining Reports
- Selecting Report Scope
- Group Hosts by Attributes
- Searching for Hosts in the Report Scope Selector
- Backup Manager Advanced Scope Selector Settings
- Solution Reports Scope Selector Settings
- Units of Measure in Reports
- Customizing Report Filter Logic
- Sorting Columns in Reports
- Distributing, Sharing, Scheduling, and Alerting
- Scheduling Exported Reports and Dashboards
- Organizing Reports
- Working 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
- Working 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
- listChargebackCatByFSDetail
- listChargebackCatByFSDetail
- listChargebackByLUNSummary
- listChargebackByLUNDetail
- listChargebackCatByLUNSummary
- listChargebackCatByLUNDetail
- Alerting
- Adding/Editing an Alert Policy
- Managing Hosts, Backup Servers and Host Groups
- NetBackup Master Servers
- Managing Attributes and Objects
- Host Groups vs Attributes
- Providing Portal Access and User Authentication
- Setting/Resetting Passwords
- Managing User Group Home Pages (Administrator)
- Configuring Master Schedules and Backup Windows
- Adding and Editing Policies
- Adding/Editing a Threshold Policy
- Capacity Chargeback Policy Types
- Solutions Administration
- Managing and Monitoring Data Collection
- About Data Collection Tasks
- Reviewing Collectors and Collection Status
- Upgrading Data Collectors
- Working 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
- About Discovery Types
- Viewing and Managing System Notifications
- Customizing 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
- Managing Your Portal Environment
- Analyzing Files
- Troubleshooting the Portal
- Retrieving Log Files
- Debugging
- Attribute Inheritance Overrides
- Understanding Report Data Caching
- Understanding the Portal
- Section IV. Report Reference
- Introduction to APTARE IT Analytics
- Alert Reports
- Risk Mitigation Solution Reports
- Risk Mitigation Reports
- Storage Optimization Solution Reports
- System Administration 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
- Host Capacity Utilization Reports
- Thin Provisioning Reports
- Hitachi Dynamic Provisioning Pool Utilization
- Capacity Forecasting Reports
- Available/Reclaimable Capacity Reports
- Storage Performance Reports
- Mission Control for Performance Analysis
- Application Capacity Reports
- Capacity at Risk Reports
- File Analytics Reports
- Capacity Chargeback 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
- Backup Administration Reports
- Host Details
- IBM Spectrum Protect (TSM) Storage Pools Dashboard
- 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
- Replication Manager Reports
- SnapVault Detail
- Section V. 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 the Status of the WMI Proxy Server
- Host Resources: Check Host Connectivity Using Standard SSH
- Host Resources: Generating Host Resource Configuration Files
- Configuring Parameters for SSH
- Firewall Configuration: Default Ports
- CRON Expressions and Probe Schedules
- Clustering Data Collectors with VCS and Veritas NetBackup (RHEL 7)
- Clustering Data Collectors with VCS and Veritas NetBackup (Windows)
- Installing the Data Collector Software
- Section VI. Data Collection for the Cloud
- Pre-Installation Setup for Amazon Web Services (AWS)
- Create an AWS IAM User
- 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
- Pre-Installation Setup for Amazon Web Services (AWS)
- Section VII. Data Collection for Data Protection (Backup)
- Introduction
- 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
- Importing EMC Avamar Server Information
- Pre-Installation Setup for EMC Data Domain Backup
- Pre-Installation Setup for EMC NetWorker
- Architecture Overview (EMC NetWorker)
- Pre-Installation Setup for Dell EMC NetWorker Backup & Recovery
- Pre-Installation Setup for Generic Backup
- Generic Backup Data Collection
- 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)
- Importing IBM Spectrum Protect (TSM) Information
- Pre-Installation Setup for NAKIVO Backup & Replication
- Pre-Installation Setup for Veritas Backup Exec
- Pre-Installation Setup for Veritas NetBackup
- Veritas NetBackup 8.1 (or later) Requirements for Centralized Collection
- Pre-Installation Setup for Oracle Recovery Manager (RMAN)
- Pre-Installation Setup for Rubrik Cloud Data Management
- Pre-Installation Setup for Veeam Backup & Replication
- Discovery Policies for Veritas NetBackup
- About Discovery Types
- About SNMP Probes
- Appendix A. Load Historic Events
- Section VIII. Data Collection for Fabrics
- Section IX. 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 X. Data Collection for Replication
- Section XI. Data Collection for Storage (Capacity)
- Data Collection for Capacity Overview
- 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
- Pre-Installation Setup 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
- Host Inventory Pre-Installation Setup
- Host Access Privileges, Sudo Commands, Ports, and WMI Proxy Requirements
- Manage Credentials
- Configure Host Discovery Policies to Populate the Host Inventory
- Execute and Monitor Host Discovery
- 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 Huawei OceanStor
- 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 INFINIDAT InfiniBox
- Pre-Installation Setup for NetApp-7
- 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 NetBackup Appliance
- Section XII. Data Collection for Virtualization
- Pre-Installation Setup for VMware
- Pre-Installation Setup for IBM VIO
- Pre-Installation Setup for Microsoft Hyper-V
- Section XIII. System Administration
- Preparing for Updates
- Backing Up and Restoring Data
- Monitoring APTARE IT Analytics
- Accessing APTARE 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
- Automating NetBackup Utilities
- Attribute Management
- Importing Generic Backup Data
- Backup Job Overrides
- Managing Host Data Collection
- System Configuration in the Portal
- Host Discovery: EMC Avamar
- Performance Profile Schedule Customization
- Configuring LDAP
- Configuring Single Sign On (SSO) Using Security Assertion Markup Language (SAML)
- Changing Oracle Database User Passwords
- Tuning APTARE 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
- Advanced Configuration for NetBackup Discovery
- Data Retention Periods for SDK Database Objects
- Configure Multi-Tenancy Data Purging Retention Periods
- Troubleshooting
- Section XIV. Portal Install and Upgrade (Windows)
- Installing the Portal on a Windows Server
- Upgrading a Portal and Data Collectors (Windows)
- Troubleshooting - Manual Data Collector Upgrades
- Attribute Merging During the Portal Upgrade
- Upgrading and Migrating to a New Server
- Installing the Portal on a Windows Server
- Section XV. Portal Install and Upgrade (Linux)
- Installing the Portal on a Linux Server
- Upgrading a Portal and Data Collectors (Linux)
- Data Collector Upgrades
- Attribute Merging During the Portal Upgrade
- Installation from a Single File Specific to an OS
- Adding Additional Products
- Upgrading and Migrating to a New Server
- Installing the Portal on a Linux Server
- Section XVI. Technical Notes
- Enabling Oracle's Transparent Data Encryption (TDE)
- Array Performance Statistics Technical Note
- EMC Symmetrix Back-end Director Performance
- Section XVII. Licensing
- License Installation and Guidelines
- Verifying the Current License Configuration
- Criteria for Determining Licensing Limits
- Managing Licenses
- Configure the Data Collector Policy to Exclude the Object
- License Key Utility
- License Installation (Command Line Alternative)
- Report Configuration Utility
- License Verification Utility
- License Installation and Guidelines
- Section XVIII. Inventory Reports
- Inventory Operations
System Methods
The following methods are packaged with the system, for use in the Dynamic Template Designer.
System Method | Vendor Product | Description |
---|---|---|
Methods: Job Enterprise Object | ||
Backup Window | All Supported Backup Products | Returns the start and finish dates in a backup window. |
Client Last Backup Job Info | All Supported Backup Products | Returns the finish date and the corresponding job IDs of the most recent full or incremental backup jobs that are in a successful or partial state. The data returned is per client. This is a stand-alone function and cannot be used in combination with other objects or functions. |
CommVault Backup Copy Info | CommVault Simpana | Returns the minimum Backup Copy Identifier for a given CommVault Simpana job. |
Commvault Job Attempts | CommVault Simpana | Returns Simpana backup jobs and try count for a client list for CommVault Simpana jobs. |
CommVault Running and Queued Job Count | CommVault Simpana | Returns the count of CommVault Simpana backup jobs that are in the running state in the last 90 days. The counts returned are per server. |
Data Domain Last Backup Job Info | Data Domain | Returns the details for Data Domain backup jobs. The data returned is per client and logical storage unit. |
Disk and Tape Usage Summary | All Supported Backup Products | For the most recent successful or partial job, this method returns the finish date, corresponding job ID, number of kilobytes saved in tape media, number of kilobytes saved in disk media, number of files saved in tape media and number of files saved in disk media. The data returned is per server, client, product type and job type. |
Failed Backup Job Detail | All Supported Backup Products | For the failed backup jobs within the selected, required time period, this method returns the following data on a per-client basis: client ID, along with its corresponding job ID, the count of failed backups, and the date of the last failed backup job. |
Failed Full Backup Job Detail | All Supported Backup Products | For the failed full backup jobs within the selected, required time period, this method returns the following data on a per-client basis: client ID, along with its corresponding job ID, the count of failed full backups and the last failed full backup date. |
HP DP Session Tape Media List | HP Data Protector | For any HP Data Protector (HP DP) session, this method returns a comma-separated list of the tape media associated with the job. The data will be returned in the following format: id1,name1|id2|name2. The IDs can be used for report drilldowns. |
Job Tape Media List | All Supported Backup Products | For any successful or partial job, this method returns a comma-separated list of the tape media associated with the job. This method returns the tape media list if the job's status is success or warning. |
NetBackup Job Error Msg | Veritas NetBackup | Relevant only for NetBackup. It returns the error message if either the job or its parent job is in an error state. |
NetBackup Job Tape Media List | Veritas NetBackup | Relevant only for NetBackup. For any successful or partial NetBackup job, this method returns a comma-separated list of the tape media associated with the job. This method returns the tape media list if the job or its parent job's status is success or warning. |
NetBackup Running and Queued Job Count | Veritas NetBackup | Relevant only for NetBackup. The method returns the number of jobs that are in the running state and the number of jobs in the queued state. The counts returned are per backup server. |
NetBackup Running Job Info | Veritas NetBackup | Relevant only for NetBackup. The method returns a value of 1 if a NetBackup job is long-running, slow-running, or stalled, based on the policies that are configured for a host group. |
NetWorker Running Job Count | EMC NetWorker | Relevant only for EMC NetWorker. The method returns the number of backup jobs in a running state. The data returned is per NetWorker server. |
NetWorker Running Job Info | EMC NetWorker | Relevant only for EMC NetWorker. The method returns a value of 1 if a NetWorker job is long-running, slow-running, or stalled, based on the policies that are configured for a host group. |
Restore Successful Job Detail | All Supported Backup Products | For successful restore jobs within the selected, required time period, this method returns the following data on a per-client basis: client ID, along with its corresponding job ID, the count of successful restore jobs, the number of files restored, and the last successful restore date. |
Successful Backup Job Detail | All Supported Backup Products | For the successful full and partial backup jobs within the selected, required time period, this method returns the following data on a per-client basis: client ID along with its corresponding job ID, the count of the number of successful backups, the last successful backup date, amount of data (in MB) saved to tape media, and the amount of data (in MB) saved to disk media. |
Successful Full Backup Job Detail | All Supported Backup Products | For the successful full backup jobs within the selected, required time period, this method returns the following data on a per-client basis: client ID along with its corresponding job ID, the count of the number of successful full backups, the last successful full backup date, amount of data (in MB) saved to tape media, and the amount of data (in MB) saved to disk media. |
Methods: Data Domain Enterprise Object | ||
Data Domain Filesystem Capacity | Data Domain | This method returns total and used filesystem capacities at the Data Domain system level. Requirement: When using this method in a template, the Scope Selector must have the Filesystem Names component selected. |
Data Domain Raw Capacity | Data Domain | Returns raw capacities at the Data Domain system level. Use this method to include the total raw capacity in a report template. |
Data Domain Tape Capacity | Data Domain | Returns tape capacities at the Data Domain system level. Use this method in a report template to display the total tape capacity, as well as the total used tape capacity. |
Data Domain VTL Count | Data Domain | Returns the number of virtual tape libraries (VTLs) at the Data Domain system level. Use this method to include a VTL count in a Data Domain report template. |
Methods: Array Enterprise Object | ||
Array Site Disk Info | IBM | Relevant only for IBM Arrays. For each Array Site, the method returns aggregated information from the physical disk. |
Data Mover CPU and Memory Usage | EMC VNX (Celerra) | Returns data only for EMC VNX (Celerra) arrays: Peak CPU Usage Percentage and Peak Memory Usage Percentage for the Movers for the specified arrays. |
LUN Array Group List | All Arrays | Returns a comma-separated Array Group list for each logical unit. |
LUN Array Port WWN List | All Arrays | Returns a comma-separated Array Port WWN list of all logical units. |
Top 10 Tiers Chargeback Capacity | All Arrays | Lists the chargeback capacity per array in kilobytes and the policy name for the top 10 chargeback policies defined in the system. |
Methods: Host Enterprise Object | ||
Analytics Host Summary | File Analytics | Lists a capacity summary for hosts from which file data has been collected. Use this method to get an overview of how devices and volumes are being used, including an indicator of how much is duplicated. |
Methods: Host Enterprise Object | ||
VM CPU Performance Detail | This method returns details about VM CPU Performance, based on the time period or dates selected in the report's scope selector. The VM CPU Performance Summary enables a Storage Administrator to have an at-a-glance look at CPU I/O performance statistics. | |
VM Disk Performance Detail | This method returns details about VM Disk Performance, based on the time period or dates selected in the report's scope selector. The VM Disk Performance details enable a Storage Administrator to have an at-a-glance look at I/O performance statistics for disks. | |
VM Guest Detail | This method returns details about VM Guests. Use this report to find the largest Virtual Machines. This report lists virtual guests/hosts with usage and status information. NOTE: VMTools must be installed to enable collection of the IP address, Host name, mount points, and guest operating system of the VM. | |
VM Memory Performance Detail | This method returns details about VM Memory Performance, based on the time period or dates selected in the report's scope selector. The VM Memory Performance Summary enables a Storage Administrator to have an at-a-glance look at memory I/O performance statistics, | |
VM Server Detail | Use this report to view the list of Virtual Machine Servers, with access to reports that provide details to help you determine what is using the space on a datastore. This report lists ESX servers, one line item for each physical server, with usage and status information. | |
Methods: Host Enterprise Object | ||
Host Zones and Hops Details | Returns the total number of zones and hops for each host within a fabric. | |
Switch and Fabric Name List Details | Returns a comma-separated list of the switch and fabric names associated with a host. | |
Methods: Host Enterprise Object | ||
Filesystem Summary | Use this method to list file system capacity and the most/least used file systems. | |
Hosts At Risk Details | Identifies hosts that require your immediate attention. Hosts at risk are determined by evaluating current and projected usage. | |
Host Utilization Details | Use this method to get an overview of host utilization to determine if there is contention for storage. | |
Over Provisioned Host Details | This method returns details about over-provisioned hosts, based on the time period or dates selected in the report's scope selector. |