Motorola 6806800C44B User Manual

Availability Service

Programmer’s Reference

6806800C44B

September 2007

2007 Motorola

Trademarks

Motorola and the stylized M logo are trademarks registered in the U.S. Patent and Trademark Office. All other product or service names are the property of their respective owners.

Intel

is a trademark or registered trademark of Intel Corporation or its subsidiaries in the United States and other countries.

™

and all other Java-based marks are trademarks or registered trademarks of Sun Microsystems, Inc. in the U.S. and other

Java countries.

Microsoft Microsoft Corporation.

PICMG PCI Industrial Computer Manufacturers Group.

UNIX

, Windows® and Windows Me® are registered trademarks of Microsoft Corporation; and Windows XP™ is a trademark of

, CompactPCI®, AdvancedTCA™ and the PICMG, CompactPCI and AdvancedTCA logos are registered trademarks of the

is a registered trademark of The Open Group in the United States and other countries.

Notice

While reasonable efforts have been made to assure the accuracy of this document, Motorola assumes no liability resulting from any omissions in this document, or from the use of the information obtained therein. Motorola reserves the right to revise this document and to make changes from time to time in the content hereof without obligation of Motorola to notify any person of such revision or changes.

Electronic versions of this material may be read online, downloaded for personal use, or referenced in another document as a URL to a Motorola website. The text itself may not be published commercially in print or electronic form, edited, translated, or otherwise altered without the permission of Motorola,

It is possible that this publication may contain reference to or information about Motorola products (machines and programs), programming, or services that are not available in your country. Such references or information must not be construed to mean that Motorola intends to announce such Motorola products, programming, or services in your country.

Limited and Restricted Rights Legend

If the documentation contained herein is supplied, directly or indirectly, to the U.S. Government, the following notice shall apply unless otherwise agreed to in writing by Motorola.

Use, duplication, or disclosure by the Government is subject to restrictions as set forth in subparagraph (b)(3) of the Rights in Technical Data clause at DFARS 252.227-7013 (Nov. 1995) and of the Rights in Noncommercial Computer Software and Documentation clause at DFARS 252.227-7014 (Jun. 1995).

Contact Address

Motorola GmbH

ECC Embedded Communications Computing

Lilienthalstr. 15

85579 Neubiberg-Munich/Germany

About this Manual . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

1 Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

1.1 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

1.2 Models and Concepts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14

1.2.1 Service Structure Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14

1.2.1.1 Availability Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

1.2.1.2 Availability Director . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

1.2.1.3 Availability Node Director . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16

1.2.1.4 Availability Agent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16

1.2.1.5 Cluster Membership Agent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16

1.2.2 Compliance Report. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16

1.2.3 Dependencies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

1.2.3.1 Service Dependencies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

1.2.3.2 Library Dependencies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

1.2.4 Service Definition Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

1.2.5 Service Extensions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22

1.2.6 Implementation Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22

1.2.7 Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22

2 Management Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23

2.1 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23

2.2 Management Information Base (MIB) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23

2.2.1 NCS-AVSV-MIB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23

2.2.2 NCS-AVM-MIB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24

2.2.2.1 Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24

2.2.3 SAF-AMF-MIB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25

2.2.4 SAF-CLM-MIB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25

2.2.5 Example MIB Operations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26

2.2.6 AvSv Traps. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28

2.2.7 XML . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29

2.3 Command Line Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29

2.3.1 set. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29

2.3.2 admin reset. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30

2.3.3 admin lock . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31

2.3.4 admswitch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

Availability Service Programmer’s Reference (6806800C44B)

Contents

A Sample Application. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35

A.1 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35

A.1.1 Sequence of Events in the Sample Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35

A.2 Configuration for the Sample Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36

A.3 Building the Sample Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37

A.4 Running the Sample Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37

A.5 Sample Application Output . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38

B Related Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53

B.1 Motorola Embedded Communications Computing Documents . . . . . . . . . . . . . . . . . . . . . . . . 53

B.2 Related Specifications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54

Availability Service Programmer’s Reference (6806800C44B)

List of Tables

Table 1-1 Compliance Table - Availability Service, SAI-AIS Volume 1: Overview and Models . . . 16 Table 1-2 Compliance Table - Availability Service, SAI-AIS Volume 2: Availability Management

Framework . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

Table 1-3 Compliance Table - Availability Service, SAI-AIS Volume 3: Cluster Membership Service 20

Table 1-4 Availability Service - Dependencies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

Table 2-1 NCS-AVSV-MIB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23

Table 2-2 NCS-AVM-MIB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24

Table 2-3 SAF-AMF-MIB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25

Table 2-4 SAF-CLM-MIB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26

Table 2-5 AvSv Traps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28

Table B-1 Motorola Publications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53

Table B-2 Related Specifications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54

Availability Service Programmer’s Reference (6806800C44B)

List of Tables

Availability Service Programmer’s Reference (6806800C44B)

List of Figures

Figure 1-1 Availability Service - Subparts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

Availability Service Programmer’s Reference (6806800C44B)

List of Figures

Availability Service Programmer’s Reference (6806800C44B)

About this Manual

Overview of Contents

This manual is divided into the following chapters and appendices.

z Chapter 1: Introduction

Describes the functionality and main features of the Availability Service

z Chapter 2: Management Interface

Describes how to configure the functionality of the Availability Service

z Appendix A: Sample Application

Describes the sample application which illustrates the functionality of the Availability Service. The sample application is delivered with the Avantellis software.

z Appendix B: Related Documentation

Provides references to further documentation and specifications that are related to NCS and the Availability Service.

Abbreviations

This document uses the following abbreviations:

Abbreviation Definition

AMC Alarm Management Controller

AMF Availability Management Framework

API Application Programming Interface

ARP Address Resolution Protocol

AvA Availability Agent

AvD Availability Director

AvM Availability Manager

AvSv Availability Service

BOM Bill of Material

CLI Command Line Interface

Cluster Membership Agent CLA

CSI Component Service Interface

DTSv Distributed Tracing Service

Event Distribution Service EDSv

FRU Field Replaceable Unit

HISv Hardware Interface Service

Availability Service Programmer’s Reference (6806800C44B)

About this Manual

Abbreviation Definition

HPI Hardware Platform Interface

LEAP Layered Enhanced Accelerated Portability

MASv Management Access Service

MBCSv Message Based Checkpoint Service

MDS Message Distribution Service

MIB Management Information Base

NCS Netplane Core Services

PCAP Payload Construction and Availability Service

SAF Service Availability Forum

SCAP System Construction and Availability Process

SG Service Group

SI Service Instance

SNMP System Network Management Protocol

SRMSv System Resource Monitoring Service

SU Service Unit

XML Extended Markup Language

Conventions

The following table describes the conventions used throughout this manual.

Notation Description

0x00000000 Typical notation for hexadecimal numbers (digits

0b0000 Same for binary numbers (digits are 0 and 1)

bold Used to emphasize a word Screen Used for on-screen output and code related

Courier + Bold Used to characterize user input and to separate it

Reference Used for references and for table and figure

File > Exit Notation for selecting a submenu

<text> Notation for variables and keys

are 0 through F), for example used for addresses and offsets

elements or commands in body text

from system output

descriptions

[text] Notation for software buttons to click on the screen

and parameter description

... Repeated item for example node 1, node 2, ...,

node 12

Availability Service Programmer’s Reference (6806800C44B)

About this Manual

Notation Description

.. Ranges, for example: 0..4 means one of the

| Logical OR

Omission of information from example/command that is necessary at the time being

integers 0,1,2,3, and 4 (used in registers)

Indicates a hazardous situation which, if not avoided, could result in death or serious injury

Indicates a hazardous situation which, if not avoided, may result in minor or moderate injury

Indicates a property damage message

Summary of Changes

This manual has been revised and replaces all prior editions.

Part Number Publication Date Description

6806800A44A February 2007 First edition

6806800A44B September 2007 Minor text updates for Avantellis Release

Comments and Suggestions

We welcome and appreciate your comments on our documentation. We want to know what you think about our manuals and how we can make them better.

Mail comments to:

No danger encountered. Pay attention to important information

3.0.2

z Motorola GmbH

Embedded Communications Computing Lilienthalstrasse 15 85579 Neubiberg

Availability Service Programmer’s Reference (6806800C44B)

About this Manual

z eccrc@motorola.com

In all your correspondence, please list your name, position, and company. Be sure to include the title, part number, and revision of the manual and tell how you used it.

Germany

Availability Service Programmer’s Reference (6806800C44B)

Introduction

1.1 Overview

The NCS Availability Service (AvSv) is the core service of the NetPlane software. It provides service availability to applications by coordinating the redundant resources in a cluster to provide a system with no single point of failure. It provides high-availability mechanisms to the application software it manages. These include life-cycle management of application software, fault detection, fault isolation, escalation, recovery, and repair.

The AvSv functionality is a highly compliant implementation of Service Availability Forum’s Application Interface Specification of Availability Management Framework (SAI-AIS-AMFB.01.01) and Cluster Membership Service (SAI-AIS-CLM-B.01.01).

The Availability Service (AvSv) provides the following functionality:

z Leverage the SAF "System Description and Conceptual Model"

z Honour the Availability Management Framework" API

z Honour the SA Cluster membership Service API

z House the MIB tables corresponding to the hardware portion of the deployment system

description which includes entity containment and fault domain hierarchy information

z House the MIB tables corresponding to the software portion of the deployment system

description which include configuration of AMF-defined logical entities and their relationship

z Perform blade validation on receipt of HPI hot swap insertion events

z Handle fault events such as HPI hot swap extraction events, threshold crossing events etc.

The AvSv maintains a software system model database which captures SAF-described logical entities and their relationships to each other. The software system model database is initially configured from data contained in the System Description file. Through time the system model will modify due to changing system realities and administrative actions.

The SAF logical entities related in the system model include components which normalize the view of physical resources such as processes, drivers or devices. Components are grouped into Service Units according to fault dependencies that exist among them. A Service Unit is also scoped to one or more (physical) fault domains. Service Units of the same type are grouped into Service Groups (SG) which exhibit particular redundancy modelling characteristics. Service Units within a SG are assigned to Service Instances (SI) and given a High Availability state of active and standby.

The hardware database maintained by AvSv includes hardware entity containment information and the hardware fault domain hierarchy. All hardware entities are represented by their HPI entity paths. The hardware entity containment tree only includes managed FRUs which may or may not include processor environments., and non-FRU resources which include processor environments. The fault domain data includes dependency relationships between parent-child

Availability Service Programmer’s Reference (6806800C44B)

Introduction Models and Concepts

entities as well as non-parent child entities. The hardware system model also includes validation data for managed FRUs and the linkages between entities and AMF logical nodes. All the processor environment entities in the hardware entity containment tree, which correspond to AMF nodes, contain the node name of the associated node. The node name provides the linkage between the hardware and the software system models.

Further functionality provided by AvSv includes:

z Automatic and administrative means to instantiate, terminate and restart resources

z Automatic and administrative means to manage or reflect Service Group, Service Unit,

Service Instance and Resource state

z Administrative means to perform switch-over

z Administrative means to reset (but not power cycle) nodes

z Heartbeat and event subscription schemes for fault detection, isolation and identification

z Health-check services to probe and prevent system trauma that lead to faults

z Fault recovery mechanisms to fail-over SIs which maintain service availability in case of

system trauma

z Fault repair mechanisms to restore failed components

z Validation of hardware resources (managed FRUs) entering the system

The AsVs itself cannot be a single-point of failure. It provides its own internal scheme and mechanisms to protect itself from its own failure.

1.2 Models and Concepts

This chapter provides information on:

z Service Structure and architecture

z Compliancy to SAF standard

z Service Dependencies

z References to SAF documents which provide details about the service functionality

z Service Extensions

z Implementation Notes

z Configuration

1.2.1 Service Structure Overview

Availability Service is made up of the following distributed sub-parts:

z Availability Manager

z Availability Director

z Availability Node Director

Availability Service Programmer’s Reference (6806800C44B)

Service Structure Overview Introduction

z Availability Agent

z Cluster Membership Agent

Figure 1-1 Availability Service - Subparts

1.2.1.1 Availability Manager

NetPlane Core Services’ Availability Manager (AvM) maintains the hardware model of the system above. It acts as a bridge between the Availability Management Framework (AMF) and the Hardware Platform Interface (HPI). It supports activation and deactivation of fieldreplaceable units (FRUs), Reset Management, Lock Management, and Fault Management. AvM interacts with internal role distribution and fault management mechanisms to capture the role of system manager hosts and propagate it to the AMF. It is also used to trigger administrative switchovers of system manager hosts. AvM resides on both the active and standby system manager hosts.

1.2.1.2 Availability Director

The Availability Director (AvD) maintains the entire system model, consisting of nodes, the Service Groups (SG), their constituent Service Units (SUs), their constituent components, and their corresponding component service instance (CSI) and service instances (SIs) that are in the system. There is an active and a standby instance of the AvD in a system. The AvD runs as part of a System Construction and Availability Process (SCAP) on the system manager host.

Its main tasks include fault detection, isolation and recovery procedures as defined in the SAF AMF. Any problems and failures on a component that cannot be handled locally, are prompted to the Availability Director which controls and triggers the isolation of the affected component and, if possible, the activation of a stand-by component.

Availability Service Programmer’s Reference (6806800C44B)

Introduction Compliance Report

1.2.1.3 Availability Node Director

The Availability Node Director (AvND) resides on each system node and its main task is to maintain the node-scoped part of the software system model described above.

The AvND coordinates local fault identification and repair of components and furthermore facilitates any wishes it receives from the Availability Director.

The AvND watches for components arriving or leaving the system and summarizes this information in a Service Unit (SU) presence state, and keeps the AvD informed about the current status and changes. The AvND is capable of disengaging, restarting and destroying any component within its scope. This may occur according to AvD instructions or as a result of an administrative action or automatically triggered by policies.

1.2.1.4 Availability Agent

The Availability Agent (AvA) is the linkable library that provides a means for the AvSv to exchange information with system components overseen by the process in which this library is planted. It does not run as a separate thread.

The AvA implements the SAF Availability Management Framework API and provides the entrypoint for accessing AMF functionality.

1.2.1.5 Cluster Membership Agent

The Cluster Membership Agent (CLA) is a linkable library that enables AvSv to provide information about nodes in the cluster to the process in which it is linked. It does not run as a separate thread.

The CLA implements the SAF Cluster Membership Service Library functionality and provides an entry point to the SAF CLM functionality.

1.2.2 Compliance Report

Availability Service conforms to the Application Interface specifications mentioned in the following SAF documents:

z SAI-AIS Volume 1: Overview and Models (SAI-AIS-B.01.01)

z SAI-AIS Volume 2: Availability Management Framework (SAI-AIS-AMF-B.01.01)

z SAI-AIS Volume 3: Cluster Membership Service (SAI-AIS-CLM-B.01.01)

Table 1-1 Compliance Table - Availability Service, SAI-AIS Volume 1: Overview and Models

Section Description Supported Notes

1 Document Introduction NA Informational

2 Overview of the AIS NA Informational

3 Programming Model and Naming

Conventions

Availability Service Programmer’s Reference (6806800C44B)

Ye s

Compliance Report Introduction

Table 1-1 Compliance Table - Availability Service, SAI-AIS Volume 1: Overview and Models

Section Description Supported Notes

4 System Description and Conceptual

Model

4.1 Physical Entities Yes AvSv supports management

4.2 Logical Entities Yes

5 AIS Abbreviations, Concepts, and

Terminology

Table 1-2 Compliance Table - Availability Service, SAI-AIS Volume 2: Availability Management Framework

Section Description Support Notes

1 Document Introduction NA Informational

2 Overview NA Informational

3 System Description and

System Model

3.1 Logical Entities Yes Constituent sub-sections that

3.1.2 Components Yes AvSv currently does not

Ye s

of hardware resources only when they are modeled using proxy components

NA Informational

are only partially supported or not supported are mentioned below. Note that the rest of the sub-sections are fully supported.

support external components

3.1.2.3 Proxy and Proxied Components

3.1.4 Service Units Yes AvSv currently does not

3.2 State Models Yes

3.3 Fail-over and Switchover

3.4 Administrative Operations

3.5 Possible Combination of States for Service Units

Availability Service Programmer’s Reference (6806800C44B)

Yes AvSv currently supports only

Yes AvSv supports switchover of

Ye s

the model in which proxied and their proxy components are on the the same Node.

support External Service Units.

service instances caused due to administrative operations specified in SAAIS-AMF-B.01.01 and some proprietary switchover mechanisms not specified in the document.

+ 37 hidden pages