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
- Export reports and dashboards
- Known Limitations for Donut Charts
- Schedule export of reports and dashboards
- Email reports and dashboards
- Schedule email of 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
- 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
- HISTORIC_TIME_INTERVAL_HOURS
- 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
- Troubleshoot test connection locale issue
- Attribute inheritance overrides
- Understanding report data caching
Add ransomware data query
Data query enables you to perform a data-driven evaluation of your ransomware preparedness. You can add a data query around a critical report value and evaluate your ransomware score and trend. To display accurate Ransomware score and its trend, the report instance used in the data query must contain only a single row, column, and numeric value. For this reason, your report instance must span your entire domain. The report instance may contain an average, a sum total, or a percentage value derived from multiple sources. Hence, this value can be typed either as a Numberor Percentage and a default score of lowest, low, medium, high, or highest is assigned to it. User responses are compared to this default score to determine the ransomware score and trend. For example, a data query to show the deployment status of a specific NetBackup EEB requires a report instance that calculates the percentage of NetBackup primaries with the EEB installed.
As a user with Ransomware Administrator privileges, you have the privilege to add data queries to the default set of queries. This procedure provides the steps you can follow to add custom data queries to the Ransomware Scorecard.
To add a ransomware data query on the Ransomware Scorecard:
- Select Reports > Ransomware > Ransomware Scorecard.
- Select the Domain, Query Status, Query Visibility, and Query Type from the scope selector to access the scorecard containing your target query and click Generate. The Ransomware Scorecard is generated based on your scope selection and the data queries are denoted as Data in the Type column of the scorecard.
- Click Add data query on the scorecard and fill the Add Data Query form based on the description below:
Field
Description
Question
Enter the query text.
Weight
Assign a weight to your query in a range of 1 to 5, where 1 indicates the least and 5 indicates the most important query. Weight is used as a multiplier of the Score to calculate Risk, which eventually impacts the Ransomware Score. Hence, assign the highest weight to the most important query.
Description
Enter any additional information about the query. This may include the details about the expected responses or guidance about how to answer the query.
Best Practice Recommendation
Describe the recommended best practice for ransomware preparedness with respect to the query. Provide guidance to implement the best practice. This recommendation hidden until the user has answered the query.
More Info Link
Provide a hyperlink to any additional information relevant to your query. This field is optional.
Saved Report Instance
Select the report instance from which the query can source values to determine the data item score.
This list displays the names of all report instances saved under My Reports. The report you select must be based on a report template that returns only one value of type number or percentage. Preferably, the value must have a drill down view that displays the sources from which it was derived. If your report does not include a drill down, you will be asked if you want to continue, as having a drill down is a best practice in most cases.
Schedule
Schedule the time when the data query must run.
Data Type
Select the type of value that the report instance must return. You can choose Number or Percentage as type of value from the list.
Default Score
Set the default value to use if the report returns a value outside the mapped range.
Default Score options:
Lowest
Low
Middle
High
Highest
Range
Define the value range and assign a resiliency score for the defined range from the options below. User response will be assigned a score from these options based on which numeric range in which their responses fit into. You can define multiple ranges depending on the anticipated user responses. If the Data Type is set to Percentage, all ranges must be specified between 0 and 100.
Start: Enter the starting value of the score range. This value is inclusive
Less than: Enter the end value of the score range. This value is exclusive.
Score: Assign a score from the list to the defined range. This score is compared with the default score to determine the ransomware score and trend.
Add Result
Click to add another score-mapping row for your data query.
Delete
Click to remove a score-mapping row.
- Click OK to save the data query. The new data query appears on the Ransomware Scorecard and becomes available to other users to register their responses.