NetVault 13.0.1 - CLI Reference Guide

nvblankmedia nvsetmedia nvbulkblankmedia nvexportmedia nvlabelmedia nvlistblankmedia nvlistmedia nvloadmedia nvmakemedia nvmediadetails nvremovemedia nvreusemedia nvscanmedia nvsyncronizesilomedia nvupdateserialnumber

Job-specific utilities

nvexpiresaveset nvjobabort nvjobcreate nvjobdelete nvjobhold nvjoblist nvjobmodify nvjobresume nvjobstart nvpolicy nvrestore nvsetcreate

Backup Selection Set Restore Selection Set Backup Options Set Schedule Set Backup Target Set Backup Advanced Options Set Restore Advanced Options Set

nvsetdelete nvsetexport nvsetimport nvsetmodify nvtrigger

Log-specific utilities

nvlogdump nvlogpurge nvreadlog

Other utilities

bonedate getmachineid installplugin licenseinstall nvlicenseinfo nvmeddbcheck nvpassword nvpluginpreconfig nvpluginaccess nvpgdbpasswd nvreport nvscheddbcheck nvsendmail nvsendopmsg nvtrace

Using the nvreport utility

About nvreport utility Report classes Plain text template files Formatting the reports

Using the format option Using the sort option Using the include option Using the title option

Creating external report files HTML template files

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:

nvreport -help

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:

nvreport -help templatename

Syntax

nvreport -server <server name> -class <class name> -templatename <template name>

nvreport -server <server name> -class <class name> -templatefile <full file path>

Table 90. nvreport

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:

•

If the “nice name” contains any spaces, enclose the variable in quotation marks (“ ”).

•

To locate the “nice name” for a template file, open the file in a text editor and note the string in the “%NICENAME” line

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.

•

If the file path contains any spaces, enclose the variable in quotation marks

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

Report class

Output

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:

•

Group name

•

Group description

•

All current clients are member of this group (“Yes” or “No”)

•

Client group members

Clients

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

•

Client name

•

NetVault version

•

Accessibility status (“Yes” or “No”)

•

Client status (“Up” or “Down”)

Defined Jobs

Displays all job definitions. The report includes:

•

Job ID

•

Job name

•

NetVault Client name

•

Policy name (if applicable)

•

Plug-in name

•

Job type (Backup, Restore, or Report)

•

Schedule Set name

•

Selection Set name

•

Backup Target Set name

•

Advanced Options Set name

•

•

•

•

Event type, like start write, stop write

Drive Performance Statistics

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

•

Time at which the drive was accessed

•

Date on which the drive was accessed

•

Drive Name

•

Job ID

•

Instance ID

•

Average data transfer rate (kb/sec)

Drives

Lists all drives accessible to NetVault. The report includes:

•

Drive Name

•

Product Name

•

Vendor Name

•

Drive status (Online or Offline)

•

Machine to which the drive or library is locally attached

•

Data written by this drive

•

Data read by this drive

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:

•

•

•

•

•

•

•

•

•

•

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

•

•

•

•

•

•

•

Job type (Backup, Restore, or Report)

•

Exit status of the job (“Completed”, “Completed with errors” or “Failed”)

•

Run length

Libraries

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

•

Library ID

•

Library name

•

Library status (Online or Offline)

•

Controlling NetVault Server

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:

•

Group label

•

Media label

•

Amount of space available

•

Amount of space used

•

Media format (MTF=Windows or UTF8=Linux/ UNIX)

•

Needs import (“Yes” indicates that the media item is marked as Foreign and it needs to be scanned to read the on-tape indices into the NetVault Database)

•

Needs recovery (“Yes” indicates that the contents on the tape are considered suspect and it needs to be scanned for backups for which indexes are not recorded in NetVault Database)

•

Media item is marked unusable (Yes, if marked as unusable; No, if not marked as unusable)

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:

•

•

•

•

•

•

•

•

Amount of data transferred to media for the job

•

Saveset expiry date

•

Saveset expiry time

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:

•

Job ID

•

Instance ID

•

Type of transfer request (“Read” or “Write”)

•

Request ID

•

Amount of data transferred

NetVault Event Types

Displays all event types.

NetVault Events

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

•

•

•

•

•

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:

•

Event class

•

Event

•

User account to which the notification profile belongs (if applicable.)

•

Notification method

Operator Messages

Displays all outstanding operator messages. The report includes:

•

Message ID

•

Date and time

•

Outstanding (“Yes”, if outstanding; “No”, if acknowledged)

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 name

•

Total number of jobs created within the policy

•

Total number of clients added to the policy.

•

Current status of the policy:

- OK: If all jobs in the policy have run successfully

- Warnings: If one or more jobs have completed with warnings

- Errors: If errors have occurred

•

List of clients added to the policy

•

Events defined for failed jobs

•

Events defined for jobs completed with warnings

Policy Clients

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

•

Policy name

•

Client name

•

Policy status

- OK: If all of the Clients in the policy are accessible

- Errors: Iff errors have occurred

Policy Jobs

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

•

Policy name

•

Job name

•

Backup Selection Set name

•

Whether the job is active

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:

•

Template filename

•

Class name

•

Output type (Plain text, HTML, or CSV)

Schedule Sets

Displays all Schedule Sets and their details.

Segments

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

•

Job ID

•

Instance ID

•

Offset, in bytes(starting point on the media where the segment of the job exists)

•

Overall size of the segment, in bytes

•

Media label

•

Media barcode

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:

•

User name

•

Real name

•

User Identification Number (the ID numbers for the default users are: “Default = 0” and “Administrator = 1”)

•

Workstation

•

Last date on which the user accessed NetVault

•

Last time at which the user accessed NetVault

Plain text template files

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

Table 92. Plain text template files
Class name	Template file “nice name”	Template filename
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.


	NOTE: Unless otherwise noted, the description of the options offered in this section assume that they are being used with report templates that use a “Plain Text” output type. These templates include “clidefault” or “- cli default template” in their filename. You can view these reports from a terminal session window.

Obtaining the real name

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:

•

Using the help option

•

Using the template file

Using the help option

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

nvreport -help fields [class name]

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:

Run the report and note the default Field Name of each column.

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

Locate the appropriate Field Name in the list, and cross-reference its Real Name.

Using the template file

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:

%CLASS "Media"

%NICENAME "Media - cli default template"

%FORMAT "%MEDIAGROUP %LABEL %SPACELEFT %SPACEUSED

%MEDIAFORMAT %NEEDSIMPORT %NEEDSRECOVERY %UNUSABLE"

%SORT %MEDIAGROUP+ %LABEL+

%OUTPUTTYPE 0

%HEADERNAME "Default"

%FOOTERNAME "Default"