Chat now with support
Chat with Support

NetVault 13.2 - 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 home>\reports\output on Windows and <NetVault 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:

•
Selecting the template file
•
Specifying the outputdir
•
Specifying the appendoutput option
•
Using the title option
Selecting the template file

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 home>\reports\ templates directory.
 
* 
NOTE: While it is possible to use the “-class” option to generate a report file for viewing outside the terminal session window, we recommend that you avoid using it. The “-class” option is designed to be used with a default template file and create a report for viewing in the terminal session window. You may not obtain the desired result in an external report with the “-class” option.
Specifying the outputdir

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

The syntax for this option is:

-outputdir <name for subdirectory>

Example:

nvreport -templatename “Executed Job History” -outputdir “Test01”

Note the following:

•
If an existing subdirectory is specified with the “-outputdir” option, it is overwritten.
The following command creates a subdirectory named “report” and saves the report file “output.html” in this directory:
nvreport -templatename “Client Groups” -outputdir report
When you generate another report, it overwrites the existing “report” subdirectory and the “output.html” file with the new file:
nvreport -templatename “Defined Jobs” -outputdir report
If you do not want to overwrite an existing report file, specify a new directory or use the ‑appendoutput option.
•
The HTML report templates contain various artwork files in their layout. When you use an HTML template, the artwork files are automatically copied to the new subdirectory.
Specifying the appendoutput option

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:

nvreport -templatename "Restore Summary" -outputdir "Test01" -appendoutput

Note the following:

•
The -appendoutput option must be used with the -outputdir option.
•
This option allows you to combine two different types of templates.
•
This option allows you to combine the HTML and plain text output types.
Using the title 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:

-title <NewReport Title>

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

Example:

nvreport -templatename "Historic Jobs - By Date" -outputdir "Test01"
-title “Job History - By Date”

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.

 
Table 94. HTML template files
Template filename
Nice name
Description

activejobs

Currently Active Jobs

Lists all active jobs. The report includes:

•
Job ID
•
Job name
•
Client name
•
Policy name
•
Running status (for example, Writing to Media)

alldrives

All Drives

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

•
Name of the machine to which the drive is attached
•
Drive Name
•
Drive status (online or offline)
•
Amount of data read (zero if no jobs are active)
•
Amount of data written
•
Number of read errors
•
Number of write errors
•
Last write date
•
Last read date
•
Last clean date
•
Amount of data written since it was last cleaned
•
Number of times the drive has been used since it was last cleaned

allfailedpolicyjobs

Failed Policy Jobs

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

•
Policy name
•
Client name
•
Job name
•
Plug-in name
•
Start date
•
Start time
•
Run length
•
Job status

clientgroups

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

clientstatuses

Client Statuses

Displays the status of added clients. The report includes:

•
Client name
•
NetVault version
•
Client accessibility status (“Yes” or “No”)
•
Client status (“Up” or “Down”)

errorlogs

Recent Error Logs

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

•
Date and time
•
Client name
•
Job ID
•
Instance ID
•
Error message
•
Warning level

events

NetVault Events

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

•
Date and time
•
Event name
•
Event class
•
Event description
•
Event message

expiredofflinemedia

Expired Offline Media

Lists expired offline media. The report includes:

•
Media label
•
Media group label
•
Barcode
•
Last read or write date
•
Offsite location

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:

•
Media label
•
Media group label
•
Barcode
•
Last read or write date
•
Media expiry date
•
Library name
•
Slot number
•
Offsite location
•
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)

globalnotifications

Global Notifications

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

•
Event class
•
Configured notification environment
•
Event
•
Notification method

historicjobs

Historic Jobs - By Date

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

•
Start date and time
•
Run length

historicjobsbysize

Historic Jobs - By Size

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

•
Job ID
•
Job name
•
Instance ID
•
NetVault Client name
•
Selection Set name
•
Backup size
•
Job status
•
Start date and time
•
Run length

jobdefinitions

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

jobhistory

Executed Job History

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

•
Start date and time
•
End time
•
Job ID
•
Instance ID
•
Phase ID
•
Job name
•
Job type (Backup, Restore, or Report)
•
Exit status of the job (“Completed”, “Completed with errors” or “Failed”)
•
Run length

libraryblankcounts

Blank Media Items In Libraries

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

•
Library name
•
Blank media count

librarycontents

Libraries' Media Contents

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

•
Library name
•
Drive name
•
Slot number
•
Media label
•
Barcode
•
Media group label
•
Amount of space used and left

logs

NetVault Logs

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

•
Job ID
•
Log class
•
Warning level
•
Date and time
•
Client that generated the log
•
Log message

mediacontentsquery

Media Contents Query

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

•
Media label
•
Media group label
•
Barcode
•
Job name
•
Client name
•
Plug-in name
•
Start date and time
•
Backup type
•
Backup size
•
Media expiry date and time

mediageneral

Media — General

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

•
Media label
•
Barcode
•
Media type (tape or disk file)
•
Media format (MTF=Windows or UTF8=Linux/ UNIX)
•
Name of the machine to which the drive is attached
•
Amount of space available
•
Amount of space used
•
Media item is marked unusable (Yes, if marked as unusable; No, if not marked as unusable)
•
Media item is marked read-only (Yes, if marked as read-only; No, if not marked as read-only)

mediasegmentcontents
query

Media Segment Contents Query

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

•
Media label
•
Barcode
•
Job name
•
Client name
•
Plug-in name
•
Backup date
•
Backup time
•
Length of the segment (in number of bytes)

mediautilization

Media Utilization

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

•
Media label
•
Barcode
•
Media group label
•
Amount of space available
•
Amount of space used

notifications

Users' Selected Notifications

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

•
Event name
•
Event description

offlinedevices

Offline Devices

Lists devices that are currently offline.

outstandingopmsgs

Outstanding Operator Messages

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

•
Date and time
•
Operator message text

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:

•
Job ID
•
Job name
•
Client name
•
Policy name
•
Job status

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:

•
Policy name
•
Total number of jobs created within the policy
•
Total number of clients added to the policy
•
Policy status:
- OK: All policy jobs have completed successfully
- Warnings: One or more policy jobs have completed with warnings
- Errors: One or more policy jobs have failed
•
List of clients added to the policy
•
Events defined for failed jobs
•
Events defined for jobs completed with warnings

restoresummary

Restore Summary

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

•
Start date and time
•
Client name
•
Job name
•
Job ID
•
Instance ID
•
Run length
•
Job status

serverlicensecapabilities

Server License Capabilities And Usage

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

•
License description (for example, number of clients allowed, number of library units, and others)
•
Available licenses
•
Used licenses

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:

•
Date and time of log entry
•
Log class
•
Warning level
•
Client that generated the log
•
Log message

single_job_media

Media Used by Single Backup

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

•
Barcode
•
Media label
•
Media type (tape or disk file)
•
Offsite location

single_job_media_
transfers

Single Job's Media Transfers

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

•
Date and time the media transfer request was received
•
Date and time the requested media transfer began
•
Date and time the requested media transfer completed
•
Type of media transfer (read or write0
•
Amount of data transferred

single_job_summary

Single Job Main Summary

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

•
Job ID
•
Job name
•
Job type (backup, restore, or report)
•
Plug-in name
•
Instance ID
•
Start date and time
•
End date and time
•
Job status
•
Size of data transferred
•
Transfer rate (applies only to backup jobs)

single_job_xfer_rates

Single Job's Data Transfer

Rate

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

•
Date and time of event
•
Drive name
•
Drive events

singlepolicybytecounts

Policy Totals

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

•
Total backup size
•
Average backup size
•
Total transfer rate
•
Average transfer rate

singlepolicyclients

Policy Clients

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

•
Policy name
•
Client name
•
Policy status:
- OK: All policy jobs have completed successfully
- Warnings: One or more policy jobs have completed with warnings
- Errors: One or more policy jobs have failed

singlepolicyfailedjobs

Failed Jobs Within Single Policy

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

•
Policy name
•
Client name
•
Job name
•
Plug-in name
•
Start date
•
Start time
•
Run length
•
Job status

singlepolicyjobs

Defined Policy Jobs

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

•
Job name
•
Policy name
•
Whether the job is currently active
•
Backup Selection Set name
•
Backup Options Set name
•
Schedule Set name
•
Target Set name
•
Advanced Options Set name

singlepolicystatus

Policy Status Information

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

•
Policy name
•
Number of clients added to the policy
•
Number of jobs added to the policy
•
Failed jobs
•
Jobs completed with warnings
•
Policy status

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:

•
Event class
•
Event
•
Notification method
•
Configured notification environment (if applicable)

userdetails

User Details

Displays the details of NetVault users. The report includes:

•
Account name
•
Real name
•
Description
•
Location
•
Contact information
•
Last logon date and time

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:

•
Account name
•
Media quota
•
Media used

 

Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating