Skip Headers
Oracle Hierarchical Storage Manager and QFS Software Command Reference
Section 1m: Maintenance Commands
Release 6.1.1
E70305-03

NAME

samset - Change the StorageTek QFS or Oracle HSM environment

SYNOPSIS

samset [keyword [parameter…]]

AVAILABILITY

SUNWsamfs

DESCRIPTION

samset is used to change or display variables that control StorageTek QFS or Oracle HSM operation. Without any arguments, samset displays current settings to stdout. If samset is executed with a keyword but with no parameter…, then the current value for just that keyword is displayed to stdout.

The keywords all have values assigned to them at startup. These values come from the defaults.conf file. samset allows you to change keywords while sam-fsd is running. Any changes made remain effective only during the current instance of sam-fsd; values revert to the defaults in defaults.conf at the next startup.

The following keywords are supported:

attended yes | attended no

attended tells the StorageTek QFS or Oracle HSM library daemon if an operator is available to manually mount media. Regardless of the attended setting, requests for media which are mounted in a drive, or present in a media changer, will be satisfied as soon as possible. attended affects the behavior of StorageTek QFS or Oracle HSM library daemon when a medium is requested which is not currently present in either a manually mounted drive, or in a library. The usual action taken by the library daemon when such a request occurs is to place it into the preview display (see samu (1m)), and await manual intervention (but see stale_time, below). However, if either attended is set to no, or the medium is marked "unavailable" in the historian catalog, then the request will not go into the preview display, and will fail with an ESRCH error. If other archive copies are available, they will be tried. If no further copies are available, ENXIO will be returned to the requester.

exported_media +u eq… | exported_media -u eq…

This option controls the flagging of media exported (see export (1m)) from the listed libraries as unavailable (+u) or available (-u) in the historian's catalog. See attended, above, for the effect of this flag. The setting of the flag for a given medium may be changed after export using chmed.

idle_unload

This is the time (in seconds) that a media changer controlled device may be idle before the media in that device is unloaded. A value of zero will disable this feature.

labels label-option

This option applies only to barcode-reader equipped tape libraries.

The media daemon can obtain the tape label from the upper-cased characters of the tape's barcode. label-option may be: barcodes, to use the first six characters of the barcode as label; barcodes_low, to use the trailing six characters; or read, to disable barcode processing and to read the magnetic label from the tape.

When labels is set to barcodes or barcodes_low, any tape robotically mounted for a write operation that is write enabled, unlabeled, has never been mounted before, and has a readable barcode will have a magnetic label written before the write is started.

stale_time minutes

Sets the amount of time (in minutes) that a request for media will wait in the preview table before being canceled with an ETIME. The file system will react to an ETIME error in the same way as an ESRCH error (see attended, above).

timeout seconds

Sets the time (in seconds) that will be allowed to elapse between I∕O requests for direct access to removable media (see request (1)). If a process fails to issue the next I∕O to the device within this time, the device will be closed and, on the next I∕O, the process will receive an ETIME error. A value of 0 implies no timeout will occur.

debug

debug manipulates the debug∕trace flags within StorageTek QFS or Oracle HSM environments to produce expanded logging. Unless otherwise specified, the debug messages are logged to the syslog facility at the LOG_DEBUG priority. parameter… is a space separated list of flags. To set a flag, give its name. To clear a flag, give its name prefixed with a '-'. The flags are:

all

Turn on all debug flags (except trace_scsi and robot_delay).

none

Turn off all debug flags.

default

Set all debug flags to the default as defined by defaults.conf.

logging

File system requests to the daemons and the daemons response to the requests are logged to files. These files are used only by Oracle support.

debug

This is catch-all for messages that might be of interest but generally do not show a problem.

moves

Log move-media commands issued to media changers.

events

This should only be used by Oracle analysts to trace the flow of events used by the media changer daemons. These messages are coded and of little use in the field. These messages are logged to syslog at LOG_NOTICE priority.

timing

This setting has been replaced by the device log timing event devlog eq [ event …]. This is described in more detail under the devlog keyword.

od_range

For optical disk media, log the range of sectors allowed for writing.

labeling

Log the VSN, blocksize (for tape media only), and label date when a label is read from a medium following the media's being mounted. These messages are logged to syslog at LOG_INFO priority.

canceled

Log when the stage process detects a canceled stage request.

disp_scsi

Display the current SCSI cdb being executed by a device. This information is appended to any existing message. If the length of the existing message and the cdb would overflow the message area, the cdb is not displayed. The message area for a device can be viewed with samu (see samu (1m)) in the "s" or "r" displays.

messages

This is used by Oracle analysts to trace the flow of messages used by the media changer daemons. These messages are coded and of little use to customers. These messages are logged to syslog at LOG_NOTICE priority.

migkit

Log events connected with the StorageTek SAM Migration Toolkit.

mounts

Log media mount requests.

opens

Log open and close of removable media devices.

trace_scsi

This option may only be set by the super user through the samset command. It causes all scsi commands issued through the user_scsi interface to be written to a file named ∕tmp∕sam_scsi_trace_xx (where xx is the equipment number of either the media changer to which this device belongs or the device itself if it does not belong to a media changer.) The trace file is opened with O_APPEND and O_CREAT on the next I∕O to each device after this flag is set. It is closed when the option is cleared and the next I∕O to that device occurs. Oracle does not recommend running with this option for long periods. The format of the trace information is:

struct {
    int    eq;      ∕* equipment number *∕
    int    what;    ∕* 0 - issue, 1 - response *∕
    time_t now;     ∕* unix time *∕
    int    fd;      ∕* the fd the ioctl was issued on *∕
    char   cdb[16]; ∕* the cdb *∕
    char   sense[20]; ∕* returned sense(valid if what=1) *∕
  }cdb_trace;

Oracle does not recommend setting this option indiscriminately, as large output files are quickly produced.

stageall

This should be used only by Oracle analysts to trace stageall processing.

devlog eq [ event …]

devlog manipulates the device log event flags for device eq. eq is either an equipment number or "all"; if "all", then the flags are set or listed for all devices. These flags control which events get written to the device log files. [ event …] is a space separated list of event names. To set an event flag, give its name. To clear a flag, give its name prefixed with a '-'. The events are:

all

Turn on all events.

none

Turn off all events.

default

Set the event flags to the default which are: err, retry, syserr, and date.

detail

events which may be used to track the progress of operations.

err

Error messages.

label

Labeling operations.

mig

Migration toolkit messages.

msg

Thread∕process communication.

retry

Device operation retries.

syserr

System library errors.

time

Time device operations.

module

Include module name and source line in messages.

event

Include the event name in the message.

date

Include the date in the message.

tapealert eq [on|off|default]

tapealert allows the user to enable or disable support for device implemented TapeAlert.

eq

is either an equipment number or "all"; if "all", then the flags are set or listed for all devices.

on

Enable TapeAlert if the device supports it.

off

Disable requesting TapeAlert information from the device.

default

Return TapeAlert to the factory setting.

sef eq [on|off|default] interval

sef allows the user to enable or disable support for tape drive implemented Log Sense delivered via sysevents.

eq

is either an equipment number or "all"; if "all", then the flags are set or listed for all devices.

on

Enable requesting tape drive Log Sense sysevents if the drive supports it.

off

Disable requesting tape drive Log Sense sysevents.

default

Return tape drive Log Sense sysevents to the factory setting.

interval

Tape drive Log Sense polling interval in seconds. A value of 300 is a polling interval once every five minutes. A string value of "once" specifies one time just before media unload and is the default. A value of 3600 is a polling interval once every hour. The smallest polling interval is five minutes.

SEE ALSO

request (1), chmed (1m), export (1m), samu (1m), defaults.conf (4), mcf (4), tapealert (1m), sefsysevent (4).

NOTES

A complete description of SEF sysevents is in the Oracle HSM Documentation Library.