NMS OAM Service Developer's Reference Manual
P/N 6818-13
Version
Version
Table of Contents
1 Introduction
- 1.1 Introduction
- 1.2 NMS OAM Overview
- 1.3 NMS OAM Components
- 1.3.1 NMS OAM Supervisor
- 1.3.2 Board Plug-Ins
- 1.3.3 Extended Management Components (EMCs)
- 1.4 Managed Objects
- 1.4.1 The Configuration Database
- 1.4.2 Board Identification Methods
- 1.5 NMS OAM and Natural Access
- 1.5.1 Natural Access Services
- 1.5.2 Natural Access Contexts
- 1.5.3 Event Queues
- 1.5.4 Natural Access Modes and NMS OAM
- 1.6 OAM Service Architecture
- 1.7 Hot Swap
- 1.7.1 Hot Swap Software Architecture
- 1.7.2 Hot Swap EMC
- 1.7.3 Hot Swap Manager
- 1.7.4 Hot Swap Drivers
- 1.7.5 Hot Swap Library
- 1.7.6 Hot Swap Driver
- 1.7.7 Layered Architecture of the Hot Swap Driver Under UNIX
2 NMS OAM Programming Model
- 2.1 Introduction
- 2.2 Types of Functions
- 2.3 OAM Service Tasks and Related Functions
- Configuring Objects
- Managing Hardware
- Starting, Stopping, and Testing Boards
- Retrieving Board ID Information
- Receiving NMS OAM Events
- Advanced Functions
- 2.4 OAM Service Events
- 2.4.1 Freeing the Event Buffer
- 2.4.2 Code Sample
3 Installing and Initializing the OAM Service
- 3.1 Introduction
- 3.2 Installing the OAM Service
- 3.3 Initializing the OAM Service: Overview
- 3.4 Starting the Hot Swap Driver and Hot Swap Manager
- 3.4.1 Starting Hot Swap Under Windows NT
- 3.4.2 Starting Hot Swap Under UNIX
- 3.5 Starting the Natural Access Server
- 3.6 Initializing an NMS OAM Client Application
- 3.6.1 Determining Which Natural Access Mode to Use
- 3.6.2 Initializing the Application
- Registering the OAM Service
- Specifying the Natural Access Mode
- Specifying a Default Natural Access Mode
- 3.6.3 Creating Event Queues
- 3.6.4 Creating CTA Contexts
- 3.6.5 Opening Services
- 3.6.6 NMS OAM Alert Notification
- 3.7 Automatic Startup Event Logging
4 Managing Configuration Data
- 4.1 Introduction
- 4.2 Accessing Configuration Data
- 4.2.1 Opening a Managed Object for Editing
- 4.2.2 Getting Keywords and Qualifiers
- 4.2.3 Setting a Keyword Value
- 4.2.4 Closing a Managed Object
- 4.3 Keywords and Values
- 4.3.1 Qualifiers
- 4.3.2 Basic Keywords
- 4.3.3 Array Keywords
- 4.3.4 Struct Keywords
- 4.3.5 StructAndArray Keywords
- 4.4 Keyword Enumeration
- 4.4.1 Enumerating the Top-Level Keywords
- 4.4.2 Array Keyword Enumeration
- 4.4.3 Struct Keyword Enumeration
- 4.4.4 StructAndArray Keyword Enumeration
- 4.5 Importing and Exporting Configuration Data
- 4.5.1 Exporting a Configuration
- 4.5.2 Importing a Configuration
5 Managing Boards
- 5.1 Introduction
- 5.2 Identifying Boards
- 5.3 Retrieving Board Information
- 5.3.1 Retrieving the Name of a Board
- 5.3.2 Retrieving Other Board Information
- 5.4 Managing Board Information
- 5.4.1 Creating Board Managed objects
- 5.4.2 Deleting Board Managed Objects
- 5.4.3 Automatically Detecting Installed Boards
- 5.5 Starting, Stopping, and Testing Boards
- 5.5.1 Starting Boards
- 5.5.2 Testing Boards
- 5.5.3 Stopping Boards
6 Hot Swap
- 6.1 Introduction
- 6.2 Hot Swap Operation
- 6.2.1 Closing Resources
- 6.3 Hot Swap Utilities
- 6.3.1 Initiating Insertion and Extraction
- Using the hsmon Utility
- Using the Board.<boardname>.Command Keyword
- 6.3.2 Debugging with the Hot Swap Manager
- 6.4 Hot Swap State Machine
- 6.4.1 Determining the Hot Swap State of a Board
- 6.5 Hot Swap Events
- 6.5.1 Handling Surprise Extraction
7 Clock Management
- 7.1 Introduction
- 7.2 Configuring the CT Bus Clock
- 7.3 The Clock Management EMC
- 7.3.1 Clock Management Architecture
8 Advanced Management Functions
- 8.1 Introduction
- 8.2 Restarting the Supervisor Process
- 8.3 Stopping the Supervisor Process
- 8.4 Sending Raw Data Buffers to a Board
- 8.5 Generating Alert Notification Messages
9 Alphabetical Function Reference
- 9.1 Introduction
- oamAddDetectedBoard
- oamAlertNotify
- oamAlertRegister
- oamAlertUnregister
- oamBoardEnum
- oamBoardGetBusSlot
- oamBoardGetDriverIDs
- oamBoardGetNumber
- oamBoardGetProduct
- oamBoardGetSerialNumber
- oamBoardLookupByBusSlot
- oamBoardLookupByDriverIDs
- oamBoardLookupByNumber
- oamBoardLookupByProduct
- oamBoardLookupBySerialNumber
- oamCloseObject
- oamConfigExport
- oamConfigImport
- oamCreateBoard
- oamDeleteBoard
- oamDetectBoards
- oamGetKeyword
- oamGetQualifier
- oamOpenObject
- oamRestart
- oamSendBuffer
- oamSetKeyword
- oamShutdown
- oamStartBoard
- oamStopBoard
- oamTestBoard
10 Demonstration Program
- 10.1 Introduction
- 10.2 Keyword Enumeration and Setting: oaminfo
11 NMS OAM Supervisor Keywords
- 11.1 Introduction
- 11.2 Keyword Summary
- 11.3 Alphabetical Keyword Reference
- AutoStartEnabled
- AutoStopEnabled
- BoardPlugins[x]
- Boards[x]
- DetectedBoards[x]
- ExtendedManagementComponents[x]
- Name
- Products[x]
- Version.Major
- Version.Minor
12 Hot Swap EMC Keywords
- 12.1 Introduction
- 12.2 Keyword Summary
- 12.3 Alphabetical Keyword Reference
- Board.<boardname>.Command
- Board.<boardname>.State
- Name
- Version.Major
- Version.Minor
13 Clock Management EMC Keywords
- 13.1 Introduction
- 13.2 Keyword Summary
- 13.3 Alphabetical Keyword Reference
- Apply
- Name
- Version.Major
- Version.Minor
Appendix A Errors, Events and Reasons
- Error Codes
- Alphabetical Error Summary
- Numerical Error Summary
- NMS OAM Events
- NMS OAM Reason Codes
Version
Want to send us feedback on our documentation? Email: Tech_Pubs@nmss.com
Copyright © 2001, Natural MicroSystems, Inc. All rights
reserved.