Overview
Welcome to the Release Notes for NetWorker API enhancements. To avail of the most recent releases, make sure you download the latest version of the Live Optics collector. We encourage you to follow this page to receive email notifications when this document is updated.
9/25/2023 | New Feature
New tabs and updates have been added to the NetWorker API Excel spreadsheet report to provide you with enhanced capacity, performance, and environment details, and accurate Front End Terabyte (FETB), and reduction information.
System Information Tab - Additional information about the NetWorker system including hostname, serial number, operating system, and time zone.
KPIs Tab - A new summary tab including Number of Clients, System FETB, System Growth Rate, Success Rates, Pre and Post Comp Capacities, Number of Backups, Backup Duration, Total Capacity Contributed for each retention range, and Data Domain MTrees for the NetWorker server.
Client Precomp and FETB Tab - Additional information including client FETB per workload and the monthly growth rate for each client and workload.
Policies Tab - Additional details about configured system policies.
Dedup Jobs - Two new data points, Backup Type and Protection Group have been added.
Backup Front End Capacity Tab - A new Backup Type column shows the corresponding backup type for each save set and protection group.
Known Issues
There are no known issues for this release.
Known Limitations
There are no known limitations for this release.
6/19/2023 | New Feature
NetWorker Online Viewer replaces the Project Details page for NetWorker API collection. It provides new and more illustrative graphs for analyzing and sizing system capacity.
Feature Outline
NetWorker Online Viewer includes:
- Summary graphs:
- System Front End Terabyte (FETB) - The final full system FETB capacity analysis for the previous two months
- Workload FETB and Max Reduction - The FETB capacity for each protected workload type, the Maximum Reduction percentage captured for the previous 60 days, and the corresponding Post Reduction Capacity (TiB).
- Workload FETB and Min Reduction - The FETB capacity for each protected workload type, the Minimum Reduction percentage captured for the previous 60 days, and the corresponding Post Reduction Capacity (TiB).
- 20 Largest FETB Clients, Min Reductions, and Backup Durations - The 20 largest FETB capacities for protected clients with the corresponding Minimum Reduction Percentage, Post Reduction Capacity (TiB), and duration of backups.
- Policy Capacity Retention Ranges - Total Contributed Capacity (TiB) for each configured Retention Range on the system.
- Top 10 Longest Backup Durations
-
Top 10 Longest Clone Durations
- Capacity Tab graphs:
- Daily Pre-Comp Capacity (TiB) - Daily input pre-compressed aggregate capacity of the system over the previous two months.
- Daily Post-Comp Capacity (TiB) - Daily post-compressed aggregate capacity of the system over the previous two months.
- Daily Average Success Rates (%)
- Weekly Capacity Growth Rates (GiB)
- Number of Backups by Duration
Known Issues
There are no known issues for this release.
Known Limitations
- API support begins at NetWorker version 19.x only
- NetWorker Online Viewer supports Networker API collections only.
- Graphs are extracted from Excel data points mapped to API calls from each NetWorker version. As some data points are gathered from older NetWorker versions (19.1 to 19.3), some graphs might not be generated for any missing data points or tabs from Excel outputs.
12/16/2022 | New Feature
Feature Outline
New tabs and updates have been added to NetWorker API Excel spreadsheet reports to provide users with enhanced capacity, performance, and environment details, accurate FETB, and reduction information.
Note: NetWorker API is used for all supported NetWorker versions (19.1 to 19.7). Script-based NetWorker is used only for legacy NetWorker versions (18.x).
New tabs have been added for:
- Client Total Cap Per Workload
- Client Statistics
- Media
- 60 days Pre-comp
- Dedup Jobs
- NetWorker Devices Detailed
- NetWorker Directives
- NetWorker Pools
- NetWorker Schedules
- NetWorker Storage Nodes
- 50 Longest Clones
Additional updates have been added in the following existing tabs:
|
Clients |
Additional columns have been added in this tab to provide further detail. |
|
Details |
A link to the Data Points Definitions KB article has been added. The following note has been added: All measurements on the report are Base 10 calculations and using the main non-SI unit for computer data storage "Byte". |
|
Backup Front End Capacity
|
Front end terabytes for HyperV and VMware VMs excludes white spaces. Front end terabytes for databases include only full backups in the calculation. |
|
Front End Capacity by Workload
|
Front end terabytes for HyperV and VMware VMs excludes white spaces. Front end terabytes for databases include only full backups in the calculation. |
|
Front End Capacity Reported |
Front end terabytes for HyperV and VMware VMs excludes white spaces. Front end terabytes for databases include only full backups in the calculation. |
|
50 Longest Backups |
Server Name has been changed to Client Name. Backup ID has been changed to Backup Name. |
Known Issues
For NetWorker deployments with VMware, the API is currently misreporting the VM Disk Used Capacity that is taken instead of Provisioned capacity to eliminate white spaces. This value is used in the FETB calculation. For accurately used capacity in VMware, Live Optics recommends running Optical Prime.
Known Limitations
- An Internet connection is required.
- The browser must be refreshed to view project updates. Once a project is uploaded to the web portal, you must refresh the page to view the updated project status.
- Live Optics Collector services must have firewall permission to run a successful collection.
- NetWorker versions 19.1 through 19.3 might display missing tabs or columns in their outputs. These will display as N/A as Rest API and its associated JSON files have only been fully stabilized from version 19.4 onwards.
5/5/2021 | Initial Release
The output for collected data is an Excel spreadsheet.
NOTE: Only NetWorker versions 19.1 – 19.x are supported.
Feature Outline
The Excel spreadsheet includes tabs for:
- Details
- System Info
- Backups
- Backup Front End Capacity
- Clients
- Data Domains
- Front End Capacity by Workload
- Front End Capacity Reported
- Jobs
- Licenses
- Policy Capacity Retention (GiB)
- 50 Longest Backups
- Client Capacity
Known Issues
There are no known issues for this release.
Known Limitations
- An Internet connection is required.
- The browser must be refreshed to view project updates. Once a project is uploaded to the web portal, you must refresh the page to view the updated project status.
- Live Optics Collector services must have firewall permission to run a successful collection.