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
Adding an EMC NetWorker Data Collector Policy
Before adding the policy: A Data Collector must exist in the Portal, to which you will add Data Collector Policies.
For specific prerequisites and supported configurations for a specific vendor, see the Certified Configurations Guide.
After adding the policy: For some policies, collections can be run on-demand using the
button on the Collector Administration page action bar. The button is only displayed if the policy vendor is supported.On-demand collection allows you to select which probes and devices to run collection against. This action collects data the same as a scheduled run, plus logging information for troubleshooting purposes. For probe descriptions, refer to the policy.
To add the policy
- Select Admin > Data Collection > Collector Administration. Currently configured Portal Data Collectors are displayed.
- Search for a Collector if required.
- Select a Data Collector from the list.
- Click Add Policy, and then select the vendor-specific entry in the menu.
During the configuration of this Data Collector, you will provide the details for SSH or SMB access to the NetWorker log files, used to collect restore data, group details, and drive performance data.
Specifically, this account needs to have read-only access to have SSH/SMB access to read files in the following directories:
<NetWorker install directory>/logs/
Also, for NetWorker 7.3 and 7.4:
<NetWorker install directory>/res/jobsdb/ssinfo
- Optionally add an EMC NetWorker Backup Server from the policy screen. This action can also be completed in the Inventory.
See Adding/Editing a EMC NetWorker Server within the Data Collector Policy.
- Enter or select the parameters. Mandatory parameters are denoted by an asterisk (*):
- Optionally, add/edit a EMC NetWorker Backup server from the policy screen. These operations can also be completed in the Inventory.
See See Table: Policy Parameters.
- Click OK to save the policy.
- On the Data Collector server, install/update the Data Collector software.
- For long-running backups, it may be necessary to configure the MMINFO_MOVE_BACKWARD_MIN Advanced Parameter to ensure that all savesets are collected successfully.
- Continue to the next step:
Table: Policy Parameters
Field | Description |
---|---|
Collector Domain |
The domain of the collector to which the collector backup policy is being added. This is a read-only field. By default, the domain for a new policy will be the same as the domain for the collector. This field is set when you add a collector. |
Policy Domain |
The Collector Domain is the domain that was supplied during the Data Collector installation process. The Policy Domain is the domain of the policy that is being configured for the Data Collector. The Policy Domain must be set to the same value as the Collector Domain. The domain identifies the top level of your host group hierarchy. All newly discovered hosts are added to the root host group associated with the Policy Domain. Typically, only one Policy Domain will be available in the drop-down list. If you are a Managed Services Provider, each of your customers will have a unique domain with its own host group hierarchy. To find your Domain name, click your login name and select from the menu. Your Domain name is displayed in your profile settings.Example: yourdomain |
Backup Management Server* |
Select the backup product management server (i.e., NetWorker Server) with which the Data Collector will communicate. The NetWorker servers that you added during Data Collector installation should all be listed here. Select the one you want the Data Collector to communicate with and verify that the IP address and OS information are correct. Only available servers are displayed. For example, if a server has been decommissioned or it has been selected for use by another policy, it will not be displayed. |
Add |
Click to add a NetWorker server. Once added, servers are also displayed in the Inventory.See Adding/Editing a EMC NetWorker Server within the Data Collector Policy. |
Edit |
Select a server and click to update the server values. |
Operating System |
The operating system on which NetWorker is running. |
Network Share for Log Files* |
Starting with NetWorker 7.5, a writable and network accessible share must be created on the NetWorker server to enable the Data Collector to transfer log files from this share to the Data Collector server. The Data Collector needs write permissions to the share to be able to copy files from the Networker directories and save them. It needs read permissions to be able to read from the share across the network via SMB (Server Message Block protocol). The Data Collector needs a network-accessible directory defined somewhere on the NetWorker host into which it can copy the log files before copying them over to the Data Collector host. This setup is needed even when the Data Collector and Networker are on the same machine. ---------------------------------------------------------- Example: User creates the directory: C:\Temp User defines the network share \\host\Temp pointed at C:\Temp User enters in this Data Collector policy field.---------------------------------------------------------- Note that though the example is for Windows, the same situation exists on *nix. |
Backup Server Host* |
The Internal name of the Backup Server Host. This is the host name known to the backup product. Example: server1 |
Cluster Name |
The name of the cluster, if applicable, to which the backup server host belongs. |
Remote Software Location* |
The home directory on the NetWorker Server where NetWorker is installed. Typically, C:\Program Files\Legato\nsr for Windows, or /nsr for Linux. |
Backup Software Location* |
The home directory of the NetWorker Admin Client software (location of the nsradmin command) - on the Data Collector Server. Typically, C:\Program Files\Legato\nsr\ for Windows, or /usr/sbin for Linux. |
Windows Domain |
The Windows domain, if applicable. |
User ID |
A Linux or Windows user id that provides access to the NetWorker log files in the directory specified in "Remote Software Location" above. Specifically, this account needs to have SSH access (Linux) or SMB access (Windows) to read log files in the following directories: <NetWorker install directory>/logs/ Also, for NetWorker 7.3 and 7.4: <NetWorker install directory>/res/ Note: The User ID and password are optional if the NetWorker server is installed on the same server as the Data Collector. Example: Administrator |
Password |
The password associated with the User ID. Example: Pwd1 |
Notes |
Enter or edit notes for your data collector policy. The maximum number of characters is 1024. Policy notes are retained along with the policy information for the specific vendor and displayed on the Collector Administration page as a column making them searchable as well. |