Chat now with support
Chat with Support

NetVault 13.0.1 - CLI Reference Guide

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

About nvreport utility

The nvreport utility allows you to generate and view canned reports from the command-line interface. These reports provide information about the backup and restore jobs, storage devices, clients, media utilization, and other aspects of NetVault.

To access help for nvreport, type:

The nvreport utility uses “template” files to output the report data. The template files determine the content, layout, and format of the report. The report templates are located in the <NetVault home>\reports\ templates directory.

There are two methods to specify a template file to generate a report:

Using the actual filename: You can use the “-templatefile” option to specify the actual template file that you want to use. With this option, you must provide the full file path for the template file.
Using the “nice name”: Each template file has an alternate name value known as its “nice name.” This name is used for the template file in the NetVault WebUI. Specify this “Nice Name” with the “‑templatename” option.

To access help for the template files, type:

Table 90. nvreport

-server

Specifies the name of the NetVault Server that administers the job.

This option is required when a remote server administers the job. It can be omitted when a local server administers the job. The server name is case‑sensitive.

-class

Specifies the report class. Class names are case-insensitive.

The main purpose of a class is to organize the individual report components or template files into groups. These template files are used to generate the reports.

When a class name is specified with the -class option, the default template file associated with the class is used to run a report.

Example:

nvreport -class Clients

For more information about the available report classes, see Report classes

-templatename

Specifies the “nice name” of the template file.

Example:

nvreport -templatename “Client Machines - cli default template”

Note the following:

For more information, see Plain text template files.

-templatefile

Specifies the name of the template file. You must specify the full file path with this option.

Example:

nvreport -templatefile C:\NetVaulBackup\reports\templates\logsclidefault

Note the following:

The report templates are located in the <NetVault home>\reports\ templates directory.

For more information, see Plain text template files.

Report classes

The following table provides a brief description of the report classes available in NetVault.

Table 91. Report classes

Advanced Options

Displays all Advanced Options Sets and their details.

Audits

Displays all operations attempted by a specific user account with their result (“Yes”, if granted; “No”, if denied) and date and time each operation was attempted.

Backup Targets

Displays all Backup Target Sets and their details.

Client Groups

Lists all client groups. The report includes:

Clients

Displays the status of the added clients. The report includes:

Defined Jobs

Displays all job definitions. The report includes:

Drive Events

Lists events related to drives controlled of the server. The report includes:

Drive Performance Statistics

Displays the performance statistics for all drives controlled by the server. The report includes:

Drives

Lists all drives accessible to NetVault. The report includes:

Entry/Exit Ports

Lists all entry/exit ports (EEPorts) that exist in any libraries controlled of the server. The report also includes the details of media items residing in the E/E port.

Index Media

Provides the summary of Index media of a backup job. The report includes:

Job History

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

Libraries

Lists all libraries controlled by the server. The report includes:

Library Drives

Lists all drives controlled by the server. The report also includes the details of media items residing in the drive.

Library Slots

Lists all slots that exist in libraries controlled by the server. The report also includes the details of media items residing in the slots.

License Capabilities

Provides a summary of available and used licenses for NetVault.

Media

Lists media items in use by devices controlled by the server. The report includes:

Media Capacities

Displays the media capacity details for media items available in the libraries and drives controlled by the server.

Media Job Contents

Lists all backup savesets stored on available media. The report includes:

Media Requests

Displays media request details. The report includes:

Media Segment Contents

Provides a summary of media segments. The report includes:

Media Transfer Requests

Displays all transfer requests. The details include:

NetVault Event Types

Displays all event types.

NetVault Events

Displays all events raised during the specified period. The report includes:

NetVault Logs

Displays all log messages. Based on the number of log entries that exist in the NetVault Database, it may take several minutes for this command to display the results.

Notifications

Lists all events for which any notification method is set. The report includes:

Operator Messages

Displays all outstanding operator messages. The report includes:

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

Policies

Provides a summary of backup policies. The report includes:

Policy Clients

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

Policy Jobs

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

Privileges

Lists the privileges currently granted to each user.

Report Templates

Displays all report template files that are saved in the templates subdirectory (<NetVault home>\reports\templates on Windows and <NetVault home>/reports/templates on Linux). The report includes:

Schedule Sets

Displays all Schedule Sets and their details.

Segments

Lists all segments for a backup job. The report includes:

Selection Options Sets

Displays all Backup Options Sets and their details.

Selection Sets

Displays all Selection Sets and their details

Users

Lists all NetVault users. The report includes:

Plain text template files

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

Advanced Options

Advanced Options - cli default template

advancedoptionsclidefault

Audits

Audits - cli default template

auditclidefault

Backup Targets

Backup Targets - cli default template

backuptargetsclidefault

Client Groups

Client Groups - cli default template

groupsclidefault

Clients

Client Machines - cli default template

clientsclidefault

Defined Jobs

Defined Jobs - cli default template

jobdefinitionsclidefault

Drive Events

Drive Events - cli default template

driveeventsclidefault

Drive Performance Statistics

Drive Performance Statistics - cli default template

driveperformanceclidefault

Drives

Drives - cli default template

drivesclidefault

Entry/Exit Ports

Entry/Exit Ports - cli default template

entryexitportsclidefault

Index Media

Index Media -cli default template

indexmediaclidefault

Job History

Executed Job History - cli default template

jobhistoryclidefault

Libraries

Libraries - cli default template

librariesclidefault

Library Drives

Library Drives - cli default template

librarydrivesclidefault

Library Slots

Library Slots - cli default template

libraryslotsclidefault

License Capabilities

This Server's License Capabilities - cli default template

licensecapsclidefault

Media

Media - cli default template

mediaclidefault

Media Capacities

Media Capacities - cli default template

mediacapacitiesclidefault

Media Job Contents

Media Contents Query - Textual

mediajobcontentsclidefault

Media Requests

Media Requests - cli default template

mediarequestsclidefault

Media Segment Contents

Media Segment Contents Query - Textual

mediasegmentcontentsclidefault

Media Transfer Requests

Media Transfer Requests - cli default template

mediatransfersclidefault

NetVault Event Types

NVBU Event Types - cli default template

eventtypesclidefault

NetVault Events

NVBU Events - cli default template

eventsclidefault

NetVault Logs

NVBU Logs - cli default template

logsclidefault

Notifications

User's Selected Notifications - cli default template

notificationsclidefault

Operator Messages

Operator Messages - cli default template

operatormessagesclidefault

Policies

Policies - cli default template

policiesclidefault

Policy Clients

Policy Clients - cli default template

policyclientsclidefault

Policy Jobs

Policy Jobs - cli default template

policyjobsclidefault

Privileges

Granted Privileges - cli default template

privilegesclidefault

Report Templates

Report Templates Installed on System

reporttemplatesclidefault

Schedule Sets

Schedule Sets - cli default template

schedulesclidefault

Segments

Segments - cli default template

segmentsclidefault

Selection Option Sets

Selection Option Sets - cli default template

seloptionsclidefault

Selection Sets

Selection Sets - cli default template

selectionsclidefault

Users

Users - cli default template

usersclidefault

Formatting the reports

The nvreport utility provides several options to format the layout and content of a report. The following sections outline the use of these options.

When a report is run and viewed from the CLI, the output includes several columns. The column header, referred to as “Field Name”, may not be the same as the “real name” of the column set up in the template file that is used to run the report. You must use the real name with the formatting options covered in this section.

You can use one of the following methods to find the real names:

To obtain a list of valid field names for a canned report class, type the following command:

The output includes four columns: Real name, Field name, Data type, and Description.

This command displays all fields that are available with the specified canned report. It includes even those fields that are not displayed when you run the report. You can include these additional fields using the format option. For more information, see Adding or removing columns.

To determine the default fields for a template file, follow these steps:

2
Run the nvreport -help fields [Class Name] command.

Open the template file in a text editor. In this file, the %FORMAT line provides the Real Name for the fields. You can find the template files in <NetVault home>\reports\templates on Windows and <NetVault home>/reports/templates on Linux.

The %FORMAT line of a template file only includes Real Names for the fields displayed when a report is run.

Sample template file:

Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating