The sample configuration file /etc/robar/abba.conf.d/templates/template.txt below is supplied for the ABBA 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 ABBA interface. # It serves as a template to create a configuration for the # virtual tape library system ETERNUS CS (formerly: CentricStor). # # 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_ABBA 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%=ETERNUS CS 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 (ABBA interface)
See also the notes on section "Notes on the section Internal environment variables (SCSI interface)" in chapter "Sample of the interface-specific configuration file (SCSI interface)".
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=CentricStor # CentricStor - ETERNUS CS (CentricStor) virtual archive system # 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)> # robots_count=<number_of_robot_arms_(1|2)> # Must be 1 for ETERNUS CS. # robot_devid=IMPLICIT|EXPLICIT # IMPLICIT means that the AML device identification is computed on # basis of the drive position in the ROBAR-SV configuration file. # EXPLICIT means the device mnemonic of the ROBAR-SV configuration # file is used as AML device identifier. # multi_processing_level=<multi_processing_level_(1|..|10)> # robot_address1=<connection_type>(<AML_address>) # <connection_type> : TCP/IP. # <AML_address> its format depends on the connection type. # for TCP/IP: <AML_address_1..253>,<port_number_1..5>. # <AML_address> can be specified as numeric IP address or # by FQDN. # robar_host_id1=<name_2..2> : the identifier must be assigned in the # configuration of the archive system to a host # resp. host alias name. # robot_output_area=*DEFAULT|<name_3..3> # robot_input_area=*DEFAULT|<name_3..3> # 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=CentricStor original_version=V7.6 location=ROBOTER1 archive_serial_number=1 robots_count=1 robot_devid=EXPLICIT multi_processing_level=10 robot_address1=TCP/IP(193.192.191.190,7055) robar_host_id1=H1 robot_output_area=*DEFAULT robot_input_area=*DEFAULT notification_host=HOST01 trace_limit=10000000 volume_error_limit=3 device_error_limit=3 repetition_count=1 hicap_var=OFF end_global_info
Notes on the section Global definitions (ABBA interface)
See also the notes on section "Notes on the section Global definitions (SCSI interface)" in chapter "Sample of the interface-specific configuration file (SCSI interface)".
archive_type configuration parameter
Defines the type of archive system.
Default value: CentricStor (must not be changed).
robots_count configuration parameter
Number of robots (ETERNUS CS is supported only as a single-robot system).
Default value: 1 (must not be changed).
robot_devid configuration parameter (mnemonic device names)
To simplify device configuration, archive systems support device names in mnemonic format (00..ZZ). The configuration parameter robot_devid can be used to stipulate that the device mnemonics will be used in the ROBAR configuration to address the devices operated by the robot in the commands intended for the robot.
The mode of address to be used is selected in the configuration parameter robot_devid. If the value EXPLICIT is defined for robot_devid, the mnemonic format is used. If the value IMPLICIT is defined for robot_devid (not recommended), the “numbered topologic form” is used.
Further explanations are provided in "Notes on the section Device definitions (ABBA interface)".
Configuration parameter robot_address1
The AML address for the configuration parameter robot_address1 must be included in the file /etc/hosts.
robot_input_area, robot_output_area configuration parameters
Name of the logical input resp. output area to be used by ROBAR-SV
(*DEFAULT: setting in the archive system).
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 CentricStor operation # <device_mnemonic> robot=<managing_robot> [type=<device_type>] # [devname=<DevName>] # # <device_mnemonic> # the mnemonic device name in BS2000. # It consists of 2 or 4 letter and/or digits. # <managing_robot_(0|1|2)> # the robot arm number (0 for manual drives). # Must be 1 for ETERNUS CS. # <device_type> # a device type defined in BS2000, i.e. TAPE-C4. # <DevName> # is a character string of length 2 (0..9, A..Z). # It allows to convert a 4 byte host device mnemonic in a 2 byte # archive system device identification. # DevName must be identical with the related device name in the # archive system configuration. # [...] # end_devices gen_devices # CentricStor devices T0 type=TAPE-C4 robot=1 T1 type=TAPE-C4 robot=1 end_devices
Notes on the section Device definitions (ABBA interface)
Names / addresses of the MTC devices
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>).
robot_devid=EXPLICIT and 4-byte MNs in BS200
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 two-byte device identifier (set of values: 0..9, A..Z) which must be specified there corresponds to the device name definition in the device configuration of the archive system (e.g. DevName in the ETERNUS CS configuration tool GXCC). The device names must be unique within an archive system.
Example
# Device definitions gen_devices A000 type=TAPE-C4 devname=G1 A001 type=TAPE-C4 devname=G2 A002 type=TAPE-C4 devname=G3 F000 type=TAPE-C4 devname=G4 . . . FFFF type=TAPE-C4 devname=ZZ 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.
Example
# Device definitions gen_devices T0 type=TAPE-C4 T1 type=TAPE-C4 A000 type=TAPE-C4 devname=M3 A001 type=TAPE-C4 devname=M4 A002 type=TAPE-C4 devname=M5 F000 type=TAPE-C4 devname=M6 . . . F123 type=TAPE-C4 devname=T1 !!! INHIBITED !!! . . . FFFF type=TAPE-C4 devname=ZZ end_devices
robot_devid=IMPLICIT and 4-byte MNs in BS2000
You are recommended not to use IMPLICIT addressing mode any longer.
However, ROBAR-SV still supports this mode and accepts the specification of 2-byte and 4-byte MNs in the device definitions section for up to 99 devices.
The devname operand may not be specified in IMPLICIT addressing mode.
# 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 (ABBA interface)
See the notes on section "Notes on the section Host VSN definitions (SCSI interface)" in chapter "Sample of the interface-specific configuration file (SCSI interface)".