Quest NetVault Backup. Command Line Interface Reference Guide. version 9.1 NVG EN-01 05/10/13

Transcription

1 Quest NetVault Backup version 9.1 Command Line Interface Reference Guide NVG EN-01 05/10/13

2 2013 Quest Software, Inc. ALL RIGHTS RESERVED. This guide contains proprietary information protected by copyright. The software described in this guide is furnished under a software license or nondisclosure agreement. This software may be used or copied only in accordance with the terms of the applicable agreement. No part of this guide may be reproduced or transmitted in any form or by any means, electronic or mechanical, including photocopying and recording for any purpose other than the purchaser's personal use without the written permission of Quest Software, Inc. The information in this document is provided in connection with Quest products. No license, express or implied, by estoppel or otherwise, to any intellectual property right is granted by this document or in connection with the sale of Quest products. EXCEPT AS SET FORTH IN QUEST'S TERMS AND CONDITIONS AS SPECIFIED IN THE LICENSE AGREEMENT FOR THIS PRODUCT, QUEST ASSUMES NO LIABILITY WHATSOEVER AND DISCLAIMS ANY EXPRESS, IMPLIED OR STATUTORY WARRANTY RELATING TO ITS PRODUCTS INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTY OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT. IN NO EVENT SHALL QUEST BE LIABLE FOR ANY DIRECT, INDIRECT, CONSEQUENTIAL, PUNITIVE, SPECIAL OR INCIDENTAL DAMAGES (INCLUDING, WITHOUT LIMITATION, DAMAGES FOR LOSS OF PROFITS, BUSINESS INTERRUPTION OR LOSS OF INFORMATION) ARISING OUT OF THE USE OR INABILITY TO USE THIS DOCUMENT, EVEN IF QUEST HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. Quest makes no representations or warranties with respect to the accuracy or completeness of the contents of this document and reserves the right to make changes to specifications and product descriptions at any time without notice. Quest does not make any commitment to update the information contained in this document. If you have any questions regarding your potential use of this material, contact: Quest Software World Headquarters LEGAL Dept 5 Polaris Way Aliso Viejo, CA [email protected] Refer to our Web site ( for regional and international office information. Patents This product is protected by U.S. Patents # 7,814,260; 7,913,043; 7,979,650; 8,086,782; 8,145,864; 8,171,247; 8,255,654; and 8,271,755. Protected by Japanese, E.U., French and UK patents and , and German patent DE Additional patents pending. Trademarks Quest, Quest Software, the Quest Software logo, Simplicity at Work, FlashRestore, GigaOS, and NetVault are trademarks and registered trademarks of Quest Software, Inc., and its subsidiaries. For a complete list of Quest Software's trademarks, please see Other trademarks and registered trademarks are property of their respective owners.

3 Table of Contents Chapter 1: Introducing Quest NetVault Backup 7 Quest NetVault Backup At a Glance... 7 Key Benefits... 7 Feature Summary... 8 About this Document... 9 Target Audience... 9 Recommended Additional Reading... 9 About Quest Software Contacting Quest Software Quest Support Chapter 2: Getting Started 13 NVBU Command Line Interface An Overview CLI Help CLI Access Control Working with Command Line Executables Preparing to Run a Command Understanding the Command Syntax Using NVBU Environmental Variables Using the nvsetmodify.cfg File Starting or Stopping NVBU from the CLI Chapter 3: Using NVBU Commands 19 Client-Specific Commands nvclient nvclientaccess nvclientadd nvclientlist nvclientname nvclientremove... 22

4 4 Table of Contents Device-Specific Commands asf_load_media asf_ release_drive nvacslsmedia nvcheckdrive nvcleandrive nvclosedoor nvcloseeeport nvcloseeeportcleaning nvdav nvddboost nvdevice nvdeviceeject nvexportmedia nvlibrarymodify nvopendoor nvopeneeport nvremovefiler nvresetdrivestats nvscandrives nvsetcleaninglives nvsetdrivecleaning nvsmartdisk nvsvtlgrow Media-Specific Commands nvblankmedia nvbulkblankmedia nvexportmedia nvlabelmedia nvlistblankmedia nvlistmedia nvloadmedia nvmakemedia nvmediadetails nvremovemedia nvreusemedia nvscanmedia nvsyncronizesilomedia nvupdateserialnumber... 52

5 Quest NetVault Backup 5 Command Line Interface Reference Guide Job-Specific Commands nvexpiresaveset nvjobabort nvjobcreate nvjobdelete nvjobhold nvjoblist nvjobmodify nvjobresume nvjobstart nvpolicy nvrestore nvsetcreate nvsetdelete nvsetexport nvsetimport nvsetmodify nvtrigger Log-Specific Commands nvlogdump nvlogpurge nvreadlog Other Commands bonedate getmachineid installplugin licenseinstall nvlicenseinfo nvmeddbcheck nvpassword nvpluginaccess nvreport nvscheddbcheck nvsendmail nvsendopmsg Chapter 4: NVBU Reporting with the CLI 99 nvreport An Overview CLI Help

6 6 Table of Contents Using nvreport Report Classes Template Files Formatting Report Layout and Content External Reports Creating External Report Files Appendix Appendix A: NVDB Check and Compact Logs 139 Logs Generated by the NVDB Check and Compact Actions Logs Generated by nvmeddbcheck Logs Generated by nvscheddbcheck

7 Quest NetVault Backup 7 Command Line Interface Reference Guide Chapter 1: INTRODUCING QUEST NETVAULT BACKUP Quest NetVault Backup At a Glance Key Benefits Feature Summary About this Document Target Audience Recommended Additional Reading About Quest Software Contacting Quest Software Quest Support Quest NetVault Backup At a Glance Quest NetVault Backup (NetVault Backup or NVBU) offers the most advanced, cross-platform data protection capabilities on the market as well as unsurpassed ease of use, out-of-the-box deployment, and pain-free scalability. NetVault Backup allows you to safeguard your data and applications in both physical and virtual environments using one intuitive console. And thanks to heterogeneous server support and extensive application support you can leverage your existing investments in data protection. NetVault Backup supports simple integration with a variety of other NetVault products and seamless installation of a host of plug-ins that let you tailor NetVault Backup to match the changing and growing landscape of your IT infrastructure, including operating systems, messaging applications, and databases Key Benefits Simple, out-of-the-box deployment for fast time to value Protection for both physical and virtual environments for cost savings Heterogeneous server support for flexibility to adjust to changing conditions or emergencies Plug-in options to tailor NetVault Backup to your environment Disk-based backup and de-duplication to significantly improve storage efficiency

8 8 Chapter 1 Introducing Quest NetVault Backup Comprehensive Network Attached Storage (NAS) protection to safeguard critical data Powerful, flexible encryption when and where you need it Bare metal recovery to drastically reduce the time it takes to recover a failed disk drive Extensive storage attachment options allow for distributed backup targets and workload Dynamic device sharing to optimize backup data transfers and reduce points of failure Feature Summary Disk-Based Backup and Deduplication Leverage disk-based and tape backups for creating on-site and off-site backups for failover and disaster recovery. You can also add Quest NetVault SmartDisk (NetVault SmartDisk or NVSD) to the backup solution for post-process data deduplication. NVSD uses patented byte-level, variable block data analysis technology to reduce data storage footprints by up to 90%. Virtualization Support Extend advanced data protection to VMware and Hyper-V environments. A NetVault Backup plug-in gives you consistent, reliable, point-and-click backup and restore for virtual environments without requiring you to be an expert. Application Protection Ensure availability of business-critical applications such as Oracle, SQL Server, Exchange, SharePoint, MySQL, PostgreSQL, Domino, Informix, and Sybase with application plug-ins. These plug-ins complement native solutions to save you time on integration no scripting is required to run backup and recovery jobs. Network Attached Storage Protection Safeguard NAS data directly on a locally attached SCSI device, a SAN-attached device (tape or VTL) or a storage device elsewhere on the network. Enterprise-Wide Control Give backup administrators the flexibility to define, manage and monitor jobs from remote locations of their choice. NetVault Backup s automated features for global event notification and policybased job management simplify their tasks across heterogeneous storage networks. Strong Security Meet regulatory requirements without sacrificing backup windows or deduplication performance with an encryption plug-in for CAST-128, AES-256, or CAST-256 algorithm support. Flexible job-level encryption lets you easily select which data to encrypt. Flexible Storage Attachment Attach storage wherever you like with the built-in NetVault Backup SmartClient. It allows you to easily distribute both real and virtual backup target workloads throughout the backup domain.

9 Quest NetVault Backup 9 Command Line Interface Reference Guide Dynamically Shared Device Share stand-alone and library-based tape drives among backup servers and SmartClients in SAN or shared-scsi environments. This allows you to optimize workloads and maximize your equipment investments. LAN-Free Backups Create a LAN-free backup environment to support writing backup data directly to locally and SAN-attached storage devices. This keeps backup traffic away from the LAN and eliminates network bandwidth constraints. Simple, Straightforward Licensing NetVault Backup can be licensed by capacity or by component, giving you incredible flexibility. With componentbased licensing, you can pick and choose which modules you need. You can deploy an unlimited number of clients or application plug-ins. Quest offers two capacity-based licensing editions for NetVault Backup, one offering great value for growing businesses and one offering comprehensive protection for larger enterprises About this Document This guide provides a detailed description of the command line utilities. For details on using the NVBU Console, refer to the Quest NetVault Backup Administrator s Guide. Important: NVBU configuration settings are stored in.cfg files that reside in the <NVBU home>\config directory. The settings in these files should only be modified under the guidance of Quest Support. Be aware that any incorrect changes to these files can cause errors and other unexpected behavior. Before you modify a configuration file, it is good practice to create a backup copy of the file Target Audience This guide is intended for backup administrators and other technical personnel who are responsible for designing and implementing a backup strategy for the organization. A good understanding of the operating systems under which the NVBU Server and Clients are running is assumed Recommended Additional Reading Quest NetVault Backup Installation Guide This guide provides complete details on installing the NetVault Backup Server and Client software. Quest NetVault Backup Administrator s Guide This guide describes how to use NetVault Backup and provides comprehensive information on all NetVault Backup features and functionality.

10 10 Chapter 1 Introducing Quest NetVault Backup Quest NetVault Backup Configuration Guide This guide explains how to configure the default settings for NetVault Backup. Quest NetVault Backup Workstation Client Administrator s Guide This guide provides complete information on administering the NetVault Backup Workstation Client software. Quest NetVault Backup Workstation Client User s Guide This guide provides complete information on using the NetVault Backup Workstation Client software. You can download these guides from the Quest website at the following address: About Quest Software Established in 1987, Quest Software (Nasdaq: QSFT) provides simple and innovative IT management solutions that enable more than 100,000 global customers to save time and money across physical and virtual environments. Quest products solve complex IT challenges ranging from database management, data protection, identity and access management, monitoring, user workspace management to Windows management. For more information, visit Contacting Quest Software Mail: Web site: [email protected] Quest Software, Inc. World Headquarters 5 Polaris Way Aliso Viejo, CA USA For regional and international office information, refer to the web site Quest Support Quest Support is available to customers who have a trial version of a Quest product or who have purchased a Quest product and have a valid maintenance contract. Quest Support provides unlimited 24x7 access to our Support Portal at From our Support Portal, you can do the following: Retrieve thousands of solutions from our online Knowledge Base Download the latest releases and service packs Create, update, and review Support cases

11 Quest NetVault Backup 11 Command Line Interface Reference Guide View the Global Support Guide for a detailed explanation of support programs, online services, contact information, policies and procedures. The guide is available at This guide is available in English only.

12 12 Chapter 1 Introducing Quest NetVault Backup

13 Quest NetVault Backup 13 Command Line Interface Reference Guide Chapter 2: GETTING STARTED NVBU Command Line Interface An Overview CLI Help CLI Access Control Working with Command Line Executables Preparing to Run a Command Understanding the Command Syntax Switch Abbreviation Underscore Character (_) in CLI Variables Spaces in CLI Variables Command Exit Status Using NVBU Environmental Variables Using the nvsetmodify.cfg File Starting or Stopping NVBU from the CLI NVBU Command Line Interface An Overview The NVBU Command Line Interface (CLI) allows you to perform various NVBU operations from a terminal session using predefined executables. Using these commands you can perform operations such as the following: Start or stop the NVBU Service. Create and submit jobs This includes creating, modifying, and submitting backup and restore jobs for any NVBU Client controlled by the NVBU Server. NVBU also provides command line executables to create and modify sets required for these jobs. Manage backup devices and media This includes importing and exporting media items, blanking media items, reviewing drive and library status, marking media items for re-use, and several other functions. Create and view Canned and custom reports This includes various reports for clients, devices, media, and jobs. View Operator Messages To determine if attention is required. Note: All NVBU CLI Scripts are non-blocking. This means that a response to the script command is returned before the action has actually completed. This allows for continuous running of various scripts without NVBU stopping.

14 14 Chapter 2 Getting Started CLI Help To access help on commands, type the command followed by -help or --help, or just type the command and press Enter. For example, to access help on nvblankmedia, you can use any of the following methods: nvblankmedia -help nvblankmedia --help nvblankmedia CLI Access Control The Access Control feature allows an administrator to limit the level of access each user has to NVBU functionality. It can also be used with the CLI. For example, if an administrator has blocked a specific user from blanking media in the NVBU Console, the same user can also be blocked from issuing CLI commands for blanking media. You can also restrict a user from using the CLI functionality. For complete details on allowing or denying access to functions in NVBU, refer to the Quest NetVault Backup Administrator s Guide. Even if CLI access has been granted to a specific user account, proper account and password must be provided before these tools can be used. The environmental variables that need to be included in a script to allow this are: NETVAULTCLIACCOUNT User account with access to use the NVBU CLI. NETVAULTCLIPASSWORD Password for the specified user account Working with Command Line Executables The following sections provide a general description of how the NVBU commands are used and any prerequisites. It is recommended that you fully review this section before using any CLI command. Important: To use the CLI commands, you must be logged on with Administrator privileges on Windows and root privileges on UNIX/Linux Preparing to Run a Command To run a command, navigate to the...\util directory (where... represents the NVBU installation directory) Understanding the Command Syntax The syntax of a command takes the following form: Command -option 1 <Value> -option 2 <Value> [-option 3 <Value> -option 4 <Value>] [-option 5],

15 Quest NetVault Backup 15 Command Line Interface Reference Guide <Value> is a user input variable for an option. For example, if the NVBU Server name is TestServer, for the servername <server name> option, enter servername TestServer. enclosed in [ ] are optional. A pipe ( ) character between two options indicates that only one of the multiple listed can be used in a command. Note: All scripts shown in the syntax format must be entered as one line, unless otherwise noted. The order of the options is not important in the syntax a b c Switch Abbreviation Switches can be specified using only the initial letter in their name, provided this letter is unique and no other option for the selected command begins with the same letter. Using the nvbulkblankmedia command as an example, a description of the command is given below: nvbulkblankmedia -libraryname <library name> -medialabel <media label> -allmedia -password <NVBU password> -wait All the options for this command begin with different letters. So, this command can be specified as follows: nvbulkblankmedia -l NVLibrary1 -m Backup* -p sunny wait where -l - represents the -libraryname option -m - represents the -medialabel option -p - represents the -password option Underscore Character (_) in CLI Variables NVBU CLI sees the use of an underscore in its syntax as a replacement for a space, because a space is not recognized in CLI. Conflicts will arise when an NVBU Server, Client, or any added backup device name contains an underscore character ( _ ) and it is referenced in an NVBU CLI command. For example, if you include the NVBU Machine Name Test_Server in a CLI command, NVBU will search for a machine named Test Server, and the command will fail as it will be unable to locate the machine. Variables that contain underscores must be enclosed within quotation marks ( ). Spaces in CLI Variables CLI cannot recognize spaces in variable names. Variables that contain spaces must be enclosed within quotation marks ( ). Otherwise, the command will fail.

16 16 Chapter 2 Getting Started d Command Exit Status Various CLI commands will return a numeric value once they are executed. This number represents the actual exit status of the command as described in the following table: Exit Status Indicates 0 Command completed successfully. 1 Command failed. 2 Arguments given in the command are invalid. For example, a variable named in the command is inaccurate Using NVBU Environmental Variables NVBU lets you use the following environmental variables with the commands to provide the required inputs: Variable NETVAULTCLIACCOUNT NETVAULTCLIPASSWORD NV_HOME NV_JOBCLIENT NV_JOBID NV_JOBTITLE NV_JOB_WARNINGS Description Specifies a user account name. The named account must have privileges to use the CLI utility. NETVAULTCLIACCOUNT=<Account Name> Specifies the password for the CLI user account. NETVAULTCLIPASSWORD=<Password> Returns the NVBU installation directory. Specifies the target client for a job. NV_JOBCLIENT=<Name of the NVBU Client> Specifies the Job ID. NV_JOBID=<Job ID> Specifies the Job Title. NV_JOBTITLE=<Job title> Returns TRUE if a job completes with warnings, else FALSE. For example If a backup completes with warnings: NV_JOB_WARNINGS=TRUE If a backup completes successfully: NV_JOB_WARNINGS=FALSE This variable can only be used in a post script. It is currently used by mail scripts but has general applicability. Note: If a backup completes with warnings, NV_STATUS will return SUCCEEDED and NV_JOB_WARNINGS will return TRUE.

17 Quest NetVault Backup 17 Command Line Interface Reference Guide Variable NV_OUTPUT_FILE NV_SERVERNAME NV_SESSIONID NV_STATUS NV_USER_ARG Description Returns the user-defined output file for reports. Specifies the NVBU Server Name. NV_SERVERNAME=<Name of the NVBU Server> Specifies the Session ID of a job. NV_SESSIONID=<Session ID> Returns the exit status of a job. It returns either SUCCEEDED or FAILED. For example, If a backup job completes successfully or completes with warnings: NV_STATUS=SUCCEEDED This variable can only be used in a post script. The return value for this script is not localized. It is SUCCEEDED or FAILED in English. Specifies the arguments passed with the pre or post scripts Using the nvsetmodify.cfg File Several commands described in this guide reference a file named nvsetmodify.cfg. This configuration file includes a list of NVBU functionality and the associated code number which can be used to identify the functionality in the CLI. To access this file and view its contents, use the following steps: 1. Navigate to the...\config directory (where... refers to the NVBU installation directory). 2. Open the file nvsetmodify.cfg for viewing. 3. Note the values for the required functionality and close this file without saving it. Important Notes Ensure that the nvsetmodify.cfg is not edited or modified in any manner. It is recommended that you print out this file and use this print for reference purposes. This functionality is intended for highly-experienced users. Therefore, it is strongly recommended that any attempt to use the values provided in this configuration file when generating CLI commands be performed under the guidance of Quest Customer Support.

18 18 Chapter 2 Getting Started Starting or Stopping NVBU from the CLI If you need to start or stop NVBU from the command line, use the following commands: Linux/UNIX # $NV_HOME/etc/startup.sh {start stop} Windows C:\ net start/stop NetVault Process Manager

19 Quest NetVault Backup 19 Command Line Interface Reference Guide Chapter 3: USING NVBU COMMANDS Client-Specific Commands Device-Specific Commands Media-Specific Commands Job-Specific Commands Log-Specific Commands Other Commands Important: The commands covered in this guide are the only ones that are supported for use with NVBU. Any commands found in the...\util directory (or other NVBU directories) that are not covered in this guide are not supported and should not be used. Quest Software can not be held accountable for any outcome that may result from the use of any non-supported CLI command(s) Client-Specific Commands nvclient nvclient nvclientadd nvclientname nvclientaccess nvclientlist nvclientremove Adds one or more NVBU Heterogeneous and Workstation Clients to the NVBU Server and assigns the clients to the specified client groups. Syntax nvclient [-add] [-list] [-password <NVBU Password>] [-file <Client List File>] [-workstation -client <Client Name>...] [-group <Client Group Name>...] [-log <Log File>] [-failure <File Name to Log Failed Clients List>] [-quiet] [-verbose] [-abort] [-args] [-timeout <timeout period>] -add Adds NVBU Clients. -list Lists current NVBU Clients. -password NVBU password for the client.

20 20 Chapter 3 Using NVBU Commands -file Name of the file containing a list of clients, client groups and passwords to enable batch submission. For example, -file Addlist specifies a file Addlist which contains the following: client1 -workstation client2 -password <password> -group <groupname> where <password> indicates the password and <groupname> indicates the group for client2. Note: Client names are case sensitive when added from the command line or using the -file option. -workstation NVBU Machine Names of the Workstation Clients that are to be added to the server. -client NVBU Machine Names of the NVBU Heterogeneous Clients that are to be added to the server. -group Names of the Client Group to which the NVBU Clients are to be added. -log Name of the log file to which the log messages are to be sent. -failure Name of the log file to which the Failed Clients List is to be sent. -quiet Suppresses display of output messages on the screen. -verbose Displays status and error messages on the screen. -abort Aborts the command if sufficient licenses are not available to accommodate the entire client list. -args Prints program parameters and exit without doing anything. -timeout Amount of time NVBU waits for the client to approve the add request. The timeout value is specified in number of seconds. If a client cannot be added within the specified period, an error message is displayed nvclientaccess Grants access to specified NVBU Clients. Syntax nvclientaccess [-client <Client Name>] [-clients <Client Names>] [-tdclients <Teradata DBS name>] [-password <password>] -client/-clients NVBU Machine Names of the clients to which access is to be granted. -tdclients Name of the Teradata DBS. Use this option to grant access to all added clients.

21 Quest NetVault Backup 21 Command Line Interface Reference Guide -password NVBU password for the client for which security has been enabled nvclientadd Adds a single NVBU Heterogeneous Client to the Server. This command must be run on the NVBU Server. You cannot use it to add NVBU Workstation Clients. Syntax nvclientadd [-client <Client Name> -clientip <IP address>] [-clientgroup <Client Group Name>] [-password <password>] [-timeout <timeout period>] [-version] -client NVBU Machine Name of the Heterogeneous Client to be added to the Server. -clientip IP address of the machine to be added as NVBU Client. -clientgroup Name of the client group to which the client is to be added. The client group must already exist on the server. -password If security is enabled on the client, use this option to specify the NVBU Password for the client. -timeout Amount of time NVBU waits for the client to approve the add request. The timeout value is specified in number of minutes. If a client cannot be added within the specified period, an error message is displayed. -version Displays the build date of the NVBU distribution installed on the target client. Notes The client must be available and running a valid installation of NVBU before it can be added to an NVBU Server. To locate a client that is unavailable, use the nvclientlist find <ipaddress> command to locate the machine. For details, refer to nvclientlist on page 21. Client groups can only be created using the NVBU Console. NVBU does not provide any CLI command to create a client group nvclientlist Performs the following functions: Lists the clients added to the NVBU Domain. Lists the available NVBU Clients. Finds an NVBU machine using its resolvable name or IP address

22 22 Chapter 3 Using NVBU Commands Syntax nvclientlist [-current [-name <Client Name>]] [-available [-name <Client Name>]] [-find <Resolvable Name or IP address>] [-version] -current Lists clients added to the NVBU Domain. -available Lists available NVBU machines that can be added as clients to the NVBU Server. -name NVBU Machine Name of the client to be located. -find Resolvable name or IP address of the machine to be located. -version Displays the build date of the NVBU distribution installed on the target Client nvclientname Allows you to rename an NVBU Client. This command cannot be used to change the name of an NVBU Server. Syntax nvclientname -clientname <New NVBU name for the client> -clientname New NVBU name for the client nvclientremove Removes a client from the NVBU Domain controlled by the NVBU Server on which the command is run. Only one client can be removed with a single use of this command. nvclientremove [-client <Client Name>] [-version] -client NVBU Machine Name of the client to be removed from the NVBU Domain. This option can only be used once per use of this command. -version Displays the build date of the NVBU distribution installed on the target client.

23 3.2.0 Device-Specific Commands Quest NetVault Backup 23 Command Line Interface Reference Guide asf_load_media nvdav nvremovefiler asf_ release_drive nvddboost nvresetdrivestats nvacslsmedia nvdevice nvscandrives nvcheckdrive nvdeviceeject nvsetcleaninglives nvcleandrive nvexportmedia nvsetdrivecleaning nvclosedoor nvlibrarymodify nvsmartdisk nvcloseeeport nvopendoor nvsvtlgrow nvcloseeeportcleaning nvopeneeport asf_load_media Loads the specified media into the drive and locks it in the drive as Windows Advanced System Format (ASF) media. Syntax asf_load_media -m <Media Label> -b <Barcode> -d <Device Name> [-s <Server Name>] [-c <Client Name>] [-wait] -m Media label of the target media item. -b Barcode of the target media item. -d Name of the target drive. -s NVBU Machine Name to which the target backup device is locally attached. If the device is locally attached to an NVBU Heterogeneous Client (NVBU SmartClient), then use this option to specify the Heterogeneous Client. -c NVBU Machine Name of the Heterogeneous Client the device is attached to. -wait Add this option to tell NVBU to wait until this task has completed before moving forward.

24 24 Chapter 3 Using NVBU Commands asf_ release_drive Releases lock placed by the asf_load_media command and allows the drive and the media to be used by NVBU. Syntax asf_release_drive -d <Device Name> [-s <Server Name>] [-c <Client Name>] -d Name of the target drive. -s Name of the NVBU Server. Use this option if the device is locally attached to the NVBU Server. -c NVBU Machine Name of the Heterogeneous Client. Use this option if the device is attached to a SmartClient or a remote NVBU Server nvacslsmedia Performs the following functions: Allocates media to an ACSLS Library. De-allocates the specified media. Ejects a piece of media Syntax nvacslsmedia [-allocate -deallocate -eject] [-medialabel <Media Label>] [-cap <acs>,<lsm>,<cap>] -libraryname <Library Name> [-servername <Server Name>] [-range <range-media >] [-file <File name >] [-version] -allocate Allocates specified media items. -deallocate De-allocates the specified media items. -eject Ejects the specified media items through the specified Cartridge Access Port (CAP). -cap CAP through which to eject the media items. Provide the ACS number of the library, LSM number of the robotic unit that controls the library and the physical number of the CAP. Use comma to separate the numeric values. For example -cap 0,0,0. -medialabel Label or barcode of the media items that you want to allocate, de-allocate, or eject from the library. For multiple labels or barcodes, provide a comma-separated list.

25 Quest NetVault Backup 25 Command Line Interface Reference Guide -libraryname Name of the target library. -servername Name of the NVBU Server that is to administer the job. If the job is to be administered by a remote NVBU Server, this option must be used to name that specific server. If the local instance of the NVBU Server is to be used to administer the job, this option can be left out of the syntax. The server name is case-sensitive. -range Range of media labels or barcode values that correspond to a series of media items to be de-allocated. Use a hyphen (without any spaces) between the values. -file Name of the file that contains a list of media labels or barcodes corresponding to the set of media items that are to be de-allocated. Only one media label or barcode can be specified per line. -version Displays the build date of the NVBU distribution nvcheckdrive Checks the status of a drive. For example, it can be used to check the status of a drive that was taken offline for some reason. If successful, the specified drive will be returned to online status so that it is available to NVBU for future jobs. Syntax nvcheckdrive -servername <Server Name> [-drivename <Drive Name>] [-libraryname <Library Name>] [-drivenumber <Drive Number>] -servername Name of the NVBU Server that is to administer the job. If the job is to be administered by a remote NVBU Server, this option must be used to name that specific server. If the local instance of the NVBU Server is to be used to administer the job, this option can be left out of the syntax. The server name is case sensitive. -libraryname Name of the target library. -drivename Name of the target drive that is to be checked. -drivenumber Drive number of the drive that is to be checked. Note: If the -libraryname option is chosen to denote a library, then the -drivename or -drivenumber option must be used to specify the target drive. Examples Check the status of Standalone Drive D-1 that is locally attached to the NVBU Server: nvcheckdrive -drivename D-1

26 26 Chapter 3 Using NVBU Commands Check the status of Drive2 in library NVLibrary that is locally attached to an NVBU Client NVCLIENT1 nvcheckdrive -servername NVCLIENT1 -libraryname NVLibrary -drivename Drive2 Check the status of drive 2 in library NVLib2 that is locally attached to a remote NVBU Server NVSERVER2 nvcheckdrive -servername NVSERVER2 -libraryname NVLib2 -drivenumber nvcleandrive Cleans library drive. If the number of cleaning lives has been set for the cleaning tape, it will be reduced by one when used for this process. Syntax nvcleandrive -libraryname <Library Name> -librarydrivenumber <Drive Number> -libraryname Name of the target library. -librarydrivenumber Drive number of the target drive that is to be cleaned. Examples Clean drive 1 of library SONY LIB-162 using the predefined cleaning media. nvcleandrive -libraryname SONY LIB-162 librarydrivenumber nvclosedoor Close the door of a library managed by the specified NVBU Server. Syntax nvclosedoor [-servername <Server Name>] -libraryname <Library Name> -servername Name of the NVBU Server that is to administer the job. If the job is to be administered by a remote NVBU Server, this option must be used to name that specific server. If the local instance of the NVBU Server is to be used to administer the job, this option can be left out of the syntax. The server name is case sensitive. -libraryname Name of the target library.

27 3.2.7 nvcloseeeport Closes the Entry/Exit (EE) Port of a specified library. Syntax Quest NetVault Backup 27 Command Line Interface Reference Guide nvcloseeeport [-servername <Server Name>] -libraryname <Library Name> [-mediatype <Media Type>] -servername Name of the NVBU Server that is to administer the job. If the job is to be administered by a remote NVBU Server, this option must be used to name that specific server. If the local instance of the NVBU Server is to be used to administer the job, this option can be left out of the syntax. The server name is case sensitive. -libraryname Name of the target library. -mediatype Type of media in the entry/exit slot nvcloseeeportcleaning Closes the EE Port of the specified library for importing a cleaning tape. Syntax nvdav nvcloseeeportcleaning [-servername <Server Name>] -libraryname <Library Name> [-mediatype <Media Type>] -servername Name of the NVBU Server that is to administer the job. If the job is to be administered by a remote NVBU Server, this option must be used to name that specific server. If the local instance of the NVBU Server is to be used to administer the job, this option can be left out of the syntax. The server name is case sensitive. -libraryname Name of the target library. -mediatype Type of media in the entry/exit slot. Performs the following WebDAV-related functions for an NVSD instance: Configures WebDAV authentication details. Removes WebDAV authentication details. Retrieves user name configured for WebDAV authentication. Syntax nvdav --server <IP address hostname> [--set --remove --user]

28 28 Chapter 3 Using NVBU Commands <IP address hostname> IP address or resolvable hostname of an NVSD Instance. --set Sets WebDAV credentials for the specified NVSD Instance. This option will replace the existing values. The user name and password will be requested interactively. --remove Removes any existing WebDAV credentials for the specified NVSD Instance. --user Retrieves the user name configured for WebDAV authentication for the specified SmartDisk instance. If there are no WebDAV credentials configured for the specified NVSD Instances, then an error message will be returned nvddboost Adds or removes an EMC Data Domain System. Syntax nvddboost --add --host <Host name or IP Address> [--force] [--user <username>] [--password <password] [--lsu <LSU name>] [--blocksize <Block size>] [--server <Server Name>] nvddboost --remove --device <name> [--force] [--server <name>] --add Adds a Data Domain system. Use the following options with the --add option. --host DNS name or IP address of the Data Domain system. The NVBU Server must be able to resolve the configured host name or the device will not be added. Use this option with -add. --user DD Boost user account. NVBU uses this account to connect to the Data Domain systems for backups and restores. The user account and password must have already been configured on the Data Domain system. --password Password for the configured user account. --lsu Logical Storage Unit (LSU) name for the Data Domain system. If the specified LSU is not present on the Data Domain system, then NVBU will automatically create it when you add the device to the server. You can configure multiple LSUs on a single Data Domain system. Each Data Domain system displayed on the NVBU Device Manager window

29 Quest NetVault Backup 29 Command Line Interface Reference Guide represents an LSU. The default value for this parameter is NVBU. If you do not provide any name, then NVBU will use the default value. --blocksize Block size for the Data Domain system. The block size in specified in number of bytes. The default value for this parameter is bytes. If you do not provide any value for this parameter, then NVBU will use the default block size. --server N VBU Server to which you want to add the Data Domain system. This option is not required if you are running the command on the NVBU Server. --remove Removes a Data Domain system. Use the following options with the --remove option. --device Data Domain system name as shown in the NVBU Console, CLI and reports. Use this option with -remove. --force: Use this option to do the following: nvdevice Forcefully add a Data Domain system to an NVBU Server when it is already added to another NVBU Server with the same device name. This option is useful if you have performed a disaster recovery to rebuild the NVBU Server. Forcefully remove a Data Domain system from an NVBU Server even when the NVSD Device cannot be contacted or some other errors block the removal. Performs the following tasks: Checks drives Cleans drives Ejects media Brings a drive online Takes a drive offline Syntax nvdevice [-check] [-clean] [-eject] [-online] [-offline] [-library <Library Name>] -drive <Drive Number> -check Check the status of the specified drive. For example, it can be used to check the status of a drive that was taken offline for some reason. If successful, the specified drive will be returned to on-line status so that it is available to NVBU for future jobs. Use the [-library <library name>] -drive <drive number> options to specify the target drive.

30 30 Chapter 3 Using NVBU Commands -clean Sends a request for cleaning of the specified drive. If the number of cleaning lives has been set for the cleaning tape, it will be reduced by one when used for this process. Use the [-library <library name>] -drive <drive number> options to specify the target drive. -eject: Use this command to remove any media item from a specified standalone drive. Use the -drive <drive number> option to specify the target drive. -online Brings a drive online. Use the [-library <library name>] -drive <drive number> options to specify the target drive. -offline Takes a drive offline. Use the [-library <library name>] -drive <drive number> options to specify the target drive. -library <library name> Name of the target library. -drive Drive number of the target drive in the library or the standalone drive nvdeviceeject Removes a piece of media from the specified drive. Syntax nvdeviceeject -devicename <Device Name> [-servername <Server Name>] [-librarydrivenumber <Drive Number>] [-wait] -devicename Name of the target device or library. -servername Name of the NVBU Server to which the device is added. When you run this command on the NVBU Server, this option can be omitted. The Server name is case sensitive. -librarydrivenumber Drive number of the target drive in the library. -wait Add this option to tell NVBU to wait until this task has completed before moving forward. Notes It is necessary to use the -librarydrivenumber option to specify the target drive if the -devicename option is used to denote a library. The device names can be ascertained by inspecting the logs for the backup job.

31 nvexportmedia Quest NetVault Backup 31 Command Line Interface Reference Guide Exports a piece of media from a tape library to its Entry/Exit (EE) Port. Syntax nvexportmedia [-servername <Server Name>] [-barcode <Barcode> -medialabel <Medial Label> -slotspec <Library Name::Slot Number>] [-wait] -servername Name of the NVBU Server that is to administer the job. If the job is to be administered by a remote NVBU Server, this option must be used to name that specific server. If the local instance of the NVBU Server is to be used to administer the job, this option can be left out of the syntax. The server name is case sensitive. -barcode Barcode of the target media item. -medialabel Label of the target media item. Use only when searching by media label. If a media label contains spaces, enclose it within quotes ( ). For example, Full DB Backups. -slotspec Name of the library and slot number where the media item resides. These two values must be separated using a double colon delimiter ( :: ). Use this option only when searching by library slot. -wait Add this option to tell NVBU to wait until this task has completed before moving forward nvlibrarymodify Use this command to perform the following tasks: Change the drive status to online or offline Remove a library Map or unmap drives List all library drives Add a drive or shared drive Syntax nvlibrarymodify [-servername <server_name>] -libraryname <library_name> [-online DRIVE <drive_number> ] [-offline DRIVE <drive_number> ] [-remove DRIVE <drive_number> ] [-map DRIVE <drive_number> <lsm>,<panel>,<drive> [-name <Drive_Name> ] ] [-unmap DRIVE <drive_number> ] [-list]

32 32 Chapter 3 Using NVBU Commands nvlibrarymodify -servername <server_name> -libraryname <library_name> -librarymachine <library_machine> -drivemachine <drive_machine> -drivepath <drive_path> -add DRIVE <drive_number> -addshared DRIVE <drive_number> Use the following options to change the drive status, map or unmap drives, list all library drives, and remove a library: -servername Name of the NVBU Server that is to administer the job. If the job is to be administered by a remote NVBU Server, this option must be used to name that specific server. If the local instance of the NVBU Server is to be used to administer the job, this option can be left out of the syntax. The server name is case sensitive. -libraryname Name of the target library that is to be modified. This is a mandatory parameter. -online Brings a drive online. Use the DRIVE <drive_number> option to specify the target drive. -offline Takes a drive offline. Use the DRIVE <drive_number> option to specify the target drive. -remove Removes a drive. Use the DRIVE <drive_number> option to specify the target drive. -map Maps a drive to the appropriate LSM, Panel and Drive. Use the DRIVE <drive_number> option to specify the target drive. The optional -name parameter can be used to specify a user-defined drive name. For example, -name ACSLS_Drive-1. -unmap Unmaps a drive. Use the DRIVE <drive_number> option to specify the target drive. -list Lists the drives in the specified library. Use the following options to add a drive or shared drive to an existing library configuration: -servername Name of the target server. -libraryname Name of the target library that is to be modified. -librarymachine Name of the NVBU Server or Client on which the library resides. It can be any NVBU machine (not necessarily the NVBU Server. It can also be an NVBU Client with ACSLS drives attached to a third machine. -drivemachine Name of the NVBU Server or Client on which the drive resides. In an ACSLS environment, the drives can reside on an

33 Quest NetVault Backup 33 Command Line Interface Reference Guide NVBU Client that is neither the NVBU Server nor the NVBU Client which controls the ACSLS library. -drivepath Name or path of the drive to be added. Depending on the type of drive that is to be added, the drive path can be a VTL directory or the SCSI target. You can use the nvscandrives command to obtain a list of available drives on a local or remote NVBU Client. The output of this command provides the drive path as it appears in the NVBU Device Management window. For details on the nvscandrives command, refer to nvscandrives on page 37. -add Adds a drive. Use the DRIVE <drive_number> option to specify the target drive. -addshared Adds a shared drive. Use the DRIVE <drive_number> option to specify the target drive. Notes When you add a drive using the nvlibrarymodify command, NVBU changes the library configuration as follows: If one or more jobs are running, then NVBU appends the drive to the existing library configuration without affecting the running jobs. If no jobs are running, then NVBU removes the existing library configuration and re-adds the library. You cannot use this command to modify an existing drive in a library. You can only use it to modify an existing library configuration by adding a drive to it. Examples Add a drive to a VTL /home/qauser1/newlibrary that is created on a Linux NVBU Server tstserver : nvlibrarymodify -servername tstserver -libraryname "/home/qauser1/newlibrary -librarymachine tstserver -drivemachine tstserver -drivepath "/home/qauser1/newlibrary/drives/2 -add "DRIVE 2 Add a drive to a SCSI library winserver: (SONY LIB-304) that is connected to a Windows NVBU Server winserver : nvlibrarymodify -servername winserver -libraryname " (SONY LIB-304) -librarymachine winserver -drivemachine winserver -drivepath " (SONY SDX-500C) -add "DRIVE 2 Add a drive to an NDMP filer-attached device. The device name is Device f880:mc9(overland LXB), and the NVBU Server name is tstserver:

34 34 Chapter 3 Using NVBU Commands nvlibrarymodify -servername tstserver -libraryname "Device f880:mc9(overland LXB) -librarymachine tstserver -drivemachine tstserver -drivepath "Tape f880:nrst17a(hp Ultrium 3-SCSI) -add "DRIVE 2 Add a SCSI drive to a Windows NVBU Client winclient. The ACSLS library is attached to a Linux NVBU Server tstserver : nvlibrarymodify -servername tstserver -libraryname "ACS0(StorageTek ACSLS/LibStation) -librarymachine tstserver -drivemachine winclient -drivepath " (SONY SDX-500C) -add "DRIVE 2 Add a SCSI drive to a Windows NVBU Client winclient. The ACSLS library is attached to a Windows NVBU Client client2 and controlled by NVBU Server tstserver : nvlibrarymodify -servername tstserver -libraryname "ACS0(StorageTek ACSLS/LibStation) -librarymachine client2 -drivemachine winclient -drivepath " (SONY SDX-500C) -add "DRIVE nvopendoor Opens the door of a library managed by the specified NVBU Server. Syntax nvopendoor [-servername <server name>] -libraryname <library name> -servername Name of the NVBU Server that is to administer the job. If the job is to be administered by a remote NVBU Server, this option must be used to name that specific server. If the local instance of the NVBU Server is to be used to administer the job, this option can be left out of the syntax. The server name is case sensitive. -libraryname Name of the target library nvopeneeport Opens the Entry/Exit Port. Syntax nvopeneeport [-servername <server name>] -libraryname <library name>

35 Quest NetVault Backup 35 Command Line Interface Reference Guide -servername Name of the NVBU Server that is to administer the job. If the job is to be administered by a remote NVBU Server, this option must be used to name that specific server. If the local instance of the NVBU Server is to be used to administer the job, this option can be left out of the syntax. The server name is case sensitive. -libraryname Name of the target library nvremovefiler Removes filer-attached drives for a specified filer. Syntax nvremovefiler [-servername <server name >] -filername <filer name> [-wait] -servername Name of the NVBU Server that is to administer the job. If the job is to be administered by a remote NVBU Server, this option must be used to name that specific server. If the local instance of the NVBU Server is to be used to administer the job, this option can be left out of the syntax. The server name is case sensitive. -filername Name of the target filer. -wait Add this option to tell NVBU to wait until this task has completed before moving forward. Notes This command removes only those drives that are idle or offline. After removing a drive, NVBU displays the following message on the screen and in the NVBU Logs window: Device removed DRIVE <#>:<Drive Name> NVBU makes only one attempt to remove a filer-attached drive. If a drive is busy, then NVBU displays the following message on the screen and moves on to the next drive. Failed to delete busy device DRIVE <#>:<Drive Name> If all drives in a library are removed, then the node representing the library arm is also removed.

36 36 Chapter 3 Using NVBU Commands nvresetdrivestats Resets the statistics for a drive. Syntax nvresetdrivestats -servername <server name> [-libraryname <library name>] [-drivename <drivename>] [-drivenumber <drivenumber>] -action <action> -servername Name of the NVBU Server that is to administer the job. If the job is to be administered by a remote NVBU Server, this option must be used to name that specific server. If the local instance of the NVBU Server is to be used to administer the job, this option can be left out of the syntax. The server name is case sensitive. -libraryname Name of the target library. -drivename Name of the target drive. -drivenumber Drive number of the target drive. -action Action to be performed. The supported actions include: drive To reset drive statistics. clean To reset drive cleaning statistics. all To reset all statistics for the specified drive. Note: If the -libraryname option is chosen to denote a library then the -drivename or -drivenumber option must be used to specify the target drive. Examples Reset statistics for a standalone drive TstDrive1 that is locally attached to the NVBU Server. nvresetdrivestats -drivename TstDrive1 -action drive Reset the cleaning statistics for Drive 1 in library NVLibrary that is locally attached to an NVBU Client NVCLIENT1 nvresetdrivestats -servername NVCLIENT1 -libraryname NVLibrary -drivename Drive 1 -action clean Reset all statistics for Drive 2 in library NVLib2 that is attached to a remote NVBU Server NVSERVER2 nvresetdrivestats -servername NVSERVER2 -libraryname NVLib2 -drivenumber 2 -action all

37 nvscandrives Quest NetVault Backup 37 Command Line Interface Reference Guide Lists drives that are available on a local or remote NVBU Server or Client. The output does not include drives that are added as shared. The output of this command provides the drive path as it appears in the NVBU Device Management window. It can be used to add a drive to an existing library configuration using the nvlibrarymodify command. For details on the nvlibrarymodify command, refer to nvlibrarymodify on page 31. Syntax nvscandrives [-servername <server name>] [-clientname <client name>] -servername Name of the NVBU Server that is to administer the job. If the job is to be administered by a remote NVBU Server, this option must be used to name that specific server. If the local instance of the NVBU Server is to be used to administer the job, this option can be left out of the syntax. The server name is case sensitive. -clientname Name of the NVBU Client for which you want to view the available drives. If you do not specify the client name, NVBU will list the drives available on the machine nvsetcleaninglives Sets the number of lives for a cleaning tape in the specified library. Syntax nvsetcleaninglives [-servername <server name>] -libraryname <library name> [-slotnumber <slot number>] [-lives <lives>] -servername Name of the NVBU Server that is to administer the job. If the job is to be administered by a remote NVBU Server, this option must be used to name that specific server. If the local instance of the NVBU Server is to be used to administer the job, this option can be left out of the syntax. The server name is case sensitive. -libraryname Name of the target library. -slotnumber Cleaning slot number in the library. -lives Number of lives to be set for the cleaning media item. Examples Set the number of lives to 7 for a piece of cleaning media in slot 6 of a library ADIC_Library_6 that is locally attached to NVSERVER.

38 38 Chapter 3 Using NVBU Commands nvsetcleaninglives -server NVSERVER -libraryname ADIC_Library_6 -slotnumber 6 -lives nvsetdrivecleaning Sets the cleaning cycle for a specified library. Syntax nvsetdrivecleaning -libraryname <library name> -librarydrivenumber <drive number> -days <number of days> -dataxfersize <data transfer size> -hours <number of hours> -rwerrors <number of read/write errors> [-displayonly] -libraryname Name of the target library. -librarydrivenumber Drive number of the drive for which the cleaning cycle has to be set. -days Number of days the drive is to be used until a clean cycle. -dataxfersize Size of data to be transferred before clean cycle. -hours Number of hours the drive is to be used until a clean cycle. -rwerrors Number of read/write errors that can occur before a clean cycle. -displayonly Use this option to include additional details for the device device. Important: Other than the -displayonly option, all other options offered for use must be included in the syntax of a single command. You can use -1 to disable any option. Examples Set Drive 1 of library SONY LIB-162 to clean itself at the following intervals 200 GB of data transfer, 100 hours of drive usage, or more than 100,000 read/write errors. nvsetdrivecleaning -libraryname SONY LIB-162 -librarydrivenumber 1 -days -1 -dataxfersize 200 -hours 100 -rwerrors nvsmartdisk Performs the following functions: Adds a NetVault SmartDisk (NVSD) Device. Removes an NVSD Device. Lists the machine names of NVSD instances added to the NVBU Server.

39 Quest NetVault Backup 39 Command Line Interface Reference Guide Syntax nvsmartdisk --add --host <Host name or IP Address> [--force] [--port <Port Number>] [--server <Server Name>] nvsmartdisk --remove --device <name> [--force] [--server <name>] nvsmartdisk --list --add Adds an NVSD Device. Use the following options with the --add option. --host DNS name or IP address of the host on which the NVSD Instance is installed. Use this option with -add. --port Port for communicating with the NVSD Instance. It is only required if NVSD is configured to use a non-default port. --server NVBU Server to which you want to add the NVSD Instance as an NVSD Device. This option is not required if you are running the command on the NVBU Server. --remove Removes an NVSD Device. Use the following options with the --remove option. --device NVSD Device name as shown in the NVBU Console, CLI and reports. Use this option with -remove. --force: Use this option to do the following: Forcefully add the NVSD Device to an NVBU Server when it is already added to another NVBU Server with the same device name. This option is useful if you have performed a disaster recovery to rebuild the NVBU Server. Forcefully remove NVSD from an NVBU Server even when the NVSD Device cannot be contacted or some other errors block the removal. --list Lists the machine names of all NVSD instances added to the NVBU Server nvsvtlgrow Performs the following functions: Displays the current status and usage of a specific SVTL or all SVTLs on the current system. Performs a test or dummy expansion of an SVTL by a given number of media items of a given size.

40 40 Chapter 3 Using NVBU Commands Performs an actual expansion of an SVTL by a given number of media items of a given size. This utility is available in the <NVBU installation directory>\bin directory. Syntax nvsvtlgrow display [-device <SVTL Device>] nvsvtlgrow test -device <SVTL Device> -size <Media Size> -count <Media Count> nvsvtlgrow grow -device <SVTL Device> -size <Media Size> -count <Media Count> display Displays all SVTLs on the machine. To display the status of a single SVTL on the machine use the following command: nvsvtlgrow display -device <svtl-device> test Perform a test expansion. -device Name of the target SVTL. -size Size of the media (for example, 800m for 800MB, 40g for 40GB, 2t for 2TB). -count Number of media items to be added. nvsvtlgrow will check these values against the available space and report whether it would be possible to create these media items. No changes will be made to the SVTL. grow Actually expands the SVTL capacity. -device Name of the target SVTL. -size Size of the media (for example, 800m for 800MB, 40g for 40GB, 2t for 2TB). -count Number of media items to be added. nvsvtlgrow will check the parameters and upon confirmation from the user will actually add the new media items to expand the SVTL size. Re-add the SVTL or restart the NVBU Service to use the added media.

41 3.3.0 Media-Specific Commands Quest NetVault Backup 41 Command Line Interface Reference Guide nvblankmedia nvlistmedia nvreusemedia nvbulkblankmedia nvloadmedia nvscanmedia nvexportmedia nvmakemedia nvsyncronizesilomedia nvlabelmedia nvmediadetails nvupdateserialnumber nvlistblankmedia nvremovemedia Important Notes A media item can be identified by its barcode, media label, or slot position within a library when using the CLI commands. If a media label contains spaces, enclose it within quotation marks ( ). For example, Full DB Backups. Various operating systems do not support special characters such as the following in a media label. For example, #, $, %, ^, &, *, (, ), >, <, \, [, ], {, },, Therefore, if a CLI command is issued to call out a piece of media whose label contains one of these characters, the command may fail with an error message. Media labels that include any of these characters can only be managed from the NVBU Console (the NVBU Media Management or NVBU Device Management windows) nvblankmedia Blanks a piece of media. Syntax nvblankmedia [-servername <Server Name>] [-libraryname <Library Name>] -barcode <Barcode> -medialabel <Media Label> -slotspec <Library Name::Slot Number> [-drivename <Standalone Drive Name>] [-wait] -servername Name of the NVBU Server that is to administer the job. If the job is to be administered by a remote NVBU Server, this option must be used to name that specific server. If the local instance of the NVBU Server is to be used to administer the job, this option can be left out of the syntax. The server name is case sensitive. -libraryname Name of the target library that contains the media item to be blanked. -barcode Barcode of the target media item.

42 42 Chapter 3 Using NVBU Commands -medialabel Label of the target media item. Use this option only when searching by media label. If a media label contains spaces, enclose it within quotes ( ). For example, Full DB Backups. If the media label is not unique for media in all available devices, then use this option with either - libraryname or -drivename. -slotspec Name of the library and slot number where the media item resides. These two values must be separated using a double colon delimiter ( :: ). Use this option only when searching by library slot. -drivename Name of standalone drive that contains the media item to be blanked. -wait Add this option to tell NVBU to wait until this task has completed before moving forward. Notes In NVBU terms, blanking a piece of media removes the NVBU header information from the media. It also deletes the media label and removes any group association. This makes the media item available to NVBU for storing future backups. The backup data residing on the media item is not deleted or erased. If it is desired to purposely destroy the data that is stored on a piece of media, then it should be blanked by NVBU and have its data securely removed by tools that are designed for such purposes. When an incorrect library/media pair is specified, NVBU displays the following error message: Blank request failed! - 'Unable to identify media' Examples Blank a piece of media in slot 21 of the library NV_Library_Large that is locally attached to an NVBU Client NVCLIENT1. nvblankmedia -servername NVCLIENT1 -slotspec 21:: NV_Library_Large Blank a piece of media labeled DB-Backup in the library Lib-2 that is connected to an NVBU Client NVCLIENT2. nvblankmedia -libraryname "NVCLIENT2: Lib-2" -medialabel "DB-Backup" nvbulkblankmedia Blanks one or more media items in the specified library. Syntax nvbulkblankmedia -libraryname <Library Name> -medialabel <Media Label> [-allmedia] -password <Password> [-wait]

43 Quest NetVault Backup 43 Command Line Interface Reference Guide -libraryname Name of the library that contains the media items to be blanked. -medialabel Label of the media items to be blanked. This option supports the wild card character * which can be used to represent a string of characters. If a media label contains the character *, then use the backslash character (\) to escape *. For example, to blank media items with the label media*star, use the -medialabel option as follows: -medialabel media\*star -allmedia Use this option to blank all media items in the specified library. -password Password for the NVBU Server. -wait Add this option to tell NVBU to wait until this task has completed before moving forward. Notes In NVBU terms, blanking a piece of media removes the NVBU header information from the media. It also deletes the media label and removes any group association. This makes the media item available to NVBU for storing future backups. The backup data residing on the media item is not deleted or erased. If it is desired to purposely destroy the data that is stored on a piece of media, then it should be blanked by NVBU and have its data securely removed by tools that are designed for such purposes. The bulk blanking operation will remove backup indexes for all backups on the selected media items from the NVDB. This command will not work on NVBU Servers on which security is disabled. The library name and media labels are case-sensitive. Examples Blank all media items with the label Full Backup Group 7. The media items reside in the library ADICLib_1. nvbulkblankmedia -libraryname ADICLib_1 -medialabel Full Backup Group 7 -password ServerPwd Blank all media items with labels that begin with C2-Backups. The media items reside in the library ADICLib_1. nvbulkblankmedia -libraryname ADICLib_1 -medialabel C2-Backups* -password ServerPwd

44 44 Chapter 3 Using NVBU Commands nvexportmedia Export a piece of media from a tape library to its Entry/Exit (EE) Port. Syntax nvexportmedia -servername <Server Name> -barcode <Barcode> -medialabel <Media Label> -slotspec <Library Name::Slot Number> [-wait] -servername Name of the NVBU Server that is to administer the job. If the job is to be administered by a remote NVBU Server, this option must be used to name that specific server. If the local instance of the NVBU Server is to be used to administer the job, this option can be left out of the syntax. The server name is case sensitive. -barcode Barcode of the target media item. -medialabel Label of the target media item. Use this option only when searching by media label. If a media label contains spaces, enclose it within quotes ( ). For example, Full DB Backups. -slotspec Name of the library and slot number where the media item resides. These two values must be separated using a double colon delimiter ( :: ). Use this option only when searching by library slot. -wait Add this option to tell NVBU to wait until this task has completed before moving forward nvlabelmedia Label new media items or re-label existing media items. Syntax nvlabelmedia [-servername <Server Name>] -barcode <Barcode> -medialabel <Media Label> -slotspec <Library Name::Slot Number> -newlabelname <New Media Label> [-newgroupname <New Media Group Name>] [-newoffsitelocation <New Offsite Location Name>] [-wait] -servername Name of the NVBU Server that is to administer the job. If the job is to be administered by a remote NVBU Server, this option must be used to name that specific server. If the local instance of the NVBU Server is to be used to administer the job, this option can be left out of the syntax. The server name is case sensitive. -barcode Barcode of the target media item.

45 Quest NetVault Backup 45 Command Line Interface Reference Guide -medialabel Media label of the target media. Use this option only when searching by media label. If a media label contains spaces, enclose it within quotes ( ). For example, Full DB Backups. -slotspec Name of the library and slot number where the media item resides. These two values must be separated using a double colon delimiter ( :: ). Use this option only when searching by library slot. -newlabelname New label for the selected piece of media. If the new media label contains spaces, underscores ( _ ) should be used in their place (for example, new_label_1 ). -newgroupname New media group name for the selected media group. If the new media group label contains spaces, underscores ( _ ) should be used in their place (for example, new_group_1 ). -newoffsitelocation New offsite location for the selected piece of media. -wait Add this option to tell NVBU to wait until this task has completed before moving forward. Notes Media items that contain existing backups cannot be re-labelled without first running either nvblankmedia or nvreusemedia commands. The offsite location of the media can be changed without blanking the media or marking it for re-use. This property is set or changed using the -newoffsitelocation option nvlistblankmedia Provides a list of slots containing blank media items for a given NVBU Server and library. Syntax nvlistblankmedia -servername <Server Name> -libraryname <Library Name> -servername Name of the NVBU Server that is to administer the job. If the job is to be administered by a remote NVBU Server, this option must be used to name that specific server. If the local instance of the NVBU Server is to be used to administer the job, this option can be left out of the syntax. The server name is case sensitive. -libraryname Name of the library.

46 46 Chapter 3 Using NVBU Commands nvlistmedia Use this command to determine which media item within a library is: Marked for Reuse Marked as ReadOnly Marked as Unusable Marked as Bad Marked as needing import Marked as needing recovery Syntax nvlistblankmedia [-servername <Server Name>] -libraryname <Library Name> -readonly -reusable -unusable -needsimport -needsrecovery -bad -group -servername Name of the NVBU Server that is to administer the job. If the job is to be administered by a remote NVBU Server, this option must be used to name that specific server. If the local instance of the NVBU Server is to be used to administer the job, this option can be left out of the syntax. The server name is case sensitive. -libraryname Name of the library. -readonly Lists read-only media items. -reusable Lists reusable media items. -unusable Lists unusable media items. -bad Lists bad media items. -needsimport Lists media items that need importing. -needsrecovery Lists media items that need recovery. -group Lists media items that belong to any media group nvloadmedia Use this command to load specific media items to a drive in order to read the media header or continue using the media from the CLI or from within a script. You can use nvdeviceeject command to return the media item to a home slot. Syntax nvloadmedia [-servername <Server Name>] -barcode <Barcode> -medialabel <Media Label> -slotspec <Library Name::Slot Number> [-wait]

47 Quest NetVault Backup 47 Command Line Interface Reference Guide -servername Name of the NVBU Server that is to administer the job. If the job is to be administered by a remote NVBU Server, this option must be used to name that specific server. If the local instance of the NVBU Server is to be used to administer the job, this option can be left out of the syntax. The server name is case sensitive. -barcode Barcode of the target media item. -medialabel Label of the target media item. Use this option only when searching by media label. If a media label contains spaces, enclose it within quotes ( ). For example, Full DB Backups. -slotspec Name of the library and slot number where the media item resides. These two values must be separated using a double colon delimiter ( :: ). Use this option only when searching by library slot. -wait Add this option to tell NVBU to wait until this task has completed before moving forward nvmakemedia Increases the capacity of a Virtual Tape Library (VTL) by creating additional media files. A VTL contains the following directories and files: Windows Linux/UNIX Description...\<vt>.../<vtl> VTL root directory....\<vtl>\drives.../<vtl>/drives Directory under the VTL root directory where the virtual drives are stored. NVBU creates a sub-directory for each virtual drive in this directory....\<vtl>\media.../<vtl>/media Directory under the VTL root directory where the virtual media items are stored....\<vtl>\slots.../<vtl>/slots Directory under the VTL root directory where the virtual slots are stored. NVBU creates asub-directory for each virtual slot in this directory...\<vtl>\.serial.../<vtl>/.serial File residing in the VTL root directory. It contains a list of media barcodes and drive numbers. For example, 4O4HR-2, where 4O4HR is the barcode and 2 is virtual drive number. :404HR-2, where 404HR is the barcode and 2 is virtual drive 2

48 48 Chapter 3 Using NVBU Commands Windows Linux/UNIX Description...\<vtl>\drives\<x>\.serial..\<vtl>\slots\<x>\.serial..\<vtl>\media\ <mediafile> To add a media item, use the following steps: 1. Stop the NVBU Service on the NVBU Server or SmartClient where the VTL is located. 2. In the.../<vtl>/slots directory, create a sub-directory which is one number larger than the existing largest numbered virtual slot directory. 3. Copy the.media file from one of the virtual slot directories to the virtual slot directory created in the step above. 4. Modify the.media file in the newly created virtual slot directory from../../1y2ny00* to../../1y2ny00x where X represents the new virtual media number. 5. Use the nvmakemedia command to create the media file. 6. Restart the NVBU Service. Syntax../<vtl>/drives/<x>/.serial../<vtl>/slots/<x>/.serial.../<vtl>/media/ <mediafile> File residing in each drive sub-directory. It contains the individual media barcode and drive number. File residing in each slot sub-directory. It contains barcode for the individual media item. For example,..\..\4o4hr001, where 404HR is the barcode and 001 is the virtual media item Actual virtual media. For example,...\vtl1\media\4o4hr001 nvmakemedia <file-size> poplib <library> nvmakemedia <file-size> mediafiles <filename> <file-size> poplib <library> This form of the command will check all media reference files within the specified <library> and offer to create the file if the corresponding media data file does not exist. Enter Y or y to confirm media file creation. <file-size> Specify an integer value followed by k for kilobytes, m for megabytes, g for gigabytes, or t for terabytes. For example, k, 50m, 4g, 2t. The minimum file size allowed is 50m. <library> Specify the full path to the target VTL name.

49 Quest NetVault Backup 49 Command Line Interface Reference Guide Example nvmakemedia 50M poplib c:\tst-vtl Figure 3-1: A media file added to a VTL using the nvmakemedia poplib option <file-size> mediafiles <file name> This form of the command will create a media file of the specified size in the given path. <file-size> Specify an integer value followed by k for KB, m for MB, g for GB, or t for TB (for example, k, 50m, 4g, 2t). The minimum file size allowed is 50m. <file name> Specify the complete file path for the new media file. The media data file name will be the barcode for the media piece. Example nvmakemedia 50M mediafiles c:\tst-vtl\1y2ny006 Figure 3-2: A media file added to a VTL using the nvmakemedia mediafiles option For more information on expanding VTLs, refer to the Quest NetVault Backup Advanced VTL Configuration Implementation Guide available at: nvmediadetails Provides details pertaining to media items and media groups. Syntax nvmediadetails [-label <Media Label>] [-group <Group Label>] [-all] [-listlabels] [-listgroups] [-version] -label Media label of the media item for which the details are to be viewed. You can specify a few initial characters to search for media items with matching labels. -group Media group label of the media group for which the details are to be viewed. -all Use this option to view details for all media items.

50 50 Chapter 3 Using NVBU Commands -listlabels Provides details of all the media items that have been assigned a media label. The -group option can be used with this option for details related to media items belonging to the specified group. -listgroups Use this option for a list of media groups. -version Displays the build date of the NVBU distribution. Examples Display details for a piece of media labeled MyTape. nvmediadetails -label MyTape Display details of all media items belonging to the Media Group MyGroup. nvmediadetails -group MyGroup -all nvremovemedia Deletes all information related to a piece of media from the NVDB. Important: The target media item must be taken offline before issuing this command. Syntax nvremovemedia [-medialabel <Media Label>] [-displaymedialist] [-version] -medialabel Label of the offline media item that is to be removed from the NVDB. -displaymedialist Provides details related to all the media items that have been assigned a media label. -version Displays the build date of the NVBU distribution nvreusemedia Mark a piece of media as reusable. Syntax nvreusemedia [-servername <Server Name>] -barcode <Barcode> -medialabel <Media Label> -slotspec <Library Name::Slot Number>

51 Quest NetVault Backup 51 Command Line Interface Reference Guide -servername Name of the NVBU Server that is to administer the job. If the job is to be administered by a remote NVBU Server, this option must be used to name that specific server. If the local instance of the NVBU Server is to be used to administer the job, this option can be left out of the syntax. The server name is case sensitive. -barcode Barcode of the target media item. -medialabel Label of the target media item. Use this option only when searching by media label. If a media label contains spaces, enclose it within quotes ( ). For example, Full DB Backups. -slotspec Name of the library and slot number where the media item resides. These two values must be separated using a double colon delimiter ( :: ). Use this option only when searching by library slot. Notes This command removes all backup indexes for backups on the selected media from the NVDB. The nvreusemedia CLI command is not supported for use with ACSLS/ ADIC DAS library systems. Attempts to use this command with these devices will result in a failure message. The nvreusemedia command does not support NVSD devices nvscanmedia Scans media items. This command can be used to import a piece of media from another NVBU device, including media items residing in devices previously controlled by a different NVBU Server. Before running this command, this type of media items are recognized as FOREIGN. Data cannot be restored from such media items until they are scanned. It writes backup indexes for all backups on the selected media to the NVDB unless the index entry is already present in the database. Important: This command cannot be used to scan NVSD Devices. Syntax nvscanmedia [-servername <Server Name>] -barcode <Barcode> -medialabel <Media Label> -slotspec <Library Name::Slot Number> [-wait]

52 52 Chapter 3 Using NVBU Commands -servername Name of the NVBU Server that is to administer the job. If the job is to be administered by a remote NVBU Server, this option must be used to name that specific server. If the local instance of the NVBU Server is to be used to administer the job, this option can be left out of the syntax. The server name is case sensitive. -barcode Barcode of the target media item. -medialabel Label of the target media item. Use only when searching by media label. If a media label contains spaces, enclose it within quotes ( ). For example, Full DB Backups. -slotspec Name of the library and slot number where the media item resides. These two values must be separated using a double colon delimiter ( :: ). Use this option only when searching by library slot. -wait Add this option to tell NVBU to wait until this task has completed before moving forward nvsyncronizesilomedia Allocates all the known media in the specified ACSLS library. Syntax nvsyncronizesilomedia [-servername <Server Name>] -libraryname <Library Name> -servername Name of the NVBU Server that is to administer the job. If the job is to be administered by a remote NVBU Server, this option must be used to name that specific server. If the local instance of the NVBU Server is to be used to administer the job, this option can be left out of the syntax. The server name is case sensitive. -libraryname Name of the target library nvupdateserialnumber Updates the serial number of any drive in the specified library back to its original number. Syntax nvupdateserialnumber [-servername <Server Name>] -libraryname <Library Name> [-bayname <Bay Name>] [-checkonly]

53 Quest NetVault Backup 53 Command Line Interface Reference Guide -servername Name of the NVBU Server that is to administer the job. If the job is to be administered by a remote NVBU Server, this option must be used to name that specific server. If the local instance of the NVBU Server is to be used to administer the job, this option can be left out of the syntax. The server name is case sensitive. -libraryname Name of the target library. -bayname Name of the drive bay in which the target drive is located. -checkonly Use this option to check the media serial number.

54 54 Chapter 3 Using NVBU Commands Job-Specific Commands nvexpiresaveset nvjobmodify nvsetdelete nvjobabort nvjobresume nvsetexport nvjobcreate nvjobstart nvsetimport nvjobdelete nvpolicy nvsetmodify nvjobhold nvrestore nvtrigger nvjoblist nvsetcreate nvexpiresaveset Performs the following functions: Deletes a specified saveset. Optionally, deletes the duplicates of the specified saveset. The savesets are deleted immediately. Marks multiple savesets for deletion. Optionally, includes the duplicates of the specified savesets. The marked savesets are deleted when the Media Manager performs the next "retirement check". Syntax nvexpiresaveset [-duplicates] -savesetid <Saveset ID> nvexpiresaveset [-duplicates] [-success] -markforexpiry -infile <saveset file> -outfile <results file> nvexpiresaveset [-version] To delete a specified saveset and its duplicates, use the following options: -savesetid Saveset ID of the saveset to be deleted. Only a single saveset ID can be specified with this form of the command. -duplicates Deletes duplicate savesets of the specified saveset. To mark multiple savesets and their duplicates for deletion, use the following options: -markforexpiry Marks the savesets specified in the input file (infile) for deletion. The savesets are expired when the Media Manager performs the next retirement check. By default, these checks are performed every 60 minutes. To change the interval between two checks, set the Retirement

55 Quest NetVault Backup 55 Command Line Interface Reference Guide Check Granularity in Mins parameter in the mediamgr.cfg file. For details on changing this value, refer to Quest NetVault Backup Administrator s Guide. -duplicates Marks duplicates of the specified savesets for deletion. -success Sends a list of successful savesets to the output file. If you omit this option, then NVBU sends a list of failed savesets to the output file. -infile Name of the input file that contains a list of saveset IDs to be marked for deletion. You can use any text editor to create this file. Enter one saveset ID per line. Specify the complete path if the input file is not located in the directory from which the command is executed. -outfile Name of the output file to which the result of the command is to be sent. By default, the file is created in the directory from which you run the command. Specify the complete path to save the file in another location. To view the version of NVBU distribution, use the following option: -version Displays the build date of the NVBU distribution. Examples Delete saveset ID 120 nvexpiresaveset -savesetid 120 Delete saveset ID 150 and its duplicates nvexpiresaveset -duplicates -savesetid 150 Mark savesets included in input file C:\deletelist.txt for deletion. Send the default output to C:\failedlist.txt nvexpiresaveset -markforexpiry -infile c:\deletelist.txt -outfile c:\failedlist.txt Mark savesets included in the input file deletelist.txt and their duplicates for deletion. Send the list of successful savesets to the output file marked.txt. nvexpiresaveset -duplicates -success -markforexpiry -infile deletelist.txt -outfile marked.txt nvjobabort This command allows a user to abort a job that is currently running. However, if the job is a scheduled one, it must actually be deleted from the NVBU Console. Syntax nvjobabort [-servername <NVBU Server Name>] -jobid <Job ID> [-instanceid <Instance ID>]

56 56 Chapter 3 Using NVBU Commands -servername Name of the NVBU Server that is to administer the job. If the job is to be administered by a remote NVBU Server, this option must be used to name that specific server. If the local instance of the NVBU Server is to be used to administer the job, this option can be left out of the syntax. The server name is case sensitive. -jobid Job ID of the job being aborted. -instanceid Instance ID of the job instance being aborted. If you do not specify the instance ID, NVBU will use the default instance ID nvjobcreate Use this command to create a backup or restore job. A job can be created to be submitted later. This is done by submitting a job title and using pre-defined sets. Note: The nvjobcreate command does not provide any option to set the Restore. These must be included in the Restore Selection Set to be used. The nvsetcreate command offers an option that is used to incorporate Restore into the Restore Selection Set. For details, refer to nvsetcreate on page 72. Syntax nvjobcreate [-servername <NVBU Server Name>] -jobtitle <Job Title> -type <Job Type> [-selectionsetname <Backup/Restore Selection Set Name>] [-selectionoptionssetname <Backup Set Name>] [-schedulesetname <Schedule Set Name>] [-backupoption <Backup Option>=<value>] [-targetsetname <Target Set Name>] [-advoptssetname <Advanced Set Name>] [-jobidfile <Output File Name>] -submit -parameters <Parameter File Name> [-version] -servername Name of the NVBU Server that is to administer the job. If the job is to be administered by a remote NVBU Server, this option must be used to name that specific server. If the local instance of the NVBU Server is to be used to administer the job, this option can be left out of the syntax. The server name is case sensitive. -jobtitle Job Title -type Job Type backup or restore. The default job type is backup.

57 Quest NetVault Backup 57 Command Line Interface Reference Guide -selectionsetname Name of the Selection Set to be used with a backup or restore job. This can be a set that was created in the NVBU Console or using the nvsetcreate command. -selectionoptionssetname Name of the Backup Set. This option is only applicable to backup jobs. -schedulesetname Name of the Schedule Set. The job will be scheduled to run immediately if this option is not used. This can be a set that was created in the NVBU Console or using the nvsetcreate command. -backupoption Specifies the Backup for a job. To use this option, you require the Tag ID of the window item that is to be set. This can either be the backup option name as recognized by the CLI or a numeric value assigned to the option by NVBU. Both of these values are grouped under the [Plugin ] section in the nvsetmodify.cfg configuration file. For details, refer to Using the nvsetmodify.cfg File on page 17. Specify either of these values in place of the <field> variable. <Value> can be set to True to enable or False to disable the option. Note: This option must be followed by a space ( ) before the Tag ID. For example, -backupoption <Tag ID>=True/False. -targetsetname Name of the Target Set used to specify the target media and drive details. This can be a set that was created in the NVBU Console or using the nvsetcreate command. The default target options as displayed in the NVBU Console are used if no Target Set is specified. -advoptssetname Name of the Advanced Set. This can be a set that was created in the NVBU Console or using the nvsetcreate command. The default Advanced displayed in the NVBU Console are used if no Advanced Set is specified for the backup or restore job. -jobidfile Name of the file to write the Job ID to. This option is useful if the nvjobcreate command has been configured to return the exit status instead of the Job ID. For details on configuring nvjobcreate to return the job exit status, refer to the Quest NetVault Backup Configuration Guide. You can specify an absolute or a relative path for the file. The file will contain the Job ID as a string that can be read by a calling script. NVBU will not delete this file. It must be deleted manually after use. -submit Use this option to submit a job and list it as an active job. If omitted, the job will be saved but not run or scheduled. The job may be scheduled at a later time using the nvjobmodify command. -parameters Use this option to redirect nvjobcreate to read options from a parameter file so that you do not have to enter them each time the command is run.

58 58 Chapter 3 Using NVBU Commands You can create this file using any standard text editor. Enter one option (with its value) per line and omit - before the option. Use spaces or tabs to separate the option and values. To include comments, begin the line with a # character. Such lines will be ignored. Following is an example of a parameter file example.txt : # nvjobcreate example file jobtitle cli job 1 selectionsetname cliselset This file can be used with the -parameters option as follows:./nvjobcreate -parameters example.txt -version Displays the build date of the NVBU distribution. Examples Create an Incremental Backup job with Backup Selection Set NVCLIENT 1 Full Data Backup and Schedule Set Repeating 1 that was created to run the job at a later time. The Job Title is Incremental Backup of NVCLIENT1 and it is to be administered by the local NVBU Server. nvjobcreate -jobtitle Incremental Backup of NVCLIENT1 -type backup -selectionsetname NVCLIENT 1 Full Data Backup -backupoption ntfsopt_typeincr=true -schedulesetname Repeating 1 -submit Submit a restore job to run immediately. The Job Title is Restore of Full Backup. The backup was administered by a remote NVBU Server NVSERVER2 and the restore items are included in Restore Selection Set RestoreFull. nvjobcreate -jobtitle Restore of Full Backup -servername NVSERVER2 -type restore-selectionsetname RestoreFull -submit Notes After using the nvjobcreate command to create one or more jobs, if you run the following nvreport command, the Scheduler may crash: nvreport class Defined Jobs format %Selection Workaround: From the NVBU Jobs window in the NVBU Console, open the jobs for editing and save them without any changes nvjobdelete Use this command in order to delete jobs matching the criteria specified by the options from the scheduler.

59 Quest NetVault Backup 59 Command Line Interface Reference Guide Syntax nvjobdelete [-servername <NVBU Server Name>] [-jobid <Job ID>] [-type <Job Type>] [-jobrange <Job ID-Job ID>] [-jobtitle <Job Title>] [-client <Client Name>] [-plugin <Plug-in Name>] [-selectionsetname <Selection Set Name>] [-schedulesetname <Schedule Set Name>] [-targetsetname <Target Set Name>] [-advoptssetname <Advanced Set Name>] [-force] [-sheduleonly] [-version] -servername Name of the target NVBU Server. -jobid Job ID of the job to be deleted. Only one job can be deleted with a single use of this option. -type Type of NVBU job to be deleted backup or restore. This option should only be used if a specific job type is to be deleted. Leave this option out of the syntax entirely if all NVBU job types are to be deleted. -jobrange Range of Job IDs corresponding to a series of jobs to be deleted. Use a hyphen to separate the start and end Job IDs. For example, -jobrange jobtitle Job Title enclosed in quotes to delete job(s) with a matching title. For example, -jobtitle Full_Backup_1 -client NVBU Machine Name the client that served as target for the jobs that are to be deleted. It deletes all jobs performed for the specified NVBU Client. For example, -client NV_Client_MKTG -plugin Name of the NVBU Plug-in used in the jobs that are to be deleted. The plug-in name must be enclosed in quotes. For example, -plugin File System. -selectionsetname Name of the Backup or Restore Selection Set that was used in the job(s) to be deleted. -schedulesetname Name of the Schedule Set that was used in the job(s) that are to be deleted. -targetsetname Name of the Target Set that was used in the job(s) that are to be deleted. -advoptssetname Name of the Advanced Set that was used in the job(s) that are to be deleted. -force If a job that meets the parameters set by another option is currently in the queue to be run (scheduled to run at a later time), any attempt to delete it will fail. Use the -force option to delete such jobs.

60 60 Chapter 3 Using NVBU Commands -scheduleonly Use this option in lieu of -force to only remove jobs from the job queue, but not actually delete them from the NVDB. -version Displays the build date of the NVBU distribution. Notes This note applies to the use of the following options with nvjobdelete command: -jobtitle -client -plugin -selectionsetname -schedulesetname -targetsetname -advoptssetname In the event that any of these options are used alone in the syntax, all instances of a job that meet the set parameters will be deleted. For example, nvjobdelete -plugin File System This command will delete all jobs for the Plug-in for FileSystem. However, other options can be used in conjunction to limit the jobs deleted. For example, if used in conjunction with the -jobrange option, only jobs that fall into the specified Job ID range specified will be deleted. Examples Delete the jobs with Job IDs fall that fail in the range: 1, 5, 7-12, nvjobdelete -jobid 1 -jobid 5 -jobrange jobrange Delete all restore jobs with the Job Title No Title nvjobdelete -type restore -jobtitle No Title Delete all jobs that are using the Schedule Set FirstTuesday on the NVBU Client MyClient nvjobdelete -client MyClient -schedulesetname FirstTuesday -force nvjobhold Use this command to put a currently scheduled report job on hold temporarily. The job can be resumed using the nvjobresume command.

61 Quest NetVault Backup 61 Command Line Interface Reference Guide Syntax nvjoblist nvjobhold [-servername <NVBU Server Name>] -jobid <Job ID> [-phaseid <Phase ID>] [-version] -servername Name of the NVBU Server that is to administer the job. If the job is to be administered by a remote NVBU Server, this option must be used to name that specific server. If the local instance of the NVBU Server is to be used to administer the job, this option can be left out of the syntax. The server name is case sensitive. -jobid Job ID of the job that is to be put on hold. Only one job can be put on hold with a single use of this command. -phaseid Phase ID for the particular phase of a job that is to be put on hold. This is an optional parameter. If you do not specify this parameter, all the scheduled phases for the job specified using the jobid parameter will be put on hold. -version Displays the build date of the NVBU distribution. Use this command to list all active jobs. The output is displayed in fixed column format. Syntax nvjoblist [-servername <NVBU Server Name>] [-delimiter <Delimiter>] [-title <Job Title>] [-noheader] [-runinfo] [-version] -servername Name of the NVBU Server that is to administer the job. If the job is to be administered by a remote NVBU Server, this option must be used to name that specific server. If the local instance of the NVBU Server is to be used to administer the job, this option can be left out of the syntax. The server name is case sensitive. -delimiter Any character that you want to use as a delimiter character. By default, a white space character is used as a delimiter. -title Job Title to list job(s) with a matching title. The Job Title must enclosed in quotes. For example, -title Full_Backup_1 -noheader Suppresses the header row in the output. -runinfo Displays run status and next run time in the output. -version Displays the build date of the NVBU distribution.

62 62 Chapter 3 Using NVBU Commands nvjobmodify Use this option to modify a given job as described by the -change option(s). Syntax nvjobmodify -jobid <Job ID> -jobname <Job Title> -type <Job Type> [-change <Change Description>] [-submit] [-parameters <Parameter File>] [-assign <Assignment Character>] [-delimit <Delimiter Character>] [-version] -jobid Job ID of the job that is to be modified. For example, -jobid 56 This option is not required if the -jobname option is used. -jobname Job Title enclosed in quotes. This command will fail if more than one job with the given title is available on the NVBU Server. In such cases, use the -jobid option. -type Type of NVBU job to be modified. For example, -type backup -type restore -change Use this option to specify the changes that are to be made to the given job. Any number of values can be specified with this option. You can omit this option if you want to submit a job without any changes. The <Change description> variable for the -change option is formatted as follows: <item>[:<field>]=<value> <item> can take one of the following values Title, Set, or <field> calls out a specific field in the item that is to be modified. <value> is the new setting for the selected field. Title To change the Job Title. Set To change the set. <value> specifies the new set name. <field> may take any of the following values: BS Backup Selection Set BO Backup Set S Schedule Set BT Backup Target Set AB Backup Advanced Set

63 Quest NetVault Backup 63 Command Line Interface Reference Guide RS Restore Selection Set AR Restore Advanced Set Note: If you specify a trigger name which is used by another job, the following warning appears when you try to save or submit the job: The Trigger Name is Already in Use. Redefine this Job if this was not Intended. This is for information only and does not stop you from saving or submitting the job. Modifies the backup options for a job. To use it, you require the Tag ID of the actual backup option that is to be set. This can either be the backup option name as recognized by the CLI or a numeric value assigned to the option by NVBU. Both of these values are grouped under the [Plugin ] section in the nvsetmodify.cfg configuration file. For details, refer to Using the nvsetmodify.cfg File on page 17. Specify either of these values in place of the <field> variable. <Value> can be set to True to enable or False to disable the option. Note: This option must be followed by a colon ( : ) and no spaces before or after the Tag ID. For example, :<Tag ID>=True/False. -submit Schedule or re-schedules the given job. This option may also be used on its own in order to schedule jobs that have been created but not scheduled. -parameter Directs nvjobmodify to read options and their values from a given parameter file so that you do not need to input them each time the command is run. You can create this file using any standard text editor. Enter one option (with its value) per line and omit - before the option. Use spaces or tabs to separate the option and values. To include comments, begin the line with a # character. Such lines will be ignored. Following is an example of a parameter file example.txt : # nvjobmodify example file jobname Backup File System type backup change Set:BS=selectionsetcli This file can be used with the -parameter option as follows:./nvjobmodify -parameter example.txt -assign Use this option to change the character used for assignment in change descriptions. It must be used if the old or new values contain the default assignment character =.

64 64 Chapter 3 Using NVBU Commands -delimit Use this option to change character used as a delimiter in change descriptions. It must be used if old or new values contain the default delimiter :. -version Displays the build date of the NVBU distribution. Examples Modify a job entitled Backup File System to perform Incremental Backup instead of Full Backup using the Plug-in for FileSystem. nvjobmodify -jobname Backup File System change :ntfsopt_typeincr=true nvjobresume Use this command to resume a job previously put on hold. The -jobid option can only be used once per use of this command. It is not possible to resume multiple jobs with a single use this command. Syntax nvjobresume [-servername <NVBU Server Name>] -jobid <Job ID> [-phaseid <Phaseid>] [-version] -servername Name of the NVBU Server that is to administer the job. If the job is to be administered by a remote NVBU Server, this option must be used to name that specific server. If the local instance of the NVBU Server is to be used to administer the job, this option can be left out of the syntax. The server name is case sensitive. -jobid Job ID of the job to be resumed. Only one job can be resume -phaseid Phase ID of the particular phase of a job that you want to resume. This is an optional parameter. If you do not specify this parameter, NVBU will resume all the known phases that are on hold for the job specified using the jobid parameter. -version Displays the build date of the NVBU distribution nvjobstart Runs a saved job using the proper Job ID, phase number, and instance number. Syntax nvjobstart [-servername <NVBU Server Name>] -jobid <Job ID> -phase <Phase ID> -instance <Instance ID> [-wait] [-version]

65 Quest NetVault Backup 65 Command Line Interface Reference Guide -servername Name of the NVBU Server that is to administer the job. If the job is to be administered by a remote NVBU Server, this option must be used to name that specific server. If the local instance of the NVBU Server is to be used to administer the job, this option can be left out of the syntax. The server name is case-sensitive. -jobid Job ID of the job to be run. -phase Phase ID of the job phase to be run. The default value for this option is 1. If this option is not specified, phase 1 of the job is executed. -instance Instance ID of the job instance to be run. If this option is not specified or the specified instance does not exist, the last instance of the job is executed. -wait Add this option to tell NVBU to wait until this task has completed before moving forward. When the job execution completes, NVBU displays the status message. By default, nvjobstart returns the following messages depending on the job exit codes: Exit Code Output Message 0 Job completed successfully 1 Job failed with error: Job Failed This message is returned for the following job completion states: Job failed Job completed with warnings Job aborted Job stopped Job died If the nvjobstart Enhanced Job Completion Status option is enabled on the NVBU Configurator, then the command returns the following messages depending on the job exit codes: Exit Code Output Message 0 Job completed successfully 1 Job Failed 2 Job Completed with Warnings 3 Job Aborted 4 Job Stopped 5 Job Died -1 Job Failed with Undefined Error

66 66 Chapter 3 Using NVBU Commands nvpolicy For details on enabling this option, refer to the Quest NetVault Backup Configuration Guide. -version Displays the build date of the NVBU distribution. Use this command to perform the following tasks: List policy jobs Delete a policy Check whether a policy job exists or not Define Clients for a policy job Create a policy definition Syntax nvpolicy -list [<Policy Name>] -delete <Policy Name> -ack <Policy Name> -addclient <Policy Name> <client name> [ <Client Name>... ] -addgroup <Policy Name> <Group Name> [ <Group Name>...] -create <Policy Definition File> -state <Policy Name> -quiesce <Policy Name> -list Lists existing policies. To view the list of jobs defined for a policy, use this option with the policy name. For example, the following command will list all jobs defined for policy p1. nvpolicy -list p1 -delete Name of the policy that is to be deleted. -ack Use this option to acknowledge errors. -addclient Adds clients to the policy definition. For example, the following command will add two Clients, Client1 and Client2, to the policy p1. nvpolicy -addclient p1 Client1 Client2 -addgroup Adds Client Groups to the policy definition. For example, the following command will add two Client Groups, Group1 and Group2 to p to the policy p1. nvpolicy -addgroup p1 Group1 Group2 -create Creates a policy with the details specified in the given file. The format for the policy definition file is shown in the example given below: [Policy] Title=policy3 EvtWarn=Event-Warn-1

67 Quest NetVault Backup 67 Command Line Interface Reference Guide EvtFail=Event-Fail-1 Clients=client1,client2,client3,client4 [Job] Title=MyJob Selection=MySelection =MyOption Target=MyTarget Source=MySource Schedule=MySchedule Advanced=MyAdvanced Active=TRUE A policy can contain one or more job definitions. For multiple jobs, include a [Job] section for each job as shown in the example below: [Policy] Title=policy3 EvtWarn=Event-Warn-1 EvtFail=Event-Fail-1 Clients=client1,client2,client3,client4 [Job] Title=MyJob Selection=MySelection =MyOption Target=MyTarget Source=MySource Schedule=MySchedule Advanced=MyAdvanced Active=TRUE [Job] Title=MyJob-2 Selection=MySelection-2 =MyOption-2 Target=MyTarget-2

68 68 Chapter 3 Using NVBU Commands Schedule=MySchedule-2 Advanced=MyAdvanced-2 Active=TRUE Important: The Source parameter is only required when defining a job for the NetVault Backup Plug-ins for Consolidation or Data Copy nvrestore -state Displays the current state of a policy. For example, Dormant, Active, or Quiescing. -quiesce Places an active policy in a quiesced state. Use this command for the following tasks: List completed backup jobs. You can filter the list by date, NVBU Client, NVBU Plug-in, or Backup Selection Set used for the job. Create restore jobs. When creating the job, it is possible to relocate or rename specific nodes and select nodes for exclusion. Syntax nvrestore -list [-client <NVBU Client Name>] [-plugin <Plug-in Name> - select <Selection Set Name>] [-startdate <DD/MM/YY>] [-enddate <DD/MM/YY>] nvrestore -create <Saveset> -title <Job Title> -path <Path> [-relocate <Path>] [-rename <Path>] [-run [-wait]] nvrestore -create <Saveset> -definition <Restore Definition File> [-run [-wait]] -list Use this form of the command to list all completed backup jobs. It can be used as a standalone command to list all jobs administered by the NVBU Server or additional parameters can be used to limit the search results. -client <NVBU Client Name> Name of the NVBU Client to list only those jobs that targeted the specified client. -plugin <Plug-in Name> NVBU Plug-in Name to list only those jobs that used the specified plug-in. -select <Selection Set Name> Name of the Backup Selection Set to list only those backup jobs that used the specified set.

69 Quest NetVault Backup 69 Command Line Interface Reference Guide Note: The -plugin and the -select parameters are mutually exclusive and cannot be used together in the same Instance of a nvrestore -list command. -startdate <DD/MM/YY> Start Date to list only those backup jobs that occurred after the specified date. The valid format for the start date is DD/MM/YY. -enddate <DD/MM/YY> End Date to list to only those backup jobs that occurred before the specified date. The valid format for the end date is DD/MM/YY. -create <Saveset Name> -title <Job Title> -path <Path> Use this form of the command to create a restore job but not run it. <saveset> Saveset number for the backup saveset to be restored. In addition to the saveset number, you can preface the saveset number with the target Client Name and the plug-in used, each separated with a colon. For example, NVSERVER:filesystem:59 This is helpful in reducing the amount of time it takes the CLI utility to locate the saveset. -title <Job Title> Job Title for the restore job. -path <path> Specific path to the directory for the restore. The path named must exist within the same path that was originally backed up. For example, if the directory /usr/saved was backed up and sub-directory, / data is to be restored, then the path -path /usr/saved/data/ would recover the /data sub-directory. To restore a single file, provide the complete file path including the file name as path. Note: You cannot use the -path parameter to relocate data for a restore. This parameter requires you to provide a path that existed on the client at the time of backup. To relocate data during restore, you must use the -relocate parameter. -relocate <Path> Alternate restore path. The specified directory must exist when the restore job is actually run. -rename <Path> Alternate name for restored directory or file. This is useful when you do not want to overwrite existing files or directories. Note: You can use both -relocate and -rename in the same command. However, both parameters must use the same <path> variable, which is the target relocation directory. -run [-wait] Use the -run option to run the job. Without this option the restore job will be created and saved, but not run.

70 70 Chapter 3 Using NVBU Commands With -wait, the NVBU waits for task completion and return a result of job succeeded or job failed before releasing the prompt for additional commands. -create <Saveset> -definition <Restore Definition File> Use this form of the command to create a restore job from a restore definition file. <saveset> Saveset number for the backup saveset to be restored. In addition to the saveset number, you can preface the saveset number with the target Client Name and the plug-in used, each separated with a colon. For example, NVSERVER:filesystem:59 This is helpful in reducing the amount of time it takes the CLI utility to locate the saveset. -definition <Restore Definition file> Name of the file that includes a list of files/directories should be included and/or excluded from the restore. The <Restore Definition File> variable refers to the complete path and file name for the file to be used. The file must be created in the following format: [Restore] Title=Restore of Full Backup Job 1 Schedule=Saturday 11pm Advanced=Advanced Restore [Include] Path=/usr/saved/data/file1 Relocate=/usr/saved/data/ [Include] Path=/usr/new [Restore] Title=<Job Title> Schedule=<desired Schedule Set to be used> Advanced=<Advanced Set to be used> [Include] Path=Specific path to the directory for the restore. The path named must exist within the same path that was originally backed up.

71 Quest NetVault Backup 71 Command Line Interface Reference Guide For example, if the directory /usr/saved was backed up and subdirectory, /data is to be restored, then the path -path /usr/saved/data/ would recover the /data sub-directory. To restore a single file, provide the complete file path including the file name as path. Relocate=Alternate restore path. The specified directory must exist when the restore job is actually run. Rename=Alternate name for restored directory or file. This is useful when you do not want to overwrite existing files or directories. -run [-wait] Use the -run option to run the job. Without this option the restore job will be created and saved, but not run. With -wait, the NVBU waits for task completion and return a result of job succeeded or job failed before releasing the prompt for additional commands. Notes The following rules apply to Restore Definition File: The Schedule and Advanced entries must be included in the [Restore] stanza with a valid variable input even if specific Schedule and Restore Advanced Sets are not required. For details, refer to nvsetcreate on page 72. You can also use sets created in the NVBU Console. Only one inclusion can be specified per line with the [Inclusion] stanza. If multiple directories and/or files are to be included, they must specified in their own line. Correct [Include] C:\data C:\new C:\Program Files If using the Rename or Relocate parameters, they must exist with a single instance of the path= parameter below its own instance of the [Include] stanza heading. If multiple Instances of the path= parameter existed with a relocate/rename parameter, the CLI would not know which Instance of the path= parameter the rename/relocate command refers to. Correct [Include] path=c:\data\files

72 72 Chapter 3 Using NVBU Commands relocate=c:\data\new [Include] path=c:\program Files relocate=c:\old Program Files Incorrect [Include] path=c:\data\files path=c:\program Files relocate=c:\data\new relocate=c:\old Program Files Both the relocate and rename parameters can be specified below the same instance of the [Include] stanza to perform both operations for a single file or directory. However, both entries must incorporate the same variable information, which is the path to relocation directory. Correct [Include] path=c:\data\new (the data to be restored, and its original path) relocate=c:\saved\data (the path data is to be relocated to) rename=c:\saved\data\old (The relocation path directory, from above, along with the new directory name) The relocation directory must exist on the target system before the restore job is actually run. You can create and save the job without using the -run parameter and establish a new directory for relocation in the command, but when the job is actually run, the target relocation directory must exist) nvsetcreate Use this command to create a set. Syntax nvsetcreate [-setname <Set Name>] -type <set type> <Set Type Specific > -assign <Assignment Character> -delimit <Delimiter Character> -parameters <Parameter File Name>] [-version]

73 Quest NetVault Backup 73 Command Line Interface Reference Guide -setname Name of the set. -type Type of set. It can be: BS Backup Selection Set BO Backup Set S Schedule Set BT Backup Target Set AB Backup Advanced Set RS Restore Selection Set AR Restore Advanced Set <set-specific options> These are dependant on the type of set to be created. For details, refer to the following sections: Backup Selection Sets on page 74 Restore Selection Sets on page 75 Backup Sets on page 77 Schedule Sets on page 78 Backup Target Sets on page 79 Backup Advanced Sets on page 80 Restore Advanced Sets on page 82 Important: To obtain a list of available options for any set type, use the following command: nvsetcreate type <set type> -- help For example, nvsetcreate type BS -- help nvsetcreate type BO -- help -assign Use this option to change the character used for assignment in change descriptions. It must be used if any value (for example, a file name or directory path) contains the default assignment character =. -delimit Use this option to change character used as a delimiter in change descriptions. It must be used if any value (for example, a file name or directory path) contains the default delimiter :. -parameters Reads options and their arguments from a given parameter file so that you do not need to input them each time the command is run. You can create this file using any standard text editor. Enter one option (with its value) per line and omit - before the option. Use spaces or tabs to separate the option and values. To include comments, begin the line with a # character. Such lines will be ignored.

74 74 Chapter 3 Using NVBU Commands Following is an example of a parameter file example.txt : # nvsetcreate example file setname workbackup type BS client WinClient This file can be used with the -parameters option as follows:./nvsetcreate -parameters example.txt Note: For the Quest NetVault Backup Plug-in for NDMP (Plug-in for NDMP), the nvsetcreate command can only be used to create Backup Selection Set. The nvsetcreate will overwrite an existing set with the same name. It is recommended that you use the nvsetcreate command instead of nvsetmodify to modify a set for the Plug-in for NDMP a Backup Selection Sets -client <client> NVBU Machine Name of the client to be backed up. -plugin <plug-in name> Name of the NVBU Plug-in to be used for the backups. Plug-in names should appear exactly as they do in the NVBU Console. For example, -plugin File System -include <path> The path to be backed up. It should consist of the names of each node below the selected item in the tree as they appear in the NVBU Backup window of the NVBU Console. The nodes should be separated by / or \ depending on the client operating system. -exclude <path> Path to be excluded from the backup. It is specified in the same way as the included paths. This option can only be used to exclude items that appear in the tree below items that have already been named for inclusion. -info <path=value[:value[: ]]> Some plug-ins add extra information to nodes in the selection tree. This may be information that would otherwise be unavailable to the plug-in at backup time. This information can be specified with the -info option, but only for nodes where default values are always added by the plug-in. The type and order of the values specified is plug-in dependant. For more information, contact Quest Customer Support.

75 Quest NetVault Backup 75 Command Line Interface Reference Guide Notes When creating a Selection Set for backing up the root directory using NetVault Backup Plug-in for FileSystem, do not include the last \. Specify only the drive letter. Thus, the path will be C: instead of C:\. Example nvsetcreate -setname testset -type BS -client WINCLIENT1 -plugin File System -include Fixed Drives\C: When creating Backup Selection Sets for using with the NetVault Backup Plug-ins for Consolidation, Data Copy or Raw Devices, specify the full file path as displayed in NVBU Console with the -include option. Use / to separate the tree items. Regardless of the O/S in use, the forward slash ( / ) can be used as a separator. Delimit the path with double quotes Include the complete Saveset Title. For example, /JobTile(Savesetnum) hh:mm DD MM YYYY Example nvsetcreate -setname DataCopy1 -type BS -client ukwk1115 -plugin Data Copy -include Backups/ukwk1115/File System/spanningTapes (Saveset 106) 11:00 31 jul 2011 For Sun NAS 7000 Unified Storage Systems, only volume names can be specified with the -include option. Directory names are not supported with this option when creating Backup Selection Sets for these filers using the Plug-in for NDMP. This is because the Sun NAS 7000 Unified Storage Systems do not offer a true browse capability. They can only list the available volumes. So, the presence of any directory or file in a volume cannot be verified or determined. Examples In the following example, a Windows-based NVBU Client WinClient is the target of a backup job for the Plug-in for FileSystem. The job backs up all files in the C:\work directory, while excluding all files with.txt extension. nvsetcreate -setname workbackup -type BS -client WinClient -plugin File System -include Fixed Drives\C:\work -exclude C:\work\*.txt b Restore Selection Sets -client <client> NVBU Machine Name of the client.

76 76 Chapter 3 Using NVBU Commands -plugin <plug-in name> Name of the plug-in used to perform the backup. The plug-in names should appear exactly as they do in the NVBU Console. For example -plugin File System. -saveset <ID> Saveset ID of the Saveset containing the data to be restored. If this option is not used, then the -title option must be used. -title <title> Job Title of the backup job to be restored. If more than one saveset exists for the job then the newest one will be used. It this option is not used, then the -saveset option must be used. -include <path> The path to be restored. It should consist of the names of each node below the selected item in the tree as they appear in the NVBU Restore window of the NVBU Console. Each node should be separated by / or \ depending on the client operating system. Important: The -include option must be specified before the -rename option when both options are used for creating a Restore Selection Set. -exclude <path> Path to be excluded from the backup. It is specified in the same way as included paths. This option can only be used to exclude items that appear in the file system tree below items that have already been named for inclusion. -rename <path> =<new name or path> Alternate path for rename or relocate. You can combine both options or use each independently. If the item is only to be renamed, then only the new name should be given. For relocating items, the full path should be specified. Important: When relocating data to a different directory, the new target directory must exist on the target machine before you run the command. NVBU will not create it automatically. Example for Rename Only -rename /usr/joe/diary=diary.old Example for Relocation Only -rename /usr/joe/diary=/home/joe/diary Example for Rename and Relocate -rename /usr/joe/diary=/home/joe/diary.old Important: If a rename value or relocation path includes an = character, then change the assignment character using the -assign option. -restoreoption <option=value> Adds Restore if the target plug-in provides any. To use this option, you require the Tag ID of the window item that is to be set. This can either be the restore option name as recognized by the CLI or a numeric value assigned to the option by NVBU. Both of these

77 Quest NetVault Backup 77 Command Line Interface Reference Guide values are grouped under the [Plugin ] section in the nvsetmodify.cfg configuration file. For details, refer to Using the nvsetmodify.cfg File on page 17. Specify either of these values in place of the <field> variable. <Value> can be set to True to enable or False to disable the option. Note: This option must be followed by a space ( ) before the Tag ID for example, -restoreoption <Tag ID>. -restoretarget <client> NVBU Machine Name of the alternate client to which the items are to be restore to. By default items are restored to the same client that they were backed up from. The selected plug-in must have been installed on the alternate client. -info <path=value[:value[: ]]> Alternate values for items in a node s plug-in information. The type and order of the values specified is plug-in dependent. For details, contact Quest Customer Support. Examples The following example creates a Restore Selection Set restore320 that restores data from saveset ID 320 created with the Plug-in for FileSystem. The data was backed up from client isp9039. The set includes the entire volume for restore except directory /a1 and relocates the file document from /usr/var to usr/tmp. Lastly, it enables the restore option Overwrite Newer Files. nvsetcreate -setname restorebig -type RS -client isp9039 -plugin File System -saveset 320 -include / -exclude /a1 -rename /usr/var/document=/usr/tmp/document -restoreoption NVFSOPT_OVERNEW=TRUE c Backup Sets -client<client> NVBU Machine Name of an NVBU Client -plugin<plug-in name> Name of the NVBU Plug-in -backupoption <option=value>: <option=value> Adds Backup if the target plug-in provides any. To use this option, you require the Tag ID of the window item that is to be set. This can either be the backup option name as recognized by the CLI, or a numeric value assigned to the option by NVBU. Both of these values are grouped under the [Plugin ] section in the nvsetmodify.cfg configuration file. For details, refer to Using the nvsetmodify.cfg File on page 17. Specify either of these values in place of the <field> variable. <Value> can be set to True to enable or False to disable the option.

78 78 Chapter 3 Using NVBU Commands -backupoptionspath <path> Only applicable if a plug-in can specify different backup option screens depending on a selection path within that plug-in, and can be used to specify a particular backup options screen via a selection path. Examples nvsetcreate -setname backupoptionset -type BO -client WinClient -plugin "File System" -backupoption NTFSOPT_TYPEINCR=true d Schedule Sets -schedule <value> Type of the Schedule to be created. The supported values are immediate, once, repeating, and triggered. -time <hh:mm> Time of day to run the schedule. -date <DD-MMM-YYYY> Date the schedule will start from. For example, -date 01-NOV-2012) -weekdays <ddd[,ddd[, ]]> Weekday(s) the scheduled job is to be run. For example, -weekdays Mon, Tue, Wed, Thu, Fri. -weeks <n[,n[, ]]> Weeks in the month the scheduled job is to be run. Use L to specify the last week in the month. For example, weeks 1, 3 L -monthdays <n[,n[, ]]> Dates in the month the scheduled job is to be run. Use L to specify the last day of the month. For example, monthdays 7, 14, 21, L -every <n-period> Time interval for scheduled jobs that are to be run after a fixed period. The interval is specified as number of hours, days, weeks or months. A hyphen (-) is used to separate the numeric value and period. For example, -every 12-month -trigger <trigger> Name of the trigger to run a triggered job. -priority <number> Used to prioritize between two or more jobs scheduled to run at the same time. The priority level ranges from 1 (highest priority) to 100 (lowest priority). A priority level of zero sets a job to run as a background task. The default value for this option is 30. -retry <boolean> Enable or disable job retries after an initial attempt to run the job fails. Set it to TRUE to enable job retries. The default value for this option is FALSE.

79 Quest NetVault Backup 79 Command Line Interface Reference Guide -retries <number> Number of retries after first failure. It can be set to any value between 1 and 10. This option is only valid if -retry is set to TRUE. The default value for this option is 1. -retrydelay <hh:mm> Time delay between retries. It can be set to any value between 00:00 and 23:59. This option is only valid if -retry is set to TRUE. By default, NVBU tries to run the job again immediately if -retry is set to TRUE and no value is set for this option. Examples Create a Schedule Set EveryLastTues that will launch a job at 11:30 pm on the last Tuesday of every month: nvsetcreate -type S -setname EveryLastTues -schedule repeating -time 23:30 -weekdays tue -weeks L e Backup Target Sets -device <name> Name of a device or library to be used. This option can be used more than once in the command. If no devices are specified, then the target set will default to Any Device. -librarydrivenumber <n> Drive within a library to be used. This option must be preceded by a -device option providing the name of the library. If more than one drive may be used, then each should be specified separately with -librarydrivenumber options. -anymedia Uses any media, including those in groups for the backup. If this option is not specified, any media except those which belong to a group will be used. -mid <mid> Uses the media with the specified media ID. -group <group> Uses any media in the specified media group. -autolabel <boolean> Labels blank media. The values that can be used are TRUE or FALSE. The default value is TRUE. -reusemedia <value> Reuse media. The values that can be used with this option are: never Never reuse media any Reuse any media or group Reuse any media item that belongs to a group -minimumspace <n> Minimum space required on a piece of media for that media to be used for backup. It is specified in MB.

80 80 Chapter 3 Using NVBU Commands -protectmedia <boolean> Set to TRUE to prevent the media used from being used for further backups. The default value for this option is FALSE. -firstonmedia <boolean> Controls whether backup is first on media. The default value for this option is FALSE. -localdrivesonly <boolean> Set to TRUE to use only locally attached devices. The default value is FALSE. -mediarequesttimeout <bool> Set to TRUE to configure a timeout interval for media availability. The default value is FALSE. -mediarequesttimeoutvalue <hh:mm> Timeout interval for availability of suitable backup media. It can be set to any value between 00:05 and 23:59. This option is only valid if'-mediarequesttimeout is set to TRUE. If you set the timeout interval to a value lesser than 5 minutes (that is, any value lesser than 00:05 minutes), then the nvsetcreate command will return an error message Invalid media request timeout value specified (Minimum 00:05, Maximum 23:55). If the specified value is not a multiple of 5, then the value will be rounded up to the nearest 5 minutes. For example, if you specify 7 minutes, then the timeout value will be set to 10 minutes; if you specify 22 minutes, then the timeout value will be set to 25 minutes. Examples Create a Backup Target Set that will use either drive 3 or drive 4 of a library MyDltLib. This set will write to any media, regardless of group, and will automatically label or reuse media as required: nvsetcreate -type BT -setname Drive4 -device MyDltLib -librarydrivenumber 3 -librarydrivenumber 4 -anymedia -autolabel TRUE -reusemedia any f Backup Advanced Sets -backuptype <value> Backup type. It can be backup (for backups) or archive (for archives). -discardtime <n-period> Period of time after which the backup is discarded. The period can be specified in number of days, weeks or years. For example, -discardtime 26-weeks -backuplife <n> Number of full backups that will be retained for this job. Any older backups will be automatically discarded. -netcompress <bool> Set to TRUE to use network compression for the data that is transferred between NVBU Client and Server. By default the data is not compressed.

81 Quest NetVault Backup 81 Command Line Interface Reference Guide -verify <boolean> Set to TRUE if backup verification has to be done. The default value is FALSE. -migrate <boolean> Set to TRUE if the original backup is to be discarded once the duplicate copy is created. The default value is FALSE. -duplicatelife <n-period> Lifetime of the duplicate copy of the backup. If none is given, then the lifetime of the original (specified with the -discardtime option) is used. -prescript <value> Name of a script to be run before the backup is performed. Scripts must reside in the...\scripts directory (where... refers to the NVBU installation directory). -prescriptarg <value> Values to be passed as user arguments to the pre script. -postscript <value> Name of the script to be run after the backup is performed. -postscriptarg <value> Values to be passed as user arguments to the post script. -encryption <boolean> Set to TRUE to enable encryption. The default value is FALSE. -deduplicate <boolean> Set to TRUE to enable deduplication. The default value is FALSE. -secondarycopy <boolean> Set to TRUE to create a secondary copy. The default value is FALSE. -duplicate <boolean> Set to TRUE to use the Duplicate Method for the secondary copy. The default value is FALSE. -datacopy <boolean> Set to TRUE to use the Data Copy Method for the secondary copy. The default value is FALSE. -encryptsecondarycopy <boolean> Set to TRUE to enable encryption for the secondary copy. The default value is FALSE. -duplicatescheduleset <value> Name of the Schedule Set for the secondary copy. -duplicatetargetset <value> Name of the Target Set for the secondary copy. -duplicatesource <value> Name of the Source Set for the secondary copy. -duplicateclient <value> Set to Server, Original, or the alternate Client Name to run the secondary copy job. -offlineindexafter <interval> Specify the interval in days, weeks, or years, after which the online index will be deleted. For example, 2-days, 24-weeks, 2-years.

82 82 Chapter 3 Using NVBU Commands -allowstreamstosharemedia <value> Set to TRUE to enable streams to share media. The default value is FALSE. This option is only valid if the -secondarycopy option is set to TRUE. Examples Create an Advanced set AdvOptBU with a backup life of 5 full backups. Enable network compression and backup verification, and run a postscript entitled jobdone. nvsetcreate -type AB -setname AdvOptBU -backuplife 5 -netcompress TRUE -verify TRUE -postscript jobdone g Restore Advanced Sets -netcompress <bool> Set to TRUE to use network compression for the data that is transferred between NVBU Client and Server. By default the data is not compressed. -prescript <value> Name of a script to be run before the restore is performed. Scripts must reside in the...\scripts directory (where... refers to the NVBU installation directory). -prescriptarg <value> Values to be passed as user arguments to the pre script. -postscript <value> Name of the script to be run after the restore is performed. -postscriptarg <value> Values to be passed as user arguments to the post script nvsetdelete Deletes a set. Syntax nvsetdelete -setname <Set Name> [-type <Set Type>] [-version] -setname Name of the set to be deleted. -type Type of set to be deleted. It can be: BS Backup Selection Set BO Backup Set S Schedule Set BT Backup Target Set

83 Quest NetVault Backup 83 Command Line Interface Reference Guide AB Backup Advanced Set RS Restore Selection Set AR Restore Advanced Set -version Displays the build date of the NVBU distribution nvsetexport Exports a set to an output file. Syntax nvsetexport [-setname <Set Name>] -type <Set Type> -file <Output File> [-version] -setname Name of the set to be exported. More than one set can be exported by repeating this option with different set names in the command. If this option is not used then all sets of the specified type are written to the output file. -type Type of set to be exported. It can be: BS Backup Selection Set BO Backup Set S Schedule Set BT Backup Target Set AB Backup Advanced Set RS Restore Selection Set R Restore Advanced Set -file Name of the output file. -version Displays the build date of the NVBU distribution. Examples Export all Schedule Sets to the file schedules.nss. nvsetexport type S file schedules.nss Export the Backup Selection Sets Blackbird and Robin to the file bandr.nss. nvsetexport type BS setname Blackbird setname Robin file bandr.nss

84 84 Chapter 3 Using NVBU Commands nvsetimport Import the specified sets from the input file to the NVBU Server. Syntax nvsetimport -file <Input File Name> [-setname <Set Name>[=<new name>]] [-assign <Assignment Character>] [-version] -file Name of the input file. -setname>[=<newname>] Sets to be imported from the file. One or more -setname options can be specified to select specific sets from the file. Each can be renamed if required. If no setname option is present, then all sets in the input file are imported, each retaining their original name. Note that if a set already exists with the given name, then it will not be overwritten. -assign Use this option to change the character used for assignment. It must be used if any value contains the default assignment character =. -version Displays the build date of the NVBU distribution. Examples Import all sets from the file schedules.nss. nvsetimport -file schedules.nss Import the set Robin from the file bandr.nss, renaming the imported set to Ptarmigan. nvsetimport -file bandr.nss -setname Robin=Ptarmigan Import the set Blackbird from file bandr.nss, renaming the imported set to b=k. nvsetimport -file bandr.nss -setname Blackbird@b=k nvsetmodify Modifies a set. Syntax nvsetmodify -setname <set name> -type <set type> -change <change description> [-parameters <parameter file>] [-assign <assignment character>] [-delimit <delimiter character>] [-version]

85 Quest NetVault Backup 85 Command Line Interface Reference Guide -setname Name of the set to be modified. -type Type of set to be modified. It can be: BS Backup Selection Set BO Backup Set RS Restore Selection Set The nvsetmodify command does not support the following types of sets: S Schedule Set BT Backup Target Set AB Backup Advanced Set AR Restore Advanced Set To modify these sets, you can use the following methods: Use the nvsetcreate command to create a new set with the same name. This will overwrite the existing set. Before using this command, make sure that you know the current settings in the specified set in order to create a new set with the same options except the ones that you want to change. Use the NVBU Console to modify the set. -change Changes to be made to the set. This option can be used more than once. The <change description> variable is formatted as follows: <item>[:<field>][:<old value>]=<new value> <item> can be set to one of the following values tree, options, and target. <field> specifies the field in the item that is to be modified. <old value> specifies the old setting for the selected item. <new value> specifies the new setting for the selected item. Note: If no <new value> variable is specified, anything that is currently selected or omitted in the <old value> will be considered de-selected by NVBU when this command is executed. tree Modifies items in the selection tree. The tree item applies only to Backup and Restore Selection Sets. For the tree item, the <field> variable can be set to the following values path, rename, info, and <node name or ID> for inclusion.

86 86 Chapter 3 Using NVBU Commands path Modifies the NVBU Client, NVBU Plug-in, or a single node in the selection path. NVBU Client To modify the NVBU Client, set the variables as follows: <old value> = Name of the current NVBU Client <new value> = Name of the new NVBU Client. Make sure that the new client has been added to the NVBU Server. NVBU Plug-in To modify the plug-in used, set the variables as follows: <old value> = Name of the current NVBU Plug-in <new value> = Name of the new NVBU Plug-in. Make sure that the new plug-in exists on the NVBU Server or Client for which the set is defined. Selection Path To modify any node in the selection path, set the variables as follows: <old value> = Full path to the node, from the plug-in root node to the node that you want to change. Depending on the client OS, use the backslash (\) character (Windows) slash (/) character (Linux/UNIX) as the path separator. <new value> = Name of the new node For example, if a Backup Selection Set for the Plug-in for FileSystem includes the following selection path on Windows: Fixed Drives\C:\work\t1\dump\a then, to change the directory t1 to t2 in this path, the variables would be set as follows: <old value> = Fixed Drives\C:\work\t1 <new value> = t2 On Linux Clients, the Plug-in for FileSystem does not include any predefined level-3 nodes ( Fixed Drives, Removable Drives, and others). Therefore, a similar selection on Linux/UNIX Client would include the following nodes: /work /t1/dump/a To change the directory t1 to t2 in this path, the variables would be set as follows: <old value> =/work/t1 <new value> =t2

87 Quest NetVault Backup 87 Command Line Interface Reference Guide rename Adds or modifies a rename/relocation command to a Restore Selection Set. To add a new rename/relocation command, set the variables as follows: <old value> = Current name or path of the rename/relocation target <new value> = New name/path for the rename/relocation target To modify an existing rename/relocation command, set the variables as follows: <old value> = Current rename/relocation syntax included in the Restore Selection Set <new value> = New rename/relocation syntax for the set Note: For complete details on the proper syntax used for the Rename command, refer to the description of this option offered on page 76. info Modifies the plug-in information object attached to a node in the selection tree. To use this option, set the variables as follows: <old value> Full path to the item, from the plug-in root node to the applicable item. <new value> New values for the plug-in information object, separated by colons ( : ). To leave any field unchanged, specify a double colon ( :: ) as the new value. <Node Name> or <ID> Includes an item in the backup or restore job. This can either be the node name as recognized by the CLI or a numeric ID assigned to the node by NVBU. Both of these values are grouped under the [Tree Nodes] section in the nvsetmodify.cfg configuration file. For details, refer to Using the nvsetmodify.cfg File on page 17. To use this option, set the variables as follows: <old value> = Node Name or Node ID of the current node. If the selection tree for the target NVBU Client contains multiple nodes of the given type, specify the Node Name instead of the Node ID. <new value> = Node name or ID of the new root node. Adds or modifies the restore options if the plug-in provides any. To use this option, you require the Tag ID of the window item that is to be set. This can either be the restore option name as recognized by the CLI or a numeric value assigned to the option by NVBU. Both of these values are grouped under the [Plugin ] section in the nvsetmodify.cfg configuration file. For details, refer to Using the nvsetmodify.cfg File on page 17. Specify either of these values in place

88 88 Chapter 3 Using NVBU Commands of the <field> variable. <Value> can be set to True to enable or False to disable the option. Important: This option must be followed by a colon ( : ) without any spaces before the Tag ID (for example, :<Tag ID>=True/False ). Target Changes items in the target tree (Restore Selection Sets only). The <field> variable is used to specify the type to be changed. The only permitted value is a valid NVBU Client name. The <new value> specifies the new target Client. -parameters Reads options and their arguments from a given parameter file so that you do not need to input them each time the command is run. You can create this file using any standard text editor. Enter one option (with its value) per line and omit - before the option. Use spaces or tabs to separate the option and values. To include comments, begin the line with a # character. Such lines will be ignored. Following is an example of a parameter file example.txt : # nvsetmodify example file setname BackSet1 type BS This file can be used with the -parameters option as follows:./nvjobmodify -parameters example.txt -assign Use this option to change the character used for assignment. It must be used if values contain the default assignment character =. -delimit Use this option to change the character used as the delimiter. It must be used if values contain the default delimiter :. -version Displays the build date of the NVBU distribution. Examples Modify the Backup Selection Set BS-Set1 to change the NVBU Client from TestClient1 to TestClient2. nvsetmodify -setname BS-Set1 -type BS -change Tree:path:TestClient1=TestClient2 Modify the Backup Selection Set BS-Set1 to change the NVBU Plug-in from File System to Data Copy. nvsetmodify -setname BS-Set1 -type BS -change "Tree:path:File System=Data Copy" Modify the Backup Selection Set BS-Set1 to change the directory t1 to t2 in the following selection path:

89 Quest NetVault Backup 89 Command Line Interface Reference Guide Fixed Drives\C:\work\t1\dump\a nvsetmodify -setname BS-Set1 -type BS -change Drives\C:\work\t1=t2" Note: In this example, the -delimit option is used to set the as the delimiter because the path includes : which is the default delimiter. Modify the Backup Selection Set BS-Set1 to change the directory t1 to t2 in the following selection path: /work/t1/dump/a nvsetmodify -setname BS-Set1 -type BS -change "Tree:path:/work/t1=t2" Modify the Backup Selection Set BS-Set1 to change the drive node from C:\ to D:\ in the following selection path: Fixed Drives\C:\work\t1\dump\a nvsetmodify -setname BackupSetName -type BS -change "Tree@path@Fixed Drives\C:\=D:\\" Note: In this example, an additional backslash character is added to the new value D:\ to escape the first backslash character. If you do not include it, then the sequence D:\ would be interpreted as D: ; the first backslash would be used to escape the quotation mark ( ). Modify the Backup Selection Set BS-Set1 to change the Network Share path from \\Server1\a to \\Server2\b nvsetmodify -setname BackupSetName -type BS -change "Tree@path@Network Shares\\\Server1\a\=\\Server2\b\\" Modify the Backup Selection Set BS-Set1 to change the Fixed Drives node to Removable Drives. nvsetmodify -setname BackupSetName -type BS -change "Tree:path:Fixed Drives=Removable Drives" Note: The Plug-in for File System (Windows only) and a few other plug-ins (the Plug-in for Consolidation, Plug-in for Data Copy, Plug-in for Databases, and Plugin for Raw Devices) include pre-defined level-3 nodes. You can obtain the exact names of these nodes from the NVBU Console. To prevent any user errors, the nvsetmodify command checks for the correctness of new value specified for level-3 nodes. An error message will be displayed if you specify an incorrect value for these nodes. The utility does not perform any checks for the correctness or existence of nodes below level-3.

90 90 Chapter 3 Using NVBU Commands nvtrigger Modify the Restore Selection Set RestoreSet1 (created for the Plug-in for FileSystem) to change the target client from WinClient1 to WinClient2. Additionally, relocate the directory C:\Mail to C:\MyMail and set the Restore Option Overwrite Newer Files. nvsetmodify -setname RestoreSet1 -type RS -change target:client:winclient1=winclient2 -change options:nvfs_opt_overnew=true Triggers a job that has already been defined in the NVBU Console and saved as a triggered job using the Triggered option of the Schedule tab. For details, refer to the Quest NetVault Backup Administrator s Guide. This command is located in the...\bin directory. Syntax nvtrigger [-server <server name>] [-wait] -verbose -killonexit <trigger name> -server Name of the NVBU Server that will administer the job. If the job is to be administered by a remote NVBU Server, this option must be used to name that specific server. If the local instance of the server is to be used to administer the job, this option can be left out of the syntax. The server name is case sensitive. -wait Add this option to tell NVBU to wait until this task has completed before moving forward. -verbose Displays additional information when the job is initiated and finishes. The details displayed when the job is initiated include Job ID, Instance ID, Job Title, and Start Time. When the job completes, the finish time is displayed. -killonexit Use this option with -wait to abort a job by terminating the trigger execution. <trigger name> Name of the trigger to be used. This must be the last parameter when the tool is invoked as shown in the example below: nvtrigger -server <server name> -wait -verbose -killonexit <triggername>)

91 Quest NetVault Backup 91 Command Line Interface Reference Guide Notes The nvtrigger command returns a numerical value when the job it is associated with completes execution. This number indicates the completion status of the job. The return values and the corresponding job status are listed below: 0 Backup Completed 1 Backup Failed 2 Backup Completed with Warnings 3 Backup Aborted Without the -wait option, the nvtrigger command can support multiple jobs. With this option, the nvtrigger command can only be used to trigger a single job. This limitation also applies to -wait -killonexit options. As a result, you cannot use this option for policy jobs that contains multiple job definitions. If the -wait option is included in a script, control is returned to the script after the triggered job completes its execution. If there is no -wait option, then control is returned immediately back to the script even if the triggered job is still executing.

92 92 Chapter 3 Using NVBU Commands Log-Specific Commands nvlogdump nvlogpurge nvreadlog nvlogdump Dumps NVBU Logs to a text file for external viewing. Syntax nvlogdump [-jobid <job id number>] [-filename <filename>] [-text] [-starttime <YYYYMMDDHHMMSS>] [-endtime <YYYYMMDDHHMMSS>] -jobid Job ID for the job for which the logs are to be dumped. -filename Name of the dump file. If you do not specify the complete path, the dump file is saved to...\log\dumps\<text> or...\log\dumps\<binary> folder, where... represents the installation directory for NVBU and <text> and <binary> represent the name of the final folder depending on the selected dump format. If you omit the -filename option, then NVBU creates a file named CLI_DUMP_<YYYYMMDD>_<HHMMSS> in the specified format. The extension.nlg is suffixed for binary log dumps, while no extension is suffixed for text dump files. -text Dumps logs in text format. If you omit this option, then logs are dumped in binary format. -starttime Time that is to serve as a starting point for the log dump. The format for specifying the date and time is YYYYMMDDHHMMSS. -endtime Time that is to serve as a end point for the log dump. The format for specifying the date and time is YYYYMMDDHHMMSS. Note: At least the jobid variable or a combination of the starttime and endtime variables must be specified to properly use this command. A combination of the jobid, starttime, and endtime variables can be specified to achieve the required log dump. For example, a specific jobid and a starttime/ endtime can be specified to dump logs for a particular job that occurred within the given period. Examples Dump logs for Job ID 50, starting from April 1, 2013, 20:33:04, to a binary file nvlogdmp.nlg.

93 Quest NetVault Backup 93 Command Line Interface Reference Guide nvlogpurge nvlogdump -filename c:\temp\nvlogdmp -starttime jobid 50 Purges log entries from the NVDB up to a specified point in time. Syntax nvlogpurge -purgetime <YYYYMMDDHHMMSS> -purgetime Time that is to serve as a stopping point for the purge. The format for specifying the date and time is YYYYMMDDHHMMSS nvreadlog Prints log information. Syntax nvreadlog [-h] [-b <days>] [-m] [-d <delimiter string>] [-o <messages>] -h Exits after printing historic logs. Note: Since this command includes -h option, the full command -help must be specified to view help for this command: nvreadlog -help -b Number of days prior from which a dump is to begin. -m Used in conjunction with the -b option, this option causes the log output to begin from midnight preceding the number of days specified with the -b option. For example, at 3 p.m., you specify -b 1, NVBU will print logs from 3 p.m. the day before. With -m, the logs will begin from midnight of the previous day. Also, if -m is given on its own or with -b 0, then logs are printed from midnight of the current day. Therefore, if you issue this command at 3 p.m., then NVBU will print 15 hours of logs. -d Specific character(s) with option, alerts the interface on how to separate displayed data. For example, -d followed by < > (two spaces) would separate each displayed item of data with two spaces. -o Displays operator messages only, where the <messages> variable requires that you to input the type of message. For example, -o <failed> would display only operator messages that included the word failed. You can include multiple items for this variable using comma as a separator.

94 94 Chapter 3 Using NVBU Commands Other Commands bonedate nvmeddbcheck nvsendmail getmachineid nvpassword nvsendopmsg installplugin nvpluginaccess nvsvtlgrow licenseinstall nvreport nvlicenseinfo nvscheddbcheck bonedate Provides the BakBone date and time in use on the current machine. It is obtained from whichever machine is currently configured as the BakBone Time Server. For details on BakBone Time, refer to the Quest NetVault Backup Configuration Guide getmachineid Provides NVBU Machine ID for the current NVBU Server or Client. The NVBU Machine ID is required to obtain permanent license key for NVBU installplugin Installs NVBU Plug-ins from the CLI. When using this command, you must provide the full file path for the.npk installation file.this command is located in the...\bin directory. Syntax installplugin <File path for the installation file> Examples installplugin C:\Downloads\<file name>.npk installplugin C:\NVBU Download\<file name>.npk licenseinstall Installs license key for NVBU or application plug-ins using the key file (the.npk file containing the key) or the key string. This command is located in the...\bin directory. Syntax licenseinstall <keyfile> <key string>

95 3.6.5 nvlicenseinfo Provides license information for the NVBU Server nvmeddbcheck Quest NetVault Backup 95 Command Line Interface Reference Guide Verifies structural, entity, and referential integrity for the Media Database and compacts the database. It checks for the following: Raw file structure Database table integrity Inter-table references and dependencies The nvmeddbcheck command can take one of the following arguments: List, Check, Compact or Force. Syntax nvmeddbcheck List Check Compact Force [-v <warning level>] List Prints a line of output for every backup record, new stream, old stream, session, segment, media, and backup index in the database. This is particularly useful in order to determine which records should be deleted. Check Performs database checks and displays the status. Compact Performs database checks, corrects faults identified during the check phase, and compacts the database. The compact action occurs only if the last successful backup was an NVDB backup. Force Performs database checks, corrects faults identified during the check phase, and compacts the database regardless of the type of the last successful backup. -v Minimum Warning Level for the error messages that are displayed during the command execution. The Warning Levels can be: all All messages back Background messages inf Information messages job Job messages warn Warnings error Errors severe Severe errors

96 96 Chapter 3 Using NVBU Commands Notes The NVDB check and compact actions can also be performed during an NVDB backup. For details on this feature, refer to the Quest NetVault Backup Built-in Plug-ins User s Guide. The NVDB check and compact actions generate several log messages during execution. For details on these log messages, refer to the Logs Generated by the NVDB Check and Compact Actions on page 139. The compact function only updates the database tables and not the backup saveset index files. This action removes empty records in the table files, thereby reducing the size of the database tables nvpassword Changes NVBU password for the NVBU Server or Client on which this command is run. There are no options to be used with this command. Type the command followed by the new NVBU password with a space separating the command and the new password. This command is located in the...\bin directory nvpluginaccess Enables CLI backups and the generation of CLI-based reports for the plug-ins that require the use of database-related utility (for example, onbar for Informix database users and rman for Oracle). The use of this command is covered in the relevant Plug-in User s Guide. Refer to these guides for details. Syntax nvpluginaccess [-remove -client <client names>] [-client <client name> (-account <account name> -password < account password>)] nvreport -client NVBU Machine Name of the NVBU Heterogeneous Client. -account Name of the NVBU user account to be used with this command. The specified user account must be granted all privileges in NVBU. -password Password associated with the user account. Allows you to use NVBU s reporting functionality from the CLI. For details on the use of this command, refer to NVBU Reporting with the CLI on page 99.

97 nvscheddbcheck Quest NetVault Backup 97 Command Line Interface Reference Guide Verifies structural, entity, and referential integrity for the Scheduler Database and compacts the database. It checks for the following: Raw file structure Database table integrity Inter-table references and dependencies The nvscheddbcheck command can take one of the following arguments: List, Check or Compact. Syntax nvscheddbcheck List Check Compact [-v <warning level>] List Prints a line of output for every policy, job, instance, instance data record, scheduled phase, and change record in the database. This is particularly useful in order to determine which records should be deleted. Check Performs database checks and displays the status. Compact Performs database checks, corrects faults identified during the check phase, and compacts the database. -v Minimum Warning Level for the error messages that are displayed during the command execution. The Warning Level can be: all All messages Notes back Background messages inf Information messages job Job messages warn Warnings error Errors severe Severe errors The NVDB check and compact actions can also be performed during an NVDB backup. For details on this feature, refer to the Quest NetVault Backup Built-in Plug-ins User s Guide. The NVDB check and compact actions generate several log messages during execution. For details on these log messages, refer to the Logs Generated by the NVDB Check and Compact Actions on page 139. The compact function only updates the database tables and not the backup saveset index files. This action removes empty records in the table files, thereby reducing the size of the database tables.

98 98 Chapter 3 Using NVBU Commands nvsendmail Sends an message. Syntax nvsendmail [-d <dest_address>] [-r <real_name] [-s <subject>] [-f <message_file>] [-a <attach_file>] [-m] [-n] -d address of the intended recipient. -r Actual name of the intended recipient. -s Subject line of the . -f message file to be sent. -a Use this option if you want to send a file as an attachment. Specify the full path and file name. -m Forces mime-format. -n Specifies notification mode in which the necessary parameters will be taken from the host environment nvsendopmsg Sends an operator message. Syntax nvsendopmsg [-n] [-test] -n Sends notification from environment variables. -test Sends test operator message.

99 Quest NetVault Backup 99 Command Line Interface Reference Guide Chapter 4: NVBU REPORTING WITH THE CLI nvreport An Overview CLI Help Using nvreport Report Classes Using the -class Option Canned Reports Canned Report Description Template Files Using a Template File Formatting Report Layout and Content Obtaining the Real Name of the Fields Format Option Sort Option Including/Excluding Data from Reports Title Option External Reports Creating External Report Files Step 1: Select the Template File Step 2: Apply the Outputdir Option Step 3: Set Format for the Output Report (Optional) nvreport An Overview The nvreport command allows you to take advantage of NVBU s extensive reporting tools from the command line and display them in the terminal session window. This chapter provides a detailed description of the nvreport command and its various options. Where applicable, it also provides a comparison between the CLI and the NVBU Console reporting functionality.

100 100 Chapter 4 NVBU Reporting with the CLI CLI Help To access help for nvreport, type: nvreport -help For additional help for each option, type the name of the option after the -help. For example, nvreport -help templatename Using nvreport The nvreport command allows you to use powerful NVBU Reporting engine from the command line. The command reports on a specific Class of NVBU operations and uses a named Template file to format the output. Syntax nvreport -server [servername] -class [classname] -templatename [template name] -or- -templatefile [complete path to template file] -server Name of the NVBU Server that will administer the report job. If the job is to be administered by a remote NVBU Server, this option must be used to name that specific server. If the local instance of the NVBU Server is to be used, this option can be omitted. The servername is case sensitive. -class [classname] Specific Class of NVBU functionality for which the report is to be generated. It is used run Canned Reports. For details, refer to Report Classes on page templatename [template nice name ]/-templatefile [complete path to template file] File that will determine the content, layout and format of the report. -templatename Use this option to specify a template file based on its nice name as displayed in the NVBU Console. -templatefile Use this option to provide the exact path file name for a template file that is to be used. For details, refer to Template Files on page Report Classes Each Report Class pertains to a specific functionality set in the software. 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. For more information on template files, refer to Template Files on page 107.

101 Quest NetVault Backup 101 Command Line Interface Reference Guide a Using the -class Option The example below shows how the -class option is used to name a specific NVBU reporting class. When you use a class in this manner, its default template file is accessed to run a Canned report. In this example, the Clients class is used. nvreport -class Clients Figure 4-1: An example of the output returned by Clients Class b c Canned Reports Each NVBU report class has a default report job that can be run in association with it. These default reports are referred to as Canned 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. For example, to run a report for the Client Groups class, use the following syntax: nvreport -class Client Groups Canned Report Description The following table provides a brief description of the canned report that will be run when its associated Class is specified with the -class option. Note the following: The names listed in the Class Name column must be used as the variable for the -class option to run its associated Canned Report. If a name contains a space in its title, enclose the full name in quotes ( ). Class Names are not case-sensitive.

102 102 Chapter 4 NVBU Reporting with the CLI Class Name Advanced Audits Backup Targets Client Groups Clients Defined Jobs Drive Events Output Alphabetical list of the Advanced Sets and their details. All operations attempted by a specific user account with their result (Yes=granted/ No=denied) and date and time each operation was attempted. Alphabetical list of Backup Target Sets and their details. A list of Client Groups. It includes: Client Group Name Description of the Client Group All? - If all current Clients are member of this group Members - If individual members belong to this group, they are displayed Current status of clients. It includes: Added Client Name Version of NVBU Currently Installed Access If access is currently available Yes or No Status Current status of the Client Up or Down List of all jobs that have been created on the NVBU Server. It includes: Job ID Number Job Title Client Name Client on which the job was performed Policy Name of the policy (if applicable) Plugin Plug-in used to run the job Type Job type (Backup, Restore, or Report) SchedSetName Name of the Schedule Set used SelSetName Name of the Selection Set used btargsetname Name of the Backup Target Set used AOptsSetName Name of the Advanced Set used Details of events related to drives controlled of the NVBU Server. It includes: Time Time the event occurred Date Date the event occurred Drive Name Name of the drive as recognized by NVBU Event Event type, like start write, stop write

103 Quest NetVault Backup 103 Command Line Interface Reference Guide Class Name Drive Performance Statistics Drives Entry/Exit Ports Job History Libraries Library Drives Output Performance statistics for all drives controlled by the NVBU Server. It includes: Time Time at which the drive was accessed Date Date on which the drive was accessed Drive Name Drive Name Job Id Job ID Instance Instance ID Rate(kb/sec) Average rate at which NVBU transferred data to media in the drive Details of the drives accessible to NVBU. It includes: DriveName Drive Name Product Product Name Vendor Vendor Name Status Current status of the drive Online or Offline DriveMachine Machine to which the drive or library is locally attached. DriveDataWritten Data written by this drive DriveDataRead Data read by this drive Details regarding the Entry/Exit Ports that exist in any libraries controlled of the NVBU Server. Information specific to any media contained in an E/E port will be displayed if any of them contain media when the command is issued. Summary of jobs performed during a given period. It includes: Start Date Start date for the job Start Time Start time for the job Job Id Job ID Instance Instance ID Phase Phase ID Job Title Job Title Type Job Type (Backup, Restore, or Report) Exit Status Exit status of the job ( Completed, Completed with errors or Failed ) Run Length Total amount of time the job took to reach its Exit Status List of libraries controlled by the NVBU Server. It includes: Library ID Library ID Library Name Library Name Library Status Current status Online or Offline Library Machine Library's Controlling NVBU Server List of drives controlled by the NVBU Server. Information specific to any media contained in a drive will also be displayed if any of them contain media when the command is issued.

104 104 Chapter 4 NVBU Reporting with the CLI Class Name Library Slots License Capabilities Media Media Capacities Media Job Contents Output List of slots that exist in libraries controlled by the NVBU Server. Information specific to any media contained in a slot will also be displayed if they contain media when the command is issued. Summary of available and used licenses for NVBU. List of media items in use by devices controlled by the NVBU Server. It includes: Group Group label Label Media label Space Left Amount of space available Space Used Amount of space used Format Media format (MTF=Windows or UTF8=Linux/ UNIX) Need Import Yes indicates that the media is marked as Foreign and must be scanned to read the ontape indices into the NVDB Need Recovery Yes implies that the contents on the tape (particularly, the last known backup on the tape) are considered suspect. The tape must be scanned for backups for which indexes are not recorded in the NVDB. In some cases, a backup job will automatically scan a tape that is in Need Recovery state in order to be able to use if of the current backup. Unusable Whether or not the media has been marked as unusable in NVBU Yes=Marked as Unusable/No=Not Marked) Media capacity details for media items available in the libraries and drives controlled by the NVBU Server. List of backup savesets stored on available media. It includes: Label Media label Group Group label Barcode Barcode for the media item Job Title Job Title Client Name NVBU Client Name Start Date Date on which the backup job was run Start Time Time at which the backup job began Xfer Size Total amount of data transferred to media for the job Expiry Date Date on which the backup saveset is scheduled to expire. Expiry Time Time at which the backup saveset is scheduled to expire.

105 Quest NetVault Backup 105 Command Line Interface Reference Guide Class Name Media Requests Media Segment Contents Media Transfer Requests NetVault Event Types NetVault Events NetVault Logs Notifications Output Media request details, including: Date The date on which the media request was issued. Time The time at which the media request was issued. Job Id The NVBU identification number of the job that made the media request. State The status of the request A summary of media segments. It includes: Label Media label Barcode Barcode of the media item Job Title Job Title Client Name NVBU Client Name Backup Date Date on which the segment of the backup job was run Backup Time Time at which the segment of the backup job was run Length File size length of this segment of the backup A summary of transfer requests made to any media in the devices controlled by the NVBU Server. It includes: Job Id Job ID Instance Instance ID Type Type of transfer requested (Read or Write) Request Id Request ID Transferred Amount of data transferred per request. Description of all NVBU events A summary of events raised during a given period. It includes: Date/Time of Event Event Name Event Class Description Event description Event Message Message issued as a result of this event A summary of logs in the NVDB. Based on the number of log entries that exist in the NVDB, it may take several minutes for this command to display the results. A list of events for which any Global Notification Method is set: Notify Class Event Class Notify Event Event Account Name - User account to which this Global Notification profile belongs (if applicable.) Notification Method Notification method

106 106 Chapter 4 NVBU Reporting with the CLI Class Name Operator Messages Policies Policy Clients Policy Jobs Privileges Report Templates Schedule Sets Output Displays all outstanding operator messages in the NVBU Status window. The report includes the message ID, the time and date they were sent, and whether or not they have been acknowledged (represented as Outstanding? Yes=Not acknowledged/no=acknowledged). If all the operator messages have been acknowledged or deleted, this report will return no information. A list of backup policies. It includes: Policy Name Jobs Total number of jobs created within the policy Clients (#) Total number of clients added to the policy. Status - Current status of the policy OK if all jobs in the policy have run successfully, Warnings if they completed with warnings and Errors if errors have occurred Clients (Names) List of clients added to the policy A list of NVBU Clients included in a policy. It includes: Policy Name Client Name Status Current status of the policy OK if all of the Clients in the policy are accessible and Errors if errors have occurred. A list of jobs set up in a policy. It includes: Policy Name Job Name Job Title Selection Set Name of the Backup Selection Set that was used in the creation of the job Active Whether the job is currently active Lists the privileges currently granted to each user. Displays all report template files that are saved in the...\reports\templates. It includes: Name File name of the template. Class Name The NVBU report class to which the template belongs Output Type It can be: Plain Text will generate a report viewable from a terminal session window. HTML Text will generate an HTML-based report suitable for viewing in a browser application. CSV Text template file will generate a comma separated report which can be imported to a spreadsheet application. Alphabetical list of Schedule Sets and their details.

107 Quest NetVault Backup 107 Command Line Interface Reference Guide Class Name Segments Selection Option Sets Selection Sets Users Output A list of segments of a backup job. It includes: Job Id Job ID Instance Instance ID Offset Starting point (in bytes) on the media where the segment of the job exists Length Overall size of the segment (in bytes) Label Media label Barcode Barcode of the media item Alphabetical list of Backup Sets and their details. Alphabetical list of Selection Sets and their details. Details of NVBU Users, including: Account Name User name Real Name Real name UID User Identification Number. The UIDs for the default users are Default = 0 and Administrator = 1 Workstation Logon Date Last date on which the user accessed NVBU Logon Time Last time at which the user accessed NVBU Template Files NVBU s Reporting utility uses a Template file to output the report data. A template is a series of individual reporting commands that have been laid out in the proper sequence, and then saved into a composite file. The template file can be specified using the following options: -templatename or -templatefile In essence, a template is actually used to generate a report, and a class is simply a category of template files a Using a Template File NVBU provides two methods to specify a template file to generate a report: Using the Template File s Actual File Name You can use the -templatefile option in conjunction with the nvreport command to name the actual template file to be used. With this option, you must provide the exact file path, including the file name of the template file: nvreport -templatefile C:\NVBU\reports\templates\logsclidefault

108 108 Chapter 4 NVBU Reporting with the CLI Note the following: The report templates are stored in the...\reports\templates directory (where... refers to the complete path to the installation of NVBU): If the file path contains any spaces, enclose the variable in quotes. For example, -templatefile C:\Program Files\Quest Software\ NetVault Backup\reports\templates\clientsclidefault ) Using the Template File s Nice Name Value Each template file has an alternate name value known as its Nice Name. This name is used for the template file in the NVBU Console (NVBU Reporting Job Editor window). Specify this Nice Name with the -templatename option in the syntax of the nvreport command: nvreport -templatename Client Machines - cli default template Note the following: If the Nice Name contains any spaces, enclose the variable in quotes ( ). To locate the Nice Name for a template file, open the file in a text editor and note the string in the %NICENAME line. Note: While it is possible to use either of the options mentioned above with any template file, it is recommended that you use the -class option when running a report using a template file that includes clidefault in its file name or cli default file / textual in its Nice Name. Template files named in this manner are the default Canned templates that are used by their class to run a canned report. Using the -class option method generally requires less syntax, and you will achieve the same result when the report is output. Template File Used to Generate Canned Report The following table lists the class name of the available canned reports and its associated template file that is used to run the report in both its actual file name and its Nice Name. You can use any of the following with appropriate options to get the same output: Class Name Use it with the -class option Nice Name Use it with the -templatename option File Name Use it with the -templatefile option. Provide the full path to the template file with this option.

109 Quest NetVault Backup 109 Command Line Interface Reference Guide For example, issuing any of the three commands below will result in the same report output: nvreport -class Clients nvreport -templatename Client Machines - cli default client nvreport -templatefile...\nvbu\reports\templates\clientsclidefault Canned Report Class Name Advanced Template File Used to Generate Canned Report NVBU Console Nice Name Advanced - cli default template File Name advancedoptionsclidefault Audits Audits - cli default template auditclidefault Backup Targets Backup Targets - cli default backuptargetsclidefault template Client Groups Client Groups - cli default template groupsclidefault Clients Client Machines - cli default clientsclidefault template 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 entryexitportsclidefault template Job History Executed Job History - cli default jobhistoryclidefault template Libraries Libraries - cli default template librariesclidefault Library Drives Library Drives - cli default librarydrivesclidefault template 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 mediacapacitiesclidefault template Media Job Contents Media Contents Query - Textual mediajobcontentsclidefault

110 110 Chapter 4 NVBU Reporting with the CLI Canned Report Class Name Media Requests Media Segment Contents Media Transfer Requests NetVault Event Types NetVault Events Media Requests - cli default template Media Segment Contents Query - Textual Media Transfer Requests - cli default template NVBU Event Types - cli default template Formatting Report Layout and Content mediarequestsclidefault mediasegmentcontentsclidef ault mediatransfersclidefault eventtypesclidefault 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 Schedule Sets Report Templates Installed on System Schedule Sets - cli default template reporttemplatesclidefault schedulesclidefault Segments Segments - cli default template segmentsclidefault Selection Option Sets Selection Sets Template File Used to Generate Canned Report NVBU Console Nice Name Selection Option Sets - cli default template Selection Sets - cli default template File Name seloptionsclidefault selectionsclidefault Users Users - cli default template usersclidefault nvreport provides you several options to format the layout and content of a report. The sections that follow outline the use of these options. Note: Unless otherwise noted, the descriptions 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 / - cli default template in their file name and are designed to be viewed from a terminal session window.

111 Quest NetVault Backup 111 Command Line Interface Reference Guide a Obtaining the Real Name of the Fields When a report is run and viewed from the CLI, data will be output in various columns and each of these columns is headed with a value referred to as a Field Name. However, the field name value may not be the same as its Real Name 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. For example, when run from the CLI, the Media Requests - cli default template file will display four columns with the headings Date, Time, Job Id and State. However, the real name setting in the template file is JOBID instead of Job ID and TRANSITION instead of State. To use a option the Job ID or State fields, you must use their real names Figure 4-2: Example displaying the field names for a report Figure 4-3: Example showing the use of -help fields command to find the real names To find the real names, you can use one of the following methods: From the Terminal Session Prompt To obtain a list of valid field names for a canned report class, type: nvreport -help fields [class name] This will list all of the fields available with the report. The resulting output will show four columns of information. The first column displays the field s real names. The second contains the field name for the column. The third column provides the type of data that the column will contain, and the last column gives a basic description of the data that is output.

112 112 Chapter 4 NVBU Reporting with the CLI Note that this command will display all fields that are available with the selected canned report. It includes even those that are not displayed when you run the report. You can apply these additional fields to the report. For details, refer to Format Option on page 112. To determine the default fields for a template file, use the following steps: a. Run the report and note each column s default Field Name. b. Run the nvreport -help fields [Class Name] command. c. Locate the appropriate Field Name in the list,and cross-reference its Real Name. Open the Template File in a Text Editor In this file, the %FORMAT line provides the Real Name for the fields. These template files are present in the...\reports\templates (where... refers to the NVBU installation directory)....\reports\templates Note: Only the Real Names for the fields displayed when a report is run are shown in the %FORMAT line of a template file. A sample template file is shown below. %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" b Format Option By default, a report will be displayed in a pre-defined layout when run in the terminal window. The -format option allows you to change various aspects of the report based on what is displayed. For example, limit the number of characters that can be displayed in a column, determine the columns that will be displayed for the report and others. Note the following: Use a Field s Real Name as Set in the Template File You must have the real name that applies to the field that is to be modified with the -format option.

113 Quest NetVault Backup 113 Command Line Interface Reference Guide Prefix the Fields with a Percentage ( % ) Symbol For the CLI to recognize each field title, it must be prefixed with a % symbol. If a percentage symbol exists in a field s real name for a selected template, use the escape sequence %% when specifying the name. Include All Required Columns If the -format option is used in any way, all fields required in the report must be named in the syntax using their real name. If any field is left out, it will not be displayed in the report. So, you can include additional columns or omit default columns using this method. An example is shown below: nvreport -class Media Requests -format %Date %JOBID %TRANSITION Figure 4-4: Example where -format option is used to display only three of the default four columns Limiting the Number of Characters Displayed in a Column The maximum number of characters to be displayed for a column can be set by appending two colons and a number to the field name. For example, %TRANSITION::3 will limit the display in the Status column to only the first three characters. nvreport -class Media Requests -format %Date %JOBID %TRANSITION::3 Figure 4-5: Example where ::3 is appended to the %TRANS- ITION variable Inserting a Line Break To include a line break between each entry in an output report, append %\n to the end of the list of field names named with the -format option. nvreport -class Media Requests -format %Date %Time %JOBID %TRANSITION %\n

114 114 Chapter 4 NVBU Reporting with the CLI Figure 4-6: Example where %/n is appended to insert a line break between each entry Adding Additional Information Columns ( Fields ) - Some template files offer several additional Field Names that can be added to a report s output in order to include additional data. This can be done with the -format option. The example below uses the drives canned report. It includes all the default fields and additionally displays the number of Write Errors for the drive. 1. Run the canned report to identify all existing Fields. Type: nvreport -class drives 2. Note the default fields included in the report: Drive Name Product Vendor Status DriveMachine Drive Data Written Drive Data Read 3. To find the available fields, type: nvreport -help fields drives 4. Do the following: Cross Reference Field Names with their Real Names. Field Name Drive Name Product Vendor Status DriveMachine Drive Data Written Drive Data Read Real Name DriveName Product Vendor Status: DriveMachine DriveDataWritten DriveDataRead

115 Quest NetVault Backup 115 Command Line Interface Reference Guide Note the Real Name for the additional column. In the list of available fields, Drive Write Errors is located in the Field Names column and its Real Name is DriveWriteErrors. 5. Type the following command to get the required result: nvreport -class drives -format %DriveName %Product %Vendor %Status %DriveMachine %DriveDataWritten %DriveDataRead %DriveWriteErrors Figure 4-7: Example showing an additional column added to the report Note the following: Before choosing an additional field, review the full list of the available fields for a template file. Using the nvreport -help field <class name> command, review the information offered in the Description column for each Field Name/Real Name. Ensure that the Field you include will provide the required data. All the rules described in the previous points in this section also apply to the new fields. When using the drives or media classes default template files to add additional columns, note the following: Reporting Read/Write Errors You can obtain the number of read/write errors for the drives as well as the frequency of these errors based on their occurrence with actual media in a library. For these, you need to use the proper template file for the class and the specific field s Real Name in the syntax: Errors Associated with Media Use the media class and the Real Names ReadErrors (Field Name = Read Errors ), and/or WriteErrors (Field Name = Write Errors ) nvreport -class media -format %<other columns> %WriteErrors Errors Associated with Drives Use the drives class and the Real Names DriveReadErrors (Field Name = Drive Read Errors ), and/or DriveWriteErrors (Field Name = Drive Write Errors ). nvreport -class drives -format %<other columns> %DriveReadErrors If the ReadErrors / WriteErrors Real Name are used with the drives class (instead of DriveReadErrors / DriveWriteErrors ), the

116 116 Chapter 4 NVBU Reporting with the CLI report will generate read/write error information, but this information is specific to any media that currently exists in a drive and not the entire range of drives in that device. If no media exists in the drive, UNKNOWN will be returned. It is recommended you save these custom commands in a text file or include them in a script to eliminate the need to manually type out the command each time the report is required c Sort Option The -sort option can be used to sort the entries on a selected field. A sort expression is specified in the following format: -sort %[field name][+/-] [field name] Field on which the report is to be sorted [+/-] Use + to sort the result in ascending order of the specified field, or - to sort the results in descending order. Important: A report can be sorted on any field a class offers. Even a Real Name for the field that is not displayed in an output report can be used for ordering the output. Example nvreport -class Job History -sort %TITLE+ Figure 4-8: Report sorted on the basis of Job Title in ascending order Note the following: Use a Field s Real Name as Set in the Template You must use the real name for the field with the -sort option. Prefixe the Fields with a Percentage ( % ) Symbol In order for the CLI to recognize each field, it must be prefixed with a % symbol. If a percentage symbol exists in a field title for a selected template, use the escape sequence %% when specifying the field title.

117 Quest NetVault Backup 117 Command Line Interface Reference Guide Sort Expressions can be Joined You can specify multiple fields with the -sort option. The resulting report will prioritize the sort based on the order of the field names in the syntax. When using multiple sort fields, enclose all fields in quotes ( ). Example nvreport -class Job History -sort %TITLE+ %EXITSTATUS- Figure 4-9: Report sorted on Job Title and Exit Status d Including/Excluding Data from Reports This option can be used to filter the data for a report. This syntax is as follows: %[field name][operator][constant] [field name] Real Name of the field. [operator] This can be any of the following: > (greater than) >= (greater than or equal to) < (less than) <= (less than or equal to) = (equal to)!= (not equal to) [constant] - This is a value to which the [field name] value will be compared. For example, to include only entries that apply to the NVBU job assigned the Job ID of 42, you would include 43 as the [constant]. nvreport -class Job History -include %JOBDEFINITIONID = 42 Figure 4-10: Example showing the use of a constant

118 118 Chapter 4 NVBU Reporting with the CLI Available Constant Types Constant Type Amount of Time Passed (Timepassed) Boolean Arguments (boolean) Date Days of the Week (daysinweek) Days of the Month (daysinmonth) Description For fields that gather data based on a time interval that has elapsed. For example, the amount of time it took to run a backup job. Can be specified in the following formats: HH:MM:SS (22:10:11) Based on a 24-hour clock HHMMSS (221011) Based on a 24-hour clock For fields that return boolean results. For example, Does the machine have the Server version of NVBU = Yes/No <option X> is enabled for this job = True. Examples of boolean values: Yes or No True or False Specific date an NVBU event occurred. For example, nvreport -class job history -include %STARTDATE >= [Date]. This can be specified in the following formats: Specific Date: YYYY/MM/DD (2013/04/15) Year/Month/Date YYYYMMDD ( ) YearMonthDate Past Date: now-[number value][time variable (YE = Year, MO = Month, WE = Week, DA = Date, HO = Hour, MI = Minute, SE = Second)]. For example, now-1ye would be one year ago) For fields that return a day of the week, use the following format: [NN] A two letter indication for each day of the week: Sunday = SU Monday = MO Tuesday = TU Wednesday = WE Thursday = TH Friday = FR Saturday = SA For fields that require a specific date in the month, use the following format: [Day(s) of the Month] Date(s). For example, 1, 2, 4, 8, 23. For multiple values use a comma separator and all enclose all values in quotes.

119 Quest NetVault Backup 119 Command Line Interface Reference Guide Constant Type Count of Hours, Days, Weeks, Months and Years (hdwmycount) Large Number Value (Integer) Number Value (Integer) pluginscreen selectiontree String of Text (String) System Time (Systime) Time Description For fields that require a total number of hours, days weeks months, and years, use the following format: [#H] [#D] [#W] [#M] [#Y] - For example, 12H 2W 10M 18Y would be 12 hours, two weeks, 10 months, and 18 years. Each time variable can be added or omitted as required. Same as Number Value below, but for larger numeric values. For example, No commas needed. For fields require a numeric value as their resulting data. For example, to only list jobs whose instance ID meets a given value nvreport -class job history -include %INSTANCEID = [Number Value] 1 5 N/A N/A For fields that require a string. For example, nvreport -class job history -include %EXITSTATUS!= [String of Text] Some examples of strings that are issued and can be used as a [constant] : Failed Completed with Warnings Strings of text with spaces must be enclosed in quotes). Specific time applying to an NVBU event that occurred in relation to the system time on the NVBU Server. This can be specified in two ways: Specific Time: The number of seconds that have passed since midnight, on January 1st Past Time: now-[number value][time value] (YE = Year, MO = Month, WE = Week, DA = Date, HO = Hour, MI = Minute, SE = Second -- for example, now-30mi would be 30 hours ago) Specific time an NVBU event occurred, for example, nvreport -class "job history" -include "%STARTTIME >= [Time]" This can be input in two ways: Specific Time: Use the following formats: HH:MM:SS (22:10:11) - Based on a 24-hour clock HHMMSS (221011) - Based on a 24-hour clock Past Time: now-[number value][time variable (YE = Year, MO = Month, WE = Week, DA = Date, HO = Hour, MI = Minute, SE = Second)]. For example, now-12ho would be 12 hours ago.

120 120 Chapter 4 NVBU Reporting with the CLI Constant Type Unique Weeks of the Month (weeksinmonth) Description N/A For fields that require a specific week in the month. Input in the following format: [Week Number] - Desired week number(s). L refers to the last week in the month (for example, 134L would include the first, third, fourth, and last week in the month) Note the following: Use the Field s Real Name as Set in the Template File You must provide the real name for the field that is to be included/excluded. Prefix the Fields with a Percentage ( % ) Symbol - In order for the CLI to recognize each field, it must be prefixed with a % symbol. If a percentage symbol exists in a field title for a selected template, use the escape sequence %% when inputting the field title. Use Boolean Arguments to Join Multiple Include/Exclude Expressions To join multiple include/exclude expressions, use the boolean arguments AND and OR. In addition, use parenthesis to indicate the priority of the boolean arguments. When using multiple entries, enclose all in quotes ( ). nvreport -class Job History -include (%JOBDEFINITIONID > 50 AND %INSTANCEID < 5) OR %TYPE = restore e Title Option When a report is run and viewed from the command line, it is given the default title Report CLI Report in the output. This option can be used to change the report title, and is applied using the following syntax: -title <NewReport Title> Note the following: If a title is to contain any spaces, the entire value must be enclosed in quotes (as demonstrated in the example image, above). While the -title option can be used to label a CLI-output report, it is better suited to label a report that is output to file, and viewed outside of the CLI.

121 Quest NetVault Backup 121 Command Line Interface Reference Guide External Reports By default, a report run using the nvreport command from a terminal session window will be output in that window for viewing. However, NVBU also makes it possible to generate actual report files from the command line that are saved to an external directory. These report files can then be used as required. For example, they can be opened for viewing in an HTML-based browser software, they can be sent as attachments for others to view. This is all made possible through the use of the proper options in the nvreport command syntax Creating External Report Files The process used to create an external report file is generally the same as the process used to run a report and view the results in the terminal session window. Some differences in the syntax do apply, and additional options must be applied. The sections that follow describe how to create an external report a Step 1: Select the Template File It is recommended that you use only following options to create an external report file: The -templatename Option Use this option with the Nice Name associated with a specific template file. The -templatefile Option - Use this option to provide the file path for the specific template file to be used. The report templates are present in the...\reports\templates directory (where... refers to the NVBU installation directory). Important: While it is possible, it is recommended that you avoid using the -class option to generate a report file for viewing outside of the terminal session window. 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 end result in an external report when the -class option is used. Which Type of Template File Should be Used? There are basically two types of report template files, based on their output format HTML-based template files and Plain Text-based template files. HTML-based Template Files NVBU also offers a selection of templates to generate HTML-based reports to view from the NVBU Console. When used with the -outputdir option, you can generate an HTML-based file for the report that can be viewed externally. Files of This Type Available for Use - The table that follows offers the actual file name for each HTML-based template file, its Nice Name value and a brief description of the report output.

122 122 Chapter 4 NVBU Reporting with the CLI Template File Name Nice Name Description of HTML-based Report activejobs Currently A summary of active jobs. It includes: Active Jobs Job Identification Number Job Title Client Name NVBU Client Name Policy Name Name of the Policy Running Status Current status, for example, Writing to Media alldrives All Drives List of all drives controlled by the NVBU Server. It includes: Machine Machine to which the drive is attached Drive Name Status Online or Offline Data Read Amount of data currently being read by the drive. Zero if no jobs are active. Data Written Amount of data written Read Errors Number of Read errors Write Errors Number of Write errors Written Date Last Write Date Read Date Last Read Date DateLastCleaned Last Clean Date DataSinceCleaning Amount of data written since it was last cleaned UseTimeSinceLastCleaning Number of times the drive has been used since it was last cleaned allfailedpolicyjobs clientgroups Failed Policy Jobs Client Groups A summary of failed policy jobs within a given period. It includes: Policy Name Client Name - NVBU Client Name Job Title Plugin - Plug-in used for the job Start Date Start Time Run Length - Amount of time the job took until it reached exit status. Exit Status List of Client Groups. It includes: Client Group Name Description of the Client Group All? If all current Clients are member of this group Members If individual members belong to this group, they are displayed

123 Quest NetVault Backup 123 Command Line Interface Reference Guide Template File Name Nice Name Description of HTML-based Report clientstatuses Client Staus of the added clients. It includes: Statuses Added Client Name Version of NVBU Installed Access Yes or No Status Up or Down errorlogs events expiredofflinemedia failedrequests fullonlinemedia Recent Error Logs NetVault Events Expired Offline Media Failed ULA Requests Full Online Media List of error logs for a given period. It includes: Date/Time of Error Log Entry Client NVBU Client Name Job Identification Number Instance Number Message Error message Warn Level Warning level List of events raised during a given period. It includes: Date/Time of Event Event Name Event Class Description Event description Event Message List of expired offline media. It includes: Media Label Media Group Media Group Label Barcode Barcode of the media item Date Written/Read Last date the target media was written to or read from. Offsite Location User-wise list of attempted operations that failed because of access level control. List of online media items that are full. It includes: Media Label Media Group Media Group Label Barcode Barcode of the media item Date Written/Read Last date the target media was written to or read from. Media Expiry Date Scheduled expiry date for the target media LibraryName Name of the library that the target media is residing in Logical Slot Position Slot number for the logical slot the target media resides in Offsite Location Need Import Whether an Import needs to be performed on the piece of media

124 124 Chapter 4 NVBU Reporting with the CLI Template File Name Nice Name Description of HTML-based Report globalnotifications Global Notifications A list of events for which any Global Notification Method is set. It includes: Notify Class Event Class Environment Configured notification environment Notify Event Event Notification Method historicjobs historicjobsbysize Historic Jobs - By Date Historic Jobs - By Size A date-wise list of jobs performed during a given period, sorted in descending order of data size. It includes: Start Time/Date Run Length A size-wise list of jobs performed during a given period, sorted by descending order of date. It includes: Job Title Job Identification Number Instance Number Client Name SelSetName Backup or Restore Selection Set used Backup Size Overall size of the backup (backup jobs only) Exit Status Start Time/Date Run Length jobdefinitions Defined Jobs List of jobs that have been created and saved, but not necessarily run is given. It includes: Job ID Number Job Title Client Name NVBU Client Name Policy Policy name, if applicable Plugin Plug-in used for the job Type Job type Backup, Restore, or Report SchedSetName Name of the Scheduled Set used SelSetName Name of the Selection Set used btargsetname Name of the Backup Target Set used AOptsSetName Name of the Advanced Set used

125 Quest NetVault Backup 125 Command Line Interface Reference Guide Template File Name Nice Name Description of HTML-based Report jobhistory Executed Job History List of jobs performed during a given period. It includes: Job Identification Number Job Title Client Name NVBU Client Name Exit Status Exit status of the job Plugin Plug-in used for the job Type Job type Backup, Restore, or Report Start Date/Time End Date/Time Run Length libraryblankcounts librarycontents logs Blank Media Items In Libraries Libraries' Media Contents NetVault Logs Number of blank media items residing in the libraries under control of the current NVBU Server. It includes: Library Name Blank Media Count Total blank media items available in the library. A summary of currently online media items. It includes: LibraryName Library name DriveName - Drive name Logical Slot Position Slot number for the the slot containing the target piece of media Media Label Barcode Barcode of the media item Media Group Media Group Label Space Used/Left Amount of space used and remaining on the media item A list of NVBU Logs generated during a given period. It includes: Job Identification Number Class Warn Level - Warning level Time/Date of Log Entry Client Name of the NVBU Client that the action that generated the log entry was running on. Message Log message.

126 126 Chapter 4 NVBU Reporting with the CLI Template File Name Nice Name Description of HTML-based Report mediacontentsquery Media Contents Query A summary of the contents of a piece of media. By default, each filter is set to *. This wildcard represents all qualifying values. The report includes: Media Label Media Group Media Group Label Barcode Barcode of the media item Job Title Client Name Name of the NVBU Client from which the job was performed. Plugin Plug-in used for the job Start Date/Time Backup Type Backup Size Media Expiry Date/Time Scheduled expiry date and time for the media item mediageneral Media - General A summary of used media. It includes: Media Label Barcode Barcode of the media item Media Type Designated type of the target media, like tape, disk file. Format MTF for Windows and CPIO for Linux/UNIX. Machine NVBU machine that controls the device where the target piece of media resides. Media Expiry Date Scheduled expiry date of the target media Offsite Location Specified offsite location for the target media SpaceUsed/Left Amount of space used and remaining on the media item Unusable Whether the target piece of media is marked as unusable Yes/No. Read Only Whether the target piece of media has been marked as Read Only Yes = True/No = False

127 Quest NetVault Backup 127 Command Line Interface Reference Guide Template File Name Nice Name Description of HTML-based Report mediasegmentcontentsquery mediautilization notifications offlinedevices outstandingopmsgs overnight_jobs_failed overnight_jobs_ failed_count Media Segment Contents Query Media Utilization Users' Selected Notifications Offline Devices Outstanding Operator Messages Failed Overnight Backup Jobs Count Of Failed Overnight Backup Jobs A summary of media segment contents. It includes: Media Label Barcode Barcode of the target media item Job Title Client Name Plugin Plug-in used for the job Backup Date Backup Time Length Length of the segment in number of bytes A summary of used media, and the count of blank media available in each backup device. It includes: Media Label Barcode Barcode of the media item Media Group Media Group Label SpaceUsed/Left Amount of space used and remaining on the media item. List of events. It includes: Event Name Description Event description List of offline drives. List of unacknowledged operator messages in the NVBU Status window. If all messages have been acknowledged or deleted, this report will return no information. It includes: Date/Time The date and time the operator message was issued. Text The operator message text. List of failed overnight backup jobs within a given date range. It includes: Job Identification Number Job Title Client Name NVBU Client name Policy Name Name of the policy that the failed job belongs to, if applicable. Exit Status Exit status of the job Total count of the overnight backup jobs that finished with warnings (for example, 1 backup job finished with warnings ).

128 128 Chapter 4 NVBU Reporting with the CLI Template File Name Nice Name Description of HTML-based Report overnight_jobs_ successful_count overnight_jobs_ total_data_stored overnight_jobs_ warnings_count policiessummary restoresummary Count Of Successful Overnight Backup Jobs Count of Data Stored In Overnight Jobs Count Of Overnight Backup Jobs Finished With Warnings Total count of the overnight backup jobs that finished successfully (for example, 12 backup jobs finished successfully ). Total count of the data stored in overnight jobs (for example, Approx. 348GB of data was stored ). Total count of the overnight failed backup jobs (for example, 0 backup jobs failed ). Policy Basics List of defined backup policies. It includes: Policy Name Clients Count Count of NVBU Clients added to the policy Job Count Count of jobs added to the policy Status Current status of the policy Clients Names of NVBU Clients added to the policy Failure Event Events defined for failed jobs Warn Event Events defined for jobs completed with warnings Restore Summary Summary of all restore jobs. It includes: Start Date/Time Client Name Name of the machine that data was restored to. Job Title Job Identification Number Instance Number Run Length Exit Status

129 Quest NetVault Backup 129 Command Line Interface Reference Guide Template File Name Nice Name Description of HTML-based Report serverlicensecapabilities serverlicenseflags single_job_drives_ events single_job_logs single_job_media Server License Capabilities And Usage Server License Flags Single Job's Drive Events Single Job's Logs Media Used by Single Backup Summary of the license capacity for the current NVBU Server. It includes: Description Description of the various capacities of an NVBU Server license (for example, number of clients allowed, number of library units, and others) Licensed Level/number allowed for the selected capacity (for example, a specific number, unlimited) Used - Number actually used in reference to the number allowed in the Licensed column. A table indicating whether or not the current Server license allows for a particular functionality. Transfer rates for the drive(s) used in a specific job. Log entries for a particular job. It includes: Date/Time of Log Entry Class Warn Level Warning level Client Name of the NVBU Client that the action that generated the log entry was running on. Message Log message Media usage details for a particular job. It includes: Barcode Barcode assigned to the target piece of media. Media Label Media Type Designated type of target media, like tape, disk file and others Offsite Location Specified offsite location for the target media

130 130 Chapter 4 NVBU Reporting with the CLI Template File Name Nice Name Description of HTML-based Report single_job_media_ transfers single_job_ summary single_job_xfer_ rates singlepolicybytecounts singlepolicyclients Single Job's Media Transfers Single Job Main Summary Single Job's Data Transfer Rate Policy Totals Policy Clients Data transfer details for a particular job. It includes: Received Date/Time Date and time the media transfer request was received Started Date/Time Date and time the requested media transfer began Done Date/Time Date and time the requested media transfer completed Type Type of media transfer read or write Transferred Amount of data transferred. Summary of a particular job. It includes: Job Identification Number Job Title Type Job type Backup, Restore, or Report Plugin Plug-in used for the job Instance Number Start Date/Time End Date/Time Exit Status - Transfer Size Size of data transferred. Transfer Rate Average amount of data transferred per second during the job (applies only to backup jobs) Data transfer rate for a particular job. It includes: Date/Time of Event Drive Name Event Event(s) occurred with the selected drive for the specified job Backup size and transfer rate for policy jobs within a given period. It includes: Backup Size Total Backup Size Average Transfer/Second Total Transfer/Second Average List of clients added to policy jobs. It includes: Client Name Names of the NVBU Clients Policy Name Status

131 Quest NetVault Backup 131 Command Line Interface Reference Guide Template File Name Nice Name Description of HTML-based Report singlepolicyjobs singlepolicystatus singleusersaudittrail singlepolicyfailedjobs userdefinedeventtypes Failed Jobs Within Single Policy Defined Policy Jobs Policy Status Information Single User's Audit Trail User-Defined Event Types List of failed jobs for a policy within a given period: Policy Name Client Name Name of the machine that the failed job ran on Job Title Plugin Plug-in used for the job Start Date Start Time Run Length Amount of time the job took until it reached exit status. Exit Status Summary of jobs added to a policy. It includes: Job Name Policy Name Job Active Whether the job is active Yes or No Selection Set Name of the Selection Set Selection - Name of the Backup Set Schedule Set Name of the Schedule Set Target Set Name of the Target Set Advanced Set Name of the Advanced Set Status of a particular policy. It includes: Policy Name Clients Count Number of NVBU Clients added to the policy. Job Count Number of NVBU jobs added to the policy Failure Event Failed jobs Warning Event Jobs completed with warnings Status Current status of the policy Audit trail for the specified user account. List of user-defined events. It includes: Notify Class Event Class Notify Event Event Real Name Real name associated with the current account. Notification Method Notification method for the event Environment Configured notification environment (if applicable)

132 132 Chapter 4 NVBU Reporting with the CLI Template File Name Nice Name Description of HTML-based Report userdetails User Details Summary of NVBU Users. It includes: Account Name Real Name Description Location 1/Telephone/Cellular/Fax/Pager Last Logon Date/Time Local Access Only Whether access is limited to local userprivileges usersmediausage workstationclientfailedjobs workstationclienthistoricjobsbyclient workstationclienthistoricjobsbydate workstationclientinactiveforaweek workstationclientsuccessfuljobs User Privileges Quotas And Media Usage Failed Workstation Client Jobs Workstation Client Jobs By Client Workstation Client Jobs By Date Workstation Clients Inactive For A Week Workstation Client Successful Backup Jobs Privileges assigned to a user. It includes: Account Name The name of the NVBU User Account Privileges Privileges assigned to the user Summary of user media quotas and usage. It includes: Account Name The name of the NVBU User Account. Media Quota Level set for media usage for the current user account (for example, 100 GB, Unlimited, etc.). Media Used The amount of media currently in use by the selected user account. List of Workstation Client backups that have failed. List of Workstation Client backup jobs sorted alphabetically by Workstation Client name. List of Workstation Client backup jobs sorted in chronological order with the most recent jobs at the top of the report. List of Workstation Clients that have not had a backup attempted for more than seven (7) days. List of Workstation Client backups that have completed successfully.

133 Quest NetVault Backup 133 Command Line Interface Reference Guide b Figure 4-11: An example of external report file generated for viewing outside of the terminal session window Plain Text Template Files This applies to all of those templates that contain the text clidefault in their file name, or cli default file / textual in its Nice Name. If a template file of this format type is called out in this syntax, an external file will be created which will contain output in plain text format. The formatting for this type of template file is designed for viewing its output in a terminal session window. An external file generated using this type of template file will display plain text characters; all formatting will be lost. For a list of template files, refer to Template File Used to Generate Canned Report on page 108. You can include plain-text template files in an external report file using the -appendoutput. The contents for such reports will appear in plain-text format below existing HTML-data. For more details on the use of the -appendoutput option, refer to The Appendoutput Option on page 134. Step 2: Apply the Outputdir Option Next, apply the -outputdir option to generate an external report file. Specify a sub-directory where NVBU will store the generated report file. This sub-directory will be created in the...\reports\output directory. The syntax for this option is: -outputdir <name for sub-directory> Example nvreport -templatename Executed Job History -outputdir Test01

134 134 Chapter 4 NVBU Reporting with the CLI Note the following: Existing Sub-directories Will be Overwritten If an existing sub-directory is specified with -outputdir, it will be overwritten. For example, The following command will create the sub-directory, report and save a report named output.html in this directory.: nvreport -templatename Client Groups -outputdir report When you generate another report, it will overwrite the existing report sub-directory and the output.html file with the new file. nvreport -templatename Defined Jobs -outputdir report To avoid losing an existing report file specify a new directory or use the - appendoutput option to append the new report data to the existing report file. For details, refer to The Appendoutput Option on page 134. HTML-based Template Files will Automatically Copy All Support Files to the New Sub-directory NVBU s default HTML-based report templates contain various artwork files in their layout. When an HTMLbased report template is used, these artwork files will be automatically copied to the new sub-directory. Viewing Report Files Created with the Outputdir Option To view an HTML-format report file: Navigate to the.../reports/output/<named directory> and open the file. Specify the full path to the output.html in the browser. Based on the O/S if the path includes a space, you may have to replace it with its ASCII character c Step 3: Set Format for the Output Report (Optional) This section describes the options that can be with the -outputdir option when creating an external report file. The Appendoutput Option If an existing sub-directory is named in the syntax of the -outputdir option, its contents will be overwritten when a new report is run. In order to maintain the contents in an existing report file, use the -appendoutput option. It allows you to new report data to the existing report file. Example nvreport -templatename "Restore Summary" -outputdir "Test01" -appendoutput

135 Quest NetVault Backup 135 Command Line Interface Reference Guide Figure 4-12: When the -appendoutput option is properly used, new report data is added to an existing output.html file Note the following: The -appendoutput Option Must Be Used with the -outputdir Option This option only applies to the -outputdir option. In addition, the subdirectory specified must already exist. Different Template Files Can be Combined This option allows you to combine two different types of templates as shown in the example above. Different Output Types can be Combined This option allows you to combine the HTML and Plain-text output types. The Title Option This option is briefly discussed in the section, Title Option on page 120, where its use with Plain Text-based reports output in a terminal session. The -title option can also be used with the -outputdir option to assign a user-defined to the saved report file. This syntax for using this option is: -title <New Report Title>

136 136 Chapter 4 NVBU Reporting with the CLI Example: nvreport -templatename "Historic Jobs - By Date" -outputdir "Test01" -title Job History By Date Note the following: Can be Used with Any Template File Format This option can be used with the -outputdir option to add a title to any format of template (HTML or Plain Text-based). Only Applies to New Report Data When used with the -appendoutput option, the -title option will be used as the title of the report that is appended to the existing output.html file. The existing report will maintain its existing title.

137 Appendix

138

139 Quest NetVault Backup 139 Command Line Interface Reference Gude Appendix A: NVDB CHECK AND COMPACT LOGS A.1.0 Logs Generated by the NVDB Check and Compact Actionsl Logs Generated by nvmeddbcheck Logs Generated by nvscheddbcheck Logs Generated by the NVDB Check and Compact Actions This appendix describes the symptoms and debug information for the errors generated by the nvmeddbcheck and nvscheddbcheck utilities. A.1.1 Logs Generated by nvmeddbcheck LogError Media Manager '%s' table failed raw database check (%ld) This is a serious error. The checker was unable to even check the database tables for simple integrity before moving on to more detailed check. Unless there is some overriding condition (for example, no disk space or memory on the machine), the most likely solution is to recover the last known good NVDB backup and scan in additional backups. LogInformation Bad segment found A missing segment has been detected. This could be caused by blanking an individual piece of media from a backup. Database compaction will remove the condition but will not recover the missing segment. Incomplete scanning of the media set associated with a backup stream could also be the cause, in which case all relevant pieces of media need to be scanned in. LogBackground duplicate xxx entry (Id = %ld, Last Id = %ld) entry out of order (Id = %ld, Last Id = %ld) entry cannot be found (Id = %ld, Last Id = %ld)

140 140 Appendix A NVDB Check and Compact Logs These entries indicate an internal discrepancy within the NVDB database. They do not cause a problem in themselves but indicate that an unknown action occurred which compromised the integrity of the database; whether that relates to scanning in backups, deleting schedules or backups/media items is unknown. This error indicates that an incomplete database update action occurred because of lack of disk space or another reason. It is recommended that the backup logs be reviewed since the last NVDB backup was performed to look for any anomalies. Running database compaction may help or recovering a good NVDB backup may be required. LogInformation Media Mid from two generations (Id = %ld, Last Id = %ld) This can be caused by the re-use of media, possibly intertwined with an NVDB recovery; this is a benign problem. LogError Internal error walking database table This is a serious error; the checker was unable to even check the database tables for simple integrity before moving on to more detailed check. Unless there is some overriding condition (for example, no disk space or memory on the machine), the most likely solution is to recover the last known good NVDB backup and scan in additional backups. LogWarning Backup %ld stream %s is incomplete Session with incomplete new streams Backup %ld Job %ld Instance %ld Phase %ld Backup %d is incomplete. Required old streams are missing The backup record does not contain all the required information. Run database compaction to remove the backup from the database and then recover the backup, if required. This is a benign problem. LogInformation No Session matching Backup Index %ld Backup Index %ld is for a deleted session There is a backup index in the database for which there is no job session record; possibly the index has been scanned in from tape or the jobs have all been deleted. Run database compaction to remove the backup from the database and then recover the backup, if required. This is a benign problem.

141 Quest NetVault Backup 141 Command Line Interface Reference Gude LogInformation Backup %ld has corrupt index file The index file is not readable; it needs to be deleted manually (the path to the file is now indicated in the log). The index can be scanned in again from the backup media. LogBackground The saveset index file is offline or missing for %ld backups The index can be scanned in again from relevant backup media. LogInformation Saveset index files found for %ld deleted backups Index files have been found for unrecorded backup. It could be caused by backups that were scanned in to recover the index files. Run database compaction. LogWarning Failed to check. There has been a problem in the checking of the database tables; possibly due to lack of resources. This needs to investigated because the database contents cannot be checked unless basic access is possible. This is similar to a problem with checking the raw integrity of the database. However, it does not necessarily indicate a problem with the databases. LogWarning Media Manager database check identified unreferenced records Some problems were identified. Run database compaction. LogWarning Failed to compact of media manager database '%s' records Failed to compact media manager database Ordinarily, compaction should run successfully; run nvmeddbcheck manually to identify the problem area. LogWarning Warning 2008/02/26 05:25: Media NetvaultServer Backup has corrupt index file Re-scan indexes from the backup media. Alternatively, recover a good NVDB backup, and re-scan the additional backups from media.

142 142 Appendix A NVDB Check and Compact Logs LogBackground Check Media table Mid index Media: Mid from two generations (Id = 57328, Last Id = 57224) This error can be caused by the re-use of media, possibly intertwined with an NVDB recovery. This is a benign problem. After being marked for re-use, the MID will increment, and when re-used, it will increment again. Normally, the records related to the use of MID are cleared but in this case the database contains information that relates to the same MID from different times. Recovering an NVDB backup or scanning in a duplicated (older) copy of the tape could have caused this. It is not a problem. A.1.2 Logs Generated by nvscheddbcheck LogError Scheduler table '%s' failed raw database check (%ld) This is a serious error; the checker was unable to even check the database tables for simple integrity before moving on to more detailed check. Unless there is some overriding condition (for example, no disk space or memory on the machine), the most likely solution is to recover the last known good NVDB backup and scan in additional tapes. LogBackground duplicate xxx entry (Id = %ld, Last Id = %ld) entry out of order (Id = %ld, Last Id = %ld) entry cannot be found (Id = %ld, Last Id = %ld) These entries indicate an internal discrepancy within the NVDB database. They do not cause a problem in themselves but indicate that an unknown action occurred which compromised the integrity of the database; whether that relates to scanning in backups, deleting schedules or backups/media is unknown. This error indicates that an incomplete database update action occurred because of lack of disk space or another reason. It is recommended that the backup logs be reviewed since the last NVDB backup was taken to look for any anomalies. Running database compaction may help or recovering a previous good NVDB backup may be required. LogError Incomplete database Table not found Incomplete database Table '%s' not found Internal error walking database table

143 Quest NetVault Backup 143 Command Line Interface Reference Gude Check that an upgrade of an older NVBU installation is not in progress; older NVBU versions would not have as many database tables as 8.0 and later versions and as a result the checker would be expecting to see a table that is not present. If the installation is recent or has been upgraded, then this indicates a serious problem for which the solution is to recover a previous NVDB Scheduler database. LogInformation Policy '%s' job '%s' uses selections set '%s', that does not exist Policy '%s' job '%s' uses selections set '%s', that could not be loaded Policy '%s' Job '%s' uses plugin '%s', that is not installed Policy '%s' job '%s' uses selections options set '%s', that does not exist Policy '%s' job '%s' uses advanced options set '%s', that does not exist Policy '%s' job '%s' uses target set '%s', that does not exist Policy '%s' job '%s' uses schedule set '%s', that does not exist Policy '%s' job '%s' for client '%s' is implemented by job id %ld, that does not exist Indicates that Selection Sets have been deleted at some in time. Either recreate the missing set, or delete the policy which relies on the missing set if the policy is no longer active. Recreate the client or reinstall the plug-in, as required. LogError Failed to walk policies table Failed to get sets table cursor for checking policies Failed to get table cursor(s) to check jobs table Failed to walk jobs table Failed to walk scheduled phases table Failed to walk job instance table Failed to walk instance data table Failed to access Scheduler tables to check references and dependencies

144 144 Appendix A NVDB Check and Compact Logs This indicates a serious problem for which the solution is to recover a previous good NVDB Scheduler database. LogInformation Scheduled phase id %ld is for job id %ld, that does not exist or has been deleted Run scheduler database compaction. LogError Scheduled phase id %ld is for job id %ld that has a corrupt entry in the jobs table This indicates a serious problem for which the solution is to recover a good backup of the NVDB Scheduler database. LogInformation Scheduled phase id %ld is for job id %ld instance %ld phase %ld but that job only has %ld phase(s) defined Scheduled phase id %ld is for job %ld instance %ld phase %ld but the previous phases instance data required cannot be found Scheduled phase id %ld is for job id %ld instance %ld that has no instances table entry Recreate the job. LogWarning Scheduled phase id %ld for job id %ld instance %ld has illegal entry in instances table\n Scheduled phase id %ld for job id %ld instance %ld conflicts with instances table entry (last instance %ld) Recreate the job. LogWarning Failed to access Scheduler tables to check references and dependencies Run Scheduler database compaction. LogWarning Scheduler database check identified unreferenced records 1 job instance id records with no job definition 2 change records with no job definition

145 Quest NetVault Backup 145 Command Line Interface Reference Gude Both messages are symptomatic of a job that was created and run previously. A Run Now was possibly performed thereafter, and then the job was deleted from the Jobs window. This resulted in the deletion of the job definition related to the instances when the job was run. The job ID is not recorded in the log. The Scheduler database should be compacted to remove the warning which is benign. Running the command line tool nvscheddbcheck Check will provide the job IDs in question; if not, then running the command with TRACE enabled will definitely show the job ID.

146 146 Appendix A NVDB Check and Compact Logs