The parameters in the INI file control the runtime behavior of SANCHECK. SANCHECK expects the INI file under the SANCHECK installation ID with the name
SYSDAT.SANCHECK.INI. If no INI file is found, SANCHECK is terminated.
Default values apply for all optional parameters which are not specified, see the description of the parameters below. If mandatory parameters are missing or illegal, error messages are issued and SANCHECK is terminated.
Structure
The INI file is divided into sections and parameter groups. Each section is introduced by a keyword in square brackets, e.g.: [FILES].
A section contains parameters groups on a line-by-line basis (e.g. SWIFILE), each of which sets one or more parameter values (e.g. NAME). A parameter group is defined by the first keyword in a line. A comma is followed by the parameters belonging to the group plus their values.
When multiple parameters (e.g. PREFIX, SUFFIX) belong to a parameter group (e.g. SWDFILE), these can be specified as follows:
In one line for the entire parameter group, separated by commas, e.g.:
SWDFILE, PREFIX=SYSDAT.SANCHECK.,SUFFIX=.DATIn one line for each parameter; each line begins with the keyword of the parameter group, e.g.:
SWDFILE, PREFIX=SYSDAT.SANCHECK.SWDFILE, SUFFIX=.DATIn the case of the parameter group BS2NODE, the WWNNs and the associated CPU IDs must always be specified together in one line because specifications can be made for more than one system here and the assignment of the two parameters must be ensured.
The following rules also apply for the INI file:
Lines which begin with
#are comment lines and are ignored when the INI file is processed. Everything which is contained in a line after the#character is a line comment and is also ignored.Blanks at the start of the line and between parameters are ignored.
Empty lines are ignored.
When the same parameter is specified more than once, only the first valid specification is used. Any other specifications are ignored.
Description of the parameters
[FILES]
Section: Definition of various file paths
The names and paths of SANCHECK input files and SANCHECK temporary files are defined in this section. If no specifications are entered here, the default values apply.
SWIFILE
Parameter group: Name of the SWITCHES file
This is the file in which the IP addresses of all switches which are to be checked by SANCHECK are stored.
The file can be located under any ID provided it can be read by all users.
Parameters
NAME=
File name
Format: <filename> (see "Formats for file names")
Default value: SYSDAT.SANCHECK.SWITCHES under the current user ID
Example
SWIFILE, NAME=SYSDAT.SANCHECK.SWITCHES
SWDFILE
Parameter group: Name of the temporary files
SANCHECK stores the data on the switches that is ascertained in these files in an internal format. The final file name consists of <prefix><id><suffix>. SANCHECK combines the parts specified here, without any additional separators, to form a name. <id> is formed internally by SANCHECK and cannot be changed. <id> is 11 characters long and contains:
in the first three characters, an identifier for the file: SWI for the file with the data for the switch SWZ for the zoning information which SANCHECK read for this switch
in the remaining eight characters, the IP address of the switch concerned in hexadecimal format
The files are created under the caller’s ID.
Parameters
PREFIX=
File name prefix
Format: <prefix> (see "Formats for file names")
Default value: SYSDAT.SANCHECK
SUFFIX=
File name suffix
Format: <suffix> (see "Formats for file names")
Default value: No suffix
Example
SWDFILE, PREFIX=SYSDAT.SANCHECK., SUFFIX=.DAT
The following file names are then formed for a switch with the IP address
192.168.222.33:
SYSDAT.SANCHECK.SWIC0A8DE21.DAT
SYSDAT.SANCHECK.SWZC0A8DE21.DAT
Parameter group: Name of the temporary file for configuration data of x86 servers. SANCHECK places the configuration files ascertained in this file. The files are created under the caller’s ID.
Parameters
NAME=filename Format: <filename> (see "Formats for file names")
Default value: SYSDAT.SANCHECK.SXCONF under the current user ID
Example
SXCFILE, NAME=SYSDAT.SANCHECK.SXCONF
[SNMP]
Section: Parameters of the SNMP interface
This section is obsolete.
Default values for accesses to the switches are now specified with *DEFAULT entries in the SWITCHES file (see section "SWITCHES file").
[HOSTS]
Section: Additional data of the user’s own host
BS2NODE
Parameter group:
Specifications for the user’s own host as a node in a SAN (for /390 servers only)
Specifications for up to 32 hosts can be made in the INI file. Each specification consists of one line with CPUID and WWNN. As a result the same INI file can be used on more than one host or more than one VM of a host.
Parameters
WWNN=
WWNN of the user’s own host (mandatory)
SANCHECK requires this specification to check the paths. As the WWNN cannot be determined using operating system functions, it must be specified in the INI file. If a host has more than one Fibre Channel adapter, an arbitrary WWNN must be specified. See also the "Ascertaining the WWNN" (Prerequisites and installation).
Format: The WWNN is 8 characters long and is specified in hexadecimal format. Here the individual characters can be separated by a point or colon. The letters may be specified in upper or lower case.
CPUID=
CPU ID of the host whose WWNN is to be specified (only for /390 servers)
The CPU ID can, for example, be ascertained using the BS2000 command /SHOW-SYSTEM-INFORMATION INFORMATION=*CPU-ID-LIST.
This specification is required to assign the host WWNN to a host. In the case of multiprocessor servers, any of the CPU IDs is specified.
Format: The CPUID is 8 characters long without separators and is specified in hexadecimal format. The letters may be specified in upper or lower case.
Examples
BS2NODE, WWNN=100000000EA08001, CPUID=3002000189000000 BS2NODE, WWNN=10.00.00.00.0e.a0.80.01, CPUID=3012000189000000 BS2NODE, WWNN=10:00:00:00:0e:a0:80:01, CPUID=3022000189000000
X2000 (obsolete)
Parameter group:
Specifications for the X2000 part of the user’s own host (for x86 servers only)
Parameters
LOCLANADDR=
LOCLAN IP address of the X2000 part of an x86 server.
This is specified in the X2000 part and identifies the access of the X2000 part via a special path (LOCLAN) which only exists directly between the BS2000 part and the X2000 part. It can be ascertained using the SE Manager.
Format: The address is specified in IPv4 (Internet Protocol Version 4) format:
aaa.bbb.ccc.ddd
aaa, bbb, ccc, ddd are one- to three-digit decimal numbers between 1 and 255. Leading zeros are permitted, but can also be omitted.
SSHKEY=
*STD | SANCHECK uses the secure shell ( |
*NONE | SANCHECK uses the remote shell ( |
*STD must be specified for x86 servers.
Example
X2000, SSHKEY=*STD
Formats for file names
<filename>
File name in accordance with BS2000 conventions, optionally with catalog ID and user ID
Format:
[:cat:][$user.]filename
cat
Optional specification of the catalog ID
Character set: A...Z and 0...9
Up to 4 characters
Must be enclosed in colons
The default value is the catalog ID which is assigned to the user ID in
accordance with the entry in the user catalog
user
Optional specification of the user ID
Character set: A...Z, 0...9, $, #, @
Up to 8 characters
May not begin with a digit
$ must be specified
The default value is the user’s own user ID
$ (special case): System default ID
name
File name without catalog ID and without user ID
Format: name1[.name2[...]]
Character set: A...Z, 0...9, $, #, @, hyphen, period
Must contain at least one of the characters A...Z
name(i) contains no period and may not begin or end with a hyphen
Up to 41 characters
May not begin or end with a period or a hyphen
May not begin with $
May not begin with # or @ (temporary files)
Not case-sensitive
Examples
| Basic file name |
| File name with user ID |
| File name with catalog ID |
| Special case: System default ID |
<prefix>
Common prefix for names of intermediate files
<prefix> together with the 11-character name component generated by SANCHECK (<id>, "INI file") and any suffix must result in a valid BS2000 file name (see "Formats for file names").
Examples
SYSDAT.SANCHECK.
SANCHECK-DATEI.
<suffix>
Common suffix for names of intermediate files
<suffix> together with the 11-character name component generated by SANCHECK (<id>, "INI file") and a prefix must result in a valid BS2000 file name (see "Formats for file names").
Example
DAT
Example of an INI file
#==============================================================================# # SANCHECK INI file # #==============================================================================# #------------------------------------------------------------------------------# [FILES] # Zwischendateien / temporary files # #------------------------------------------------------------------------------# SWIFILE, NAME=SYSDAT.SANCHECK.SWITCHES # FC switch IP address file SWDFILE, PREFIX=SANCHECK., SUFFIX=.DAT # intermediate files SXCFILE, NAME=SYSDAT.SANCHECK.SXCONF, # SQ server: intermediate data #------------------------------------------------------------------------------# [HOSTS] # Angaben zum eigenen Hosts / data for the users own host # #------------------------------------------------------------------------------# BS2NODE, WWNN="0000000000000001", CPUID=0000000000000001 # /390 server #1 BS2NODE, WWNN="0000000000000002", CPUID=0000000000000002 # /390 server #2 X2000, LOCLANADDR=192.168.138.12 # SQ server: LOCLAN node addr. M X2000, SSHKEY=*STD # SQ server: use ssh #==============================================================================# # SANCHECK INI file : END # #==============================================================================#