Quest NetVault Backup. Command Line Interface Reference Guide. version NVG EN-01 05/29/12

(1)

NVG-102-8.6.3-EN-01 05/29/12

version 8.6.3

Command Line Interface

Reference Guide

(2)

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 92656 email: [email protected]

Refer to our Web site (www.quest.com) 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; and 8,171,247. Protected by Japanese, E.U., French and UK patents 1615131 and 05250687.0, and German patent DE602004002858. Additional patents pending.

Trademarks

Quest, Quest Software, the Quest Software logo, Simplicity at Work, FlashRestore, 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

http://www.quest.com/legal/trademarks.aspx. Other trademarks and registered trademarks are property of their respective owners.

(3)

Chapter 1: Introducing Quest NetVault Backup

7

• Quest NetVault Backup – At a Glance ... 7

• Key Benefits ... 8

• Feature Summary ... 9

• About this Document ... 10

• Target Audience ... 10

• Recommended Additional Reading ... 10

• About Quest Software ... 11

- Contacting Quest Software ... 11

- Quest Support ... 11

Chapter 2: Getting Started

13

• NVBU Command Line Interface – An Overview ... 13

- CLI Help ... 13

- CLI Access Control ... 14

• Working with Command Line Executables ... 14

- Preparing to Run a Command ... 14

- Syntax ... 14

- Abbreviation ... 15

- NVBU Names ... 15

- The “nvsetmodify.cfg” File ... 17

- Starting and/or Stopping NVBU from the CLI ... 18

Chapter 3: Using NVBU Commands

19

• Client-Specific Commands ... 19 - nvclient ... 19 - nvclientaccess ... 20 - nvclientadd ... 21 - nvclientlist ... 22 - nvclientname ... 22

(4)

- nvclientremove ... 22 • Device-Specific Commands ...23 - asf_load_media ... 23 - asf_ release_drive ... 23 - nvacslsmedia ... 24 - nvcheckdrive ... 25 - nvcleandrive ... 26 - nvclosedoor ... 26 - nvcloseeeport ... 26 - nvcloseeeportcleaning ... 27 - nvdevice ... 27 - nvdeviceeject ... 28 - nvexportmedia ... 29 - nvlibrarymodify ... 29 - nvopendoor ... 32 - nvopeneeport ... 33 - nvremovefiler ... 33 - nvresetdrivestats ... 34 - nvscandrives ... 35 - nvsetcleaninglives ... 35 - nvsetdrivecleaning ... 36 - nvsmartdisk ... 37 • Media-Specific Commands ...38 - nvblankmedia ... 38 - nvbulkblankmedia ... 40 - nvexportmedia ... 41 - nvlabelmedia ... 41 - nvlistblankmedia ... 42 - nvlistmedia ... 43 - nvloadmedia ... 43 - nvmakemedia ... 44 - nvmediadetails ... 47 - nvremovemedia ... 47 - nvreusemedia ... 48 - nvscanmedia ... 49 - nvsyncronizesilomedia ... 50 - nvupdateserialnumber ... 50 • Job-Specific Commands ...51 - nvexpiresaveset ... 51 - nvjobabort ... 51

(5)

- nvjobcreate ... 52 - nvjobdelete ... 55 - nvjobhold ... 57 - nvjoblist ... 57 - nvjobmodify ... 58 - nvjobresume ... 60 - nvjobstart ... 60 - nvpolicy ... 61 - nvrestore ... 63 - nvsetcreate ... 67 - nvsetdelete ... 76 - nvsetexport ... 77 - nvsetimport ... 78 - nvsetmodify ... 78 - nvtrigger ... 81 - Log-Specific Commands ... 83 - nvlogdump ... 83 - nvlogpurge ... 84 - nvreadlog ... 84 • Other Commands ... 85 - bonedate ... 85 - getmachineid ... 85 - installplugin ... 85 - licenseinstall ... 85 - nvlicenseinfo ... 86 - nvmeddbcheck ... 86 - nvpassword ... 87 - nvpluginaccess ... 87 - nvreport ... 87 - nvscheddbcheck ... 87 - nvsendmail ... 88 - nvsendopmsg ... 89 - nvsvtlgrow ... 89

Chapter 4: NVBU Reporting with the CLI

91

• nvreport – An Overview ... 91

- CLI Help ... 92

• Using “nvreport” ... 92

(6)

- Template Files ... 99

- Formatting Report Layout and Content ... 102

• External Reports ...113

- Creating External Report Files ... 113

Appendix

Appendix A: NVDB Checker Errors 131

• Debugging Errors Generated by NVDB Checker ...131

- Errors Generated by nvmeddbcheck ... 131

(7)

Chapter 1:

I

NTRODUCING

Q

UEST

N

ET

V

AULT

B

ACKUP

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

1.1.0 Quest NetVault Backup – At a Glance

Quest NetVault Backup (NetVault Backup or NVBU) offers the most advanced, cross-platform data protection capabilities along with 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 from one intuitive console. With the NetVault Backup Plug-ins, you are not required to understand storage, database or email internals. You select the backup strategy that best fits your database or email environment, and then just point and click. This enterprise-level software does not require you to be an expert, but has the flexibility to tune it as you want.

NVBU is engineered to keep up with the organizational changes and let you make choices that are best for your company. For example, if an organizational merger takes place or a key department acquires a major application that requires a different platform, that is no problem with NVBU’s heterogeneous server and extensive application support. The freedom of choice continues with the powerful disk-based data protection product, Quest NetVault SmartDisk (NetVault

SmartDisk or NVSD) and its deduplication option which provides seamless integration with NVBU to allow you to be in control of which data should be deduplicated and which should not without restricting you to specific types of storage drives and appliances. Additionally, administrators have increased choice including the ability to copy or move data between NVSD Instances, to Virtual Tape Library (VTL) or tape-based devices in order to place redundant backups at offsite locations for failover and disaster recovery purposes. You can select your

(8)

backup device of choice from a very large list of supported Network Attached Storage (NAS), VTL and tape systems. You decide when and where to encrypt to reduce backup windows while still meeting regulatory requirements. You can deploy and protect physical or virtual machines. With the NVBU Plug-ins, you easily select the best backup method to protect all the popular operating systems, messaging and database applications. NVBU SmartClient gives you the freedom to attach virtual and physical tape devices where you want to.

NVBU is architected to protect and leverage existing investments in data

protection while making necessary changes and upgrades to support the growth and health of your organization. NVBU’s ability to efficiently scale from small installations to very large global companies means you would not be penalized by being forced to rip and replace your data protection infrastructure just because your organization is successful and growing. NetVault SmartDisk integrates with NVBU to shrink backup windows and reduce storage costs with its post-process deduplication option which can be scheduled outside the backup window. Your investment in storage systems is protected through automated access to hundreds of different storage devices. You avoid vendor lock-in by taking advantage of NVBU’s heterogeneous server support as well as powerful messaging, database and virtualization protection options. With NVBU, you protect your vital IT assets because you can still recover your data even in a worst case scenario in which you only have your backup media, but no NVBU database. Plus, you can redeploy into a different operating system for an emergency recovery.

1.2.0 Key Benefits

Intuitive interface requiring only minimal experience to operate 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

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

(9)

Dynamic device sharing to optimize backup data transfers and reduce points of failure

1.3.0 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 NetVault SmartDisk 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 policy-based 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. 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.

(10)

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.

1.4.0 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.

1.5.0 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.

1.6.0 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.

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: https://support.quest.com/Search/SearchDownloads.aspx

(11)

1.7.0 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

www.quest.com.

1.7.1 Contacting Quest Software

For regional and international office information, refer to the web site.

1.7.2 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 www.quest.com/support.

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

View the Global Support Guide for a detailed explanation of support programs, online services, contact information, policies and procedures.

The guide is available at www.quest.com/support. This guide is available in English only.

Email: [email protected]

Mail: Quest Software, Inc. World Headquarters 5 Polaris Way Aliso Viejo, CA 92656 USA

(12)

(13)

Chapter 2:

G

ETTING

S

TARTED

NVBU Command Line Interface – An Overview CLI Help

CLI Access Control

Working with Command Line Executables Preparing to Run a Command

Syntax

The “nvsetmodify.cfg” File

Starting and/or Stopping NVBU from the CLI

2.1.0 NVBU Command Line Interface – An Overview

The NetVault Backup 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:

Start or stop the NVBU Service

Create and Submit Jobs – This includes creating, editing and submitting backup and restore jobs for any NVBU Client controlled by the NVBU Server. You can also create and modify Selection Sets required for these jobs from the command line.

Manage Backup Devices – This includes importing and exporting media, blanking media, getting drive and library status, listing the library, marking media for re-use, and others.

Generate Canned and Custom Reports – This includes various reports for clients, devices, media and jobs.

View Operator Messages – To determine if attention is required.

2.1.1 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

(14)

2.1.2 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 NetVault: Backup Administrator’s Guide.

Note that even if CLI access has been granted to a specific user account, the 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 CLI. NETVAULTCLIPASSWORD – Password for the specified user account.

2.2.0 Working with Command Line Executables

The sections that follow 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.

Notes

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. To use the CLI commands, you must be logged on with Administrator

privileges on Windows- and root privileges on UNIX/Linux.

2.2.1 Preparing to Run a Command

To run a command, navigate to the ...\util directory (where ... represents the NVBU installation directory.

2.2.2 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], …

<Value> is a user input variable for an option. For example, if the NVBU Server name is “Server1”, for the “servername <server name>” option, enter “servername Server1”.

Options enclosed in “[ ]” are optional.

A “|” symbol between two options indicates that only one of the multiple listed can be used in a command.

(15)

All scripts shown in syntax format are to be entered as one line, unless otherwise noted.

The order of the options is not important in the syntax.

2.2.3 Abbreviation

Options 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

-libraryname – Name of the target library. -medialabel – Media label to search for. -allmedia – Blanks all media in the library. -password – NVBU Administrator password.

-wait – Add this option to tell NVBU to wait until this task has completed before moving forward.

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

2.2.4 NVBU Names

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. The CLI sees the use of an underscore in its syntax as a replacement for a space, because a space is not recognized. Therefore, if a machine whose actual name is “NVBU_Server” is included in a CLI command, NVBU will search for a machine named “NVBU Server”. Not finding a machine with this name, the command will return a failed result. To correct this issue, enclose the variables that contain underscores in quotes (“ ”).

2.2.4.a Using Spaces in CLI Variables

If a variable contains spaces, enclose it in quotes (“ ”). Variables with spaces that are not enclosed in quotes will not be recognized by the CLI and an error message will be returned.

(16)

Example:

nvscanmedia -library “NV Library 1”

2.2.4.b NVBU Environmental Variables

You can use the following NVBU environmental variables with the commands to provide the required inputs:

Variable Description

NETVAULTCLIACCOUNT Specifies a user account name. The named account must have privileges to use the CLI utility.

NETVAULTCLIACCOUNT=<Account Name> NETVAULTCLIPASSWORD Specifies the password for the CLI user account.

NETVAULTCLIPASSWORD=<Password> NV_HOME Returns the NVBU installation directory. NV_JOBCLIENT Specifies the target client for a job.

NV_JOBCLIENT=<Name of the NVBU Client> NV_JOBID Specifies the Job ID.

NV_JOBID=<Job ID> NV_JOBTITLE Specifies the Job Title.

NV_JOBTITLE=<Job title>

NV_JOB_WARNINGS 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.

NV_SERVERNAME Specifies the NVBU Server Name.

NV_SERVERNAME=<Name of the NVBU Server> NV_SESSIONID Specifies the Session ID of a job.

(17)

2.2.4.c Command Exit Statuses

Various CLI commands will return a numeric value once they are executed. This number represents the actual exit status of the command. It can be:

0 – The command completed successfully 1 – The command failed

2 – Arguments given in the command are invalid (for example, a variable named in the command is inaccurate).

2.2.5 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 named “nvsetmodify.cfg” for viewing.

3. Note the values for the required functionality and close this file without saving it.

Notes:

Ensure that the nvsetmodify.cfg is note 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 only for highly-experienced users. Therefore, it is strongly recommended that any attempt to use any of the values displayed in this configuration file when generating CLI commands be performed under the guidance of Quest Customer Support.

NV_STATUS 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.

NV_USER_ARG Specifies the arguments passed with the pre or post scripts.

(18)

2.2.6 Starting and/or Stopping NVBU from the CLI

To start/stop NVBU from the command line, you can use the following commands: Linux/UNIX

# $NV_HOME/etc/startup.sh {start | stop} Windows

(19)

Chapter 3:

U

SING

NVBU C

OMMANDS

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).

3.1.0 Client-Specific Commands

3.1.1 nvclient

Adds one or more NVBU Heterogeneous and Workstation Clients to the NVBU Server. Assigns the clients to various 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>]

Options

-add – Adds NVBU Clients. -list – Lists current NVBU Clients.

-password – NVBU password for the Client.

nvclient nvclientadd nvclientname

(20)

-file – Name of the file containing a list of Clients, Client Groups and

Passwords to enable batch submission. For example, -file clientlst specifies a file “clientlst” 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 Client(s) that are to be added

-client – NVBU Machine Names of the NVBU Heterogeneous Client(s) that are to be added.

-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 – Timeout value for client response. It is specified in seconds.

3.1.2 nvclientaccess

Grants access to specified NVBU Clients.

Syntax

nvclientaccess [-client <Client Name>] | [-clients <Client Names>] | [-tdclients <Teradata DBS name>] [-password <password>]

Options

-client/-clients – NVBU Machine Names of the clients to grant access to it. -tdclients – Name of the Teradata DBS. Use this option to grant access to all

the added clients.

-password – NVBU password for the client for which security has been enabled.

(21)

3.1.3 nvclientadd

Adds a single NVBU Heterogeneous Client to the Server. This command must be issued from the NVBU Server itself. It cannot be used to add NVBU Workstation Clients.

Syntax

nvclientadd [-client <Client Name> | -clientip <IP address>] [-clientgroup <Client Group Name>] [-password <password>]

[-timeout <timeout period>] [-version]

Options

-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. -password – If security is enabled on the client, use this option to specify the

NVBU Password for the client.

-timeout – Period of time (in minutes) that NVBU will wait on the client to approve the “add” request. If this period elapses and the client could not be added, an error message will be displayed.

-version – Displays the build date of the NVBU distribution installed on the target client.

Notes

The client should be available and running a valid installation of NVBU before it can be added to an NVBU Server.

If the client is unavailable you can use the nvclientlist –find <ipaddress> command to locate the machine. For details, refer to nvclientlist on page 22. The Client Group must already exist on the NVBU Server. It will not be

created automatically. Client Groups must be created using the NVBU Console. NVBU does not provide any CLI command to create a Client Group.

(22)

3.1.4 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

Syntax

nvclientlist [-current [-name <Client Name>]]

[-available [-name <Client Name>]] [-find <Resolvable Name or IP address>] [-version]

Options

-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.

3.1.5 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>

Options

-clientname – New NVBU name for the client.

3.1.6 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 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

3.2.1 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]

Options

-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.

3.2.2 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>] asf_load_media nvcloseeeportcleaning nvremovefiler

asf_ release_drive nvdevice nvresetdrivestats nvacslsmedia nvdeviceeject nvscandrives nvcheckdrive nvexportmedia nvsetcleaninglives nvcleandrive nvlibrarymodify nvsetdrivecleaning nvclosedoor nvopendoor nvsmartdisk nvcloseeeport nvopeneeport

(24)

Options

-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.

3.2.3 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]

Options

-allocate – Allocates the specified media. -deallocate – De-allocates the specified media.

-eject – Ejects the specified media through the specified Cartridge Access Port (CAP).

-cap – CAP through which to eject the media. 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 – Media label or barcode of the media that is to be allocated, de-allocated or ejected. For multiple labels or barcodes, provide a comma-separated list.

-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 label or barcode values that correspond to a series of media to be de-allocated. Use a hyphen (with no spaces) between the values.

(25)

-file – Name of the file that contains a list of media labels or barcodes corresponding to the set of media 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.

3.2.4 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>]

Options

-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 “Stndalone1” that is locally attached to the NVBU Server:

nvcheckdrive -drivename Stndalone1

Check the status of “Drive 1” in library “NVLibrary” that is locally attached to an NVBU Client named “NVCLIENT1”

nvcheckdrive -servername NVCLIENT1 -libraryname NVLibrary -drivename Drive 1

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 2

(26)

3.2.5 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>

Options

-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 1

3.2.6 nvclosedoor

Close the door of a library managed by the specified NVBU Server.

Syntax

nvclosedoor [-servername <Server Name>] -libraryname <Library Name>

Options

3.2.7 nvcloseeeport

Closes the Entry/Exit (EE) Port of a specified library.

Syntax

nvcloseeeport [-servername <Server Name>] -libraryname <Library Name> [-mediatype <Media Type>]

(27)

Options

-libraryname – Name of the target library. -mediatype – Type of media in the entry/exit slot.

3.2.8 nvcloseeeportcleaning

Closes the EE Port of the specified library for importing a cleaning tape.

Syntax

nvcloseeeportcleaning [-servername <Server Name>] -libraryname <Library Name> [-mediatype <Media Type>]

Options

-libraryname – Name of the target library. -mediatype – Type of media in the entry/exit slot.

3.2.9 nvdevice

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>

(28)

Options

-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.

-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: U– se this command to remove any media 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.

3.2.10 nvdeviceeject

Removes a piece of media from the specified drive.

Syntax

nvdeviceeject -devicename <Device Name> [-servername <Server Name>] [-librarydrivenumber <Drive Number>] [-wait]

Options

-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

(29)

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.

3.2.11 nvexportmedia

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]

Options

-barcode – Barcode of the target media item.

-medialabel – Media label of the desired media. Use only when searching by media label. If a media label contains spaces, enclose it within quotes (“ ”). For example, “my media 1”.

-slotspec – Name of the library and slot number of the target media item. These two values must be separated using a double colon delimiter (“::”). Use this option only when searching by library slot.

3.2.12 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

(30)

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]

– or –

nvlibrarymodify -servername <server_name> -libraryname <library_name>

-librarymachine <library_machine> -drivemachine <drive_machine> -drivepath <drive_path> -add “DRIVE <drive_number>”

-addshared “DRIVE <drive_number>”

Options

The following list describes the parameters that you can use to change the drive status, map or unmap drives, list all library drives, and remove a library:

-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.

(31)

The following list describes the parameters that you can use 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 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 35.

-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 named “/home/qauser1/NewLibrary”. The VTL is created on a Linux NVBU Server named tstserver:

nvlibrarymodify -servername tstserver -libraryname "/home/qauser1/NewLibrary” -librarymachine tstserver -drivemachine tstserver -drivepath

(32)

Add a drive to a SCSI library named “winserver: 2-0.4.0 (SONY LIB-304)”. The library is connected to a Windows NVBU Server winserver:

nvlibrarymodify -servername winserver -libraryname "2-0.4.0 (SONY LIB-304)”

-librarymachine winserver -drivemachine winserver -drivepath "2-0.2.0 (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: 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 named 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 "2-0.2.0 (SONY SDX-500C)” -add "DRIVE 2” Add a SCSI drive to a Windows NVBU Client named winclient. The ACSLS

library is attached to a Windows NVBU Client named client2 and controlled by NVBU Server tstserver:

nvlibrarymodify -servername tstserver

-libraryname "ACS0(StorageTek ACSLS/LibStation)” -librarymachine client2 -drivemachine winclient -drivepath "2-0.2.0 (SONY SDX-500C)” -add "DRIVE 2”

3.2.13 nvopendoor

Opens the door of a library managed by the specified NVBU Server.

Syntax

nvopendoor [-servername <server name>] -libraryname <library name>

Options

(33)

3.2.14 nvopeneeport

Opens the Entry/Exit Port.

Syntax

nvopeneeport [-servername <server name>] -libraryname <library name>

Options

3.2.15 nvremovefiler

Removes filer-attached drives for a specified filer.

Syntax

nvremovefiler [-servername <server name >] -filername <filer name> [-wait]

Options

-filername – Name of the target filer.

Notes

This command will only remove those drives that are idle or offline. After removing a drive, NVBU will display the following message on the screen and in the NVBU Logs window:

Device removed ‘DRIVE <#>:<Drive Name>’

NVBU will only make one attempt to remove a filer-attached drive. If a drive is busy, then NVBU will display the following message on the screen and move on to the next drive.

(34)

If all drives in a library are removed, then the node representing the library arm will also be removed.

3.2.16 nvresetdrivestats

Resets the statistics for a drive.

Syntax

nvresetdrivestats -servername <server name> [-libraryname <library name>] [-drivename <drivename>] [-drivenumber <drivenumber>] -action <action>

Options

-libraryname – Name of the target library. -drivename – Name of the target drive.

-drivenumber – Drive number of the target drive. -action– Action to be performed. It can be:

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 named “Stndalone1” that is locally attached to the NVBU Server.

nvresetdrivestats -drivename Stndalone1 -action drive Reset the cleaning statistics for “Drive 1” in library “NVLibrary” that is locally

attached to an NVBU Client named “NVCLIENT1”

nvresetdrivestats -servername NVCLIENT1 -libraryname NVLibrary -drivename “Drive 1” -action clean

Reset all statistics for “Drive 2” in library “NVLib2” that is locally attached to a remote NVBU Server, with the NVBU name “NVSERVER2”

nvresetdrivestats -servername NVSERVER2 -libraryname NVLib2 -drivenumber 2 -action all

(35)

3.2.17 nvscandrives

Lists drives that are available on a local or remote NVBU Server or Client. The output will not include drives that have been 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 29.

Syntax

nvscandrives [-servername <server name>][-clientname <client name>]

Options

-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.

3.2.18 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>]

Options

-slotnumber – Cleaning slot number in the library. -lives – Number of lives to be set for the cleaning media.

(36)

Examples

Set the number of lives to 7 for a piece of cleaning media in slot 6 of a library named “ADIC_Library_6”. The library is locally attached to the NVBU Server “NVSERVER.

nvsetcleaninglives -server NVSERVER -libraryname ADIC_Library_6 -slotnumber 6 -lives 7

3.2.19 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]

Options

-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: Every 200 GB of Data Transfer

Every 100 Hours of Drive Usage:

If More than 100,000 Read/Write Errors Occur

nvsetdrivecleaning -libraryname “SONY LIB-162” -librarydrivenumber 1 -days -1 -dataxfersize 200 -hours 100 -rwerrors 100000

(37)

3.2.20 nvsmartdisk

Adds or removes NetVault SmartDisk (NVSD) Device.

Syntax

nvsmartdisk --add --host <Host name or IP Address> [--force] [--port <Port Number>] [--server <Server Name>]

nvsmartdisk --remove --device <name> [--force] [--server <name>]

Options

--add – Adds an NVSD Device.

--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 –N VBU 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.

--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 can be useful if an NVBU Server has been re-built.

Forcefully remove NVSD from an NVBU Server even when the NVSD

(38)

3.3.0 Media-Specific Commands

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 quotes (“ ”). For example, “my media 1”.

Various operating systems do not support special characters such as the following in a media label. For example,

:, !, @, #, $, %, ^, &, *, (, ), >, <, \, [, ], {, }, “, or ”)

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 (NVBU Media Management or NVBU Device Management windows).

3.3.1 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]

Options

-libraryname – Name of the target library that contains the media item to be blanked.

nvblankmedia nvlistmedia nvreusemedia nvbulkblankmedia nvloadmedia nvscanmedia

nvexportmedia nvmakemedia nvsyncronizesilomedia nvlabelmedia nvmediadetails nvupdateserialnumber nvlistblankmedia nvremovemedia

(39)

-barcode – Barcode number of the target media item.

-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, “my media 1”. If the media label is not unique for media in all available devices, then use this option with either -libraryname or -drivename.

-drivename – Name of standalone drive that contains the media item to be blanked.

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”. This library is locally attached to an NVBU Client named “NVCLIENT1”. nvblankmedia -servername NVCLIENT1 -slotspec 21::“NV_Library_Large”

Blank a piece of media labeled “DB-Backup” in the library “Lib-2”. This library is connected to an NVBU Client named “NVCLIENT2”.

nvblankmedia -libraryname "NVCLIENT2: Lib-2" -medialabel "DB-Backup"

(40)

3.3.2 nvbulkblankmedia

Performs bulk media blanking.

Syntax

nvbulkblankmedia -libraryname <Library Name> -medialabel <Media Label> [-allmedia] -password <Password> [-wait]

Options

-libraryname – Name of the library containing the media to be blanked. -medialabel – Common string that appears in the labels of all the media

items to be blanked.

-allmedia – Use this option to blank all media items in the specified library. -password – NVBU Administrator password required for the bulk media

blanking operation.

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.

Bulk blanking will remove all backup indexes for backups on the selected media from the NVBD.

This command will not work on NVBU Servers on which security is disabled The library name and media label are case sensitive.

The wild card character “*”, used to represent a series of characters, is supported by the -medialabel option

Examples

Bulk blank a series of media with the media label “Full Backup Group 7”. The media items reside in the library “ADICLib_1”

nvbulkblankmedia -libraryname ADICLib_1

(41)

3.3.3 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]

Options

-barcode – Barcode number of the target media item.

-medialabel – Media 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, “my media 1”.

3.3.4 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]

Options

(42)

-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, “my media 1”.

-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, “my_media_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, “my_media_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.

3.3.5 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>