HP StoreOnce Backup System CLI Reference Guide

vtl erase cartridge
Description of Command Function
Erases data on a cartridge from a given virtual tape library or erases all the cartridges from a
given library. This operation leaves the cartridge configuration intact.
Command Syntax
vtl erase cartridge [SETX] LIBX [{CARTX | ALL}] [barcode <string>] [mail
<num>] [ slot <num> ]
Command Authority
Administrator
Command Object Requirements
• SET X – This object defines the service set containing the virtual tape library from which
cartridges is deleted. X is the numeric index of the service set. This object must be defined
when the are command is used on a multi-node system. The use of this object is optional on
a single-node system. If it is used on a single-node system, the object must be defined as SET1.
• LIB X – This object is the virtual tape library from which the cartridges are deleted. X is the
numeric index of the library.
• CART X – The optional object defines the virtual cartridge erased by the command. X is a
numeric index which uniquely defines the cartridge. Instead of this object, the global default
ALL may be used. If ALL is used, all the cartridges in the defined virtual library are erased.
If the object is not defined, another parameter must be used to define the cartridge to be
deleted.
Command Parameter Requirements
• barcode – This optional is parameter defines the barcode label of the cartridge to be erased.
The value is a character string which must match a barcode label of a cartridge in the virtual
library defined by LIBX. If this parameter is not defined, another parameter must be used to
define the cartridge to be erased from the virtual library.
• mail – This optional parameter defines the mail slot location of the cartridge to be erased. The
value is a number which must match a mail slot location which contains a cartridge in the
virtual library defined by LIBX. If this parameter is not defined, another parameter must be
used to define the cartridge to be erased from the virtual library.
• slot – This optional parameter defines the slot location of the cartridge to be erased. The value
is a number which must match a slot location which contains a cartridge in the virtual library
defined by LIBX. If this parameter is not defined, another parameter must be used to define
the cartridge to be erased from the virtual library.
Requirements for Command Execution
• The command entry must conform to command syntax.
• The defined service set must be valid.
• The defined library must be valid.
• A cartridge object or location parameter must be included in the command sequence.
• If a cartridge object is defined, it must exist.
• If a mail slot or regular slot is defined, they must be valid.
• If a mail slot or regular slot is defined, a cartridge must exist in the slot.
• The barcode must be valid and meet library barcode parameters.
• If a barcode string is defined, a cartridge must exist in the library with that barcode.
• No slots in the range can be replication targets.
vtl erase cartridge 233