Return to vaultrc.1m CVS log

Up to [cvs.NetBSD.org] / othersrc / nastore / volman / srvr / rc / vault

Import of snapshot of nastore3 code. Includes kernel code for dmfs, dmfs
user utilities, ms66 import and export, vvm, and volman. Also includes
makefile magic to automatically generate .tgz source files from the source.
Solaris support a bit of a question as zoularis is not working at the
moment.

.TH VAULTRC 1M "" "" "\s-1NAStore\s+1 Man Pages"
.SH NAME
vaultrc \- Volume Manager Vault Repository Controller
.SH SYNOPSIS
.B vaultrc 
.I rc [\-i]
&
.SH DESCRIPTION
The \fIvaultrc\fR is a \fIvolman\fR(8) Repository Controller (RC)
that manages volumes in an operator-controlled vault.
If the vaultrc is to be run on the same host as the 
Volume Manager \fIvold\fR(1M), vold will start
it automatically with the \fIrc\fR argument if the
PATH variable for the RC is defined in the \fIvold\fR(1M)
VCONF file.  If vaultrc is started manually, for 
example on another host than vold, it should be run 
in the background, and the \fIrc\fR argument must agree 
with VCONF. 

The \fIrc\fR argument determines which volumes in the \fIvolman\fR(8) 
database the process will manage; at NAS, the \fIrc\fR is 2.
The optional \fI\-i\fR argument instructs the process not
to exit if vold shuts down; instead, the vaultrc will wait 
and try to reconnect until vold is restarted. When vaultrc
reconnects, it reloads the configuration from vold and
reinitializes.  This option is for convenience when running 
vaultrc on a non-vold host.  Once a vaultrc process has been 
started in this manner, it can only be shut down using 
\fIkill\fR(1).

The vaultrc gets a list of the drives it manages
from the vold, which reads them as part of the
RC configuration at startup from its VCONF file. 
The vaultrc accepts mount requests from the 
vold and broadcasts operator requests to logins 
under the console account specified by the SYSLOG
statement in VCONF (see below).  
The vaultrc cooperates with the \fIacsrc\fR(1M) in 
coordinating moves of cartridge tapes between the 
ACS Cartridge Entry Ports and the vault.

The \fIrcerr\fR(1M) utility is used by operators to fail a request made
by a vaultrc.

.SH CONFIGURATION
This is the vaultrc configuration (format defined in \fIvold\fR(1M))
as found in the VCONF file, showing 3490 drives:
.nf

	BEGIN_RC
	  NUMBER	2
	  NAME		"Vault RC"
	  ID		VAULTRC
	  TYPE		VAULTRC
	  LOGIN		volman
	\#  SYSLOG: define a console for 'mount xxxxxx on drive yyy'
	\#  requests - normally same as volman error console
	\#  - maps to /etc/syslog.conf entry:
	\#    local0.notice			volman
	  SYSLOG	LOG_LOCAL0
	\#
	\#  presence of PATH instructs vold to fork/exec process
	\#
	  PATH		vaultrc
	  CAPACITY	-1
	  VARY		Vary34X0
	  FLAGS		TIMER_MSGS MOUNT_OK ASYNC_UNMOUNT 
				ALLOC_OK RECYCLE_OK NODEMOUNT
	  MEDIA		34X0
	  DRIVES
	\#
	\#	name     dev_num    medium   channel 
	\#
           vlt01      1        34X0     39_0
	END_RC
.fi

The vaultrc package includes a server that can run on
a remote host which manages a database for tracking 
vault volumes, and broadcasts its own console messages,
coordinating with a hand-held bar-code scanner with an
LCD display. This part of the package would be vital if
vault storage was ever changed to non-serial filing,
since it enables the operator to register the location
of volumes in the vault by scanning their labels along
with vault location labels, as well as providing a
readout of requested volumes and their locations on
the scanner's LCD. Code for both server and scanner 
are included; they were tested but have never been used 
in production.

.SH DIAGNOSTICS
The vaultrc broadcasts messages to the designated console account.

.SH FILES
.nf

	/usr/mss/lib/volman/vaultrc
	/usr/mss/lib/volman/VCONF

.fi
.SH SEE ALSO
rcerr(1M), vold(1M), volman(8).