The tmf.config(5) man page is provided below for your reference during the initial system startup. The EXAMPLES section, shown in Example 2-1, is omitted.
For information on displaying and printing the tmf.config(5) page once your system is running, see Appendix A, “Man Page List”.
mf.config(5) Last changed: 10-27-99
NAME
tmf.config - TMF configuration file
IMPLEMENTATION
SGI IRIX systems licensed for the Tape Management Facility (TMF)
DESCRIPTION
The system uses a Tape Management Facility (TMF) configuration file
named tmf.config in the/etc/config directory. This file defines all
of the tape devices that the system uses.
The TMF configuration file consists of comments (optional) and
statements. A comment begins with the # symbol and continues to the
end of line. A statement consists of a name followed by a list of
keyword parameters. There are four statements; one of these
statements also consists of substatements. Statements must be in the
order shown:
1. LOADER statements (one per loader)
2. DEVICE_GROUP statements (one per device group)
3. AUTOCONFIG statement (one per system)
The AUTOCONFIG statement consists of DEVICE statements.
DEVICE statements (one per device)
DEVICE statements define devices that TMF will control and
that are automatically configured during the system boot.
4. OPTIONS statement (one per system)
Statement Syntax Rules
The following syntax rules apply to tmf.config statements:
* The statement name and its parameters are separated by one or more
white spaces (blank, tab, or newline characters).
* Adjacent parameters are separated by a comma.
* The end of the parameter list is indicated by the absence of a
comma.
* Adjacent statements are separated by one or more white spaces.
The following is a list of keyword parameter syntax rules:
* The keyword is separated from its value by the = symbol.
* The value of a keyword may consist of keywords, numbers, character
strings, and lists of keywords, numbers, and character strings.
* If the value of a keyword is a list, the list is enclosed within
left and right parentheses. Adjacent elements of a list are
separated by a comma. If the list consists of one element, you do
not have to enclose it in parentheses. The elements of a list may
be lists.
* Numbers may be specified in decimal, octal, and hexadecimal formats.
These formats are the same as those used in the C programming
language:
Decimal First digit is not 0 (1372)
Octal First digit is 0 (0563)
Hexadecimal First 2 characters are either 0x or 0X (0xf2)
* Character strings are series of characters. If any one of the
special characters (white space, ", #, =, {, }, (, ), ', \ ) is
needed in the string, you must enclose the string in a pair of
double quotation marks ("). Within a pair of double quotation
marks, the sequence of characters will be replaced by x; x is any
character. This is the only way you can specify a " and a \ in a
quoted string.
* Comments may appear between any symbols described previously.
You can code the names of statements and keywords in a mixture of
uppercase and lowercase letters. The values specified by the user is
case sensitive. The following specify the same thing:
Name = A
name = A
The following are different:
name = A
name = a
The following are descriptions of the tape configuration statements.
You must specify a value for each parameter unless a default is
specified or the parameter is described as optional.
LOADER Statement
The LOADER statement identifies the loaders in the tmf.config file and
has the following format:
LOADER parameter_list
A description of the parameters follows:
Parameter Description
loader_ring_status = status Specifies whether the loader
is alerted to ring status.
ALERT Alerts loader
to the ring
status when a
tape is
mounted, and
checks that the
ring status
matches the
ring status
requested by
the tape user.
IGNORE Ignores the
ring status
when a tape is
mounted. A
logical ring
out status is
used for a tape
that has been
requested with
a ring out
status, but its
actual ring
status is ring
in. The
default is
ALERT.
message_path_to_loader = path Specifies the message path to
the servicing loader.
MSGDAEMON Uses message
daemon to send
message to
loader.
NETWORK Uses TCP/IP
protocol to
send message to
loader.
message_route_masks = location Routes mount request messages.
You can route the mount
request message to multiple
locations. The list may
consist of the following:
FRONTEND Issues the
mount message
to the front
end that may be
reached through
a TPC/IP
connection.
SERVER Issues the
mount message
to the server
station.
IRIX Issues the
mount message
to the message
daemon. For
more
information,
see
msgdaemon(8).
mode = value Specifies attended mode:
ATTENDED Prompts for
operator
intervention.
UNATTENDED Assumes
negative
response for
operator
intervention.
name = name Specifies the loader name,
which is the object of several
tmconfig(8) requests.
network_retry_tries = number Specifies the number of times
the TMF loader child program
attempts to send a request
over the network to the server
after an initial attempt
fails. The default for each
child program is 5.
network_send_timeout = number Specifies the time in seconds
during which the TMF loader
child program tries to send a
request over the network to
the server. The default for
each child program is 3
seconds.
ov_tmf_application_name = tmf_application_name
Specifies the OpenVault
application name for TMF. The
default is tmf.
ov_tmf_keyfile = keyfile_path_name Specifies the pathname of the
OpenVault key file for TMF.
You specify this parameter
only if your site is using the
OpenVault security key.
The key file specifies the
security key for TMF when it
initiates a session with
OpenVault.
For example, if OpenVault is
running on citron, the
application name of TMF is tmf
and the security key is
Zyh3wi, the key file contains
the following line:
citron tmf * CAPI Zyh3w
For more information on the
key file and security key, see
the OpenVault Operator's and
Administrator's Guide.
queue_time = seconds Each volume has a designated
"best" loader type for the
tape mount. If the best
loader is not available, this
time is used to queue the tape
mount request and to wait for
the best loader to become
available. If the best loader
does not become available
during this time, the mount
request will be issued to the
next best loader.
A value of 0 indicates to wait
up to 24 hours; a nonzero
value specifies the number of
seconds to wait.
return_host = host_name Specifies the name of the IRIX
host that serves as the return
address for the server. This
parameter is only used if it
is set; there is no default.
scratch_volume_label_type = scratch_type
Specifies the types of scratch
requests that the loader may
process. If you specify
OPERATOR for the type
parameter on the LOADER
statement, the following types
of scratch requests are
available. If you specify any
other loader type for the type
parameter, only NONE is valid.
AL ANSI labeled scratch
tape requests.
NL Nonlabeled scratch
tape requests.
NONE Scratch labels
cannot be used.
SL IBM standard labeled
scratch requests.
server = server_name Specifies the server name.
If you specify OPENVAULT as
type, the server name is the
name of the host where
OpenVault is running.
server_reply_wait_time = number Specifies the time in seconds
during which a request that is
being processed by the server
is kept in a queue by the TMF
loader child program. If a
reply has not been received
within this time, the child
program queries the state of
the outstanding request.
The default value for each
child program is 180 seconds.
For a StorageTek library, this
value is multiplied by the
number of Library Storage
Modules in the Automated
Cartridge System.
status = status Specifies the status (UP or
DOWN) of the loader when TMF
starts.
type = type Specifies the loader type.
Currently, supported types are
as follows:
EMASS An EMASS Grau
library running
VolServ is
used.
IBMTLD IBM 3494 Tape
Library
Dataserver is
used.
OPERATOR Operator loads
the drive.
STKACS A StorageTek
library that is
supported by a
SGI system
running the
IRIX operating
system is used.
OPENVAULT OpenVault, a
storage library
management
facility, is
used.
You must specify at least one
OPERATOR type loader in the
TMF configuration file. If
the file does not contain such
an entity, TMF in its
initialization process creates
one assuming the following
values:
LOADER
name = Operator ,
type = OPERATOR ,
status = UP ,
message_PATH_TO_LOADER = MSGDAEMON ,
server = "" ,
scratch_volume_label_type = NONE ,
queue_time = 1 ,
verify_non_label_vsn = YES ,
message_route_masks = IRIX ,
mode = ATTENDED ,
return_host = ""
verify_non_label_vsn = value Specifies whether the nonlabel
VSN should be verified. value
may be either YES or NO.
DEVICE_GROUP Statement
The DEVICE_GROUP statement has the following format:
DEVICE_GROUP parameter_list
A description of the parameters follows:
Parameter Description
avr = value Specifies whether this device
group uses the automatic
volume recognition (AVR)
feature of TMF. To do so, the
device group must be
associated with the OPERATOR
type in the LOADER statement.
This optional parameter may be
either YES or NO; omission
implies NO.
name = name Specifies the device group
name.
overcommit = value Specifies whether this device
group uses the overcommit
feature. This optional
parameter may be either YES or
NO; omission implies NO.
AUTOCONFIG Statement
The AUTOCONFIG statement is made up of DEVICE statements, one for each
device in the system.
DEVICE Statement
The DEVICE statement specifies the characteristics of a device and has
the following format:
DEVICE parameter_list
A description of the parameters follows:
Parameter Description
device_group_name = device_group_name Specifies the name of the
device group defined by a
DEVICE_GROUP statement.
file = file Specifies the path name of the
device specific file.
loader = loader Specifies the loader name
defined in a LOADER statement.
name = name Specifies the device name.
status = status Specifies the initial status
(UP or DOWN) of the device.
vendor_address = vendor_address Specifies the vendor address
of the drive in a library.
The format for a StorageTek
drive is as follow:
acs#,lsm#,panel#,drive#
The format for an EMASS Grau
VolServ drive is as follows:
drive#
OPTIONS Statement
The options in force when TMF is built are specified in the
/usr/include/tmf/tmfdefaults.h file. You can specify most of these
options in the OPTIONS section of the tmf.config file.
To override the value with which TMF was built, specify the following
options and their corresponding values. The options that you can
specify in the tmf.config file with the OPTIONS statement are similar
to the options in tmfdefaults.h, but not identical. Values are often
given in a different form in the two files (for example, the value for
the ask_blp keyword is expressed as 0 or 1 in tmfdefaults.h, but it is
expressed as YES or NO in tmf.config).
The format of the OPTIONS statement follows:
OPTIONS parameter_list
The following parameter list includes valid values or brief
definitions of the options.
Parameter Description
ask_label_switch = value Seeks permission (YES or
NO) from the operator to
switch label type.
Default: YES
ask_vsn = value Seeks permission (YES or
NO) from the operator to
specify a VSN when a
nonlabel tape is mounted.
Default: YES
blp_ring_status = value Specifies the user status
for the use of the -r
option of the tmmnt(1)
command when the user
requests bypass label
processing. UNRESTRICTED
specifies the user can
use both -r in and -r
out. OUT specifies the
user can use only -r out.
Default: UNRESTRICTED.
blocksize = size Specifies the maximum
block size to use when
the user does not specify
a maximum block size by
using the tmmnt(1)
command -b option.
Default: 32768
check_expiration_date = value Specifies whether the
operator should check and
confirm (YES or NO) the
expiration date on the
header label of a labeled
tape. Default: YES
check_file_id = value Specifies whether the
file identifier on a
labeled tape should be
checked (YES or NO) when
the file is opened.
Default: YES
check_protection = value Specifies whether the
protection flag on the
header should be checked
(YES or NO). Default:
NO
check_vsn = value Specifies whether the VSN
on labeled tapes should
be checked (YES or NO).
Default: YES
device_group_name = name Specifies the default
device group name if it
is not specified on the
-g option of the tmmnt(1)
command. Default: CART
fes_daemon_frontend_id = identifier Specifies the front-end
identifier of the TCP
daemon. Default: " "
fes_daemon_socket_port_number = number Specifies the socket port
number of the TCP daemon.
Default: 1167
file_status = status Specifies the file status
(NEW or OLD) if it is not
specified on the tmmnt(1)
command. Default: OLD
label_type = type Specifies the label type
(AL, SL, or NL) if it is
not specified on the
tmmnt(1) command.
Default: AL
loader_device_assignment_order = method Specifies the method
(DEVICE_LIST or
ROUND_ROBIN) with which
the loader assigns
devices. Default:
ROUND_ROBIN
max_number_of_tape_users = number Specifies the maximum
number of tape users.
Default: 100
number_of_autoloader_retries = number Specifies the number of
times to try to send a
request to the library
before informing the
operator of an error.
Default: 10
operator_message_destination = value Specifies where operator
messages are sent; IRIX,
SERVER, and FRONTEND.
Default: (IRIX)
operator_message_frontend_id = identifier Specifies the front-end
identifier for operator
messages. Default: " "
overcommit_max = value Specifies the maximum
number of overcommitted
mount requests that TMF
can issue. When the
number of tape mount
requests exceeds this
number, the system stops
processing requests until
one or more of the
already overcommitted
mount requests are
satisfied. To change
this setting, see the
tmset(8) command.
Default: 20
retention_period_days = days Specifies the retention
period (in days).
Default: 0
ring_status = status Specifies the ring status
when the ring option (-r)
is not specified on the
tmmnt(1) command (IN,
OUT, or (IN,OUT)).
Default: (IN,OUT)
scratch_volume_retries = number Specifies the number of
retries to get a scratch
volume mounted. Default:
3
scratch_volume_vsn = vsn Specifies the scratch
tape VSN. Default:
??????
servicing_frontend_id = identifier Specifies the servicing
front-end identifier to
use when the -m option is
missing on the tmmnt(1)
command. Default: " "
servicing_frontend_mandatory = value Specifies whether the
front-end identifier
specified by the
servicing_frontend_id
parameter is used (YES or
NO) regardless of the -m
option on the tmmnt(1)
command. Default: NO
system_code = value Specifies the system code
to put on tape labels.
Default: SGI/IRIX
tmf_major = number Specifies the major
device number of the TMF
driver. Default: 261
trace_file_group_id = identifier Specifies the group
identifier of the TMF
trace files. Default: 3
trace_file_mode = mode Specifies the file mode
of the TMF trace files.
Default: 0640
trace_file_owner = identifier Specifies the owner
identifier of the TMF
trace files. Default: 0
trace_directory = value Specifies the TMF trace
file prefix. Default:
/var/spool/tmf/trace
trace_file_size = size Specifies the size (in
bytes) of the TMF trace
files. Default: 409600
trace_state = value Specifies whether tape
tracing is enabled (ON or
OFF). Default: ON
trace_save_directory = value Specifies the prefix to
the TMF save files.
Default:
/var/spool/tmf/trace_save
user_exit_mask = value Enables the use of the
listed user exits. If no
user exits are required,
this entry is not needed.
For a list of user exits,
see the IRIX TMF Release
and Installation Guide.
Default: UEX_NONE
verify_scratch_vsn = value Indicates (YES or NO)
that you may need to send
the operator a message
that requests
verification that a
scratch tape is being
used to satisfy a tape
mount request. You must
consult the operator if
front-end servicing is
not in use. Default:
YES
EXAMPLES
The following example shows the sample tmf.config file that
is shipped . . .
FILES
/etc/config/tmf.config TMF configuration file
/usr/include/tmf/tmfdefaults.h Default TMF values
/usr/include/tmf/tmfreq.h TMF interface definition file
SEE ALSO
msgdaemon(8), tmconf(8), tmconfig(8), tmmls(8)
IRIX TMF Administrator's Guide
IRIX TMF Release and Installation Guide
This man page is available only online. |