Backup3G/Stacker/Man Pages

From Documentation

Revision as of 07:30, 1 May 2006

stkrctrl

NAME

stkrctrl - Load/unload media in a media library

SYNOPSIS

stkrctrl [-i|-l|-u [-eRtVD] <media-device> <slot#> [<pos>]

DESCRIPTION

Stkrctrl moves media within a media library device, loads and unloads media to/from drives within the device, and if the hardware supports it, adds and removes mediato/from the library via a letter-box slot or other user-accessible slots, sometimes referred to as CAPs (cartridge access positions) or import/export slots.

A library device usually has 3 classes of media location:

• Standard slots within the media library;
• Drives;
• (optionally) import/export slots.

Although the hardware uses unique hardware-dependent addresses for the above, stkrctrl maps each of the above classes to a numeric address starting from 1. Thus to address the 3rd drive, you should specify <pos> as 3, and the 24th slot as 24. If <pos> is omitted, it defaults to 1.

OPTIONS

-i

Display information about the library device only - do not do any movements. Information displayed includes the number of slots and drives in the library.

-l

Load the media from slot <slot#> into drive <pos>.

-u

Unload the media from drive <pos> into slot <slot#>. Note that depending on the type of media drive in use, the media may have to be ejected from the drive prior to this operation. Typically this is done using the command:

mt -f <tape-device> offline

-a

Add a media to the lirary by moving it from external (import/export) slot <pos> to library slot <slot#>.

-r

Remove a media from the library by moving it from library slot <slot#> to external (import/export) slot <pos>.

-e

Certain devices with import/export slots have a special arm which must be retracted when adding a new media (-a) and extended when removing a tape (-r) to/from the library. This option causes this to happen, and can only be used with the -a or -r options.

-R

Use "raw" (hardware) slot and drive addresses. Only for use if the library doesn't support the "mode sense" SCSI command, or if this command returns incorrect information. Use the -i option to test for this.

-t <address>

For use with the -R option. This specifies the transport element address (the address of the robotic arm).

-V

Turn on verbose mode, causing more messages and status to be displayed.

-D

Turn on debug mode. Sometimes useful when installing a new library.

EXAMPLES

stkrctrl -l /dev/stkr4 28 2

In library device /dev/stkr4, load the media from slot 28 into drive 2.

stkrctrl -u /dev/stkr4 17 1

Unload the media from drive 1 into slot 17.

stkrctrl -a /dev/stkr4 10 2

Move the media from import/export slot 2 into slot 10.

stkrctrl -re /dev/stkr4 15

Move the media in slot 15 to import/export slot 1. Then extend the import/export arm to cause the media to be pushed out of the letter-box slot.

SEE ALSO

stkrinv(1)

COPYRIGHT

Copyright © 1990-2006 Functional Software. All rights reserved.

stkrinv

NAME

stkrinv - Inquire about the inventory in a SCSI media library

SYNOPSIS

stkrinv [-d|-e] [-bEfinRVD1] <stkr-device> [<pos>]

DESCRIPTION

Stkrinv returns information about the inventory in a SCSI library device. It can be used to:

• Return the barcode(s)on one or more tapes (where supported by the hardware);
• Determine which slots are free or occupied;
• Determine which import/export slots are free or occupied;

OPTIONS

-b

Suppress returning the barcode of the media. This is mandatory if the hardware does not support barcodes.

-d

Scan the tape drives for media instead of the library slots. Note that not all hardware can support this option.

-e

Scan the import/export slots instead of the library slots.

-E

Display the empty slots only.

-f

Full scan. Examine all the slots of the selected class (slot, import/export or drive).

-i

Issue an "Initialize element status" SCSI command. Many library devices with barcode support require this to perform the physical barcode scanning.

-n <num>

Examine the specified number of slots starting from position <pos>.

-R

Indicates that <pos> is a "raw" (hardware) address.

-V

Turn on verbose mode, causing more messages and status to be displayed.

-D

Turn on debug mode. Sometimes useful when installing a new library.

-1

Stop after the first slot found. For use with -f or -n only. This is useful to search for the first occupied or free slot.

Unless the -R flag is specified, <pos> refers to either a slot number, drive position (with -d), or import/export slot number (with -e), each of which are numeric positions starting from 1. It defaults to 1 if omitted.

When either -f or -n is used, a list of slot numbers is written to STDOUT, one per line. If barcodes are requested (-b is not specified) and they are available, they are written to the right of the slot number. Stkrinv returns exit status 1 if no appropriate slots are found, or an error occurs and 0 otherwise.

EXAMPLES

stkrinv /dev/stkr4 12

Displays the barcode of the tape in slot 12.

stkrinv -b /dev/stkr4 12

Tests whether slot 12 is occupied. Returns status 0 if occupied, 1 if empty.

stkrinv -E /dev/stkr4 12

Tests whether slot 12 is empty.

stkrinv -f /dev/stkr4

Does a full inventory of the slots in the stacker, returning a list of the slot number and barcode for each occupied slot.

stkrinv -n5 /dev/stkr4 10

As above, but only examines slots 10 through 14.

stkrinv -Ebf /dev/stkr4

Returns a list of free slot numbers, one per line.

stkrinv -fb1 /dev/stkr4

Returns the first occupied slot number.

stkrinv -Efeb1 /dev/stkr4

Returns the first slot number of a free import/export slot.

SEE ALSO

stkrctrl(1)

COPYRIGHT

Copyright © 1990-2006 Functional Software. All rights reserved.