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 legal@quest.com 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: info@quest.com 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.