A

Address keyword type. See keywords, Address type

ag.rpt 53

AGLOAD 44

agmon 53

alert notification

message generating 95, 100-101

registering an application for 53, 102

unregistering an application from receiving 53, 103

Apply keyword 186

Array keywords

containing Structs 62

defined 61

determining no. of elements in array 61

enumerating 65

asynchronous function 28

AutoStartEnabled keyword 164

AutoStopEnabled keyword 165

B

Base qualifier. See qualifiers, Base

biostest utility 80

board managed objects

and NMS OAM database 14

closing 59, 125-126

creating 73-74, 131-132

creating for detected boards 74, 99

defined 13

deleting 74, 133-134

enumerating top-level keywords for 64

opening 57, 140-142

board name

as central identification object 71

changing 74

defined 15, 70

retrieving 72

retrieving all names from database 72, 104-105

board number

changing 74

defined 15, 70

retrieving 72, 109-110

retrieving board name using 72, 119-120

board plug-in. See plug-in

Board.boardname.Command keyword 81, 178

Board.boardname.State keyword 81, 84, 179

BoardPlugins[x] keyword 166

boards

automatically detecting 74, 135

determining Hot Swap state of 84

identification methods 15

managed objects. See board managed objects

sending raw data buffers to 94-95, 144-145

starting 75, 149-150

stopping 76, 151-152

testing 75-76, 153-154

Boards[x] keyword 167

.bpi files. See plug-in

C

cfbm.exe 91

Choices qualifier. See qualifiers, Choices

Choices.Count qualifier. See qualifiers, Choices.Count

client application 19

clkdef.h 35, 192, 197

CLKERR_FAILURE 193, 196

CLKERR_NO_RESOURCES 193, 196

CLKERR_NOT_FOUND 193, 196

CLKEVN_CONFIG_FAILED 90, 198

CLKEVN_CONFIGURED 90, 198

CLKEVN_INVALID_CONFIG_DATA 90, 198

CLKEVN_OPEN_OAM_FAILED 90, 198

CLKEVN_OPEN_SWITCH_FAILED 90, 198

clkmgr.emc 91

Clock Management 88-91

architecture 91

configuration keywords 89

configuring 88-89

EMC 12, 90, 184

EMC keywords 184-189

events 90

clock slaves 88

context

and NMS OAM architecture 19

creating 52

described 16

handle. See context handle

context handle

retrieving 52

returned in CTA_EVENT structure 34

CT bus clock. See Clock Management

CTA context. See context

cta.cfg 47, 49-51

CTA_EVENT 34-37

description 33

fields in 34

listing 33

CTA_INTERNAL_BUFFER 38

CTA_IS_ERROR macro 192

CTA_MODE_LIBRARY 50

CTA_MODE_SERVER 50

CTA_SERVICE_DESC 52

CTA_SERVICE_NAME 50

CTA_TRACE_SEVERITY_ERROR 36

CTA_TRACE_SEVERITY_INFO 36

CTA_TRACE_SEVERITY_WARNING 36

ctaCreateContext 34, 52

ctaCreateContextEx 52

ctaCreateQueue 51-52

ctadef.h 33, 35, 192, 197

CTAERR_BAD_ARGUMENT 99-100, 104, 106-107, 109, 111, 113, 115, 117, 119, 121, 123, 127, 129, 131, 133, 136, 138, 140, 144, 146

CTAERR_INVALID_HANDLE 125, 136, 138, 146

CTAERR_INVALID_SEQUENCE 86

CTAEVN_CLOSE_SERVICES_DONE 86

CTAEVN_DESTROY_CONTEXT_DONE 86

ctaflags 50

ctaFreeBuffer 34, 38

ctaGetTimeStamp 34

ctaInitialize 17, 48-51

CTAmode 51

ctaOpenServices 52

ctaSetEventSources 53

ctaWaitEvent 33

ctdaemon 20

as part of NMS OAM architecture 19

components 20

defined 12, 17

starting 47-48

D

Description qualifier. See qualifiers, Description

DetectedBoards[x] keyword 168

driver board ID

described 15, 70

retrieving 72, 107-108

retrieving board name using 72, 117-118

driver name 15, 70

E

EMC

as part of NMS OAM architecture 20

Clock Management. See Clock Management

defined 12

Hot Swap. See Hot Swap EMC

loading at startup 12

.emc files. See EMC

environment variables 44

errors

alphabetical listing 193

numerical listing 195

returned in CTA_EVENT structure 34

event queue

creating 51

described 16

events

alphabetical listing 198

Clock Management 90

data structure 33

event queue. See event queue

fields 34

freeing event buffer 38

Hot Swap 84-86

logging startup events 53

receiving 33

registering to receive NMS OAM 53, 102

unregistering an app from receiving NMS OAM 53, 103

extended management component. See EMC

ExtendedManagementComponents[x] keyword 169

F

Filename keyword type. See keywords, Filename type

functions

reference 97-155

summary 29-33

types 28

H

H.100/H.110. See Clock Management

Hot Swap 20-25, 78-86

board state if unsupported 84

closing resources 80

defined 20

determining Hot Swap state of a board 84

driver. See Hot Swap driver

EMC. See Hot Swap EMC

events 84-86

handling surprise extraction 86

initiating insertion or extraction 81

keywords 176-182

LED 20, 23, 79-80, 86

manager. See Hot Swap Manager

operation 78-79

software architecture 21-22

state machine 82-83

utilities 80

Hot Swap driver

architecture 24-25

defined 23

operation 78

starting 45-47

utility 80

Hot Swap EMC

defined 12

described 22

keywords 176-182

opening to determine state of board 84

Hot Swap Manager

debugging with 82

defined 22

functions 23

HSM library 23

monitoring 80

operation 78

starting 45-47

utility 80

HS_CSR 22, 25

hsmgr utility

debugging with 82

described 80

starting 46

hsmon utility

described 80

initiating insertion or extraction with 81, 85-86

hsmstart shell script 46

hssrv utility 45, 80

hswdef.h 35, 192, 197

HSWERR_FAILURE 193, 196

HSWERR_INVALID_BUS 193, 196

HSWERR_NO_RESOURCES 193, 196

HSWERR_NOT_FOUND 193, 196

HSWEVN_BOARD_INSERTED 84, 198

HSWEVN_BOARD_OFFLINE 85-86, 198

HSWEVN_BOARD_READY 85-86, 198

HSWEVN_BOARD_REMOVED 84, 86, 198

HSWEVN_ONLINE_PENDING 84-85, 198

HSWEVN_PCI_CONFIG_FAILED 84-85, 198

HSWEVN_PREPARATION_FAILED 85, 198

HSWEVN_REMOVAL_REQUESTED 86, 198

I

Integer keyword type. See keywords, Integer type

K

keywords 59-66

Address type 61

Array type. See Array keywords

Clock Management configuration 89

Clock Management EMC 184-189

described 14

determining type 59

enumeration 64-66

Filename type 61

getting/setting with oaminfo 157-159

Hot Swap EMC 176-182

importing/exporting. See NMS OAM database, importing

Integer type 61

Object type 61

qualifiers. See qualifiers

retrieving settings 58, 136-137

setting 58, 146-147

String type 61

Struct type. See Struct keywords

StructAndArray type. See StructAndArray keywords

summary of 162, 176, 184

Supervisor 162-173

types 59

Keywords qualifier. See qualifiers, Keywords

Keywords.Count qualifier. See qualifiers, Keywords.Count

L

LD_LIBRARY_PATH environment variable 44, 46-47

Library mode

defined 17, 49

specifying as default mode 51

specifying for your app 50

M

managed objects

and configuration database 14

closing 59, 125-126

defined 13-14

enumerating top-level keywords for 64

for boards. See board managed objects

opening 57, 140-142

Max qualifier. See qualifiers, Max

Min qualifier. See qualifiers, Min

Multi mode

defined 17

description 49

specifying as default 51

specifying for your app 50

N

Name keyword

in Clock Management EMC managed object 187

in Hot Swap EMC managed object 180

in Supervisor managed object 170

Natural Access

and OAM service 16

client applications 19

closing resources when board is removed 80

defined 16

initializing 49

modes. See Natural Access modes

server. See ctdaemon

Natural Access modes

determining which to use 48-49

introduced 17-18

specifying default 51

specifying for your application 50

Natural Access Server. See ctdaemon

NMS Clock Fallback Manager 44

NMS OAM

and Natural Access 16

and Natural Access modes. See Natural Access modes

architecture 19

board ID methods 15

capabilities 10

components 11-12

database. See NMS OAM database

defined 10

initializing service 45-53

installing 44

opening service 52

registering service 50

Service Manager 20

startup event logging 53

Supervisor. See Supervisor

NMS OAM database

as part of NMS OAM architecture 20

described 14

exporting 66, 127-128

importing 67, 129-130

O

oam.rpt 53

OAM_IS_OAM_EVENT macro 35

OAM_MSG 84

constructing for oamAlertNotify 95, 100

determining associated managed object 36, 84

fields in 35-37

in CTA_EVENT structure 34

OAM_READONLY 57, 140-141

OAM_READWRITE 57-58, 140-141, 147

OAM_REASON_FAILED 75-76, 149, 151, 154, 200

OAM_REASON_FINISHED 75-76, 149, 151, 153, 200

oamAddDetectedBoard

reference 99

summary 30

using 74

oamAlertNotify

reference 100

summary 32

using 95

oamAlertRegister

reference 102

summary 32

using 53

oamAlertUnregister

reference 103

summary 32

using 53

oamBoardEnum

reference 104

summary 31

using 72

oamBoardGetBusSlot

reference 106

summary 31

using 71-72

oamBoardGetDriverIDs

reference 107

summary 31

using 71-72

oamBoardGetNumber

reference 109

summary 31

using 71-72

oamBoardGetProduct

reference 111

summary 31

using 71-72

oamBoardGetSerialNumber

reference 113

summary 31

using 71-72

oamBoardLookupByBusSlot

reference 115

summary 31

using 71-72

oamBoardLookupByDriverIDs

reference 117

summary 31

using 71-72

oamBoardLookupByNumber

reference 119

summary 31

using 71-72

oamBoardLookupByProduct

reference 121

summary 31

using 71-72

oamBoardLookupBySerialNumber

reference 123

summary 31

using 71-72

oamcfg utility 10, 19-20, 56

oamCloseObject

reference 125

summary 29

using 59

oamConfigExport

reference 127

summary 29

using 66

oamConfigImport

reference 129

summary 29

using 67

oamCreateBoard

reference 131

summary 30

using 73-74

oamdef.h 35, 192, 197

oamDeleteBoard

reference 133

summary 30

using 74

oamDetectBoards

and DetectedBoards[x] keyword 162

reference 135

summary 30

using 74

OAMERR_ACCESS_DENIED 57, 99, 125, 127, 129, 133, 135-136, 138, 140-141, 146, 153, 193, 195

OAMERR_ALREADY_EXISTS 102, 125, 193, 195

OAMERR_AUTO_DETECT_BOARD_FAIL 193, 195

OAMERR_BOARD_SELFTEST_FAIL 193, 195

OAMERR_BOARD_SELFTEST_INVALID 193, 195

OAMERR_CANT_CREATE_THREAD 149, 151, 153, 193, 195

OAMERR_CLOSE_OBJECT_FAIL 193, 195

OAMERR_CREATE_BOARD_FAIL 193, 195

OAMERR_DESTORY_BOARD_FAIL 193, 195

OAMERR_FILE_READ_ERROR 127, 129, 140, 143, 193, 195

OAMERR_FILE_WRITE_ERROR 99-100, 125, 127, 129, 131, 143, 194-195

OAMERR_GET_BOARD_KEYWORD_FAIL 194-195

OAMERR_GET_QUALIFIER_FAIL 194-195

OAMERR_NOT_ENOUGH_MEMORY 99, 102-104, 107, 111, 113, 115, 117, 119, 121, 123, 125, 127, 129, 131, 133, 136, 138, 140, 143, 146, 194-195

OAMERR_NOT_FOUND 61, 63, 72, 103-107, 109, 111, 113, 115, 117, 119, 121, 123, 125, 131, 136, 138, 140, 144, 146, 149, 151, 153, 194-195

OAMERR_NOT_SUPPORTED_WARNING 194-195

OAMERR_OPEN_DRIVER_FAIL 194, 196

OAMERR_OPEN_OBJECT_FAIL 194-195

OAMERR_PLUGIN_EXIT_FAIL 194-195

OAMERR_PLUGIN_INIT_FAIL 194-195

OAMERR_SEND_BUFFER_FAIL 194, 196

OAMERR_SERVER_NOT_FOUND 99-100, 104, 106-107, 109, 111, 113, 115, 117, 119, 121, 123, 125, 127, 129, 131, 133, 135-136, 138, 140, 144, 146, 149, 151, 153, 194-195

OAMERR_SERVER_NOT_RUNNING 99-100, 104, 106, 108-109, 111, 113, 115, 117, 119, 121, 123, 125, 127, 129, 131, 133, 135, 137, 139-140, 144, 146, 149, 151, 153, 194-195

OAMERR_SET_BOARD_KEYWORD_FAIL 194-195

OAMERR_START_BOARD_FAIL 194-195

OAMERR_STOP_BOARD_FAIL 194-195

OAMEVN_ALERT 198

OAMEVN_BOARD_DEAD 198

OAMEVN_CREATED 198

OAMEVN_DELETED 198

OAMEVN_MODIFIED 199

OAMEVN_RENAMED 199

OAMEVN_REPORT 199

OAMEVN_STARTBOARD_DONE 34, 75, 149, 199

OAMEVN_STOPBOARD_DONE 76, 151, 199

OAMEVN_TESTBOARD_DONE 76, 153, 199

OAMEVN_TRACE 199

oamGetKeyword

reference 136

summary 29

using 58

using to enumerate keywords 65

oamGetQualifier

reference 138

summary 29

using to enumerate keywords 64-65

oaminfo utility 20, 156-159

oammon utility 10, 19-20

oamOpenObject

opening Hot Swap object with 84

reference 140

summary 29

using 57

oamRestart

reference 143

summary 32

using 94

oamSendBuffer

reference 144

summary 32

using 95

oamSetKeyword

reference 146

summary 29

using 58

oamShutdown

reference 148

summary 32

using 94

oamStartBoard

reason codes 200

reference 149

summary 30

using 75

oamStopBoard

reason codes 200

reference 151

summary 30

using 76

oamsys utility 10, 20, 56

oamTestBoard

reason codes 200

reference 153

summary 30

using 75

object handle 34

Object keyword type. See keywords, Object type

objHd 34

P

PCI bus and slot

as board identification method 15, 70

retrieving 72, 106

retrieving board name using 72, 115-116

plug-ins

as part of NMS OAM architecture 20

defined 12

loading at startup 12

primary clock master 88

product type

retrieving 72, 111-112

retrieving board name using 72, 121-122

Products[x] keyword 171

Q

qualifiers

Base 60-61

Choices 60-61

Choices.Count 60

defined 58

Description 60

Keywords 60, 63

Keywords.Count 60, 63-65

Max 60-61

Min 60-61

ReadOnly 60, 162, 176, 184

retrieving 58, 138-139

Type 59-60, 65-66

types 60-61

R

ReadOnly qualifier. See qualifiers, ReadOnly

reason codes

alphabetical listing 200

returned in CTA_EVENT structure 34

return codes

defined 28

lists of 192-196

S

secondary clock master 88

serial number

described 15, 70

retrieving 72, 113-114

retrieving board name using 72, 123-124

Server mode

defined 17

description 49

specifying as default 51

specifying for your app 50

service

defined 16

NMS OAM. See NMS OAM

opening 52

size 34

startup event logging 53

startup.log 53

String keyword type. See keywords, String type

Struct keywords

containing arrays 62

defined 62

determining number of keywords in struct 63

enumerating 65

StructAndArray keywords

defined 63

enumerating 66

Supervisor

as part of NMS OAM architecture 20

defined 11

keywords 162-173

loads EMCs and plug-ins 12

managed object 14

restarting 94, 143

shutting down 94, 148

surprise extraction 86

synchronous function 28

T

timestamp 34

timing references 88

Type qualifier. See qualifiers, Type

U

utilities

hsmgr 45, 80, 82

hsmon 80-81, 85-86

hssrv 45, 80

oamcfg 10, 20, 56

oaminfo 20, 157-159

oammon 10, 20

oamsys 10, 20, 56

V

Version.Major keyword

in Clock Management EMC managed object 188

in Hot Swap EMC managed object 181

in Supervisor managed object 172

Version.Minor keyword

in Clock Management EMC managed object 189

in Hot Swap EMC managed object 182

in Supervisor managed object 173