NAME

defaults.conf - Set default values for StorageTek QFS and Oracle HSM software

SYNOPSIS

∕etc∕opt∕SUNWsamfs∕defaults.conf

AVAILABILITY

SUNWqfs

SUNWsamfs

DESCRIPTION

The defaults configuration file allows the site to set certain default values within the StorageTek QFS Software and Oracle Hierarchical Storage Manager (Oracle HSM) environments. The defaults.conf file is read when sam-fsd is started. It may be changed at any time while sam-fsd is running. The changes will take place when sam-fsd is restarted, or sent the signal SIGHUP. Temporary changes to the environment values can be made using the samset (1m) command.

The defaults.conf file consists of directive lines that are separated into two sections, the environment variable section and the trace file control section.

Environment variables.

The commands for the environment section of the file consists of a list of keyword = value pairs that set site-definable defaults. All keyword and value entries are case-sensitive and must be entered as shown. Values can be either unquoted strings (if string values are expected) or integers in decimal (123), octal, (0123) or hex (0x123) format.

The keywords and their expected arguments are as follows:

attended = yes | no

If attended = yes, it is assumed that an operator is available to mount media that is not flagged as unavailable by the historian; the default is yes. If attended = no, any request for media known to the historian is rejected unless it is already mounted.

debug = options

Sets the default for the debug flags used by the StorageTek QFS and Oracle HSM daemons for logging messages. For options, specify a space-separated list of debug options from the list of possible options described on the samset (1m) man page. The default is logging.

devlog = eq_number [ event … ]

Manipulates the device log event flags for the device specified by Equipment Number eq_number. The eq_number must be either the keyword all (to specify all devices) or must match an Equipment Number from the mcf file.

The device log event flags control the events that get written to the device log files. For the list of possible event arguments, see the samset (1m) man page. To specify more than one event, separate the events in the list with space characters. The default is err retry syserr date.

dev_blksize = size

Specifies the default block size for tapes of type dev. For size, specify 16, 32, 64, 128, 256, 512, 1024, or 2048. The size value is multiplied by 1024 to arrive at the actual block size.

For information on supported dev arguments and for information on the default released block sizes for various media, see the mcf (4) man page.

The default is used when no size is specified or during automatic labeling when labels = barcodes has been specified. For information on how the default can be overridden when manually labeling a tape, see the tplabel (1m) man page.

dev_delay = seconds

Specifies the dismount time, in seconds, for device type dev. After a cartridge is loaded onto this device type, this time must elapse before the cartridge unloaded and another cartridge is loaded. By default, dev_delay = 30. For information on supported dev arguments, see the mcf (4) man page.

dev_position_timeout = seconds

Specifies the timeout value, in seconds, to be used during tape positioning for device type dev. During most tape positioning command processing (such as locate and space) this is the maximum amount of time to wait for the command to complete. For information on the default values, see the example file (∕opt∕SUNWsamfs∕examples∕defaults.conf) supplied with your software. Any device not in the example file defaults to 1800 seconds. For information on supported dev arguments, see the mcf (4) man page.

dev_unload = seconds

Specifies the unload wait time, in seconds, for device type dev. This is the amount of time that the library daemons wait after the device driver returns from a SCSI unload command. This interval gives the library time to eject the media, open the door, and perform other actions before the daemon commands the library to remove the media. The seconds specified should the longest time needed for the worst-case library configured. For information on the default values, see the example file (∕opt∕SUNWsamfs∕examples∕defaults.conf) supplied with your software. Any device not in the example file defaults to 0 seconds. For information on supported dev arguments, see the mcf (4) man page.

distio = off | on

Globally enables or disables the distributed tape IO feature as follows:

• If distio = off, SAM will not use distributed tape IO. All tape IO will be local to the MDS. The sam-datamoverd (4) daemon will not be started for any shared filesystems on this host. The default is off.

• If distio = on, for shared filesystems where this host is the MDS, SAM will use distributed tape IO against shared clients who also have distio = on. Only hosts running Solaris 11 can participate in distributed tape IO.

  The sam-datamoverd (4) daemon will be started for all shared filesystems on this host.

• For more information about the distributed tape IO feature, see the sam-datamoverd (4) man page.

dev_distio = off | on

Specifies whether distributed tape IO is enabled, for device type dev.

If the global distio parameter is enabled, then only device types that have dev_distio = on will participate in distributed tape IO.

This parameter allows the administrator to select device types that should or should not participate in distributed tape IO. By default only the ti (STK T10000) and li (LTO) are set to on, and all other devices are set to off.

div = on | verify | off

Enables or disables the DIV (Data Integrity and Validation) feature for all of the DIV capable device types.

• If div = off, the DIV feature is disabled. The default is off.

• If div = on, the DIV capable tape drives will use the DIV feature.

• If div = verify, the DIV capable tape drives will use the DIV feature and the archiver verifies the archive file (tarball) for DIV errors before the file inodes are updated.

dev_div = on | off

This option provides DIV control for a specific device type. If this option is used then the device types not set are disabled. Valid device types for dev are ti and li.

exported_media = value

Declares exported media to be available or unavailable to the historian, as follows:

• If exported_media = available, media exported from a library is considered to be available in the historian. The default is available.

• If exported_media = unavailable, media exported from a library is considered to be unavailable in the historian. Cartridges with this characteristic are not used by the archiver, stager, or other Oracle HSM tools. They are considered to reside outside of the Oracle HSM environment. This might be used, for example, for cartridges to be transported to offsite storage.

  For more information, see the historian (7) man page.

idle_unload = seconds

Specifies the time, in seconds, that a library-controlled device can be idle before the media in that device is unloaded. Specifying idle_unload = 0 disables this feature. By default, idle_unload = 600, which is 10 minutes.

shared_unload = seconds

Specifies the time, in seconds, that a shared library-controlled device can be idle before the media in that device is unloaded. A device is shared if it is used by more than one Oracle HSM server. For more information on shared devices see the stk (7) man page. Specifying shared_unload = 0 disables this feature. By default, shared_unload = 60, which is 60 seconds.

inodes

This keyword is still accepted for backward compatibility, but it has no effect. For more information, see the samfs.cmd (4) man page.

labels = mode

For tape libraries with bar code label readers, this keyword sets the tape label equal to the first or the last characters of the bar code label (uppercased). For mode, specify either barcodes, barcodes_low, or read, as follows:

• If labels = barcodes, the first part of the bar code is used as the label. Default.

• If labels = barcodes_low, the last part of bar code is used as the label.

• If labels = read, the label is read from the tape. If you wish to have the labels different from the barcodes on a library with a bar code label reader, you must set labels = read.

  When labels is set to barcodes or barcodes_low, a label is written to the tape before the write is enabled for any tape mounted for a write operation that is write enabled, unlabeled and has a readable bar code label.

log = facility

Sets the facility code used for issuing log messages. For information on the accepted facility types, see the syslog (3) man page. The default is LOG_LOCAL7.

oper_privileges = privilege

Adds privileges to the operator group. By default, members of the operator group do not have the privileges to perform the following tasks: media labeling, performing storage element movement actions, submitting full audit requests, changing a device state (except to ON a device), and clearing mount requests. To grant the privileges needed to perform those actions, specify one or more of the following privilege arguments.

privilege

Result

all

Grants all privileges in this list.

clear

Grants the ability to clear cartridge load requests.

fullaudit

Grants the ability to perform a full library audit.

label

Allows cartridge labeling.

slot

Allows mounting, unloading, and moving cartridges within a library.

state

Grants the ability to change the device state. Operator group members can ON devices regardless of this setting.

Use a space character between privilege arguments if specifying more than one.

operator = group

Specifies the name of the group that to be granted operational privileges within certain commands (chmed (1m), load (1m), samfsdump (1m), and samfsrestore (1m)) and command queues. Only one group name can be specified. Users must have their effective group IDs set to group in order to gain operational privileges.

optical = media_type

Sets the default media type to media_type when a generic optical disk (od) is requested. A string value is expected. For information on the accepted media types, see the mcf (4) man page. The default is mo.

previews = requests

Sets the number of outstanding mount requests. Care should be taken when changing this value. Each entry takes about 500 bytes of shared memory. By default, previews = 100.

samrpc = on | off

Invokes the RPC API server process. If samrpc = on, the RPC API server process, sam-rpcd, is automatically started when StorageTek QFS or Oracle HSM is started. By default, samrpc = off, so sam-rpcd is not started automatically.

remote_keepalive = seconds

Specifies the time in seconds the SAMremote server can be idle before a SAMremote client sends a packet to check for the existence of the server. By default, remote_keepalive = 300, which is five minutes. Specifying remote_keepalive = 0 disables the keepalive function.

alerts = on | off

Specifies whether alert notification via Simple Network Management Protocol (SNMP) or fault history logging via the GUI is supported. With this turned on, you can monitor a StorageTek QFS or Oracle HSM system remotely from a management console such as Remote Services (SRS) By default, alerts=on is in effect.

avail_timeout = seconds

Allows the stager to delay before unloading a volume being used to stage a file with the stage -n attribute set. This allows a subsequent stage request for this file to be processed in preference to a file requesting a different volume. Setting avail_timeout = 0 disables this function. By default, avail_timeout = 0.

stale_time = minutes

Sends an error to any request for removable media that has waited for minutes number of minutes. Setting stale_time = 0, disables this function. By default, stale_time = 30.

tape = media_type

Sets the default media type to media_type when a generic tape (tp) is requested. A string value is expected. For information on the accepted media types, see the mcf (4) man page. The default is lt.

timeout = seconds

Sets the timeout interval, in seconds, for direct access removable media. If a process fails to issue an I∕O request to the device within this time, the device is removed from job assignment and the process receives an ETIME when the next I∕O to the device commences. Specifying timeout = 0 disables this timeout. The minimum value allowed is timeout = 600. For backwards compatibility, values from 1 to 599 are allowed, but are overridden by the minimum value. By default, timeout = 600.

tp_mode = mode

Specifies the mode set for tape drive device nodes when not under control of the Oracle HSM software. For information, see the chmod (2) man page. When the Oracle HSM software is controlling the drive, the mode bits are 0660.

tapealert = eq_number on | off

Enables or disables media changer or tape drive TapeAlert support by Equipment Number eq_number. The eq_number must be either the keyword all (to specify all devices) or must match a tape device Equipment Number from the mcf file. By default, tapealert = all on.

sef = eq_number [on|off|default] interval

Enables or disables support for tape drive implemented Log Sense delivered via sysevents by Equipment Number eq_number. The eq_number must be either the keyword all (to specify all devices) or must match an Equipment Number from the mcf file. The interval specfies the log sense polling rate. 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. By default, sef = all on once.

Note: The defaults.conf sef entry only controls the equipment number and frequency interval for sef data. It is the presence or absence of the file ∕var∕opt∕SUNWsamfs∕sef∕sefdata at Oracle HSM initialization that determines if sef will run or not. When ∕var∕opt∕SUNWsamfs∕sef∕sefdata is present, sef will be initialized. You must create the sefdata file yourself. To turn off sef, the sefdata file must be removed or renamed.

tapeclean = eq_number autoclean [on|off] logsense [on|off]

Enable or disable the robot initiated auto-cleaning feature. Enable or disable additional auto-cleaning log sense cleaning indicators from the TapeAlert log sense page (2E) flags clean now(20), clean periodic(21) and expired cleaning media(23) and the Sequential-Access Device log sense page(0C) cleaning required flag in parameter(256). Support is by Equipment Number eq_number. The eq_number must be either the keyword all (to specify all devices) or must match a tape device Equipment Number from the mcf file. Note that the logsense on setting has no effect unless autoclean is also on. By default, tapeclean = all autoclean off logsense on. Note: When using the auto-cleaning feature with a library that has more than two drives, it is recommended that you have at least two cleaning cartridges per robot. If a cleaning cartridge is not available when a drive needs to be cleaned, the drive will be put into a down state.

ltfs = mount_point [ workers [ idle_timeout ] ]

Enable Oracle HSM Linear Tape File System (LTFS) support.

The mandatory mount_point parameter identifies the directory where the LTFS file system attaches to the host file system.

The optional workers parameter specifies the maximum number of drives that can mount LTFS tape volumes at any given time. The default is 1, the minimum is 1, and the maximum is 1024.

The optional idle_timeout parameter sets the time in seconds that a drive waits between finishing I∕O and unmounting a tape. The default is 30 seconds, the minimum is 15 seconds, and the maximum is 600 seconds (10 minutes).

To set either optional parameter to its default value, enter a hyphen (-).

Trace file controls.

The daemon trace files are controlled by directives in the trace file section. This section begins with the trace directive, and ends with the endtrace directive. The trace file control directives are of the form:

daemon_name . variable_name = value

daemon_name = on

daemon_name = off

daemon_name can be one of the following: sam-archiverd, sam-catserverd, sam-fsd, sam-rftd, sam-recycler, sam-sharefsd, sam-stagerd, sam-serverd, sam-clientd, sam-verifyd, sam-migrationd, sam-datamoverd, fsmgmt ",orall .

Note that fsmgmt is used by fsmgmtd and libfsmgmt.so.

If daemon_name is all, then the variable_name is set to value for all daemons.

For the form: daemon_name = on the trace file controls will be set to the pre-defined values for daemon_name.

In particular, using only the directive

all = on

enables tracing for all daemons. The trace files are written to files named for the daemons (e.g. sam-rftd) in the ∕var∕opt∕SUNWsamfs∕trace subdirectory.

For the form: daemon_name = off tracing will be turned off for daemon_name.

The variable_name is one of: file, options, age, or size.

daemon_name

set the name of the trace file to file_name. The default is no trace file.

If the daemon_name is all, then file_name is the name of the trace subdirectory that will contain the daemon tracefiles. file_name must be absolute in this case. The default subdirectory is ∕var∕opt∕SUNWsamfs∕trace.

If file_name is relative (no leading '∕'), the file name will be made relative to the trace base directory. If the file does not exist, sam-fsd will create it.

daemon_name .options = option_list

Set the trace file options to option_list. option_list is a space separated list of trace options. A trace option is an event to trace, or an element to include in the trace line. To exclude an option, prefix the option with a '-'.

For selecting events, option may be one or more of:

none

Clear all event types.

all

Set event types for tracing the most interesting events. These are: cust err fatal ipc misc proc rft.

alloc

Memory allocations.

cust

Customer notification syslog or notify file messages.

err

Non-fatal program errors.

fatal

Fatal syslog messages.

files

File actions.

rft

File transfer events.

ipc

Inter process communication.

misc

Miscellaneous.

oprmsg

Operator messages.

proc

Process initiation and completion.

queue

Archiver queue contents when changed.

For selecting message elements, option may be one or more of:

date

Include the date in message (the time is always included).

module

Include source file name and line number in message.

type

Include event type in message.

The pre-defined events are: cust, err, fatal, misc, proc, rft. The message elements program[pid] and time are always included and can't be deselected.

daemon_name .age = age

Set the time between trace file rotations to age. age may be specified with the suffixes 's', 'm', 'h', 'd', 'w' and 'y', for seconds, minutes, hours, days, weeks and years. Note: Do not set this value to two minutes or less. If you do, the rotation will never take place. sam-fsd can perform trace file "rotations" using the script ∕opt∕SUNWsamfs∕sbin∕trace_rotate. Trace file rotations are useful to control the size of trace files.

daemon_name .size = size

Set the trace file size at which trace file rotations will be performed. size may be specified with the suffices 'b', 'k', 'M', 'G', and 'T', for bytes, kilobytes, megabytes, gigabytes, and terabytes.

EXAMPLES

Here is a sample defaults.conf configuration file.

optical = mo
debug = logging debug timing
tape = lt
log = LOG_LOCAL7
timeout = 30
idle_unload = 600
tp_mode = 0666
rc_delay = 10
cy_delay = 10
ml_delay = 10
hp_delay = 10
ds_delay = 10
lt_unload = 7
st_unload = 15
lt_blksize = 16
operator = sam
oper_privileges = label slot
trace
all = on		# Turn on tracing for all daemons
sam-archiverd.size = 10M # Rotate archiver trace file after 10 megabytes
sam-rftdsam-recycler = off  # Turn off tracing for sam-recycler daemon
endtrace

FILES

∕opt∕SUNWsamfs∕examples∕defaults.conf

Contains an example of a defaults.conf file.

SEE ALSO

request (1).

sam-datamoverd (1m), sam-fsd (1m), sam-verifyd (1m), samset (1m), tapealert (1m), tplabel (1m).

chmod (2).

syslog (3).

mcf (4), samfs.cmd (4), trace_rotate (4), sefsysevent (4).

historian (7), ltfs (7).