HP StoreOnce Backup System CLI Reference Guide

vtl modify cartridge
Description of Command Function
Modifies the parameters of an existing cartridge.
Command Syntax
vtl modify cartridge [SETX] LIBX [{CARTX|ALL}] [slot <num>] [WriteProtect
{yes|no}] [barcode <string>] [CartSize
{10|25|50|100|200|400|800|1000|1200|1400|1600|3200}]
Command Authority
Administrator
Command Object Requirements
• SET X – This required object defines the service set containing the virtual tape library that
contains the cartridge to be modified. X is the numeric index of the service set. It is optional
on a single-node system but must be defined on a multi-node system. If used on a single-node
system, the object must be defined as SET1.
• LIB X – This required object is the virtual tape library that contains the cartridge to be modified.
X is the numeric index of the library.
NOTE: This is the library object name, not the user-defined name of the library. Locate the
LIBX object name for a library using the vtl show library list command (see “vtl show
library list” (page 260) for more information).
• CART X – This optional object is the cartridge to be modified. X is a numeric index which
uniquely defines the cartridge. If not defined, the cartridge to be modified must be defined
by the slot parameter.
Command Parameter Requirements
• slot – This optional parameter defines the slot in which the cartridge to be modified is located.
The value for this parameter consists of an integer corresponding to the slot location in the
virtual tape library. If not defined, the cartridge to be modified must be defined by the CARTX
object or the global default ALL.
• WriteProtect – This optional parameter determines if data can only be read from the cartridge.
The value is either yes or no. Yes indicates that data cannot be written to the cartridge, and
no indicates that data can be written to the cartridge. If not included, the current value remains
unchanged.
• barcode – This optional parameter consists of a string of characters defining the new barcode
to replace the existing barcode on the cartridge. The barcode string must conform to the
barcode parameter of the virtual tape library containing the cartridge. If not included, the
current value remains unchanged. The parameter cannot be used when the global default
ALL is used to define all the cartridges in the library.
• CartSize – This optional parameter defines the size in GB to which the cartridges is modified.
The values are defined in the Command Syntax. If not included, the current value remains
unchanged. If the cartridges to be modified contain more user data than the defined cartridge
size, an error is generated.
Requirements for Command Execution
• The command entry must conform to command syntax.
• All object values must be valid. See object requirements for details.
• All parameter values must be valid. See parameter requirements for details.
vtl modify cartridge 237