TEXAS MEMORY SYSTEMS, INC. RamSan. SNMP Guide. Version: 5.4.2

TEXAS MEMORY SYSTEMS, INC. RamSan SNMP Guide Version: 5.4.2

Copyright c 2011, Texas Memory Systems, Inc. All rights are reserved. Any trademarks or registered trademarks used in this document belong to the companies that own them. No part of this work may be reproduced or used in any form or by any means graphic, electronic, or mechanical, including photocopying, recording, taping, or information storage and retrieval systems without permission of the copyright owner. RamSan SNMP Guide - i - Texas Memory Systems, Inc.

Table of Contents 1 Preface 1 2 Introduction 2 3 SNMP Configuration 3 3.1 Enabling SNMP...................................... 3 3.2 SNMP Community Strings................................ 3 3.3 SNMP System Information Strings............................ 4 3.4 The MIB File........................................ 4 4 Traps 5 4.1 The Trap Sink List..................................... 5 4.2 Enabling Traps....................................... 5 4.3 Testing Traps........................................ 5 4.4 Trap Resend Period.................................... 5 4.5 Mailing Traps........................................ 6 4.6 RamSan Traps....................................... 6 4.6.1 System Message Notification........................... 6 4.6.2 Environmental State Notifications........................ 7 4.6.2.1 Temperature State Notification....................... 7 4.6.2.2 Power State Notification........................... 8 4.6.2.3 Fan State Notification............................ 9 4.6.2.4 Battery State Notification.......................... 10 4.6.3 Fibre Channel State Notification......................... 11 4.6.4 Fibre Channel Configuration Notification.................... 11 4.6.5 Infiniband Channel State Notification...................... 12 4.6.6 Infiniband Channel Configuration Notification................. 12 4.6.7 Logical Unit Notification............................. 13 4.6.8 System State Notification............................. 13 4.6.9 Flashcard State Notification............................ 14 4.6.10 Flashcard Health Notification........................... 15 RamSan SNMP Guide - ii - Texas Memory Systems, Inc.

1 Preface Document Overview This document provides operating procedures for the RamSan SNMP configuration and trap setup under firmware version 5.4.2. In addition, an overview of available traps is included. RamSan SNMP Guide - 1 - Texas Memory Systems, Inc.

2 Introduction RamSan systems support the Simple Network Management Protocol (SNMP), which is the dominant enterprise network management protocol. The industry has accepted this protocol due to its relative simplicity. The SNMP standards provide a framework for the definition of management information along with a protocol for the exchange of that information. The RamSan is compatible with SNMP V2c. The SNMP model contains managers and agents. A manager is a software module responsible for managing the configuration on behalf of the network management application end users. Agents are devices, such as the RamSan, which are responsible for maintaining local management information and delivering that information to a manager via SNMP. Both the manager (via polling) and the agent (via a trap) can initiate management information exchanges. RamSan SNMP Guide - 2 - Texas Memory Systems, Inc.

3 SNMP Configuration The SNMP agent may be configured using either the web management interface or the command line interface. For step-by-step, operational details for each of the following sub-sections, please consult the RamSan Web Interface Guide or RamSan Command Line Interface Guide for your system. Feature: Default Setting: SNMP Community Strings Read: read Write: readwrite SNMP System Information Strings Description: Description Unconfigured Location: Location Unconfigured Contact: Contact Unconfigured SNMP Trap IPs None configured SNMP agent Enabled SNMP Traps All enabled except the System Message Notification Table 1: Default SNMP Configuration 3.1 Enabling SNMP By factory default, the RamSan SNMP agent is enabled. The enabled or disabled state is preserved through power cycles. When the agent is disabled, the RamSan system s SNMP object identifier (OID) tree will not be available and no traps will be sent for system events. 3.2 SNMP Community Strings The SNMP community string is like a user id or password that allows access to the RamSan system s SNMP information tree of OIDs. If the community string is correct, the RamSan returns the requested information. If the community string is incorrect, the RamSan simply discards the request and does not respond. There are two community strings for the RamSan: The SNMP read-only community string enables a remote device to retrieve read-only information. The SNMP read-write community string allows a remote device to read information and to modify settings. The RamSan ships from the factory with a read-only community string of read and a read-write community string of readwrite. It is standard practice for network managers to change all the community strings so that outsiders cannot see information about the internal network. RamSan SNMP Guide - 3 - Texas Memory Systems, Inc.

3.3 SNMP System Information Strings The SNMP standards allow you to configure the system information reported by the agent. This information can be set through the web management interface or the command line interface; for example, setting the system location (i.e. Row 11, Rack C ) and an administrative contact for the system (i.e. Pat Smith, (713) 555-1212 ). 3.4 The MIB File The network manager makes virtual connections to the RamSan, which returns information to the manager regarding the device s status. The agent contains a database, known as the SNMP Management Information Base (MIB), describing these application parameters. The manager uses this database to make requests to the agent and interpret the signals received. The MIB describes a set of statistical and control values defined for hardware nodes on the RamSan. The RamSan system s MIB file is available for download through the web management interface s SNMP panel. RamSan SNMP Guide - 4 - Texas Memory Systems, Inc.

4 Traps The RamSan has the ability to send unsolicited messages to managers when it detects a significant event. The SNMP standard refers to this type of message as a trap. 4.1 The Trap Sink List A trap sink defines a host and a community string pair. When a trap event occurs on the RamSan, the SNMP agent will send out a trap to each host in the trap sink list using the community string. This community string is for host-side access to trap monitoring software, such as Net-SNMP s snmptrapd application, rather than the RamSan system s SNMP agent access. The trap sink list may be configured through the web management interface s SNMP configuration wizard or using the command line interface command snmp sinks. By factory default, no trap sinks are defined. 4.2 Enabling Traps The RamSan has the ability to individually disable or enable traps. Each trap s disabled state may be viewed and set through either the command line interface s snmp traps command or with the web management interface s SNMP panel Traps dialog. 4.3 Testing Traps The RamSan can be requested to send out test traps for each of its trap types. This is useful for testing that the trap sinks are correct and that the receiving host is correctly configured. The test trap will look exactly like an actual trap for a system event but with dummy information. For example, the test trap for a system message notification will send the message This is a trap test. To initiate test traps, use the web management interface s Traps dialog or the command line interface s snmp test trap command using a trap ID from the snmp traps command. 4.4 Trap Resend Period The RamSan can be configured to periodically resend a trap message. For example, if a temperature sensor becomes too hot and triggers a temperature state warning notification, the system can resend this trap every few hours until the sensor returns to normal so the warning state is not forgotten. Each notification type has an individually configurable resend period. These may be edited using the web management interface s SNMP panel Traps dialog or with the command line interface RamSan SNMP Guide - 5 - Texas Memory Systems, Inc.

command snmp resend. By default, traps are either configured to have the periodic resend turned off or set to 12 hours. 4.5 Mailing Traps The RamSan has the ability to send traps to specified e-mail addresses. E-mail reports containing system event messages are sent periodically depending on their rate of occurrence. This prevents an excessive number of e-mails from flooding the specified e-mail targets. This feature may be configured and enabled through the Mail Service. To configure the Mail Service, use the web management interface s Mail Service configuration wizard or the command line interface s mail command. It may be tested by using the web management interface s Mail Service panel Test button or the command line interface s mail test command. 4.6 RamSan Traps The following subsections provide detailed information about the SNMP v2 notifications (traps) that the RamSan generates because of various system events. Each trap contains a time stamp, the trap OID, a brief message, and sometimes the relevant system object and/or state variable. Trap OIDs and definitions are located in the MIB file. 4.6.1 System Message Notification Name systemmessagenotif Includes trapmessage The system message text Table 2: System Message Notification System message traps are general messages about the system. They range from warning or error messages about ECC events or power failures to informational messages for events such as the system has been patched. RamSan SNMP Guide - 6 - Texas Memory Systems, Inc.

4.6.2 Environmental State Notifications The temperature, power, fan, and battery notifications are all environmental notifications and have similar behavior. Each reports a state change in the overall state of the sensor group of that category. In most cases, if only one sensor has gone into the warning state, the overall state becomes warning even when the remaining sensors are good. The most common states are Good, Warning and Error. Often when the overall state goes into the error state, one or more sensor has gone into a dangerous state and the RamSan will shutdown to prevent damage to system components. Another of the states is Not Present. This means there is a sensor missing in the group. For example, a system that has multiple fan banks that can be independently unplugged and one bank is unplugged. The corresponding fan sensors for this bank as well as the overall fan state will be Not Present. Other possible states are Test and Comm. Error. The Test state usually indicates testing software is testing sensors in this group. When the periodic battery test is running, the battery overall state will be Test. Comm. Error, or Communication Error, means that the SNMP agent has failed to retrieve the overall state. If this should happen, consult the event log or contact support@texmemsys.com to resolve the problem. 4.6.2.1 Temperature State Notification Name temperaturenotif Includes trapmessage Message describing the state change trapenvstate The new state: 1 commerror An error occurred reading the sensors state. 0 good All sensors are good. 1 warning One or more sensor is in state warning. 2 error One or more sensor is in state error. 3 notpresent One or more sensor is missing. 4 test The sensors are in state test. Also the trap test notification state. Table 3: Temperature State Notification This trap indicates a change in the overall state of all temperature sensors. The temperature table OID to read the individual temperature sensor values and states is temperaturetable. If the overall state is Warning, the fans may need to be serviced or the system moved into a RamSan SNMP Guide - 7 - Texas Memory Systems, Inc.

different environment. If the temperature goes into error state, the levels are dangerously high and the system will shutdown. 4.6.2.2 Power State Notification Name powernotif Includes trapmessage Message describing the state change trapenvstate The new state: 1 commerror An error occurred reading the sensors state. 0 good All sensors are good. 1 warning One or more sensor is in state warning. 2 error One or more sensor is in state error. 3 notpresent One or more sensor is missing. 4 test The sensors are in state test. Also the trap test notification state. Table 4: Power State Notification The RamSan contains multiple sensors to measure voltages and currents throughout the system. The power state trap is for the overall state of these sensors and follows the same lines as the temperature trap. A warning state means that some of the voltage or current levels are outside the specification range or that AC power has been lost. If a critical sensor goes into an error state, the system will be shut down to prevent damage. RamSan SNMP Guide - 8 - Texas Memory Systems, Inc.

4.6.2.3 Fan State Notification Name fannotif Includes trapmessage Message describing the state change trapenvstate The new state: 1 commerror An error occurred reading the sensors state. 0 good All sensors are good. 1 warning One or more sensor is in state warning. 2 error One or more sensor is in state error. 3 notpresent One or more sensor is missing. 4 test The sensors are in state test. Also the trap test notification state. Table 5: Fan State Notification The fan trap indicates a change in the overall fan state. Unlike the other environmental groups, fans in most RamSan systems have built-in redundancy. Because of this, if a single fan of a redundant group (usually a pair) goes into a warning or error state (meaning it is stopped or reporting slower than expected rotation speed), the overall state will never go beyond warning. If a warning state persists, the fans may need to be serviced, but there is no immediate danger. If all fans of a redundant group have stopped or slowed, the overall state will become Error. In this case, the system temperatures may rise to critical levels and cause a system shutdown. RamSan SNMP Guide - 9 - Texas Memory Systems, Inc.

4.6.2.4 Battery State Notification Name batterynotif Includes trapmessage Message describing the state change trapenvstate The new state: 1 commerror An error occurred reading the sensors state. 0 good All sensors are good. 1 warning One or more sensor is in state warning. 2 error One or more sensor is in state error. 3 notpresent One or more sensor is missing. 4 test The sensors are in state test. Also the trap test notification state. Table 6: Battery State Notification The battery sensors include the battery and charger voltages and currents, plus each battery s charge percentage. When the battery state is Warning, the batteries may be in use or charging because AC power has been lost or regained, respectively. In the event of an error notification, the batteries may need to be serviced or one or more of the batteries has voltages that threaten the system s ability to backup data in the event of a power loss. RamSan SNMP Guide - 10 - Texas Memory Systems, Inc.

4.6.3 Fibre Channel State Notification Name fcstatenotif Includes trapmessage Message describing the event trapobject The Fibre Channel port object trapfcstate The new state: 2 test Trap test notification state. 1 unknown An error occurred reading the FC state. 0 none No state is available. 1 online The port is online and functional. 2 offline A device is plugged into the FC port, but the linkup procedure has not completed successfully. 3 disabled The port has been disabled. 4 nolight Nothing is plugged into the FC port. Table 7: Fibre Channel State Notification The Fibre Channel state trap is sent when a Fibre Channel port s state changes. If the state changes to disabled, it is likely that the system is powering off. 4.6.4 Fibre Channel Configuration Notification Name fcconfignotif Includes trapmessage Message describing the event trapobject The Fibre Channel port object Table 8: Fibre Channel Configuration Notification This trap is sent whenever a Fibre Channel port s configuration is changed, such as changing the topology or link speed. RamSan SNMP Guide - 11 - Texas Memory Systems, Inc.

4.6.5 Infiniband Channel State Notification Name ibstatenotif Includes trapmessage Message describing the event trapobject The Infiniband port object trapfcstate The new state: 2 test Trap test notification state. 1 unknown An error occurred reading the IB state. 0 none No state is available. 1 online The port is online and functional. 2 offline A device is plugged into the IB port, but the linkup procedure has not completed successfully. 3 disabled The port has been disabled. Table 9: Infiniband State Notification The Infiniband state trap is sent when an Infiniband port s state changes. 4.6.6 Infiniband Channel Configuration Notification Name ibconfignotif Includes trapmessage Message describing the event trapobject The Infiniband port object Table 10: Infiniband Configuration Notification This trap is sent whenever an Infiniband port s configuration is changed. RamSan SNMP Guide - 12 - Texas Memory Systems, Inc.

4.6.7 Logical Unit Notification Name lunnotif Includes trapmessage Message describing the event Table 11: Logical Unit Notification The logical unit (LU) trap covers two general changes to the LU configuration: the LU configuration has changed or the logical unit access policies have changed. This trap is sent for events such as adding or removing an LU, resizing an LU or changing its access policies. 4.6.8 System State Notification Name systemstatenotif Includes trapmessage Message describing the event trapobject The system object relevant to this event Table 12: System State Notification The system state notification is sent when system operations start or complete. RamSan SNMP Guide - 13 - Texas Memory Systems, Inc.

4.6.9 Flashcard State Notification Name fcardstatenotif Includes trapmessage Message describing the event trapobject The Flashcard object trapfcardstate The new state: 2 test Trap test notification state. 1 unknown An error occurred reading the state. 0 shutdown The Flashcard is shut down. 1 starting The Flashcard is starting. 2 formatting The Flashcard is being formatted. 3 uninitialized The Flashcard is uninitialized and must be formatted before it is usable. 4 good The Flashcard is operational. 5 shuttingdown The Flashcard is shutting down. 6 fault The Flashcard has faulted and is neither readable nor writable. 7 read-onlyfault The Flashcard has faulted but is still readable. 8 dstroying The Flashcard is going through the dstroy process, which destroys all data on the card. Table 13: Flashcard State Notification The Flashcard state trap is sent when a Flashcard s state changes. RamSan SNMP Guide - 14 - Texas Memory Systems, Inc.

4.6.10 Flashcard Health Notification Name fcardhealthnotif Includes trapmessage Message describing the event trapobject The Flashcard object trapfcardhealthstate The new health state: 2 test Trap test notification. 1 unknown An error occurred reading the health. 0 good The Flashcard s health is good. 1 warning The Flashcard s health has degraded and requires service. Table 14: Flashcard Health Notification The Flashcard health trap is sent when a Flashcard s health state changes. Note: If a Flashcard s health changes to warning, please contact Texas Memory Systems, Inc. as the card requires service or replacement. RamSan SNMP Guide - 15 - Texas Memory Systems, Inc.