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
Load Relationships Between Hosts and Host Group
Description | Imports host-to-host-group relationships from a comma-delimited file. You can choose to audit the host movement, which records the details when a host is removed, added, or moved. See Sample Audit File (output from load_package.loadGroupMemberFile). |
Usage | execute load_package.loadGroupMemberFile('<file_name>', '<recycle_group>', <remove_old_entries>,'<audit_pathname>', '<audit_output_file>', <do_log>); Where: file_name is the fully qualified path to the csv file. For example: /opt/aptare/database/hosts.csv recycle_group is the full path to the group into which deleted hosts will be moved (i.e., the 'recycle bin'). remove_old_entries enables you to remove relationships in the Reporting Database that are not in the file. If set to 1 and where there are hosts with a previous relationship to a host group and where that relationship is no longer represented within the file, the utility moves those hosts to the recycle group. If set to 0, the utility does not remove those hosts. audit_pathnameis the full path to the audit file, not including the filename. audit_output_fileis the name of the audit file where the audit results will be stored. do_logenables you to turn on the auditing function so that all host movements are logged in the audit_output_file. Enter a numeric: 0 or 1, where 0 = No, 1 = Yes. Example command: execute load_package.loadgroupmemberfile ('/opt/aptare/database/movehosts.csv','/Global1/Recycle',1,'/opt/aptare/database','movehosts.out',1); |
Load File Specification | The specification for the comma-delimited file is as follows: path_to_host_group, internal_name1, internal_name2, internal_name3, etc. Where path_to_host_group is the fully qualified path to the host group into which the hosts should be added, and internal_name1 is the internal name of a host within the existing host group hierarchy. Example: /APTARE/Test, testhost01, testhost02 /APTARE/Infrastructure, testhost02, testhost03 Detailed specification for each field follows: internal_name CHAR(64) NOT NULL |
Data Constraints | The first field, path_to_host_group, must be the full path to an existing host group. If any host groups in the path_to_host_group field value do not exist, the utility creates them. Field values cannot contain embedded commas. The csv file must exist and be readable. The recycle group folder must exist. Each row must have at least one host specified, otherwise the row will not be processed. |
Logic Conditions | If you list hosts after the path_to_host_group field and those hosts are located in the existing host group hierarchy, the utility adds those host groups to the specified host group. If a host with the specified internal name does not exist in the hierarchy, the relationship will not be added. The host must already be configured in the reporting database. If any host groups in the path_to_host_group field value do not exist, the utility creates them. If the removeOldEntries parameter is set to 1, the utility assumes that this file will contain all the required relationships. In other words, for all the host groups that you specify in the file, only those hosts will be in that group after you run this utility. If the host group previously contained other host(s) that are now no longer listed in the file, the utility removes those host(s) from the host group and moves them to the recycle folder. The utility does not delete host groups from the Reporting Database; it only removes members of a host group. If a host group in the Reporting Database is not listed in the file, the utility does not take any processing action against that host group. Host groups with many hosts can be split into multiple lines for ease of file maintenance--for example, the host group and some of the hosts appear on the first line, then the same host group and other hosts appear on subsequent lines. |
Logging | The utility logs all additions, updates, warnings, and errors to the scon.log file, which is located under /tmp by default on Linux systems and C:\opt\oracle\logs on Windows systems. Logging strings are typically in the following format: Date -> Time -> Level -> load_package:sub_routine -> Action Where: Level is DBG, INFO,WARN, or ERR. sub_routine is the sub routine that is being executed (e.g. loadServerLine). Action is the action that was being reported on. Example: 14-MAY 19:00:06 ERR load_package:loadServerGroupMembers: Host group /APTARE/Business Views/Regional Offices/ Connecticut does not exist on line 6 of the data load file |