NetVault Backup 12.3 - CLI Reference Guide

Introduction Getting started Using the command-line utilities Using the nvreport utility

Creating external report files

The report files generated using the nvreport utility can be saved to the output subdirectory in the reports directory (<NetVault Backup home>\reports\output on Windows and <NetVault Backup home>/reports/output on Linux) and used as required. For example, they can be opened for viewing in a browser or sent as email attachments. The procedure for creating an external report file includes the steps outlined in the following sections:

There are two types of report template files.

HTML template files: These templates are used to by the NetVault WebUI. You can use them with the ‑outputdir option to create HTML-based external files. For more information about these templates, see HTML template files.
Plain text template files: These templates are used by the CLI utilities to display output in the terminal window. You can use them with the ‑outputdir option to create plain text external files. The plain-text template files contain the text “clidefault” in their filename or “cli default file” or “textual” in their “Nice Name.” For more information about these templates, see Plain text template files.

Use the following options to create the report file:

-templatename: Specifies the “nice name” of the template file
-templatefile: Specifies the name of the template file. You must specify the full file path with this option. The report templates are located in the <NetVault Backup home>\reports\ templates directory.

The output directory is created in <NetVault Backup home>\reports\output on Windows and <NetVault Backup home>/reports/output on Linux.

The syntax for this option is:

Example:

Note the following:

If an existing subdirectory is specified with the -outputdir option, it is overwritten when a new report is generated. To retain the contents of an existing report file, use the -appendoutput option. It allows you to append the new report data to the existing report file.

Example:

Note the following:

The -appendoutput option must be used with the -outputdir option.

The -title option can be used with the -outputdir option to assign a user-defined to the saved report file. This syntax for using this option is:

If a title is to contain any spaces, the entire value must be enclosed in quotation marks.

Example:

Note the following:

This option can be used with the -outputdir option to add a title to any format of template (HTML or plain text.
When used with the -appendoutput option, the -title option is used as the title of the report that is appended to the existing “output.html” file. The existing report maintains its existing title.

HTML template files

The following table provides the “nice name” and filename of the HTML template files.

activejobs

Currently Active Jobs

Lists all active jobs. The report includes:

alldrives

All Drives

Lists all drives controlled by the NetVault Backup Server. The report includes:

allfailedpolicyjobs

Failed Policy Jobs

Provides a summary of failed policy jobs for the specified period. The report includes:

clientgroups

Client Groups

Lists all client groups. The report includes:

clientstatuses

Client Statuses

Displays the status of added clients. The report includes:

errorlogs

Recent Error Logs

Lists error logs generated during the specified period. The report includes:

events

NetVault Events

Lists events raised during the specified period. The report includes:

expiredofflinemedia

Expired Offline Media

Lists expired offline media. The report includes:

failedrequests

Failed ULA Requests

Provides a summary of failed user requests for the specified period.

fullonlinemedia

Full Online Media

Lists online storage devices that are full. The report includes:

globalnotifications

Global Notifications

Lists events that are included in the global notification profile. The report includes:

historicjobs

Historic Jobs - By Date

Displays date-wise summary of jobs performed during the specified period. The report includes:

historicjobsbysize

Historic Jobs - By Size

Displays size-wise summary of jobs performed during the specified period. The report includes:

jobdefinitions

Defined Jobs

Displays all job definitions. The report includes:

jobhistory

Executed Job History

Provides a summary of jobs performed during the specified period. The report includes:

libraryblankcounts

Blank Media Items In Libraries

Displays the number of blank media items residing in the libraries controlled by the NetVault Backup Server. The report includes:

librarycontents

Libraries' Media Contents

Provides a summary of currently online media items. The report includes:

logs

NetVault Logs

Displays system logs generated during the specified period. The report includes:

mediacontentsquery

Media Contents Query

Provides a summary of data stored on individual media items. The report includes:

mediageneral

Media — General

Provides a summary of used media items. The report includes:

mediasegmentcontents
query

Media Segment Contents Query

Provides a summary of data stored on each segment. The report includes:

mediautilization

Media Utilization

Displays the storage utilization statistics for devices controlled by the NetVault Backup Server. The report includes:

notifications

Users' Selected Notifications

Lists all events that have been included in any user notification profile. The report includes:

offlinedevices

Offline Devices

Lists devices that are currently offline.

outstandingopmsgs

Outstanding Operator Messages

Lists operator messages that have not been acknowledged. The report includes:

If all messages have been acknowledged or deleted, this report returns no information

overnight_jobs_failed

Failed Overnight Backup Jobs

Provides a summary of overnight backup jobs that failed. The report includes:

overnight_jobs_failed_
count

Count Of Failed Overnight Backup Jobs

Displays the total number of the overnight backup jobs that failed (for example, “0 backup jobs failed”).

overnight_jobs_
successful_count

Count Of Successful

Overnight Backup Jobs

Displays the total number of the overnight backup jobs that completed successfully (for example, “12 backup

jobs finished successfully”).

overnight_jobs_total_
data_stored

Count of Data Stored

In Overnight Jobs

Displays the total amount of the data stored in overnight jobs (for example, “Approx. 348GB of data was stored”).

overnight_jobs_

warnings_count

Count Of Overnight

Backup Jobs Finished

With Warnings

Displays the total number of the overnight backup jobs that completed with warnings (for example, “1 backup job finished with warnings”).

policiessummary

Policy Basics

Provides a summary of backup policies. The report includes:

restoresummary

Restore Summary

Provides a summary of all restore jobs. The report includes:

serverlicensecapabilities

Server License Capabilities And Usage

Displays available and used licenses for NetVault Backup. The report includes:

serverlicenseflags

Server License Flags

Lists the functionality offered by current Server License type.

single_job_drives_events

Single Job's Drive Events

Displays the transfer rates for the drives used in a specific job.

single_job_logs

Single Job's Logs

Displays the log entries for a particular job. The report includes:

single_job_media

Media Used by Single Backup

Displays the media usage details for a particular job. The report includes:

single_job_media_
transfers

Single Job's Media Transfers

Displays the data transfer details for a particular job. The report includes:

single_job_summary

Single Job Main Summary

Provides a summary of a particular job. The report includes:

single_job_xfer_rates

Single Job's Data Transfer

Rate

Displays the data transfer rate for a particular job. The report includes:

singlepolicybytecounts

Policy Totals

Displays the backup size and transfer rate for a backup policy. The report includes:

singlepolicyclients

Policy Clients

Lists all clients included in a policy. The report includes:

singlepolicyfailedjobs

Failed Jobs Within Single Policy

Lists all failed jobs for a backup policy. The report includes:

singlepolicyjobs

Defined Policy Jobs

Provides a summary of jobs added to a policy. The report includes:

singlepolicystatus

Policy Status Information

Displays the status of a particular policy. The report includes:

singleusersaudittrail

Single User's Audit Trail

Displays auditor logs for the specified user account.

userdefinedeventtypes

User-Defined Event Types

Lists all user-defined events. The report includes:

userdetails

User Details

Displays the details of NetVault Backup users. The report includes:

userprivileges

User Privileges

Lists privileges granted to individual users.

usersmediausage

Quotas And Media Usage

Provides a summary of used and assigned media quota for each user account. The report includes:

 

Documents connexes