OpenHPI Manual

Sean Dague

Kevin gao

David Judkovics

Rusty Lynch

Louis Zhuang

Tariq Shureih

Thomas Kanngieser

Renier Morales

This material may be distributed only subject to the terms and conditions set forth in the Open Publication License, v1.0 or later (the latest version is currently available at http://www.opencontent.org/openpub/). Distribution of substantively modified version of this document is prohibited without the explicit permission of the copyright holder.

Other company, product, or service names may be trademarks or service marks of others.


Table of Contents
1. Introduction
1.1. The Basics
1.1.1. Purpose of this Document
1.1.2. Document Scope
1.1.3. Terminology
2. Getting OpenHPI
2.1. Download
2.2. Installing OpenHPI
2.3. Configuring OpenHpi
3. Overview of SA HPI - 10,000 foot view
3.1. Resource Model
3.1.1. Resources
3.1.2. Resource Capabilities
3.1.3. Entity Path
3.1.4. Resource Data Records
3.1.5. Discovering Resources
3.2. Event Model
3.2.1. HPI Events
3.2.2. Accessing Events
3.2.3. System Event Logs
3.3. Domain Model
3.3.1. Domains
3.3.2. OpenHPI's take on Domains
3.3.3. Sessions
3.4. SA HPI Data Structures
3.4.1. RPT Data Structures
4. OpenHPI 10,000 foot view
4.1. Theory
4.1.1. Guiding Principles
4.1.2. Requirements / Expectations
4.2. Implementation
4.2.1. Application Interface Stubs
4.2.2. Infrastructure
4.2.3. Utility Functions
4.2.4. OpenHPI Plugin Interface
4.2.5. OpenHPI Plugins
5. OpenHPI Structure
5.1. OpenHPI Plugins
5.1.1. Plugin ABI
5.1.2. Handlers
6. OpenHPI Plugin Usage
6.1. General Configuration
6.2. Dummy Plugin
6.2.1. Prerequisites
6.2.2. Configuration
6.3. SNMP BladeCenter Plugin
6.3.1. Prerequisites
6.3.2. Configuration
6.4. SNMP RSA Plugin
6.4.1. Prerequisites
6.4.2. Configuration
6.5. Watchdog Timer Plugin
6.5.1. Prerequisites
6.5.2. Configuration
6.6. Sysfs Plugin
6.6.1. Prerequisites
6.6.2. Configuration
6.7. IPMI Plugin
6.7.1. Prerequisites
6.7.2. Configuration
6.8. IPMI Direct Plugin
6.8.1. Prerequisites
6.8.2. Configuration
7. OpenHPI Plugin Development Guide
7.1. General plug-in concepts
7.2. Naming convention and return codes
7.3. The Open function
7.4. The close function
7.5. The discover_resources function
7.5.1. The oh_handler_state structure
7.6. The get_event function
7.7. discover_resources, saHpiResourceDiscover and get_event
7.8. Resources, ResourceId and EntityPath
7.9. OpenHPI internal helper utility interfaces
7.9.1. SNMP Utilities
7.9.2. RPT Utilities
7.9.3. Entity Path Utilities
7.9.4. Resource UID Utilities
7.10. Sensor functions
7.10.1. The get_sensor_data function
A. Appendix A: Design Description Techniques
A.1. Usage Scenarios