A6K-RSM-J SHELF MANAGER SOFTWARE TECHNICAL PRODUCT SPECIFICATION

Transcription

1 A6K-RSM-J SHELF MANAGER SOFTWARE TECHNICAL PRODUCT SPECIFICATION January

2 Revision history Version Date Description September 2010 First edition May 2011 Second edition. Updated values for voltage and temperature threshold sensors in Table 9 on page 31. Revised event output strings in Table 92 and Table 170. Removed 0030 and 0036 event codes from Table 85 on page 226. Noted in Fantray Control Mode on page 119 that fan tray local control mode is not supported. Added Setting/Getting the Active Network Direction procedures on page 159. Added Setting Ethernet Bonding on page 164. Added POWERON_IGNORE_CRITICAL_TEMP_SHELF parameter for configuring the cooling policy. Added Filter Run Time shelf sensor. Revised the FRU Update Utility chapter to include information about FRU data recovery and command options for the fru_update utility September 2011 Third edition. New Radisys document branding; fixed broken links; corrected Table 125 on page 249 and Table 138 on page 258 to remove the open ejector request event January 2012 Fourth edition. See What s New in This Manual on page 15 for a description of the changes in this edition by Radisys Corporation. All rights reserved. Radisys and Procelerant are registered trademarks of Radisys Corporation. AdvancedTCA, ATCA, and PICMG are registered trademarks of PCI Industrial Computer Manufacturers Group. Wind River is a registered trademark of Wind River Systems Inc. Red Hat and Enterprise Linux are registered trademarks of Red Hat Inc. Procomm Plus and Symantec are registered trademarks of Symantec Corporation. Intel is a registered trademark of Intel Corporation. Linux is a registered trademark of Linus Torvalds. All other trademarks, registered trademarks, service marks, and trade names are the property of their respective owners.

3 Table of Contents 1.0 Document Organization Document Organization What s New in This Manual Glossary of Terms Used in This Document Introduction Overview AdvancedMC* Support Third-party Chassis Integration Specification Conformance Related Documents System Level Specifications U-Boot* Operating System File System Organization Flash Storage Random Access Memory Configuration Files Factory Reset Application Hosting Startup and Shutdown Scripts Available System Resources System Management Interfaces Ethernet Interfaces IPMB Telco Alarms Front Panel LEDs LED Types and States Power Good LED Hot Swap LED Active LED Out of Service LED Retrieving a Location s LED Properties Retrieving Color Properties of LEDs Retrieving State of LEDs Using Lamptest Function LED Boot Sequence Sensors Overview Threshold-based Sensors Threshold-based Sensors on RSM Discrete Sensors OEM Sensors Sensor Event Description String Sensor Information Details SEL Entries SNMP Traps Sensor Targets Health Events Overview Health Queries

4 6.3 Healthevents Queries Healthevents Queries for Individual Sensors Healthevents Queries for All Sensors on Location No Active Events Not Present or Non-IPMI Locations Health Event Property Configuration Alarms Overview Annunciators Acknowledging Alarms System Event Log SEL Architecture on RSM Retrieving SEL SEL Display Format Header Text Translation Raw Output Configuring SEL Display Format Displaying Unrecognized SEL Events Retrieving SEL in Raw Format Clearing SEL SEL Configuration Trap Generation and Platform Event Filtering Trap Generation and Platform Event Filtering Configuration Event Filtering Method PEF Filter PEF Alert Policy PEF Alert String System GUID Supported PEF Functionality PET Trap High Availability Overview Readiness State Changing Peer RSM Readiness State HA Redundancy Sensor HA State Presence State HA State Sensor In-service Request Sensor Out-of-service Request Sensor Redundancy Sensor Health Score Health Score Sensor Data Synchronization Time and Date Synchronization User Scripts Synchronization Data Synchronization Failure Heterogeneous Synchronization DataSync Status Sensor

5 10.6 Failover and Switchover Switchover Failover Standby Reboot HA Control Sensor CMM Status Sensor Re-enumeration Overview Re-enumeration Sensor Event Regeneration Cooling Resolution of EKeys Process Monitoring and Integrity Overview Process Existence Monitoring Process Watchdog Monitoring Process Integrity Monitoring Processes Monitored Process Monitoring Targets Process Dependency Peer Processes Process Monitoring Dataitems Examples Process Monitoring RSM Events Failure Scenarios and Event Processing No action recovery Successful restart recovery Successful failover and restart recovery Successful failover and reboot recovery Failed failover and reboot recovery for a non-critical process Failed failover and reboot recovery for a critical process Excessive restarts and escalation is no action Excessive restarts and successful failover/reboot escalation Excessive restarts, failed failover/reboot escalation, non-critical process Excessive restarts, failed failover/reboot escalation, critical process Process administrative action Configuration Configuration Parameters Security Role-based Access Control User Management Security Sensor Hardware Platform Interface Overview OpenHPI* RSM Plug-in to OpenHPI* Shelf Management & OAM API Overview Shelf Management and OAM API Client Library ShM API Access Permissions Command Line Interface Overview

6 17.0 Simple Network Management Protocol Net-SNMP* Supported MIBs Chassis Management Module MIB OAM MIB MIB II Use of Sub-FRUs Third-party Chassis Support Fan Tray Power Entry Module Air Filter Tray Shelf FRU SAP Alias Mappings SNMP Agent Configuration Files Configuring SNMP Agent Port Configuring Agent to Respond to SNMP v3 Requests Configuring Agent Back to SNMP v Setting up SNMP v1 MIB Browser Setting up an SNMP v3 MIB Browser Changing the SNMP MD5 and DES Passwords SNMP Traps SNMP Trap Format Proprietary SNMP Trap Format Configuring SNMP Trap Format Configuring the SNMP Trap Port Configuring RSM to Send SNMP v3 Traps Configuring RSM to Send SNMP v1 Traps Configuring and Enabling SNMP Trap Addresses Configuring SNMP Trap Addresses Enabling and Disabling SNMP Traps Alerts Using SNMP v Configuring SNMP Trap Acknowledgement Configuring SNMP Trap Retries Sending SNMP Traps for Unrecognized Events Trap Connect Sensor SNMP Security SNMP v1 Security SNMP v3 Security Authentication and Privacy Protocol Additional Notes Redundant ListDataItems MIB Objects Remote Management Control Protocol RMCP Client and Server Communication RMCP Modes Enabling and Disabling RMCP RMCP Discovery IPMB Slave Addresses Communicating with RMCP Server on RSM RMCP Security RMCP User Privilege Levels RMCP Maximum Privilege Levels Configuring IPMI Command Privileges BMC Key Authentication IPMI System GUID RMCP over SCTP Transport

7 18.9 Supported IPMI Commands Completion Codes for RMCP Messages IPMI Pass-Through Overview Command Syntax Command Request String Format Response String Usage Examples Using the CLI Using ShM API Using SNMP RSM Scripting Command Line Interface Scripting Event Scripting Triggering Scripts from Health Events Triggering Scripts from Event Codes Script Execution Listing Scripts Associated with Events Disassociating Scripts from an Event Script Synchronization Environment Variables Error Processing and Messages Invalid pathname Script does not exist Pathname specified is a directory Moved or removed script still associated with event Script has zero bytes Script lacks execute permission Script is on the standby RSM Unable to write to policy.conf Default Scripts Limitations Usage of switchover commands Operational State Management Hot Swap States Hot Swap Sensor FRU Control Scripts FRU Activation Policy Checking Node Presence Power Management Node Operational Power Management Power Levels Shelf Power Budget Power-on Sequence Power Feed Targets Forced Power State Changes on Blades Powering Off a Blade Powering On a Blade Resetting a Blade Obtaining the Power State of a Blade Cooling and Fan Control Temperature Condition Sensor Cooling Policy Process for modifying the shm.conf file Normal Cooling Adjustments

8 23.3 Fan Control in Re-enumeration Fan Tray Cooling Properties Retrieving Current Cooling Level Setting Current Cooling Level Fan Tray Sensors Control Modes for Fan Trays RSM Control Mode Fantray Control Mode Emergency Shutdown Control Mode Automatic Control Mode Change Fan Tray LED Electronic Keying Management Point-to-Point EKeying Bused EKeying EKeying CLI Commands CDMs, Shelf FRU, and FRU Information Chassis Data Modules Shelf FRU Election Process Shelf FRU Information FRU Information Physical IPMC FRU Virtual IPMC FRU Virtual IPMC FRU Virtual IPMC FRU Virtual IPMC FRU Virtual IPMC FRU Virtual IPMC FRU Virtual IPMC FRU Virtual IPMC FRU Virtual IPMC FRU FRU Query Syntax Shelf Address Command and Error Logging Log Levels and Facilities Environment Variables Log Level Control Command Logging Error Logging error.log debug.log Linux* logger Configuring syslog Log Rotation and Archives Restarting syslog-ng Caveats and Limitations Diagnostics U-Boot Diagnostic Tests BOARD_INIT_RAM_TEST POST Diagnostics Manufacturing Diagnostics Run-Time Diagnostics Flash Diagnostics Ethernet Diagnostics Reboot Reason Discovery RSM Crash Logging

9 27.5 Core Dump Kernel Crash Logging Kinds of Data Logged Accessing Logged Data Kernel Crash Log Rotation Sample Log File cmmdump Utility Operating System Flash Corruption Detection & Recovery Monitoring Static Images Monitoring Dynamic Images Statistics Querying Statistics Values OS Statistics Time Synchronization Default Configuration Configuring NTP Client Configuring NTP Server Configuring NTP Server in Broadcast Mode Time Synchronization Sensor RTC Synchronization Configuration File Setting Up the RSM Connecting to the RSM Initial Setup Setting IP Address Properties Setting a Hostname Mounting NFS Setting Time for Auto-logout Setting Date and Time Establishing an Interactive Session Connect through SSH Rebooting the RSM IP Network Configuration Introduction Shelf Manager IP Connection Record OEM Network Data Record Startup Behavior Setting and accessing network configuration data Setting the Active Network Direction Getting the Active Network Direction Setting Data for Active RSM Retrieving Data for Active RSM Setting Ethernet Port Data Retrieving Ethernet Port Data Resetting Ethernet Port Data to Factory Default Values Examples Setting Active RSM Data Setting eth0 Network Configuration Data for RSM Setting eth1 Network Configuration Data for RSM Setting eth2 Network Configuration Data for RSM Setting eth3 Network Configuration Data for RSM Querying Factory Defaults Using ShM API to Set and Get Network Configuration Data Using SNMP to Set and Get Network Configuration Data Start-up Network Configuration Data

10 31.10 Synchronization Between RSMs Setting Ethernet Bonding Enabling/Disabling Ethernet Bonding Bonding Configuration Verifying Proper Bonding Operation Bonding Tests Updating RSM Software Overview Main Features of Firmware Update Process Update Process Elements Dual Image Next Boot Role Setting the Next Boot Role Automatic Rollback System Booting Failures Restarting Specified Image Critical Software Update Files and Directories Generating the update package Update Package Update Package File Validation Firmware Image Properties Single RSM System Redundant RSM Systems CLI Software Update Procedure Update Process Local Upgrade Sensor Configuration Upgrade U-Boot Update Process Chassis Component Firmware Update FRU Update Utility Overview FRU Update Architecture Required Files Update Verification FRU Data Recovery FRU Update Usage ipmitool Parameters Chassis slot and FRU IPMB addresses Command Examples: Customizing FRU-Specific Data Third-Party Chassis Integration Introduction Integrating RSM Firmware into Chassis Creating Chassis FRU Information About frugen.pl Command Options Creating Configuration Files cmm.ini IPMB Section Alias Input Section Alias Output Section CMM Section Blade Section FanTray Section PEM Section

11 Power Feed Section Fan section PEM Section Installing Configuration Files Adding Files to RSM Copying Files to RSM Manually Creating OEM.zip File Adding Chassis Support using Update Command Assumptions and Limitations LED Control Chassis Data Module Sensors Fronted FRU Aliasing Agency Information North America (FCC Class A) Canada Industry Canada (ICES-003 Class A) Safety Instructions English French Taiwan Class A Warning Statement Japan VCCI Class A Korean Class A Australia, New Zealand Safety Warnings Mesures de Sécurité Sicherheitshinweise Norme di Sicurezza Instrucciones de Seguridad Chinese Safety Warning A Sensor Numbers A.1 Shelf Sensors A.2 RSM Sensors A.2.1 RSM Sensors - Physical IPMC A.2.2 RSM Sensors - Virtual IPMC A.2.3 Device Sensor Data Record (SDR) Repository B IPMI Generic Sensor Events B.1 Introduction B.2 Explanation of Abbreviations and Symbols B.3 Event Severity and Contribution to System Health C IPMI Typed Sensor Events C.1 Introduction C.2 Explanation of Abbreviations and Symbols C.3 IPMI Typed Sensor Tables D OEM Sensor Events D.1 Introduction D.2 Explanation of Abbreviations and Symbols D.3 PICMG Hot Swap Sensor D.4 PICMG IPMB-0 Link Sensor D.5 HA Trap Connect Sensor D.6 HA Out of Service Request Sensor D.7 HA In Service Request Sensor D.8 HA State Sensor D.9 DataSync Status Sensor D.10 HA Health Score Sensor

12 D.11 HA Redundancy Sensor D.12 HA Control Sensor D.13 PMS Fault Sensor D.14 PMS Info Sensor D.15 PMS Health Sensor D.16 Local Upgrade Sensor D.17 Log Usage Sensor D.18 Power Allocation Sensor D.19 Power Budget Sensor D.20 Cooling Policy Sensor D.21 Temperature Condition Sensor D.22 Re-enumeration Sensor D.23 RT Diagnostics Sensor D.24 Reboot Reason Sensor D.25 Security Sensor D.26 NTP Status Sensor D.27 Non Compliant FRU Sensor D.28 Filter Run Time Sensor D.29 CMM Status Sensor D.30 HA Peer Lost Sensor D.31 Power Restoration Failure D.32 IPMC Reset Sensor D.33 LMP Reset Sensor D.34 CFD Watchdog Sensor D.35 IPMC HA State Sensor D.36 IPMC Failover Sensor D.37 System Firmware Progress Sensor E Statistics E.1 OS Statistics E.2 Events Statistics E.3 Data Synchronization Statistics E.4 IPMI Generic Statistics E.5 IPMI Message Pool Statistics E.6 Cooling Statistics E.7 Local Sensor Repository Statistics F Legacy RPC Interface F.1 Setting Up the RPC Interface F.2 Using the RPC Interface F.2.1 GetAuthCapability() F.2.2 ChassisManagementApi() F.2.3 ChassisManagementApi() threshold response format F.2.4 ChassisManagementApi() string response format F.2.5 ChassisManagementApi() integer response format F.2.6 FRU String Response Format F.3 RPC Sample Code F.4 RPC Usage Examples G Reference Information G.1 AdvancedTCA* Product Information G.2 AdvancedTCA Specifications G.3 IPMI

13 H ShMgr Version Feature Differences H.1 LISM H.1.1 ShMgr software 7.1.x is designed to be a Location Independent Shelf Manager (LISM) H.1.2 For version 8.x, the "software IPMC process" and associated functionality are decoupled from the LISM H.2 Porting to version 8.1.X includes porting ShMgr software to a different platform H.2.1 Wind River H.2.2 New LMP processor H.2.3 New IPMC H.2.4 U-Boot firmware bootstrapping H.3 Shelf management functionality is divided into two distinct components H.3.1 Low-level code running on the Renesas H8S/2472 H.3.2 microcontroller (ShMC) High-level code running on a Local Management Processor (LMP) H.4 Cannot upgrade from ShMgr versions 5.2.x, 6.1.x, and 7.1.x H.5 FRU power management H.6 Performance improvements H.6.1 Event management H.6.2 SDR management

14 Chapter Document Organization 1.1 Document Organization This document describes the operation and use of the A6K-RSM-J shelf manager (RSM). The following topics are covered in this document. Chapter 2.0, Introduction, introduces the key features of the RSM. This chapter includes a product definition and a list of product features. Chapter 3.0, System Level Specifications, provides system specifications for the RSM. Chapter 4.0, Front Panel LEDs, describes LEDs. Chapter 5.0, Sensors, defines sensors and access methods. Chapter 6.0, Health Events, defines health events. Chapter 7.0, Alarms, defines alarms and annunciators. Chapter 8.0, System Event Log, specifies the content and architecture of System Event Log. Chapter 9.0, Trap Generation and Platform Event Filtering, defines proprietary and IPMI methods for filtering platform events in the RSM. Chapter 10.0, High Availability, specifies architecture and user instrumentation of high availability. Chapter 11.0, Re-enumeration, describes chassis re-enumeration. Chapter 12.0, Process Monitoring and Integrity, describes Process Monitoring service (PM) that monitors the general health of processes running on the RSM and takes recovery actions upon detection of failed processes. Chapter 13.0, Security, specifies role based access control and user management in RSM. Chapter 14.0, Hardware Platform Interface, gives brief description of HPI. Chapter 15.0, Shelf Management & OAM API, gives brief description of OAM & ShM API. Chapter 16.0, Command Line Interface, gives brief description of CLI. Chapter 17.0, Simple Network Management Protocol, specifies how SNMP can be used for chassis management. Chapter 18.0, Remote Management Control Protocol, specifies how RMCP and IPMI LAN interface can be used for chassis management. Chapter 19.0, IPMI Pass-Through, specifies how IPMI Pass Through interface can be used for chassis management. Chapter 20.0, RSM Scripting, specifies usage model for calling the Command Line Interface (CLI) indirectly through scripts using bash shell scripting. Chapters 21.0 through 25.0 specify how RSM implements PICMG shelf management functions: operational state management, power and cooling management, E-Keys management, FRU and Shelf FRU information management. Chapter 26.0, Command and Error Logging, describes RSM logging service. Chapter 27.0, Diagnostics, specifies diagnostic instrumentation. 14

15 1 Chapter 28.0, Statistics specifies instrumentation for statistics. Chapter 29.0, Time Synchronization, describes how RSM implements time management and synchronization. Chapter 30.0, Setting Up the RSM, describes device setup and initial configuration. Chapter 31.0, IP Network Configuration, describes how IP configuration is maintained and managed. Chapter 32.0, Updating RSM Software, describes architecture and procedures of RSM firmware Chapter 33.0, Chassis Component Firmware Update, addresses firmware update on other chassis components, such as fan trays, PEMs, etc. Chapter 34.0, FRU Update Utility, describes the architecture and usage models of FRU Update utility. Chapter 35.0, Third-Party Chassis Integration, describes how RSM must be configured in order to integrate into chassis from third party vendors. Chapters 36.0 and 37.0 provide agency information and safety warnings. Appendix A, Sensor Numbers lists the shelf and RSM sensor numbers, names and types. Appendix B, IPMI Generic Sensor Events documents the generic sensors and their events that are implemented in the RSM firmware. Appendix C, IPMI Typed Sensor Events documents the typed sensors and their events that are implemented in the RSM firmware. Appendix D, OEM Sensor Events lists all of the OEM sensors and events defined for the RSM. Appendix E, Statistics describes the statistics that are implemented in the RSM firmware. Appendix F, Legacy RPC Interface describes how custom remote applications can administer the RSM by using remote procedure calls. Appendix G, Reference Information provides links to data sheets, standards, and specifications for the technology designed into the RSM. Appendix H, ShMgr Version Feature Differences describes the feature differences between the 8.x version of the A6K-RSM-J ShMgr software and earlier versions used on previous CMMs. 1.2 What s New in This Manual Added a note to the +3.0V Battery sensor that event generation for the sensor is disabled when the RSM is used in an NECCH0001 chassis. The System Firmware Progress sensor table was moved from appendix C to appendix D because the sensor events are handled as OEM types, not IPMI types. Added section , shelf FRU data backup commands. Changes to documented output to match actual firmware output. RmcpProtocol command replaced with RmcpTransport. Event Logging Disabled sensor Assertion/Deassertion severity changed to OK for event codes 0x543, 0x544, and 0x545. Added sensors CDM 1 Health and CDM 2 Health to Table 76, Virtual FRU 1 and Virtual FRU 2. 15

16 1 1.3 Glossary of Terms Used in This Document Table 1, Glossary lists a glossary of terms used in this document. Table 1. Glossary (Sheet 1 of 2) Term Used AdvancedTCA AMC ASCII ATCA CDM CLI CRC DHCP FFS FIS FPGA FRU FTP GPIO HPI HS IP IPMB IPMC IPMI LAN LED LSB MIB MIB II MRA MSB OEM OS PEF PEM PICMG RMCP RPC RSM RTM SAF SBC SDR SEL Description Advanced Telecom Computing Architecture AdvancedTCA* Mezzanine Card American Standard Code for Information Interchange Advanced Telecom Computing Architecture Chassis Data Module Command Line Interface Cyclic Redundancy Check Dynamic Host Configuration Protocol Flash File System Flash Image System Field-Programmable Gate Arrays Field Replaceable Unit File Transfer Protocol General Purpose Input/Output Hardware Platform Interface Hot Swap Internet Protocol Intelligent Platform Management Bus Intelligent Platform Management Controller Intelligent Platform Management Interface Local Area Network Light Emitting Diode Least Significant Bit Management Information Base Management Information Base for Network Management II MultiRecord Area Most Significant Bit Original Equipment Manufacturer Operating System Platform Event Filtering Power Entry Module PCI Industrial Computer Manufacturers Group Remote Management Control Protocol Remote Procedural Calls Radisys Shelf Manager module Rear Transition Module Service Availability Forum Single Board Computer Sensor Data Record System Event Log 16

17 1 Table 1. Glossary (Sheet 2 of 2) Term Used SIF ShMC SNMP SSH TFTP UDP WDT Description Sensor Information File Shelf Management Controller Simple Network Management Protocol Secure Socket Shell Trivial File Transfer Protocol User Datagram Protocol Watchdog Timer 17

18 Chapter Introduction 2.1 Overview This document describes the features and specifications of the firmware and software that runs on the A6K-RSM-J Shelf Manager module (RSM). The A6K-RSM-J RSM is a shelf manager that monitors and controls the hardware components installed in an AdvancedTCA chassis. The RSM plugs into a dedicated slot in compatible systems. It provides centralized management and alarming for up to 16 node and/or fabric slots as well as for system power supplies, fans, and power entry modules. The RSM may be paired with a backup RSM for redundant use in high-availability applications. In such a configuration one RSM functions as the active RSM and manages the devices in the chassis; the other RSM functions as a standby RSM, ready to take over management of the chassis if a failover is needed or requested. The A6K-RSM-J has its own processor, memory, PCI bus, operating system, and peripherals. The RSM monitors and configures IPMI-based components in the chassis. When thresholds (such as temperature and voltage) are crossed or a failure occurs, the RSM captures these events, stores them in an event log, and sends SNMP traps. The RSM can query FRU information (such as serial number, model number, manufacture date, etc.), detect the insertion or removal of components (such as fan tray, CPU board, etc.), perform health monitoring of each component, control the power-up sequencing of each device, and control power to each slot via Intelligent Platform Management Interface (IPMI). Note: This document assumes some basic familiarity with the Linux* operating system and associated tools (such as the vi text editor). 2.2 AdvancedMC* Support The RSM firmware supports AdvancedMCs (Advanced Mezzanine Cards, or AMCs) as sub-frus on an SBC (Single Board Computer) or CPM (Compute Processing Module). This support includes power management of the AMCs, hot swap capability, and support for sensors on the AMC. The sensors can be read, the health of the AMC can be monitored and logged, and events pertaining to the AMC can be sent via SNMP traps. Scripts can be written to monitor the AMCs and take appropriate action in response to events generated by the AMC. 2.3 Third-party Chassis Integration The A6K-RSM-J running version 8.1.x of the ShMgr firmware can be integrated into most shelves (chassis) that comply with the PICMG 3.0 Revision 2.0 (AdvancedTCA) specification. Provided with the proper configuration information, such as IPMB (Intelligent Platform Management Bus), topology, slot layout, hardware addresses, etc., the RSM firmware is able to manage most third party shelves that have been developed for the RSM hardware. 2.4 Specification Conformance The RSM is designed to function in a chassis with components that conform to the PICMG* 3.0 Revision 2.0 AdvancedTCA* Base Specification, and the Intelligent Platform Management Interface Specification version 1.5 Document Revision 1.1, and version 2.0 Document Revision

19 2 2.5 Related Documents The following documents relate to the A6K-RSM-J shelf manager: A6K-RSM-J Hardware Reference Document Revision 0001, May 2011, Radisys A6K-RSM-J Installation Guide Document Revision 0001, May 2011, Radisys A6K-RSM-J Firmware and Software Update Instructions Document Revision 0004, June 2011, Radisys Command Line Interface Reference for CMMs A6K-RSM-J, MPCMM0001, MPCMM0002 Document Revision 0002, January 2012 Radisys A6K-RSM-J, MPCMM0001 and MPCMM0002 Chassis Management Module ShM & OAM API Reference Manual Document Revision 0001, August 2010, Radisys Alert Standard Format Specification Version 2.0, April 23, 2003 Distributed Management Task Force, Inc. Intelligent Platform Management Interface Specification v1.5 Document Revision 1.1, February 20, 2002 Intel Corporation, Hewlett-Packard Company, NEC Corporation, and Dell Computer Corporation Intelligent Platform Management Interface Specification v2.0 Document Revision 1.0, February 12, 2004 Intel Corporation, Hewlett-Packard Company, NEC Corporation, and Dell Computer Corporation Platform Management FRU Information Storage Definition v1.0 Document Revision 1.1, September 27, 1999 Intel Corporation, Hewlett-Packard Company, NEC Corporation, and Dell Computer Corporation. Platform Event Trap Format Specification v1.0 Document Revision 1.0, December 7, 1998 Intel Corporation, Hewlett-Packard Company, NEC Corporation, and Dell Computer Corporation. PICMG 3.0 Revision 2.0 AdvancedTCA Base Specification February 11, 2005 PCI Industrial Computer Manufacturers Group Service Availability Forum Hardware Platform Interface Specification Version SAI-HPI-B.01.01, 2004 Service Availability Forum Service Availability Forum HPI-to-AdvancedTCA Mapping Specification Version 0.9, July 2005 Service Availability Forum Alert Standard Format (ASF) Specification version 2.0 DMTF document DSP

20 2 RFC1057 Remote Procedure Call Protocol Specification RFC1157 SNMPv1 message processing models RFC1213 MIB II RFC1215 SNMP TRAP v1 RFC1305 Network Time Protocol RFC3410 SNMPv3 RFC3414 User-based Security Model RFC3415 View-based Access Control Model (VACM) RFC3416 SNMP TRAP v2 IPMI Intelligent Platform Management Interface Specification Second Generation v2.0, Document Revision PET IPMI - Platform Event Trap Format Specification v Appendix G, Reference Information on page

21 Chapter System Level Specifications 3.1 U-Boot* The RSM enters into the U-Boot firmware to bootstrap the embedded environment once power is applied to the chassis. 3.2 Operating System The RSM runs Wind River 3 on the FreeScale P2020 processor. 3.3 File System Organization The general structure of the file system is like that of a typical UNIX* system. Table 2, File System Organization lists an outline of the file system organization. Not all directories are listed in this table, just those that are mount points or are otherwise important. Table 2. File System Organization Directory Mounting point Description / yes Root of the file system /bin no Major OS utilities /sbin no Major OS administrative utilities /dev no Kernel devices /etc yes OS configuration /etc/cmm no RSM configuration /etc/cmm/chassis no Chassis specific configuration /lib no OS libraries /usr/bin no Additional OS utilities /usr/lib no Additional libraries /usr/cmm/bin no RSM binaries and other executables (e.g. tools) /usr/cmm/lib no RSM dynamic libraries /usr/local/data yes Crashdump storage area /usr/share/cmm no User storage /usr/share/cmm/bin no User executables /usr/share/cmm/scripts yes User scripts /var/log/cmm yes Log storage /var/log/cmm/sel no System event log (incl. archives) /var/log/cmm/cmm no RSM and OS error log files (incl. archives) /var/log/cmm/cmm/crash no Crash log /var/run no Symbolic link /tmp /tmp tmpfs Temporary data in tmpfs /proc procfs kernel info and control /sys sysfs Kernel info 21

22 Flash Storage RSM flash storage consists of two banks of 1 gigabyte each. The flash partitions and bank assignments are listed in Table 3. Table 3. Flash Partitions and Bank Assignments Partition mtd0 mtd1 mtd2 mtd3 mtd4 mtd5 mtd6 mtd7 mtd8 mtd9 mtd10 mtd11 Bank Assignment Whole active flash bank Active flash bank U-Boot Active flash bank Linux Active flash bank raw persistent storage (should not be used) Whole backup flash bank Backup flash bank U-Boot Backup flash bank Linux Backup flash bank raw persistent storage (should not be used) Active flash bank JFFS persistent storage Backup flash bank JFFS persistent storage SPI boot flash active bank SPI boot flash backup bank Whole Bank U-Boot Linux This area contains the entire flash device, ignoring any partitioning. This area contains space reserved for U-Boot applications. This area contains the Linux kernel image and ramdisk image with RSM image and Linux root file system. The active RSM image is mounted at /usr/cmm Raw Persistent Storage JFFS File Systems SPI Boot Flash This area consists space used internally by the Linux kernel to provide persistent storage partitions. User executables and scripts are mounted at /usr/share/cmm. The scripts are located in the directory /usr/share/cmm/scripts. Partition mounted at /var/log/cmm provides persistent storage for system event log (SEL), error logs, last reboot reason log, and other OS log files (incl. archives). Variable system configuration is mounted at /etc/cmm. As the /etc directory is read-only (it is a part of the root file system), editable configuration files are located here and have symbolic links in /etc. This area contains the U-Boot images and the U-Boot environment variables. 22

23 3 3.4 Random Access Memory Total RAM size is 1 GB. 3.5 Configuration Files The RSM configuration is stored in a number of configuration files in directory /etc/cmm. RSM configuration files use ASCII text format. The files and the parameters are described in the relevant sections of this Technical Product Specification. When the RSM is running, user edits bypassing system management interfaces (e.g. CLI) are not allowed. The following configuration files contain parameters corresponding to CLI dataitems: shm.conf, policy.conf, trap.conf, snmpd.local.conf, rmcp.conf, ipmi.conf, timesync.conf, permissions.conf, and networks.conf. When the RSM is running, the user can change a parameter value in one of these files by executing the proper CLI command. Configuration files snmpd.conf, pm.conf, events.conf, and busekey.conf cannot be modified with CLI. The files can be edited by the user at any time. The new values are read once at RSM startup. File local.conf is writable by RSM but it should not be modified by the user. Chassis configuration files are located in /etc/cmm/chassis. They are described in detail in Chapter 35.0, Third-Party Chassis Integration on page 183. Note: If a given parameter is not present in a particular configuration file, it assumes the default value. 3.6 Factory Reset The RSM startup script supports the factory reset command. When the user calls cmm --factory- RESET, all files located in directories /etc/cmm, /var/log/cmm, and /usr/share/cmm/ are erased. Next, the erased configuration files and default scripts are replaced with factory default files stored in the read-only /.etc-orig/cmm.skel directory. 3.7 Application Hosting The RSM allows applications to be hosted and run locally. This is useful for adding small custom management utilities to the RSM Startup and Shutdown Scripts The RSM can run user-created scripts automatically on boot-up or shutdown. This can be done by editing the /usr/share/cmm/scripts/startup and /usr/share/cmm/scripts/shutdown files with a text editor. These files are standard shell scripts, so scripts can be added along with anything else that can be done in a shell script. When /etc/inittab executes, it performs a typical sysvinit setup by calling each script in /etc/ rc.d/rc2.d with a start argument. The script names match the format SDDscriptname, where DD is a two-digit number in increasing numerical order. Scripts are also provided for executing the / usr/share/cmm/scripts/startup files. Note: At the time when a user-defined startup script is executed, the CLI may still not be available. When the reboot command is executed from the shell prompt, that command in turn executes all scripts matching the format /etc/rc.d/rc2.d/kddscriptname, where DD represents a two-digit number. These scripts are executed in increasing numerical order with a stop argument. The RSM software provides a script which calls the /usr/share/cmm/scripts/shutdown script, if it exists. 23

24 Available System Resources Flash Storage RAM Disk Storage RAM Constraints Since the RSM has firmware of its own running at all times, user applications must adhere to certain resource and directory constraints to avoid disrupting the operation of the RSM firmware. Specifically, restrictions are placed on an application's consumption of file system storage space, RAM, and interrupts. Exceeding these guidelines may interfere with proper RSM operation. Applications should not perform excessive amounts of flash file I/O at runtime because this will impair performance of the RSM. The following directories are of interest: /usr/share/cmm/scripts - Used for storing user scripts. /usr/share/cmm/bin - Used for storing application binaries. This directory is not persistent. The last two directories can comprise at most 1 MB of data. Files in this location are stored in RAM and will be lost during RSM reboots. Due to the constraints of writing to flash memory, larger file operations such as decompressing an archive should be performed on RAM disk in the following directory: /tmp. This directory is useful for storing temporary files. Applications should make a subdirectory for use with their temporary files. Do not add more than 5 MB of data to this location. Up to 512 megabytes of RAM are available for user applications Interrupt Constraints User applications should not use interrupts. All interrupts are reserved for use by the RSM firmware Priority Constraints User applications must run with OS priority less than or equal to NORMAL. 3.8 System Management Interfaces The following set of system management interfaces can be used by a remote System Manager application to manage the chassis: HPI Shelf Management & OAM API CLI SNMP IPMI over RMCP Legacy RPC RSM supports Hardware Platform Interface (HPI) version B [see Service Availability Forum Hardware Platform Interface Specification]. HPI is an industry standard interface defined by Service Availability Forum (SAF) to monitor and control highly available systems. The HPI allows user applications and middleware to access and manage hardware components via a standardized interface. HPI is covered in Section 14.0, Hardware Platform Interface on page 78. RSM supports Shelf Management and OAM interface. The Shelf Management interface exposes functions defined as IPMI commands in accordance withintelligent Platform Management Interface Specification v2.0 and PICMG 3.0 Revision 2.0 AdvancedTCA Base Specification. The remote OAM 24

25 3 interface defines new functions that cover functionalities not addressed in the above mentioned specifications, such as alarm management, upgrade, diagnostics, or performance measurements. Shelf Management & OAM API is covered in Section 15.0, Shelf Management & OAM API on page 79. The Command Line Interface (CLI) connects to and communicates with the intelligent management devices of the chassis, boards, and the RSM itself. The CLI is an application that runs on top of the ShM and OAM API and can be accessed directly or through a higher-level management application. Administrators can access the CLI through Telnet or SSH. Using the CLI, users can access information about the current state of the system including current sensor values, threshold settings, recent events, and overall chassis health, access and modify shelf and RSM configurations, set fan speeds, perform actions on a FRU, etc. The CLI interface is covered in Section 16.0, Command Line Interface on page 81. The chassis management module supports both queries and traps on Simple Network Management Protocol (SNMP) v1 or v3. A Management Information Base (MIB) for the entire platform is included with the RSM. The SNMP agent provides the support for the following MIBs: MIB II (RFC1213) - standard IETF MIB RSM MIB OAM MIB The last two MIBs are RSM-related MIBs. SNMP agent sends unsolicited events received from RSM to the System Manager as SNMP traps. The traps are generated in IPMI Platform Event Trap format and RSM format. The traps are transmitted to the set of configurable recipients. SNMP is covered in Section 17.0, Simple Network Management Protocol on page 82. Remote Management Control Protocol (RMCP) is a protocol that defines a method to send IPMI packets over a Local Area Network (LAN). The RMCP server on the RSM can decode RMCP packages and forward the IPMI messages to the appropriate destinations, including: SBC blades, power entry modules (PEMs), fan trays, and local destinations within the RSM. When there is a responding IPMI message coming from SBC blades, PEMs, or fan trays destined for the RMCP client, the RMCP server formats this IPMI message into an RMCP message and sends it to through the designated LAN interface back to originator. RMCP is covered in Section 18.0, Remote Management Control Protocol on page 93. In addition to the HPI and ShM/OAM programmatic interfaces, the RSM can be administered by custom remote applications via remote procedure calls (RPC) legacy interface. With introduction of HPI and ShM/OAM API interfaces, the legacy RPC interface is deprecated and shall not be supported in the next firmware versions. The legacy RPC interface is covered in Appendix F, Legacy RPC Interface on page

26 3 3.9 Ethernet Interfaces 3.10 IPMB 3.11 Telco Alarms The RSM has four Ethernet ports, with two ports positioned on the front faceplate and two provided through the connector on the backplane. All four Ethernet ports remain active. For configuration details, see Section 31.0, IP Network Configuration on page 156. An AdvancedTCA* Shelf uses an Intelligent Platform Management Bus (IPMB) for the management communication among all intelligent FRUs. The sensors (Slot Ready) are maintained by the IPMC software. Telco alarms provided on a system chassis can be used to announce system alarms. The RSM IPMC generates the Telco sensor events for major reset, minor reset, and cutoff for chassis types that have these input signals. The power alarm, minor alarm, major alarm, and critical alarm can be controlled using the Set Telco Alarm State command. The IPMC illuminates the respective minor, major, and critical LEDs when the Set Telco Alarm State command is used to enable alarms. 26

27 Chapter Front Panel LEDs The RSM has four LEDs on the front panel for displaying the status of the RSM. They include: One Power Good (PG) LED (Green) One Active (ACT) LED (Amber) One Out of Service (OOS) LED (Red or Amber) One Hot Swap (HS) LED (Blue) For more information on the RSM LEDs, see the A6K-RSM-J Shelf Manager Reference. 4.1 LED Types and States Power Good LED The RSM can retrieve values for LEDs on the RSM, fan trays, PEMs, and blades in the chassis. The following tables list the default values for the LEDs on the RSM. Other devices will likely have different LED properties that can be retrieved through the RSM. For information about LEDs on other devices, see the appropriate documentation for that device.. Table 4. The RSM maintains a power good LED to provide the health status of the RSM. RSM Power Good LED States Color Description Off Solid Green No power to the RSM Normal operation power OK Hot Swap LED The RSM maintains a single blue hot swap LED to provide the status of the RSM itself. The Hot Swap LED cannot have its state set or changed; it is read-only. Table 5. RSM Hot Swap LED States Color Description Off RSM is operational Blinking RSM is transitioning to or from an operational state Solid Blue RSM is not activated and can be safely extracted Active LED 1. During the shutdown process, after the HS LED becomes solid blue, wait a few seconds before extracting the RSM board from chassis.. Table 6. The RSM maintains an active LED to indicate the operational status of the RSM. RSM Active LED States Color Description Off Solid Amber RSM is on standby RSM is active 27

28 Out of Service LED. Table 7. The RSM maintains an out of service LED that shows the service status. RSM Out of Service LED States Color Description Off Solid Red RSM is operating normally RSM is out of service 4.2 Retrieving a Location s LED Properties The properties of a location s LED control status can be retrieved using this command: cmmget -l <location> -d ledproperties 4.3 Retrieving Color Properties of LEDs The valid colors that an LED supports and the default color properties for that LED can be retrieved using the command: cmmget -l <location> -t <led> -d ledcolorprops Note: The above command does not accept the target all_leds or n:all_leds (where n is a sub-fru ID) for the value of <led>. 4.4 Retrieving State of LEDs The state of an LED on a location can be retrieved using the command: cmmget -l <location> -t <led> -d ledstate Note: The above command does not accept the target all_leds or n:all_leds (where n is a sub-fru ID) for the value of <led>. 4.5 Using Lamptest Function If you attempt the lamptest function with any device other than the shelf manager module itself, the RSM firmware will simply pass the request to that device. It is entirely up to the device to determine how to respond to or reject the request. If you attempt the lamptest function on the RSM, you must specify all_leds. 4.6 LED Boot Sequence During the boot process, the LEDs change in a pattern as described in Table 8, LED Event Sequence to indicate boot progress. Once the RSM firmware is running, the administrator can control the LEDs through standard interfaces or via programmatic control. Table 8, LED Event Sequence describes the sequence of events following the insertion of the RSM and the corresponding LED state for each event. 28

29 4 Table 8. LED Event Sequence Event Power Good LED Hot Swap LED Active LED Out of Service LED Initial insertion or power on with ejector latch closed Off Solid blue U-Boot* initialization Solid green Off U-Boot* initialization finished. User script running. Solid green Off Linux* initialization finished. OS at init level 1. RSM init script running. Core process loaded. RSM at M1 Initial RSM initialization finished (FRU election). RSM at M2 Solid green Solid green Solid green Off Off Off RSM IPMC at M3 or M4 Solid green Off Lit when the IPMC is the active shelf management controller (ShMC). Otherwise, the LED is off. IPMC does not light this LED, but external software may control the LED using standard IPMI commands. 29