The sample configuration file /etc/robar/scsi.conf.d/templates/template.txt below is supplied for the SCSI interface.
The file contains notes in English and German. Only the English comments are shown in this manual.
The notes on the various sections of the file are contained at the end of the section concerned; they are arranged according to the order of their occurrence.
# This file is an example of an editable configuration file for # ROBAR-SV 7.6B for SCSI-Interface. # It serves as a template to create real configurations for the tape # library system models 'i' (e.g. i6000). # # As for the handling of configuration files, please refer to the section # "Configuring ROBAR-SV" in the ROBAR manual. # # The following shortcuts are used in this context: # <text_m..n> : string of characters; m, n are integers and m..n defines # the minimal and maximal fieldwidth. # <instance_number_(l|m|..|n)> : the available values are enumerated from l up # to n. l, m, n can be integers, strings, $, #, @. # Notice : it is an error to define parameters not supported with values! # Each parameter must always have a value. # All string identifiers are case sensitive. # # Internal environment variables # # gen_env_vars # CLOSE_DISPLAY=YES|NO # If CLOSE_DISPLAY=YES, open DISPLAY and MANUAL menus are closed when # ROBAR-SV is started. # LTRACE=YES|NO # ROBAR_TRACE=YES|NO # SERVER_TRACE=YES|NO # The LTRACE, ROBAR_TRACE and SERVER_TRACE variables are used # internally and are therefore not described here. # MANCHECK=YES|NO # Input parameter check in commands of the menu MANUAL # ROB_STAT_NOTIF=TYPE|PAUSE # If this variable is defined, a TYPE or a PAUSE message # is output depending on the setting. # ROBAR_ARCHIV=<vsn_list> # Archive numbers (VSNs) which may be processed by this # ROBAR-SV instance. # ROBAR_INFO_MSG=YES|NO # Specifies whether ROBNxxx messages are to be output # to the BS2000 console # ROBOT_OFF_MSG=TYPE|PAUSE # If the robot switches to OFF mode, the message sent to # the BS2000 system is a TYPE or a PAUSE message. # INIT_RESTART_OPTION=YES|NO # Sets the initial value of automatic instance restart during # the first start of DEFINED instance. # This can be dynamically changed afterwards with # SET_RESTART_OPTION_SCSI command or by the web application. # MSG_LOG_LEVEL=VERBOSE|NONE # Specifies ROBAR message output verbosity. # <VERBOSE> is the default value. # <NONE> suppresses some warning messages non-critical for operation. # Any other value or omitting this variable means the default value. # end_env_vars # # The next line is a specially formatted comment to display optionally # additional user info in ROBAR-SV Manager. # It has to begin with #%INFO%= without blank characters before it. # Max. up to 80 characters after "=" can be displayed. # Example: #%INFO%=Scalar gen_env_vars CLOSE_DISPLAY=NO LTRACE=NO ROBAR_TRACE=NO SERVER_TRACE=NO MANCHECK=NO #ROB_STAT_NOTIF= #ROBAR_ARCHIV=volna1-volna8,volnal,volnam ROBAR_INFO_MSG=NO ROBOT_OFF_MSG=PAUSE INIT_RESTART_OPTION=NO MSG_LOG_LEVEL=VERBOSE end_env_vars
Notes on the section Internal environment variables (SCSI interface)
Information field %INFO%
Additional archive system information. In the ROBAR-SV Manager this is displayed in the archive system’s status information.
CLOSE_DISPLAY configuration parameter
The MANUAL and/or DISPLAY menus can remain open during the ROBAR start procedure. If the relevant ROBAR server indicates a low level of performance, a data bottleneck may have occurred between the ROBAR processes and the display processes that leads to a timeout during initialization of the start procedure. If the CLOSE_DISPLAY shell variable is defined and the variable value is set to YES, the two accessed menus are closed automatically during the ROBAR-SV start procedure. Default value: CLOSE_DISPLAY=NO
MANCHECK configuration parameter MANCHECK allows you to restrict the range of volumes that can be processed using the menu MANUAL. In a multisystem configuration, for instance, you can stop foreign volumes from being processed using the MANUAL menu (access protection for foreign volumes).
If MANCHECK=YES, then the commands entered via the menu MANUAL are subject to the same checks as the commands from a BS2000 system. All parameters contained in the command are checked for plausibility and reliability.
The following checks are carried out:
VSN specifications are compared with the configuration parameter ROBAR_ARCHIV. If the configuration parameter is present and has been supplied with values, the VSN specifications of all commands are compared with the values in the configuration parameter.
If the check was positive, the values contained in the
Host VSN definitionssection of the configuration file may also be included in the check.
If MANCHECK=NO, the commands from the menu MANUAL are not checked.
The section Host VSN definitions in the configuration file must contain a server with the host name MAN and with a VSN list for this function to be available.
If the configuration file does not contain a host called MAN, the following error message is issued: RSV1332 HOST NOT AUTH. HOST: MAN.
Default value: MANCHECK=NO
ROBAR_ARCHIV configuration parameter ROBAR_ARCHIV shows the archive numbers (VSNs) which may be processed by this ROBAR-SV instance. If this variable is not set, all VSNs are accepted for processing. In entries made during installation, lowercase letters are automatically converted into uppercase. Maximum length: 1024 characters.
Note the following guidelines for entering VSNs:
The VSN consists of six of the following characters: A..Z, a..z, 0..9, $, @, #.
- When specifying VSN ranges (e.g.
ARCHxx-ARCHyy),xxandyymust be numbers. The letters in the number range must correspond as they are used to define the start and end of the number range.
The first VSN may not be greater than the last VSN.
The first and last VSNs in the VSN range are separated by a hyphen (-).
The first and last VSNs in the VSN range have the same length.
VSNs and VSN ranges in a list must be separated by commas.
There must be no blanks.
Any number of hyphens ("-") or commas (",") are permitted at the end of the list.
A possible entry might be: A00001-A00030,B00003,B00005,B00010-B00015,---
ROBAR_INFO_MSG configuration parameter
If ROBAR_INFO_MSG=YES the ROBNxxx messages are output to the BS2000 console. The messages are suppressed if this configuration parameter is NO or not defined. ROBNxxx messages are always output as a reaction to Nxxx error messages that originate in the archive system. It is not however practical to output ROBNxxx messages in BS2000 systems as generally measures to eliminate the relevant error are initiated at the same time as the archive system error messages and more serious errors are displayed directly on the screen using the relevant ROBAR messages.
ROBOT_OFF_MSG configuration parameter
As soon as the robot switches to OFF mode, an appropriate message is sent to the BS2000 systems. This message is always a PAUSE message unless the configuration parameter ROBOT_OFF_MSG exists and has the value TYPE.
Default value: PAUSE
INIT_RESTART_OPTION configuration parameterINIT_RESTART_OPTION defines whether the automatic restart is enabled (YES) or not (NO) for the instance when a ROBAR-SV instance is started for the first time. See section "Automatic restart of ROBAR-SV instances" in chapter "Automating the behavior of ROBAR-SV".
Default value: NO
MSG_LOG_LEVEL configuration parameterMSG_LOG_LEVEL specifies ROBAR message output verbosity. NONE suppresses some warning messages non-critical for operation. VERBOSE value or omitting this parameter means the default verbosity.
Default value: VERBOSE
# Global definitions # # gen_global_info # archive_type=scsi-1 # 'scsi-1' should be always set for the SCSI interface # original_version=<version_1..4> # Version of the ROBAR-SV installation. # The identity of this parameter and the version of the actually # installed ROBAR-SV is expected. # location=<robot_location_name_1..8> # location must match the location name defined in MAREN and NDM # (see also /ADD-DEVICE-DEPOT) # archive_serial_number=<instance_number_(1|2|3|4)> # multi_processing_level=<multi_processing_level_(1|..|10)> # robot_address1=<connection_type>(<library_device_address_1..32>) # <connection_type> : SCSI # <libray_device_address_1..32> # Either full pathname of the device special file (e.g. /dev/sg3) # or full pathname of the persistent device node file # (example: /dev/rob/1ADIC_203100195_LL5) # notification_host=*ALL|<name_1..6> # defines the target for the commands TYPE, PAUSE or COMMAND # transmitted by ROBAR. # Its value is the host alias name defined in gen_hosts. # trace_limit=<maximum trace file size in bytes> # If this parameter is not specified, then 1000000 is assumed. # volume_error_limit=<maximum error number per volume> # If this parameter is not specified, then 3 is assumed. # device_error_limit=<maximum error number per device> # If this parameter is not specified, then 3 is assumed. # repetition_count=<counter_value> # <counter_value> is a positive integer number. # The repetition_count defines the maximum number of connection # attempts to the archive system during its startup. # If this parameter is omitted then the value 1 is assumed. # Notice : However to ensure a successfully communication start also # in the start up phase of the robot we suggest a value of # at least 20. # hicap_var=<value_(ON|OFF)> # This parameter controls the transmission of MAREN-related messages # for export or import requests. # ON : only the MAREN-hosts defined in gen_maren_processors will be # informed. # OFF : if there are MAREN-hosts defined in gen_maren_processors they # will be informed. Otherwise all hosts defined in gen_hosts # are informed. # Default value is OFF. # end_global_info gen_global_info archive_type=scsi-1 original_version=V7.6 location=ROBOTER1 archive_serial_number=1 multi_processing_level=10 robot_address1=SCSI(/dev/rob/1ADIC_203100195_LL5) notification_host=HOST01 trace_limit=10000000 volume_error_limit=3 device_error_limit=3 repetition_count=20 hicap_var=OFF end_global_info
Notes on the section Global definitions (SCSI interface)
archive_type configuration parameter
Defines the type of archive system.
Default value: scsi_1 (may not be changed).
location configuration parameter
A storage location name is required for the MTC devices administered by ROBAR.
A separate storage location name must be defined for each ROBAR-SV instance in accordance with the MTC devices administered and the archive system.
archive_serial_number configuration parameter
This configuration parameter is only described for reasons of compatibility.
Specification of a value <1 .. 4> is required to create default names for local CMX names. A different value should be defined for each ROBAR-SV instance if the default names are used for local CMX names.
robot_address1 configuration parameter
See section "Device Special File" in chapter "Connections at the SCSI interface".
repetition_count configuration parameter
When ROBAR-SV is started, a connection to the archive system is established. The response from the archive system is expected within 20 seconds. If there is no response from the archive system, the connection is closed down and all processes of the ROBAR-SV instance are terminated.
The number of connection establishment attempts can be defined using the repetition_count configuration parameter. Default value: repetition_count=1.
# Host definitions # # gen_hosts # <host_alias_name_1..8> partner=<TNS_partner_name_8..8> # [local=<TNS_local_name_1..8>] # <host_alias_name_1..8> # identifies the system of the ROBAR client installation. # Same name can be used as for <TNS_partner_name_8..8>. # <TNS_partner_name_8..8> # identifies the system of the ROBAR client installation # in the configuration file for CMX. # <TNS_local_name_1..8> # identifies the ROBAR client application. If it is # omitted a name will be created concatenating # "robar" and "host_number + (archive_serial_number - 1) * 40". # [...] # end_hosts gen_hosts HOST01 partner=PARNAME1 local=LOCNA1 HOST02 partner=PARNAME2 local=LOCNA2 HOST03 partner=PARNAME3 local=LOCNA3 end_hosts
# Device definitions # # gen_devices # for native MTC device processing # <device_mnemonic> type=<device_type> [RRF_dir=<RRFname_1..10>] # devaddr=<DevAddr_(256|..|4095)> [devname=<DevName>] # logic_library_LUN=<LUN_number_(1|2|...|255)> # # <device_mnemonic> # the mnemonic device name in BS2000. # It consists of 2 or 4 letter and/or digits. # <device_type> # a device type defined in BS2000, i.e. TAPE-U6. # <RRFname_1..10> # identifies the directory containing the Robar Rule File # to be used for this device. # <DevName> # is a character string of length 2 (0..9, A..Z). # It allows to convert a 4 byte device mnemonic into a 2 byte # archive system device identification. # Due to compatibility reasons ROBAR-SV uses 2 byte mnemonics # internally. Therefore this parameter is important for the # archive systems. # <DevAddr_(256|..|4095)> # This value establishes the relationship between the device # mnemonic and the element address of the MTC drive in the # scalar i archive system. # DevAddr conforms with the Data Transfer Element Address # of the MTC drive in the assigned logical library. # <LUN_number_(1|2|...|255)> # LUN number of the logical library which the drive is # assigned to. # [...] # end_devices gen_devices A0 type=TAPE-U6 RRF_dir=TYPE-1 devaddr=256 logic_library_LUN=1 A001 type=TAPE-U6 RRF_dir=TYPE-1 devname=M1 devaddr=257 logic_library_LUN=1 end_devices
Notes on the section Device definitions (SCSI interface)
RRF_dir configuration parameter
See chapter "ROBAR rule files".
Names / addresses of the MTC devices
The name and consequently also the address of the MTC devices differ in BS2000 and the archive system. The mnemonic device name in BS2000 cannot be used directly. In this section you must specify the assignments for the device address.
In this section an entry with the assignment of the mnemonic device name to the devaddr and logic_library_LUN configuration parameters must exist for each device. The relationship to the mnemonic name of the tape device is preset by the BS2000 generation.
<LUN_number>=1. You can ascertain the device addresses <DevAddr> using the Internet access from the Reports menu item, All Slots submenu, Element Address column.In the Scalar i6000 archive system you can ascertain the device addresses <DevAddr> and the LUN <LUN_number> using the LMC.
You will find <LUN_number> (when you specify the physical library) in the Setup --> Blades --> Access --> FC Host --> LUN Mapping menu.
You will find <DevAddr> in the View menu (when you specify the partition), then in the Monitor menu and there under the Drives menu. The WWPN and other information for the configured devices are displayed in the Drive Status window. The devices are displayed in ascending order in accordance with their position in the archive system’s housing. The position is shown in the Location column. According to the SCSI Reference Guide, the start address for the drives (Data Transfer Elements) has the value 256 (hexadecimal: 0100). Consequently the first device displayed in the table will be assigned the value 256 in the devaddr configuration parameter. The other devices will each receive an element address which is incremented by 1.
MTC devices can be assigned a 4-character device name (4-byte MN). However, at the interface to the archive systems ROBAR-SV still only uses a 2-character field for the device name (<DevName>).
If 4-byte MNs are used in a BS2000 system, ROBAR-SV must convert the 4-byte MN into the 2-byte device name of the archive system. The devname = <DevName> operand is provided for this purpose in the device definitions. The device names must be unique within an archive system.
Example
# Device definitions gen_devices A000 type=LTO-U6 devname=G1 devaddr=256 logic_library_LUN=1 A001 type=LTO-U6 devname=G2 devaddr=257 logic_library_LUN=1 A002 type=LTO-U6 devname=G3 devaddr=258 logic_library_LUN=1 F000 type=LTO-U6 devname=G4 devaddr=259 logic_library_LUN=1 . . . FFFF type=LTO-U6 devname=ZZ devaddr=... logic_library_LUN=1 end_devices
A mixture of 2-byte MNs and 4-byte MNs can also occur in the device definition. In this case you must ensure that a 2-byte MN is not used as <DevName> in one of the devname = <DevName> operands.
ROBAR-SV also uses a 2-byte MN automatically as a 2-byte device name (in this case the devname operand can be omitted).
Example
# Device definitions gen_devices T0 type=LTO-U6 devaddr=256 logic_library_LUN=1 T1 type=LTO-U6 devaddr=257 logic_library_LUN=1 A000 type=LTO-U6 devname=M3 devaddr=258 logic_library_LUN=1 A001 type=LTO-U6 devname=M4 devaddr=259 logic_library_LUN=1 A002 type=LTO-U6 devname=M5 devaddr=260 logic_library_LUN=1 F000 type=LTO-U6 devname=M6 devaddr=261 logic_library_LUN=1 . . . F123 type=LTO-U6 devname=T1 !!! INHIBITED !!! . . . FFFF type=LTO-U6 devname=ZZ devaddr=... logic_library_LUN=1 end_devices
# MAREN host definitions # # gen_maren_processors # <host alias list (1 to 10 items)>|*NO_HOST|*ALLHOST # Notice : physically exists only one central MAREN host which controls the # MAREN-catalog. Therefore the definition of more than one processor # could cause redundant updates of the MAREN-catalog. # The central MAREN host has to be attached. # end_maren_processors gen_maren_processors HOST01 end_maren_processors
# Host-VSN definitions # # gen_hosts_vsn # <TNS_partner_name_8..8> <vsn_list>; # A list of up to 1024 characters is allowed for each partner system. # <TNS_partner_name_8..8> is the partner as defined in gen_hosts. # <vsn_list> is # <vsn_name_1..6>;|<vsn_name_1..6>-<vsn_name_1..6>;[<vsn_list>;] # <vsn_name_1..6> volume identifier. # [...] # end_hosts_vsn gen_hosts_vsn PARNAME1 volna1-volna2; PARNAME2 volna3-volna4;volna5-volna6;volnak-volnan; PARNAME3 volna7-volna8;voln9-voln10;volnal;volnam; end_hosts_vsn
Notes on the section Host VSN definitions (SCSI interface)
You can define VSN number ranges in two ways in ROBAR-SV:
Definition of global VSN number ranges via the configuration parameter
ROBAR_ARCHIV(see "ROBAR_ARCHIV configuration parameter"). This means, however, that the VSNs entered there can be used by all BS2000 systems which communicate with ROBAR-SV.Definition of server-related VSN number ranges in the ROBAR-SV configuration file. This enables you to assign VSN-dependent actions to selected servers (multiclient capability).
In the
Host VSN definitionsection you can define lists in the form<Hostname> <vsnbeg>-<vsnend>;(specification of range)
and / or <Hostname> <vsn>; ....; <vsn>;(specification of single VSN) <vsnbeg>and<vsnend>specify the first and last elements in a range of MTC VSNs. When a range is specified, the letters in<vsnbeg>and<vsnend>must match; the range is defined by the number part. The number in<vsnbeg>must be less than that in<vsnend>. Example:D00100-D00800.For compatibility reasons, all VSNs defined in the
gen_hosts_vsnsection must also be contained in the set of values of theROBAR_ARCHIVconfiguration parameter. Otherwise the definitions in thegen_hosts_vsnsection will be meaningless. The lines in thegen_hosts_vsnlines must be terminated by a semicolon.Example
gen_env_vars ROBAR_ARCHIV=A00100-A01200,B11111,C10000-C11000,D00100-D00800,D02222, D03333,E00500-E01000 end_env_vars gen_hosts S200 partner=PAD1EDXX local=PAD1ED SANDRA partner=PAD3EDXX local=PAD3ED end_hosts gen_hosts_vsn PAD1EDXX A00100-A01200;B11111;C10000-C11000; PAD3EDXX D00100-D00800;D02222;D03333;E00500-E01000; end_hosts_vsn