FS
Documentation

Backup3G/Stacker/Man Pages

From Documentation

(Difference between revisions)
Jump to: navigation, search
Revision as of 04:41, 1 May 2006
Moff (Talk | contribs)

← Previous diff
Revision as of 04:58, 1 May 2006
Moff (Talk | contribs)
(stkrctrl)
Next diff →
Line 1: Line 1:
== stkrctrl == == stkrctrl ==
 +'''NAME'''
 +:stkrctrl - Load/unload media in a media library
 +
 +
 +'''SYNOPSIS'''
 +:<tt>stkrctrl [-i|-l|-u [-eRtVD] <media-device> <slot#> [<pos>]</tt>
 +
 +
 +'''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:
 +:::<tt>mt -f <tape-device> offline</tt>
 +
 +:;-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'''
 +:<tt>stkrctrl -l /dev/stkr4 28 2</tt>
 +::In library device /dev/stkr4, load the media from slot 28 into drive 2.
 +
 +:<tt>stkrctrl -u /dev/stkr4 17 1</tt>
 +::Unload the media from drive 1 into slot 17.
 +
 +:<tt>stkrctrl -a /dev/stkr4 10 2</tt>
 +::Move the media from import/export slot 2 into slot 10.
 +
 +:<tt>stkrctrl -re /dev/stkr4 15</tt>
 +::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'''
Line 5: Line 63:
<br> <br>
 +
== stkrinv == == stkrinv ==

Revision as of 04:58, 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

COPYRIGHT

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