Use of this file enables customization of the fault monitoring method. Define the file on the Manager and Agent sides.
Event log messages and operations using linkage with Systemwalker Centric Manager, linkage with Shell/Bat and linkage with External Script can be defined for SNMP Traps received from individual device (including server node). Customize the contents of this file to change default values of this software on the Manager side according to the operating environment of the storage system used.
It defines a fault monitoring method of an Agent server node. Customize its contents to change the monitoring method from default.
Reflecting Contents of Setting File
The setting file on the Manager side is dynamically read into this software and therefore no special reflection method is provided.
The setting file on the Agent side is read into this software statically and therefore the Agent needs to be restarted to reflect the contents of the setting file on this software.
Customization
Note
If an error is detected in an XML definition file, a message in the format shown below is output to the event log. The fault level of notification is the information level. Linkage with Systemwalker Centric Manager and linkage with Shell/Bat are not used.
Message format: "XML parse error (detected trap: (SNMP Trap data character string))"
Except for some devices, all swsag codes that are reported to Systemwalker Centric Manager are 4821.
When customizing SNMP Trap processing, do not edit the definition file in the installation directory but edit the one in the customization directory.
The SNMP Trap XML definition file is created for each device. It is then stored in the following directory when Manager is installed or upgraded.
Platform of Manager | Location |
|---|---|
Windows | $INS_DIR\ESC\Manager\opt\FJSVssmgr\lib\snmpth |
Solaris OS, | /opt/FJSVssmgr/lib/snmpth |
When customizing SNMP Trap processing of Manager, copy the SNMP Trap XML definition file in the above directory to the customization directory shown below, and edit the copy of the file.
Platform of Manager | Customization Directory |
|---|---|
Windows | $ENV_DIR\ESC\Manager\etc\opt\FJSVssmgr\current\snmpth |
Solaris OS, | /etc/opt/FJSVssmgr/current/snmpth |
Manager operates as follows:
When the SNMP Trap XML definition file exists in the customization directory
Manager operates in accordance with its file.
When the SNMP Trap XML definition file does not exist in the customization directory
Manager operates in accordance with the definition file in the installation directory. (default)
In a trap of a device, the file name is enterprise code in which "." is replaced with "_".
Device Type | File Name |
|---|---|
ETERNUS DX S5 series | 1_3_6_1_4_1_211_4_1_1_126_1_153.xml |
ETERNUS DX S4 series (excluding the ETERNUS DX8000 S4 series) | 1_3_6_1_4_1_211_4_1_1_126_1_150.xml |
ETERNUS DX8000 S3 series | 1_3_6_1_4_1_211_4_1_1_126_1_152.xml |
ETERNUS DX60 S2 | 1_3_6_1_4_1_211_4_1_1_126_1_101.xml |
ETERNUS DX80 S2/DX90 S2 | 1_3_6_1_4_1_211_4_1_1_126_1_100.xml |
ETERNUS DX8000 S2 series | 1_3_6_1_4_1_211_4_1_1_126_1_102.xml |
Brocade series | 1_3_6_1_4_1_1588_2_1_1_1.xml |
ETERNUS LT140/LT260 | 1_3_6_1_4_1_20884_3.xml |
ETERNUS LT270 S2 | 1_3_6_1_4_1_211_4_1_1_126_3_6.xml |
Tape encryption device | 1_3_6_1_4_1_2021_250_10.xml |
Fibre Alliance MIB support device | 1_3_6_1_3_94.xml |
ETERNUS AX/HX series | 1_3_6_1_4_1_789.xml |
ETERNUS AB/HB series | 1_3_6_1_4_1_789_1123_2_500.xml (*1) |
ETERNUS VS850 S3 | 1_3_6_1_4_1_2_6_190.xml |
ETERNUS LT20 S2/LT40 S2/LT60 S2 (SAS/FC model) | 1_3_6_1_4_1_20884_10893_2_101_3.xml |
ETERNUS CS2000 | 1_3_6_1_4_1_231_2_48_2_0.xml |
Event from performance management | 1_3_6_1_4_1_211_4_1_3_21_3.xml |
Multipath-related event from Solaris OS Agent or Windows Agent | 1_3_6_1_4_1_211_4_1_3_21_2.xml (*2) |
PRIMECLUSTER GD or PRIMECLUSTER GFS series event from Solaris OS Agent | 1_3_6_1_4_1_211_4_1_3_21_2_2.xml (*2, *3) |
Multipath-related event from Solaris OS Agent | 1_3_6_1_4_1_211_4_1_3_21_2_21.xml (*2, *3) |
Multipath-related event from Windows Agent | 1_3_6_1_4_1_211_4_1_3_21_2_5.xml (*2, *3) |
MPIO event from Windows Agent | 1_3_6_1_4_1_211_4_1_3_21_2_51.xml (*2, *3) |
ETERNUS multipath driver event from Linux Agent | 1_3_6_1_4_1_211_4_1_3_21_2_3.xml (*2, *3) |
PRIMECLUSTER GD or PRIMECLUSTER GFS series event from Linux Agent | 1_3_6_1_4_1_211_4_1_3_21_2_31.xml (*2, *3) |
Device-Mapper Multipath event from Linux Agent | 1_3_6_1_4_1_211_4_1_3_21_2_32.xml (*2, *3) |
LVM(PV-Links) event from HP-UX Agent | 1_3_6_1_4_1_211_4_1_3_21_2_4.xml (*2, *3) |
HBA driver event from HP-UX Agent | 1_3_6_1_4_1_211_4_1_3_21_2_41.xml (*2, *3) |
Multipath-related event from AIX Agent | 1_3_6_1_4_1_211_4_1_3_21_2_6.xml (*2, *3) |
Checking the settings for SNMP Traps from Agent | 1_3_6_1_4_1_211_4_1_3_21_2_2.xml (*4) |
*1: This file can be changed or added only Convert tag in "Definition File Format". Do not change other tags.
*2: This file can be changed only concerning the on/off setting of "linkage with Systemwalker Centric Manager" (only Shell/Bat linkage control can be done and Systemwalker Centric Manager linkage cannot be.) and "external script linkage 1" and "external script linkage 2" in "Operation definition" (the flag attributes) in "Definition Contents" of "Definition File Format". For "Fault level" and "Message," this file cannot be changed.
*3: When this file is updated, the file with the same name on the Agent side must also be updated so that their contents are the same.
*4: When SNMP Trap is used as a test, 1 is used for the Specific Trap Type number.
The XML definition file for customizing the fault monitoring method of an Agent server node is saved at the following location:
Platform of Agent | Location |
|---|---|
Windows | $ENV_DIR\ESC\Agent\etc\snmpth |
Solaris OS, | /etc/opt/FJSVssage/snmpth |
The file is read and used when Agent starts. Therefore, the restart of Agent is needed to operate according to the modified contents when the file is modified.
The file name is the enterprise code in a trap issued from Agent to Manager and in which "." is replaced with "_".
Server Node | File Name (*1) | Monitoring Target |
|---|---|---|
Solaris OS | 1_3_6_1_4_1_211_4_1_3_21_2_2.xml | PRIMECLUSTER GD, PRIMECLUSTER GFS series |
1_3_6_1_4_1_211_4_1_3_21_2_21.xml | ETERNUS multipath driver | |
1_3_6_1_4_1_211_4_1_3_21_2_22.xml | EMC PowerPath | |
1_3_6_1_4_1_211_4_1_3_21_2_23.xml | HITACHI JP1/HiCommand Dynamic Link Manager | |
1_3_6_1_4_1_211_4_1_3_21_2_24.xml | Sun MPxIO | |
Windows | 1_3_6_1_4_1_211_4_1_3_21_2_5.xml | ETERNUS multipath driver |
Linux | 1_3_6_1_4_1_211_4_1_3_21_2_3.xml | ETERNUS multipath driver |
1_3_6_1_4_1_211_4_1_3_21_2_31.xml | PRIMECLUSTER GD, PRIMECLUSTER GFS series | |
1_3_6_1_4_1_211_4_1_3_21_2_32.xml | Device-Mapper Multipath | |
HP-UX | 1_3_6_1_4_1_211_4_1_3_21_2_4.xml | PV-LINK (LVM function) |
1_3_6_1_4_1_211_4_1_3_21_2_41.xml | HBA driver | |
AIX | 1_3_6_1_4_1_211_4_1_3_21_2_6.xml | MPIO |
*1: When this file is updated, the file with the same name on the Manager side must also be updated so that their contents are the same.
Operations are defined by the following items for the Specific Trap Type in the definition file:
Item | Description |
|---|---|
Operation definition | Whether to post a status change to a window Whether to output the event log Whether to implement linkage with Systemwalker Centric Manager and linkage with Shell/Bat Whether to enable external script linkage 1 |
Fault level | Notification levels of individual events and linkage with Systemwalker Centric Manager (Information/Warning/Error) |
Message | Message output for event and linkage with Systemwalker Centric Manager |
The following figure shows the hierarchy of tag nodes:
Attribute Name | Description |
|---|---|
name | Device name |
ver | Version of this definition file |
This tag defines the script name when using external script linkage. ExternalScript1 indicates external script linkage 1 and ExternalScript2 indicates external script linkage 2. A script defined here is executed when the corresponding linkage bit is set on in the flag attribute of the TrapType tag or the Convert tag.
ExternalScript1 and ExternalScript2 tag must be defined in a line above the TrapType tag definition.
Attribute Name | Description |
|---|---|
name | Executed script name (using full path name) |
This tag defines trap analysis operations for each Specific Trap Type. Traps of types not defined by the TrapType tag are not analyzed and discarded.
Attribute Name | Description |
|---|---|
type | "ST" + Specific Trap Type number (decimal) |
flag | Control of event, linkage with Systemwalker Centric Manager, linkage with Script, and E-mail notification (in 9 bits binary) The "0" is interpreted as "off", the "1" is "on". bit8 ... (Cannot be changed) For example, only linkage with Systemwalker Centric Manager is set to on flag="000001000". If you specify it only 4 bits length, the values of bit4 - bit8 are interpreted as "0". For example, flag="1111" is interpreted as flag="000001111". |
level | Specify events and the levels that are posted to Systemwalker Centric Manager. (I: Information / W: Warning / E: Error) |
msg | Messages displayed for events and linkage with Systemwalker Centric Manager, sending and linkage with Script. The following parameters can be included in messages: %d: Decimal number As many ARG tags as the number of parameters included in a message must be defined as described in (4) below. If any character other than 'd', 'x', and 's' follows %, the % is handled as a character and displayed as is. |
*1: Set it to on if you want to enable the E-mail notification of an information event or disable the E-mail notification of a warning event and an error event.
*2: Since events of the Agent are not reported to Systemwalker Centric Manager, only Shell/Bat linkage control can be done in the definition file of the Agent.
The ARG tag defines correspondence between a parameter specified in the msg attributes of the TrapType tag and a Variable Binding index in trap data. There are as many ARG tags as the number of parameters specified in the msg attributes must be defined.
Attribute Name | Description |
|---|---|
index | Index number (0 or larger) of a parameter included in the msg attributes of the TrapType tag described in (3). |
VBIndex | Index number (0 or larger) of Variable Binding in Trap data |
The Convert tag specifies how to express a character string for an INTEGER type or STRING type data value of a trap. Definition of this tag is optional. For example, to use Trap data value 0 to indicate the status of OK, specify <Convert val="0" name="OK"/> so that character string "OK" can be displayed instead of "0".
By specifying the flag attribute and level attribute (options), a fault level specified in the level attribute of the TrapType tag can be changed and posted. (If the msg attribute includes multiple ARGs and the flag or level attribute is specified in individual Convert tags, the values specified in the Convert tag of the last ARG are used.)
Attribute Name | Description |
|---|---|
val | Numeric data value (decimal) of the INTEGER type in a Trap |
flag (option) | Control of events, linkage with Systemwalker Centric Manager, linkage with Script, and E-mail notification (in 7-bit binary) Refer to "TrapType Tag" for values. |
level (option) | Fault level "I", "W", or "E" This tag is given a higher priority than the TrapType tag. |
name | Character string corresponding to val |
If a value that does not exist in the definition is received, INTEGER type Traps are displayed as a numerical expression, but STRING type Traps are not displayed.
Point
Definitions for data values of the STRING type are only available for the ETERNUS AB/HB series. Define monitoring keywords (such as "^Critical$" and "^Info$") for the Event Priority of a Trap that occurs from the device. To display a test trap, temporarily add a Convert tag with "^Info$" as the monitoring keyword.
The MSG tag defines a monitoring keyword for Server Node Agent monitoring. It is valid only for Server Node Agent.
Windows Agent: Monitors with the id, src, and type attributes (ignores the key attribute).
Another Agent: Monitors with the key attribute (ignores the id, src, and type attributes).
Attribute Name | Description |
|---|---|
key | Monitoring keyword for monitoring (required for a non-Windows Agent) |
id | Event ID of the event to be monitored (required for a Window Agent) |
src | Source name of the event to be monitored (required for a Windows Agent) |
line | When a VAL tag is used (a substring of a monitored event is added to notification information), specify the number of monitored event lines for the line attribute. The line attribute can be omitted for a single line or when a Windows Agent is used. |
type | Specify the type of event logs to be monitored. (Valid only for windows Agent) System: Monitor the system log. (Default) |
To change the monitoring keyword, change this keyword.
Regular expression can be specified to the monitoring keyword.
To add a monitoring keyword for monitoring, add the TrapType tag and later shown below. Be sure not to specify a Specific Trap Type number that is already specified.
The VAL tag is used to define the method of retrieving a character string from the monitored event and adding it to notification information. The VAL tag is valid only for Server Node Agent.
Attribute Name | Description |
|---|---|
ref | Specify the value to be added to notification information. Specify the value in parentheses () in regular expression. |
During SNMP Trap control, the type attribute of the TrapType tag is used as the ID attribute for searches, so DTD must be described as follows in the XML definition file:
<!DOCTYPE SNMPTrapControl[ <!ATTLIST TrapType type ID #REQUIRED> ]>
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE SNMPTrapControl[
<!ATTLIST TrapType type ID #REQUIRED>
]>
<SNMPTrapControl name="SW3800" ver=1.0">
<TrapType type="ST1" flag="111111" level="E" msg="Faulty reason: %d">
<ARG index="0" VBIndex="0">
<Convert val="0" flag="000110" level="I" name="sw-ok"/>
<Convert val="1" name="sw-faulty"/>
</ARG>
</TrapType>
<TrapType type="ST2" flag="000111" level="E" msg="%s: is currently in state %d">
<ARG index="0" VBIndex="4"/>
<ARG index="1" VBIndex="0">
<Convert val="1" name="unknown"/>
<Convert val="2" name="faulty"/>
<Convert val="3" name="below-min"/>
<Convert val="4" flag="000110" level="I" name="nominal"/>
<Convert val="5" name="above-max"/>
<Convert val="6" name="absent"/>
</ARG>
</TrapType>
</SNMPTrapControl>Example
Method of Suppressing Brocade series FC Port Online/Offline Traps:
To suppress Brocade series FC port Online/Offline traps, change the following locations in the corresponding XML definition file.
The flag attribute is changed to "000000" in val="1" and val="2" of the Convert tag in <ARG index="1" VBIndex="0"> for which "ST3" is specified as the type attribute.
<Convert val="1" flag="000000" level="I" swsag="4203" name="Online"/> <Convert val="2" flag="000000" level="I" swsag="4203" name="Offline"/>