Enstore Configuration Keys


 

Common Keys (for all servers)

All mandatory common keys must be defined in all servers and movers configurations

Key Description Presence Default
hostserver host nameMandatoryNone
hostipserver host IP addressMandatoryNone
portserver port numberMandatoryNone
lognameserver name in the logMandatoryNone
inq_ignoreif present the inquisitor will not monitor corresponding server OptionalNone
norestartif present inq will not restart corresponding server/mover OptionalNone
noupdown'enstore system' process will not look at the corresponding server when generating the SAAG page, and will not use the information in deciding to turn the ball red OptionalNone

Library Manager Keys

Key Description Presence Default
lockif specified LM will start in this state. Allowed values:locked, unlocked, ignore, pause, nowrite, noread Optionalunlocked
max_suspect_moversif number of suspect movers on which a given volume failed >= of max_suspect_movers, this volume will be set to NOACCESS state Optional3
suspect_volume_expiration_timeremove entry from suspect volume list after this period of time OptionalNone
min_file_sizeminimal file size Optional0
max_file_sizemaximal size of the file allowed by this library Optional2GB-2kB
blank_error_incrementdo not set volume to NOACCESS in case of FTT_EBLANK error until the number of erros exceeds max_suspect_movers+blank_error_increment Optional5
legal_encp_versionminimal encp version number allowed to acess enstore OptionalNone
CleanTapeVolumeFamilyvolume family for cleaning tapes OptionalNone
storage_group_limitsMinimal amount of drives that can be used by a certain storage group (fair share) when different storage groups compete for tape drives OptionalNone
max_requestsMaximal amount of requests in the queue. The rest will be ignored (and retried later by encp) Optional2000

Mover Keys

Key Description Presence Default
do_ejecteject tape on dismount Optional'yes'
do_cleaningclean tape drive by the mover request Optional'yes'
mc_devicemedia changer device as declared in the robot MandatoryNone
min_buffer minimal amount of memory to allocate for buffering when transferring data Optional8MB
max_buffermaximal amount of memory to allocate for buffering (recommended not less than 1GB Optional64MB
max_ratemaximum sustained transfer rate for writes. Used to calculate optimal buffer size. Recommended to set to the max. rate of the drive Optional11.2MB
devicepathname to the UNIX tape device MandatoryNone
dismount_delaydelayed dismount value to use when none specified by the client. Set to negative value to get "infinite" dismount delay Optional60s
mount_delaynumber of seconds to wait after media changer mount completes, before trying to open device. Default is 15 for FTT driver, 0 for NULL driver Optional15s
max_dismount_delaymaximal dismount delay that can be set for this mover Optional600s
librarylibrary(ies) that this mover serve MandatoryNone
driverlow lewel media driver ('FTTDriver' for tape, 'NullDriver' for null mover) MandatoryNone
max_consecutive_failuresnumber of any consecutive errors after which the mover goes OFFLINE Optional2
max_failuresMover will go OFFLINE if this many transfers fail within failure_interval (see below) Optional3
failure_intervalInterval for above Optional3600s
send_statssend tape drive statistics to the drivestat Data Base (defaul value 1, which means "send") Optional1
typespecifies the type of mover ('','Mover','DiskMover') Optional""
media_typemedia type used for the mover. Recommended to set to the type of the media Optional"8MM"
log_stateif set log the state of the mover processes. Used for debugging OptionalNone
syslog_entryexpression to match in the syslog for the low level failure diagnostics OptionalNone
restart_on_errorrestart mover if it went to the ERROR state. Default - do not restart OptionalNone
connect_timeoutTimeOut for mover connection to encp Optional15s
connect_retriesnumber of connection retries to encp Optional4
update_intervalinterval for the mover to ask LM for the work. Recommended value 5 s) Optional15
single_filemarkif not 0 write single file mark (Default value - 0 - write 2 filemarks) Optional0
check_written_fileif greater than 0, then randomly check files written using this number as the mean (default value:0 - don't check) Optional0
check_first_written_fileReread and check CRC on a first write after a tape mount Optional0
max_time_in_statemaximal time for a mover to be in any transfer state (other than IDLE or ACTIVE) Optional600s
max_in_state_cntif this counter expires Mover errors out with "Mover stuck..." message. Optional3
statistics_pathpath to the statistics file(default - None) OptionalNone
compression0 means no compression. Everything else means use the drive compression (default: None - use the drive compression). Set this key to 0!!! OptionalNone
get_remaining_from_statsget remaining bytes info from drive OptionalNone
blank_error_incrementSometimes ftt returns FTT_EBLANK for not blank tapes. To allow a tape to be in a pool and not to go to NOACCESS. Optional5

Media Changer Keys

Some media changer keys are specific for different types of robotic libraries

Key Description Presence Default
typetype of the media changer (currently RDD_MediaLoader - for null movers, STK_MediaLoader, AML2_MediaLoader, Manual_MediaLoader) MandatoryNone
acls_hosthost name of STK robot control machine (specific for STK Library) MandatoryNone
acls_unameuser name to access STK robot control program (specific for STK Library) MandatoryNone
RobotArmrobot arm in AML2 robot (specific for AML2 robotic library) MandatoryNone
IdleTimeHomehome robot arm if it is idle and not in a home position after this period of time has expired (default 5 min, specific for AML2 robotic library) MandatoryNone
IOBoxMediaspecifies types of media and addresses of IO box for importing/exporting tapes into the robot (specific for AML2 robotic library) MandatoryNone
DriveCleanTimeif present, specifes the type of media, time until cleaning tape gets dismounted and number of cleaning cycles to clean a tape drive MandatoryNone
max_workif present, specifes the maximal number of simultaneous requests to robot. Optional7
tape_libraryif present, suplies a name to the tape library (robot) for reporting. OptionalSL8500

Volume Clerk Keys

Key Description Presence Default
max_noaccess_cntif number of volumes consecutively set to NOACCES reaches this number, the corresponding library will be paused Optional2

File Clerk Keys

Key Description Presence Default
brandbrand for bit file id to distinguish between systems Optional""

Info Server Keys

Uses only general keys (along with database keys which are the same for file, volume clerks and info server).

Database Keys

Key Description Presence Default
db_dirAux database directory MandatoryNone
jou_direnstore database journal directory MandatoryNone
dbhostenstore database host MandatoryNone
dbnameenstore database name MandatoryNone
dbportenstore database port MandatoryNone
dbuserenstore database account MandatoryNone
dbuser_readerenstore readonly database account MandatoryNone
dbserverownerowner of enstore database server process MandatoryNone
dbareaenstore database area MandatoryNone

Accounting Server Keys

Key Description Presence Default
dbhostaccounting data base host machine MandatoryNone
dbportaccounting database port MandatoryNone
dbnameaccounting data base name MandatoryNone
dbuserenstore database account MandatoryNone
dbuserenstore readonly database account MandatoryNone
dbserverownerowner of enstore database server process MandatoryNone
dbareaenstore database area MandatoryNone

Drivestat Server Keys

Key Description Presence Default
dbhostdrivestat database host MandatoryNone
dbportdrivestat database port MandatoryNone
dbnamedrivestat data base name MandatoryNone
dbuserenstore database account MandatoryNone
dbuserenstore readonly database account MandatoryNone
dbserverownerowner of enstore database server process MandatoryNone
dbareaenstore database area MandatoryNone

Web Server Keys: define httpd.conf and top level directories

Key Description Presence Default
ServerHost name of the host running http serverMandatoryNone
ServerName name of web serverMandatoryNone
DocumentRoot top level web directoryMandatoryNone
ScoreBoardFile ScoreBoardFileMandatoryNone
PidFile full path to httpd pid fileMandatoryNone
CustomLog
combined full path to combined log file
referer full path to referer log file
agent full path to agent log file
Mandatory
Mandatory
Mandatory
None
None
None
ServerRoot location of httpd.conf (e.g. /etc/httpd)MandatoryNone
ScriptAlias
fake e.g. /cgi-bin/
real real path to cgi scripts
Mandatory
Mandatory
None
None

Inquisitor Keys

Key Description Presence Default
alive_rcv_timeoutamount of time to wait when doing a tcp transfer MandatoryNone
alive_retriesnumber of times to retry a failed tcp transfer MandatoryNone
default_alive_intervalnumber of seconds expected between alive messages from the event_relay MandatoryNone
default_hung_intervalnumber of seconds after which if no alive message is received, the server is marked as dead MandatoryNone
html_filedirectory location of the html web area MandatoryNone
http_log_file_pathpath to log files in the as used in a url MandatoryNone
max_encp_linesmaximum number of encps reported on the encp history page MandatoryNone
node_write_checkset an alarm if there are writes in the library manager queue (from these nodes) and there are no active transfers from the nodes MandatoryNone
refreshautomatic refresh rate for the web pages MandatoryNone
user_log_dirsdictionary specifying additional links that should be added to the log file web page under user log dirs MandatoryNone
www_hosturl description of the web host MandatoryNone

Alarm Server Keys

Key Description Presence Default
alarm_actionsdictionary describing actions to be taken when the specified alarms are received. the format is as follows - [severity_string:[[action1, action_parameters, action_parameters], ...], ...}.supported actions are - send email; params = [action_name, 1|*, optional_params...]; if 1, only send mail the first time the alarm is seen, * - always send mail when get this alarm or add the alarm to the web page only MandatoryNone

Log Server Keys

Key Description Presence Default
log_file_pathpatt to the log files directory MandatoryNone
msg_type_logslog extractions based on the log type pattern OptionalNone

Log Server Keys

Key Description Presence Default
log_file_pathpath to the log files directory MandatoryNone
msg_type_logslog extractions based on the log type pattern OptionalNone

System Keys

Key Description Presence Default
allowed_downdictionary defining how many times a server is allowed down before it is marked with a red ball by the 'enstore system' command. each server has a list associated with it that has the followinw format - [number of consecutive times when checked and no alive message rcvd, timeout] MandatoryNone

Encp Keys

Key Description Presence Default
crc_seedvalue of the initial adler32 seed. the standard says this should be one, but some institutions have decided to use zero. Optional1

pnfs server Keys (optional)

Key Description Presence Default
hosthost on which pnfs server runs. MandatoryNone

Last modified: Tue May 27 10:47:15 CDT 2008