HP StoreOnce Backup System CLI Reference Guide

vtl create cartridge
Description of Command Function
Adds a cartridge to an existing virtual tape library.
Command Syntax
vtl create cartridge [SETX ] LIBX {ALL|slot <number>|mail <number>}
[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 object defines the service set containing the virtual tape library into which the
cartridge is added. 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 into which the drive is added. X is the
numeric index of the library.
• CART X – This object is not used within the command sequence. It represents the virtual cartridge
created by the command. X is a numeric index.
Command Parameter Requirements
• ALL – This global default is optional. If used, a cartridge is created in every empty slot within
the virtual tape library. Either this global default, the slot parameter, or the mail parameter
must exist in the command sequence.
• slot – This parameter defines the slot into which the cartridge is added after creation. The
value for this parameter consists of an integer corresponding to an empty slot location in the
virtual tape library defined by this command. The slot value assigned to parameter must exist
within the library to which the cartridge is being added. Either this global default, the slot
parameter, or the mail parameter must exist in the command sequence.
• mail – This parameter defines the mail slot into which the cartridge is added after creation.
The value is an integer corresponding to an empty mail slot location in the virtual tape library
defined by this command. Either this global default, the slot parameter, or the mail parameter
must exist in the command sequence.
• WriteProtect – This optional parameter defines if data can only be read from cartridge. The
value is either yes or no. If not included, a default value of no is used.
◦ Yes – data cannot be written to the cartridge
◦ No – data can be written to the cartridge.
• barcode – This optional parameter consists of a string of characters defining the barcode on
the cartridges created by this command. The string of characters must conform to the barcode
parameters defined for the library into which the cartridge is being added and must not match
any existing barcode in the library. If not included, a unique barcode string is created
automatically according to the virtual library barcode template. The parameter cannot be
used when the global default ALL is used to create cartridges in the empty slots.
• CartSize – This optional parameter defines the size in GB of the cartridges to be created in
the virtual library by this command. The values are defined in the Command Syntax. If not
included, the default value is that defined by the library emulation parameter value.
vtl create cartridge 217