SWITCHES file

The SWITCHES file must contain the address of the SNMP agent for every switch in the SAN configuration which is to be checked.

The file name and user ID are defined in the INI file (FILES section, SWIFILE parameter). If the specification is missing, the default name SYSDAT.SANCHECK.SWITCHES is used in the current user ID.
If the SWITCHES file is not found, SANCHECK is terminated.

Structure

The SWITCHES file contains precisely one IP address of an SNMP agent in each line plus further parameters for SNMO access to the switch.

The following rules also apply for the SWITCHES file:

• Lines which begin with # are comment lines and are ignored when the SWITCHES 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.

Format of an entry

An entry in the SWITCHES file has the following format:

<agent_addr> [,VFID=<vfid>] [,SNMPVERS={1/3}] [,COMMUNITY=<community>]

[,USER=<user>] [,PASSWORD=<password>]

Description of the parameters

<agent_addr>

Address of an FC switch's SNMP agent. Format:

• IPv4 (Internet Protocol Version 4): 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.

• Host name: Character string with no blanks: Maximum length: 48 characters.

• *DEFAULT: Default values for the SNMPVERS, COMMUNITY, USER and PASSWORD operands. These specifications apply for all subsequent entries. All parameter combinations are permitted here. The following default values apply when no *DEFAULT entry is specified:

  SNMPVERS=1, COMMUNITY=public, USER=sancheck, PASSWORD=password.

  The VFID is regarded as not specified.

  
  

  When a host name is specified, it must be defined in the name service. In the network a name server must be accessible which can resolve the host name. If the IP address of a host name cannot be ascertained, SANCHECK issues an error message and the entry is rejected.

 

VFID=<vfid>

Virtual fabric ID. This references a virtual switch on a real switch.Format: Decimal number 1 .. 128.
Default value: No VFID specified.
Otherwise VFID is treated as not having been specified.

This parameter may not be specified for real switches (i.e. switches on which no virtual fabric is configured).

When this parameter is not specified but a virtual fabric is configured on the switch concerned, the data of the default switch is ascertained. By default this has VFID=128.

When this parameter is specified, SNMPVERS=1 may not be specified as this is required to ascertain the data of an SNMPv3 virtual switch. Otherwise SANCHECK issues an error message and the entry is rejected.

SNMPVERS={1/3}

SNMP version to be used. Values:

1	SNMP Version 1. In this case the community name specified explicitly (COMMUNITY parameter) or the default community name is used. No virtual fabric ID (VFID parameter) may be specified.Otherwise SANCHECK issues an error message and the entry is rejected.
3	SNMP Version 3. In this case the user ID specified explicitly (USER parameter) or the default user ID is employed.No community name (COMMUNITY parameter) may be specified.Otherwise SANCHECK issues an error message and the entry is rejected. Default value: 1 or the value assigned with the *DEFAULT entry.

COMMUNITY=<community>

Community name which must be specified as access protection when communication takes place with SNMP The community name is defined in the switch and can be modified there.
Format: Character string with no blanks.
Maximum length: 48 characters.
Default value: public or the value predefined by means of the *DEFAULT entry.

This parameter only has a meaning when the SNMPv1 protocol is used. If SNMPVERS=3 is specified in the switch entry or this is set by the DEFAULT specification, this entry is rejected as faulty.

The community name must be specified in precisely the same way as it was defined in the FC switch, including the same use of upper and lower case. The maximum length for the community name accepted in the switches can be less than the length accepted by SANCHECK.

 

USER=<user>

User ID which is employed for SNMPv3 accesses as the SNMP user ID and for ascertaining the zoning data as the switch user ID.
The user IDs are defined in the switch and can be modified there by the switch administrator.
Format: Character string with no blanks.
Maximum length: 48 characters.
Default value: sancheck or the value predefined by means of the *DEFAULT entry.

In the case of virtual switches a switch user ID of the same name must exist for an SNMP user ID to enable data to be transferred.

PASSWORD=<password>

Password of the switch user ID which is used to ascertain the zoning data. The password is defined in the switch and can be modified there by the switch administrator.Format: Character string with no blanks.
Maximum length: 48 characters.
Default value: password or the value predefined by means of the *DEFAULT entry.

Example 1

*DEFAULT SNMPVERS=3, COMMUNITY=mycomm, USER=snmpuser1, PASSWORD=password

The entries below use the specified parameters if the parameters if they are not specified there explicitly.

The SWITCH11 entry then corresponds to:

SWITCH11 SNMPVERS=3, USER=snmpuser1, PASSWORD=password

The SWITCH12 SNMPVERS=1 entry then corresponds to:

SWITCH12 SNMPVERS=1, COMMUNITY=mycomm, USER=snmpuser1, PASSWORD=password

Example 2

172.18.80.2

If no default settings were specified beforehand (*DEFAULT entry), the data of the real switch or of the default switch (if a virtual fabric has been enabled on this switch) is ascertained with the specified IP address using SNMPv1. public is used as an SNMPv1 community. In the case of switches of the vendor Brocade with firmware version 6.4.3 or higher, the default user ID sancheck and the default password password are used to ascertain the zoning data.

Example 3

FCSW303, SNMPVERS=1, COMMUNITY=internal, USER=sanchecker, PASSWORD=mypasswd

If no default settings were specified beforehand (*DEFAULT entry), the data of the real switch or of the default switch (if a virtual fabric has been enabled on this switch) is ascertained with the specified name using SNMPv1. The specified SNMPv1 community is used. In the case of switches of the vendor Brocade with firmware version 6.4.3 or higher, the specified user ID and the specified password are used to ascertain the zoning data.

 

Example 4

172.18.80.4, SNMPVERS=3

If no default settings were specified beforehand (*DEFAULT entry), the data of the real switch or of the default switch (if a virtual fabric has been enabled on this switch) is ascertained with the specified IP address using SNMPv3. sancheck is employed as the SNMPv3 user. In the case of switches of the vendor Brocade with firmware version 6.4.3 or higher, the user ID sancheck and the password password are used to ascertain the zoning data.

Example 5

FCSW505, SNMPVERS=3, USER=sanchecker,

The data of the real switch or of the default switch (if a virtual fabric has been enabled on this switch) is ascertained with the specified name using SNMPv3. The specified user ID is employed as the SNMPv3 user ID. In the case of switches of the vendor Brocade with firmware version 6.4.3 or higher, the zoning data is ascertained by means of CLI access by the specified user with the default password password.

Example 6

FCSW606, VFID=6, SNMPVERS=3, USER=sanchecker, PASSWORD=mypass

The data of the virtual switch with virtual fabric ID 5 on the real switch with the specified name is ascertained with SNMPv3. The specified user is employed as the SNMPv3 user. In the case of switches of the vendor Brocade with firmware version 6.4.3 or higher, the specified user ID and the specified password are used to ascertain the zoning data.

 

Example of a SWITCHES file

#==============================================================================#
#                            SANCHECK SWITCHES file                            #
#==============================================================================#
#------------------------------------------------------------------------------#
# Fabric 1                                                                     #
#------------------------------------------------------------------------------#
192.168.111.1, COMMUNITY=sancheck # remark: NAME=SANSW1 DOMAIN=1
192.168.111.2, COMMUNITY=sancheck # remark: NAME=SANSW2 DOMAIN=2
192.168.111.3, COMMUNITY=sancheck # remark: NAME=SANSW3 DOMAIN=3
192.168.111.4, COMMUNITY=sancheck # remark: NAME=SANSW4 DOMAIN=4 PRINCIPAL
#------------------------------------------------------------------------------#
# Fabric 2                                                                     #
#------------------------------------------------------------------------------#
# defaults: SNMPVERS=1,COMMUNITY=sancomm,USER=sancheck,PASSWORD=password
FCSW201                           # remark: IP=192.168.222.1 DOMAIN=1
FCSW202                           # remark: IP=192.168.222.2 DOMAIN=2
FCSW203                           # remark: IP=192.168.222.3 DOMAIN=3
FCSW204                           # remark: IP=192.168.222.4 DOMAIN=4 PRINCIPAL 
#------------------------------------------------------------------------------#
# Fabric 3 (virtual)                                                           #
#------------------------------------------------------------------------------#
*DEFAULT SNMPVERS=3,USER=sanuser,PASSWORD=sanuserpwd
FCSW301 VFID=3#
FCSW302 VFID=3#
#------------------------------------------------------------------------------#
# Fabric 4 (virtual)                                                           #
#------------------------------------------------------------------------------#
FCSW301 VFID=4#
FCSW302 VFID=4#
#==============================================================================#
#                         SANCHECK SWITCHES file : END                         #
#==============================================================================#