# Using keywords

The keywords for a CX 2000 board describe that board's configuration. Some keywords are read/write and others are read-only:

Keyword type | Description
Read/write (editable) | Determines how the board is configured when it starts up. Changes to these keywords become effective after the board is rebooted.
Read-only (informational) | Indicates the board's current configuration. Read-only keywords cannot be modified.

This topic describes:

- Setting keyword values

- Retrieving keyword values

Note: To learn how to use NMS OAM utilities such as oamsys and oamcfg, refer to the NMS OAM System User's Manual. To learn about setting and retrieving keywords using OAM service functions, refer to the NMS OAM Service Developer's Reference Manual.

Plug-in keywords exist in a separate record in the NMS OAM database. They indicate certain board family-level information.

A keyword has the general syntax:

keyword = value

Keywords are not case sensitive except where operating system conventions prevail (for example, file names under UNIX). All values are strings, or strings that represent integers. An integer keyword can have a fixed numeric range of legal values. A string keyword can support a fixed set of legal values, or can accept any string.

## Setting keyword values

There are several ways to set the values of read/write keywords:

- Use or modify one of the sample board keyword files corresponding to your country and board type. Specify the name of this new file in the File statement in oamsys.cfg, and run oamsys again. Refer to the NMS OAM System User's Manual for information about board keyword file syntax.

Note: Using oamsys reboots all boards in the system.

- Create a new board keyword file, either with additional keywords or with keywords whose values override earlier settings.

- Specify parameter settings using the oamcfg utility. Refer to the NMS OAM System User's Manual for information about oamcfg.

- Specify the settings using OAM service functions. Refer to the NMS OAM Service Developer's Reference Manual for more information.

To set board keywords, specify the board name in the system configuration file or on the oamcfg command line. To set CX plug-in level keywords, specify the CX plug-in name (cx.bpi).

Note: Keyword values take effect after the board is rebooted.

## Retrieving keyword values

To retrieve the values of read/write and read-only keywords:

- Run the oaminfo sample program. From the command line, specify the board using either its name (with the -n option) or number (with the -b option):

oaminfo -n boardname
oaminfo -b boardnum

To access CX plug-in level keywords, specify the CX plug-in name on the command line:

oaminfo -n cx.bpi

oaminfo returns a complete list of keywords and values. For more information about oaminfo, refer to the NMS OAM Service Developer's Reference Manual.

- Use the OAM service. Refer to the NMS OAM Service Developer's Reference Manual for more information.