stk - The StorageTek interface through ACSAPI
SUNWsamfs
stk
is the StorageTek QFS and Oracle HSM interface to the StorageTek libraries.
This interface utilizes the ACSAPI interface supplied by StorageTek.
The Oracle HSM software package installs the libraries and daemons
for the client side of the API.
For more information on ACSAPI and interfacing the StorageTek libraries, see
the documentation supplied with the StorageTek hardware and server side daemons.
It is assumed that the site has the server daemons (CSI and ACSLM) configured and operating with the StorageTek library.
The Equipment Identifier
field in the mcf
file, (see mcf
(4)),
is the full path name to a parameters file used by stk
. This file
consists of keyword = value and path_name = value pairs.
All keyword, path_name, and value entries are case-sensitive.
The keywords are:
access
This is the user_id used by this client for access control. If this parameter is not supplied, the access control string will be a null string (no user_id).
hostname
This is the hostname for the server that is running ACSLS. If the hostname is not supplied, the default will be localhost. All sites should set this value.
ssihost
This is the name used for the Oracle HSM server when a multihomed Oracle HSM server is used. The ssihost would be the name of the Oracle HSM server on the lan connecting to the ACSLS host. Only sites where a multihomed Oracle HSM server is used need to supply an ssihost value. The default will be localhost.
portnum
This is the portnum for SSI services on the server that is running ACSLS.
If the port number is not supplied, the default is 50004. Please note
that if you are running co-hosted ACSLS 5.3 or higher, the default value does
not work (try a higher port number, like 50014). If you are running multiple
connections to ACSLS servers, then the port number for each stk
configuration
file needs to be unique (for example, 50014 in one, 50015 in the next, etc.).
ssi_inet_port
This is the fixed port number for incoming responses and specifies the port the SSI will use for incoming ACSLS responses in a firewall environment. Valid values are 1024 - 65535, and 0. Setting this environmental variable to a non-zero value makes the SSI use this port for incoming ACSLS responses. This means that the firewall needs to allow incoming requests on that port in order for the ACSLS responses to be received by the SSI. Setting this value to zero or leaving it unset indicates that the previous behavior of allowing the port to be dynamically allocated will remain in effect.
csi_hostport
This firewall environmental variable specifies the port to which the SSI will send its ACSLS requests on the ACSLS server. Setting this variable eliminate queries to the portmapper on the ACSLS server and instead, sends requests to this port on the ACSLS server. Valid values are 1024 - 65535, and 0. Setting this variable to zero or leaving it unset indicates that the previous behavior of querying the portmapper on the ACSLS server will continue to be used.
capid
This specifies the CAP (Cartridge Access Port) to be used for exporting of volumes when the -f option is used with export command. Following the capid is the description of this CAP in terms of the StorageTek library. This description starts with an open parenthesis followed by 3 keyword = value pairs followed by a close parenthesis. The keyword = value pairs between the parentheses may be separated by a comma (,), a colon (:) or by white space.
acs
is the ACS number for this CAP as configured in the StorageTek library.
lsm
is the LSM number for this CAP as configured in the StorageTek library.
cap
is the CAP number for this CAP as configured in the StorageTek library.
capacity
This is used to set the capacity of the media supported by the StorageTek.
The parameter to capacity
is a comma separated list of
index = value pairs enclosed in parentheses. index is the index into
the media_type file (supplied by StorageTek and located on the ACS system)
and value is the capacity of that media type in units of 1024 bytes.
You should only need to supply this entry if the ACS is not returning the
correct media type or new media types have been added.
StorageTek QFS and Oracle HSM have defaults
for index values that were current at the time of release.
Generally, it is necessary to supply an index only for new
cartridge types. For the capacity of each cartridge type, see
the Oracle HSM Documentation Library.
There is one device_path_name entry
for every drive attached to this client. The device_path_name is the
path to the device on the client.
This name must match the Equipment Identifier of an
entry in the mcf
file.
Following the device_path_name is the description of this drive
in terms of the StorageTek library. This description starts with an open parenthesis
followed by 4 keyword = value pairs followed by a close parenthesis.
The keyword = value pairs between the parentheses may be separated
by a comma (,), a colon (:) or by white space. Following the close parenthesis
is an optional keyword used by StorageTek QFS and Oracle HSM software to designate
when a drive is shared with other StorageTek QFS and Oracle HSM servers.
The keyword identifiers and their meanings are as follows:
acs
is the ACS number for this drive as configured in the StorageTek library.
lsm
is the LSM number for this drive as configured in the StorageTek library.
panel
is the PANEL number for this drive as configured in the StorageTek library.
drive
is the DRIVE number for this drive as configured in the StorageTek library.
shared
The shared keyword follows the close parenthesis. This keyword is optional and is used to indicate the drive is shared with other StorageTek QFS and Oracle HSM servers.
Here is a sample parameters file and mcf
entries
for a StorageTek library:
# # This is file: ∕etc∕opt∕SUNWsamfs∕stk50 # hostname = acsls_server_name portnum = 50004 ssi_inet_port = 0 csi_hostport = 0 access = some_user # No white space allowed in the user_id field capid = (acs=0, lsm=1, cap=0) ∕dev∕rmt∕0cbn = (acs=0, lsm=1, panel=0, drive=1) #a comment ∕dev∕rmt∕1cbn = (acs=0, lsm=1, panel=0, drive=2) shared #a comment capacity = (0=215040, 1=819200, 5=10485760)
The mcf
file entries that reference this configuration file are:
# # Sample mcf file entries for a StorageTek library # ∕etc∕opt∕SUNWsamfs∕stk50 50 sk sk50 - ∕var∕opt∕SUNWsamfs∕catalog∕sk50 ∕dev∕rmt∕0cbn 51 st sk50 - ∕dev∕rmt∕1cbn 52 st sk50 -
import∕export
commands and GUI buttons will only
affect the library catalog. The import
command has optional
parameters for supplying a single volume to be added or to add a number of
volumes from a pool
(see import
(1m)).
export
(see
export
(1m)) will remove an entry from the catalog.
The StorageTek QFS and Oracle HSM systems automatically build a library catalog for a StorageTek automated library. However, you must populate the library catalog. For information on populating the library catalog, see the Oracle HSM Documentation Library.
To aid in communication issues between the STK ACSLS server and
this client, change into a writable directory where two files are
written; event.log
and \fbtrace.log.
Then start the ∕opt∕SUNWsamfs∕sbin∕mini_el
daemon. After the
daemon has started, send a SIGUSR1
signal to the ssi_so
process. Use ∕opt∕SUNWsamfs∕sbin∕trace_decode
trace.log to
decode the trace file.
mcf
The configuration file for the StorageTek QFS and Oracle HSM software.
∕etc∕opt∕SUNWsamfs∕scripts∕ssi.sh
A shell script used to start ssi_so
.
∕opt∕SUNWsamfs∕sbin∕ssi_so
A shared object version of the SSI daemon supplied by StorageTek.
∕opt∕SUNWsamfs∕lib∕stk∕*
The libraries needed by the API interface supplied by StorageTek.
∕opt∕SUNWsamfs∕sbin∕stk_helper
A program to issue commands for the StorageTek ACSAPI
build_cat
(1m),
dump_cat
(1m),
export
(1m),
import
(1m),
sam-robotsd
(1m).
Oracle HSM Documentation Library