11.1 Introduction

11.2 Keyword Summary

11.3 Alphabetical Keyword Reference

AutoStartEnabled 164

AutoStopEnabled 165

BoardPlugins[x] 166

Boards[x] 167

DetectedBoards[x] 168

ExtendedManagementComponents[x] 169

Name 170

Products[x] 171

Version.Major 172

Version.Minor 173

11.1 Introduction

The Supervisor has a managed object in the NMS OAM database containing keywords which you can access to retrieve and change Supervisor parameters. This chapter contains:

• A summary of the NMS OAM Supervisor keywords

• An alphabetical reference of the NMS OAM Supervisor keywords

To learn about setting and retrieving keywords programmatically, refer to Chapter 11. To learn how to specify keywords in configuration files using NMS OAM utilities, refer to the NMS OAM System User's Manual.

11.2 Keyword Summary

The following table summarizes the keywords that you can change. The Readonly qualifier for these keywords is set to No:

If you want to...	Use these keywords...
Specify whether the board is started automatically when the Supervisor starts, or when the board is Hot Swap inserted	AutoStartEnabled
Specify whether the board is stopped automatically when the Supervisor stops	AutoStopEnabled

The following table summarizes the keywords that cannot be changed. The Readonly qualifier for these keywords is set to Yes:

If you want to...	Use these keywords...
Determine what software components are installed	BoardPlugins[x] ExtendedManagementComponents[x]
Retrieve a list of board names that are in the configuration database	Boards[x]
Retrieve a list of boards detected using oamDetectBoards	DetectedBoards[x]
Retrieve information about the Supervisor managed object	Name Version.Major Version.Minor
Retrieve a list of all products supported by the set of plug-ins currently installed	Products[x]

11.3 Alphabetical Keyword Reference

The following sections list and describe each keyword in the Supervisor's managed object. Each keyword description includes:

Syntax	The syntax of the keyword
Access	Indicates if the keyword's value can be retrieved and changed: Read/Write Value can be retrieved or changed. Read-only Value can be retrieved only. Write-only Value can be changed only. Retrieved value contains no information.
Type	The data type of the value: String or Integer
Default	Default value
Allowed Values	A list of all possible values
Example	An example of usage
Description	A detailed description of the keyword's function
See Also	A list of related keywords