NetBackup IT Analytics User Guide
- Introduction
- Understand the Portal
- Overview
- Portal access
- Portal overview
- Navigating with search
- Valid entries for search
- Search results view: Narrowing the scope
- Filtering data in management grids
- Advanced filtering
- Customizing advanced filter logic
- Saving advanced filters (Inventory)
- Advanced filtering examples
- Advanced filter operators
- Clear advanced filters
- Delete saved advanced filters
- Select columns on management pages
- Detect alerts in the inventory
- About the Inventory tab
- About the Reports tab
- Reports tab keyboard shortcuts
- Reports tab basics
- Templates, reports, and dashboards overview
- About the Alerts tab
- About the Admin tab
- Explore your inventory
- Exploring your inventory
- Inventory privileges
- Getting started with the Inventory navigator
- Hierarchy toolbar to organize your data
- Show objects
- Reset inventory defaults
- Host groups
- Use attributes to organize your data
- Use host groups to organize your data
- Create custom object lists
- Working with the inventory reports view
- Accessing inventory reports
- Choose reports to display
- Filter within available reports by category
- Pin reports - saving reports with inventory objects
- Inventory reports and the action menu
- Work with the inventory list view
- Filter the inventory list view
- Manage objects in the inventory list view
- Assign attributes in the inventory list view
- Set attribute values in the inventory list view
- Import host attribute values
- Export objects from the inventory list view
- Delete objects using the inventory list view
- Customize columns in the inventory list view
- Get acquainted with reports
- Overview
- Reports and templates
- Cloud reports and templates
- Report library
- Report orientation
- Shared reports and dashboards
- About dashboards
- Work in the Reports tab
- New badge
- About caching
- Sections in the navigation panel
- About badging
- About the action bar
- Reports tab keyboard shortcuts
- Folder types
- Report template icons
- Navigate through reports
- Generate and maintain reports
- Report Scope
- Select Report Scope
- Configure report scope with attributes
- Group hosts by attributes
- Search for hosts in the report Scope Selector
- Alert scope selector settings
- Amazon Web Services (AWS) scope selector settings
- Backup Manager scope selector settings
- Backup Manager advanced scope selector settings
- Capacity Manager scope selector settings
- Data Collection Status Details scope selector settings
- Host scope selector settings
- Ransomware Scorecard scope selector
- Solution reports scope selector settings
- System health check scope selector
- Generate reports
- Generate reports from the Cloud
- Units of Measure in Reports
- Advanced Filtering for Tabular Reports
- Customize report filter logic
- Sort columns in reports
- Refresh and set refresh intervals
- Modify Reports
- Convert tabular report to chart
- Add and remove custom header and footer to a report or dashboard
- Set or edit the drill down preference
- Access NetBackup web interface from the IT Analytics Portal
- View report statistics
- Interact with Reports
- Work with Topology
- Add a note to a Backup Job Details Report
- Use new and updated User Report Templates
- Use new and updated System Report Templates (Super User only)
- Save Reports
- Save Cloud Reports
- Delete Reports
- Distribute, share, schedule, and alert
- Exporting Reports and Dashboards
- Known Limitations for Donut Charts
- Scheduling Exported Reports and Dashboards
- Emailing Reports and Dashboards
- Scheduling Emailed Reports and Dashboards
- Viewing and Managing Your Scheduled Reports
- Schedule Types
- Deleting Scheduled Reports and Dashboards
- Setting Up Alerts for Tabular Reports
- Configuring an alert
- Deleting Report-Based Alerts
- Share Reports, Dashboards, and Folders
- Working with Shared Reports
- Organize reports
- Work with dashboards
- Understand the dashboard Icons
- About Cached Reports on Dashboards
- Create new dashboards and add reports
- Add reports to an existing dashboard
- Save a dashboard with a different name
- Customize a Dashboard
- Edit the scope for a report on a dashboard
- Edit the dashboard scope
- Expand a report to full size on a dashboard
- Set the dashboard layout
- Delete a dashboard
- Remove reports from dashboards
- Create a custom report folder
- Create shortcuts to reports and templates
- Manage My Home Pages
- User Home Pages and User Group Home Pages
- Work with the dynamic template designer
- Dynamic Template Designer Overview
- Dynamic Template Designer Cheat Sheet
- Modify an Out-of-the-Box Dynamic Template
- Dynamic Template Designer Quick Start
- Quick Start Step 1: Create a Basic Table Dynamic Template
- Quick Start Step 2: Format Fields
- Quick Start Step 3: Create a Calculated Field
- Quick Start Step 4: Configure Table Column Totals
- Quick Start Step 5: Define the Scope Selector
- Quick Start Step 6: Generate a Report and View the Automatically Generated Help
- Steps to Create Dynamic Templates
- Working with Enterprise Objects and Fields
- Select an Enterprise Object
- Configure General Dynamic Template Designer Components
- Converting to a Homogeneous, Product-Specific Template
- Add Fields and Methods to a Dynamic Template
- Alias Names for Fields
- Conditions When Hidden Fields are Included by Default
- Dynamic Template Field Configuration
- Valid Formatter Patterns
- Examples of Dynamic Templates Containing Graphics Tool Tips
- Dynamic Template Drilldown Configuration
- Custom Drilldowns and Examples
- Drilldown Parameters
- Examples of Dynamic Templates Containing Drilldowns
- Using Groups in Dynamic Templates
- Add a Group to Create Separate Line Charts in a Report
- Add a Group to Create a Double Header in a Tabular Report
- Dynamic Template Function Configurations
- Examples of Dynamic Templates Containing Functions
- Create User-Defined Fields with the Field Builder
- Create Fields with the Field Builder
- Configure a Static Filter
- Filter on Date Fields
- Static Filter vs. Tabular Report Filter
- Configure the Field Sort Order
- Return Unique Results
- Dynamic Template Scope Selector Components
- Scope Selector Component - Custom Filter
- Data Domain Enterprise Object Scope Selector Components
- Host Enterprise Object Scope Selector Components
- Job Enterprise Object Scope Selector Components
- Storage Array Enterprise Object Scope Selector Components
- Customize and Export Dynamic Templates
- Export/Import Dynamic Templates Containing Custom Attributes
- Export a dynamic template that contains attributes
- Import a dynamic template that contains attributes
- Save a Dynamic Template After Edits
- Format the Dynamic Template Output
- Configure a Bar Chart Dynamic Template
- Steps to Create a Bar Chart Dynamic Template
- Bar Chart Dynamic Template: Use Case
- Bar Chart Dynamic Template Step 1: Create a Dynamic Template
- Bar Chart Dynamic Template Step 2: Configure Basic Field Functionality
- Bar Chart Dynamic Template Step 3: Configure Functions for a Field
- Bar Chart Dynamic Template Step 4: Configure Drilldowns for a Field
- Bar Chart Dynamic Template Step 5: Configure a Line Field
- Bar Chart Dynamic Template Step 6: Define the Scope Selector
- Bar Chart Dynamic Template Step 7: Save and Run the Report Template
- Examples of Bar Chart Dynamic Templates
- Configure an Area/Stacked Area Chart Dynamic Template
- Area/Stacked Area Chart Dynamic Template Step 1: Create a Dynamic Template
- Area/Stacked Area Chart Dynamic Template Step 2: Configure Basic Field Functionality
- Area/Stacked Area Chart Dynamic Template Step 3: Configure Functions for a Field
- Area/Stacked Area Chart Dynamic Template Step 4: Define the Scope Selector
- Area/Stacked Area Chart Dynamic Template Step 5: Save and Run the Report Template
- Configure a Donut Chart Dynamic Template
- Example of a Donut Chart Dynamic Template
- Configure a Horizontal Bar Chart Dynamic Template
- Example of a Horizontal Bar Chart Dynamic Template
- Configure a Horizontal Stacked Bar Chart Dynamic Template
- Example of a Horizontal Stacked Bar Chart Dynamic Template
- Configure a Line Chart Dynamic Template
- Line Charts for Performance Metrics
- Steps to Create a Line Chart Dynamic Template
- Line Chart Field Requirements
- One Object Per Line Chart, One or More Metrics Per Chart
- Multiple Objects Per Line Chart, One Metric Per Chart
- Format Line Chart Fields
- Line Chart Scope Selections
- Examples of Line Chart Dynamic Templates
- Configure a Pie Chart Dynamic Template
- Examples of Pie Chart Dynamic Templates
- Configure a Stacked Bar Chart in a Dynamic Template
- Example of a Stacked Bar Chart Dynamic Template
- Configure a Table Dynamic Template
- Examples of Tabular Dynamic Templates
- Create a Sparkline Chart in a Tabular Dynamic Template
- Configure Chart Axes
- Using Methods in Dynamic Templates
- Overview of Method Creation
- System Methods
- Stand-Alone Methods
- Viewing Methods
- Adding or Editing Methods
- Tokens for Methods
- Exception Tables for a Method's Join Clause
- Validate and Save a Method
- Delete a Method
- Troubleshooting Dynamic Templates
- Work with the SQL template designer
- SQL template designer overview
- Database Published Views
- Steps to Create SQL Templates
- Create a SQL Template
- Configure SQL Template Scope Selector Components
- Date Range
- Host Groups and Client Scope
- Array Scope Selector
- Datastore Scope Selector
- VM Servers Scope Selector
- VM Guests Scope Selector
- Custom Text Fields
- Example of Custom Text Field Configuration in a SQL Template
- Access Help for Database Views
- Static Custom Combo Box
- Example of a Combo Box Configuration in a SQL Template
- Query Custom Combo Box
- Example of a Query Custom Combo Configuration in a SQL Template
- Construct the SQL Query
- Help for Database Views
- Accessing the Published Database Views from the CLI
- Special Characters in SQL Queries
- Sample SQL Queries
- Example of a Query for Host Attributes
- Using the apt_v_server_attribute View in Queries
- Considerations for Attributes Used in SQL Template Designer Queries
- Example of a Query of Failed Backup Jobs
- Example of the SQL Custom Join Feature in a SQL Template
- Example of a Sparkline Query in a SQL Template
- Example of Sums in a SQL Template
- Example of Using a Special Character as a Literal in a SQL Query
- Configure SQL Template Scope Selector Components
- Use Functions in Queries
- Format the SQL Template Output
- Configure a Bar Chart SQL Template
- Example of a Bar Chart SQL Template: Host CPU Performance
- Configure a Line Chart SQL Template
- Configure a Donut Chart SQL Template
- Example of a Donut Chart SQL Template: NetBackup Job Size by Job Type
- Configure a Gauge Chart SQL Template
- Example of a Gauge Chart SQL Template: Allocated Capacity
- Configure a Horizontal Bar Chart SQL Template
- Example of a Horizontal Bar Chart SQL Template: Host CPU Performance
- Configure a Horizontal Stacked Bar Chart SQL Template
- Example of a Horizontal Stacked Bar Chart SQL Template: Available/Allocated Capacity
- Configure an Area Chart SQL Template
- Example of Area Chart SQL Template: Allocated Available
- Configure a Pie Chart SQL Template
- Example of a Pie Chart SQL Template: Overall Job Status Summary
- Configure a Pivot Table SQL Template
- Example of a Pivot Table SQL Template: NetBackup Job Size
- Configure a Stacked Bar Chart SQL Template
- Example of a Stacked Bar Chart SQL Template: Host CPU Performance
- Configure a Table in the SQL Template Designer
- Save and Share Report Templates
- Advanced SQL Report Template Options
- Export/Import SQL Templates
- Pipelined functions for report query building
- About Pipelined Functions
- General Functions
- APTlistOfDates
- aptStringConcat
- collectString
- getLicenseClientDetail
- getServerAttributeValue
- getObjectAttributeValue
- getChildServerGroupContextById
- getServerGroupContextById
- secsToHoursMinSecs
- Backup Manager Functions
- APTgetJobTypeName
- APTgetTapeDriveStatusName
- getFullPathname
- listJobSummaryAfterRestart
- listJobSummaryAfterRestartNBW
- listJobSummaryAfterRestart for NetWorker Backup Jobs
- listOfBackupWindowDates
- listOfBackupWindowDates (by Backup Window ID)
- Policy Auditing Functions
- listClientChanges
- listPathnameChanges
- listPolicyChanges
- listScheduleChanges
- Capacity Functions
- listChargebackCatByVOLSDetail
- listChargebackCatByNcVolDetail
- listChargebackCatByFSDetail (for HNAS)
- listChargebackCatByFSDetail (for EMC Isilon)
- listChargebackByLUNSummary
- listChargebackByLUNDetail
- listChargebackCatByLUNSummary
- listChargebackCatByLUNDetail
- Alert configuration
- Manage hosts, backup servers, and host groups
- Manage attributes and objects
- About attributes
- Attribute example
- Host groups vs attributes
- Bulk load utilities and attributes
- System attributes
- Attribute inheritance
- Manage attributes
- Set attributes on hosts
- Add attributes
- Edit or rename attributes
- Enable granular user access using authorization attributes
- Delete attributes
- Attribute naming rules
- Examples of attributes and values
- Understanding the attribute management view
- Attribute management view (Top-Level domain)
- Attribute management view (Sub-Domain)
- Export/Import dynamic templates with custom attributes
- About object maintenance
- Product specific objects for reporting
- Maintaining objects
- Assign attributes using object maintenance
- Search for objects by type in object maintenance
- Customize library objects
- Permanently remove devices, libraries, and drives
- Provide Portal access and user privileges
- Providing user access to the portal
- Creating portal user accounts
- About user types
- Selecting user groups for users
- Working with user groups
- Creating user groups
- Assigning users to user groups
- About user privileges
- Assigning user privileges
- Setting user group privileges
- Enabling new product report templates
- Importing reports
- Enabling cloud privileges
- Granting access to template designers
- Enabling all privileges in a category
- Managing users and user groups
- Searching for users and user groups
- Editing user accounts
- Impersonating user accounts
- Setting / Resetting passwords
- Account lockout
- Managing user group home pages (Administrator)
- Removing portal users
- Deactivating user accounts
- Configure primary schedules and backup windows
- Add, edit, and move policies
- Add/Edit a Cloud Policy to share performance statistics
- Configure community performance profiling
- Add/Edit a threshold policy
- Add/Edit a capacity billing and usage policy
- Capacity Chargeback policy types
- Add/Edit a backup SLA policy
- Add/Edit a SAN Fabric Chargeback policy
- NetBackup IT Analytics Billing and Chargeback policies
- Add/Edit a Billing and Chargeback policy
- Solutions administration
- Manage and monitor data collection
- Data collection overview
- Data collection component configuration
- About data collection tasks
- Data collection installation summary
- Update the Local Hosts file for data collection
- Data Collector security and data encryption
- Manage Data Collectors and collection policies
- About validation and status
- Add/Edit Data Collectors
- Enable/Disable data collectors
- Enable and disable data collection policy schedules
- Review collectors and collection status
- Deleting a data collector
- Upgrade Data Collectors
- Monitoring data collection status
- Organize the collection status view
- Quick Filters
- View data collection status
- Troubleshoot data collection status
- Use reports to monitor data collection status
- Work with Capacity Manager host data collection
- Understand the host data collection process
- Host resources prerequisites and configurations
- Host Access Privileges, Sudo Commands, Ports, and WMI Proxy Requirements
- Host access requirements
- Command path verification
- Host discovery and collection configuration steps
- Host discovery and collection setup overview
- Host discovery and collection maintenance overview
- Before discovering hosts
- Configure/Search
- Manage credentials
- Manage WMI Proxy
- Manage paths
- Manage access control
- Host management
- Configure host discovery policies to populate the host discovery and collection view
- Execute and monitor host discovery
- Discovery processes
- Validate host connectivity
- Show errors
- Filter the host discovery and collection window - Hide/Unhide, remove
- Search and export in host discovery and collection
- Export in host discovery and collection
- Configure and edit host probes
- Propagate probe settings: Copy probes, paste probes
- Discovery policies for Veritas NetBackup
- View and manage system notifications
- Customize with advanced parameters
- Overview of advanced parameters
- Use cases for advanced parameters
- Adding an advanced parameter
- Access control advanced parameters
- General Data Collection advanced parameters
- DC_START_CONNECT_RETRIES
- COMMAND_TIMEOUT
- DATARCVR_READ_TIMEOUT
- LOGGING_LEVEL
- METACOLLECTOR_MAX_THREADS
- METACOLLECTOR_MIN_THREADS
- PATH_CONTROL_PARAM
- SSH_ALTERNATE_PKG_USE
- SSH_CHANNEL_WAIT_TIME
- SSH_CIPHERS
- SSH_DEBUG
- SSH_PORT
- STDOUT_ERROR
- STDOUT_FILTER_LIST
- THREAD_IDLE_TIMEOUT
- WMI_PROXY_VERSION_TIMEOUT
- Cloud data collection advanced parameters
- Host discovery and collection advanced parameters
- Backup Manager advanced parameters
- COMMVAULT_OLDEST_JOB_HOURS
- MMINFO_MOVE_BACKWARD_MIN
- NBU_AUDIT_LOOKBACK_DAYS
- NBU_DUP_JOB_PARTIAL_STATUS_OVERRIDE
- NO_AVAMAR_CLI
- RMAN_BACKUP_LOOKBACK_DAYS
- RMAN_BACKUP_LOOKBACK_OVERRIDE
- SUPPRESS_KERBEROS_PROMPT
- USE_ALT_NBU_INCL_EXCL
- USE_NTML_V2
- VEEAM_BACKUP_LOOKBACK_DAYS
- VEEAM_BACKUP_LOOKBACK_DAYS_OVERRIDE
- Capacity Manager advanced parameters
- File Analytics advanced parameters
- Virtualization Manager advanced parameters
- Manage your Portal environment
- Manage ransomware scorecard
- Analyze files
- Troubleshoot the Portal
- Support tools
- Requesting a support package
- File selector wildcards
- Retrieving log files
- Archiving script
- Debug
- Login errors
- Add notes to failed jobs
- Host name processing - Filters and aliases
- Change the Portal server's IP address
- Changing the port for Portal server communication
- Determine report rendering statistics
- Clearing the inventory and report cache
- Troubleshoot Oracle performance issues in NetBackup IT Analytics
- Attribute inheritance overrides
- Understanding report data caching
Syslog configuration
Configure a Syslog server in your environment before setting Syslog as the alert notification method. With this configuration Syslog notification becomes available for default alerts and report-based alerts.
The following Syslog server details are required for the configuration:
Server IP
Name
Port number
Application name and protocol
The rest of the details can be specified during the configuration.
Before you configure the Syslog notification, you must ensure you have Syslog server already configured in your environment and you have its IP, name, port number, application name, and protocol details. See Configure alerting for a domain.
To configure Syslog notification:
- Go to Alerts > Syslog Configuration. If you are adding the first notification, the page appears blank. During subsequent configurations, the page displays a list of previously configured notifications.
- Select a domain from the Domain list. The Domain list is displayed only if you have access permissions to more than one domains.
- Click Add to open the configuration screen.
- Configure Syslog notification based on the descriptions below:
Field Name
Description
Name
Name of your Syslog configuration. This name appears in the list displayed on the Syslog Configuration page and in the Syslog list when you configure an alert notification.
Description
A short description of your Syslog configuration.
Server Name
Enter the IP address of the Syslog server.
Server Port
Port number on which the Syslog server is running.
Application Name
The device or application that generated the message.
Message ID
The identification number of the message.
Protocol
Protocol used to send the message. Choose from TCP or UDP.
Message Format
Choose from RFC_3164, RFC_5424, or RFC_5424.
Facility
Facility represents the machine process that created the Syslog event. For example, is the event created by the kernel, by the mail system, or by security/authorization processes, and so on. In the context of this field, it is a kind of filter, instructing SMS to forward to the remote Syslog Server only those events whose facility matches the one defined in this field.
Severity
Select the level of severity that will trigger the notification.
SSL
SSL works between the portal and the Syslog server. To communicate securely both need each other's certificates.
Hence, Portal certificate must be present in the portal keystore before configuring Syslog with SSL. See Add a Certificate into the portal keystore in the NetBackup IT Analytics System Administrator guide.
Click Accept Certificate to fetch the Syslog server's certificate and display it for verification. After accepting the certificate, it is used to validate the identity of Syslog server.
- Click Test to verify the configuration and connectivity on the Syslog server.
- Click Save. Your configuration appears in the Syslog Configuration list. Once saved, the Syslog configuration name also appears in the list against the Syslog checbox of the Add Alert Notification screen.
Prerequisite: Before you enable Syslog notification for report-based alerts, enable Syslog alerting for the domain from Admin > Domains > Domains > Alerting tab. See Configure alerting for a domain.
To enable Syslog notification for report-based alerts:
- Open the report for which you want to enable Syslog alert notification.
- Right-click on the report and select Alert from the menu. The Alerting screen is displayed.
- Define the alert frequency and select Syslog as the alert delivery mode. Also, specify the Syslog configuration from the list.
- Click OK to save the changes. The portal uses the specified Syslog configuration to send notifications of the report-based alerts.
You can delete the configuration for Syslog notification only if it is no longer attached to any report or alert. The portal displays an error message stating the Syslog is configured with a report or alert when you attempt to delete an attached configuration.
To delete a Syslog configuration from the portal:
- Make sure the none of the alerts or reports are attached to the Syslog configuration.
- Go to Alerts > Syslog Configuration. The page displays a list of configured notifications.
- Select the configuration and click Delete.