# Creating a system configuration file

A system configuration file is an ASCII text file. Typically, this file is named oamsys.cfg. By default, oamsys looks for a file with this name when it starts up.

If you know the PCI bus and slot locations of the boards in your system, create the system configuration file manually as described in this topic. If you do not know the locations of your boards, use the oamgen utility (included with the NMS OAM software) to create a skeleton system configuration file for your system. You can then complete this file manually, and then run oamsys. For more information, refer to System configuration file creator: oamgen.

This topic provides the following information:

- Configuration file sections

- Mandatory statements

- Board keyword sections

- Configuring non-board objects

- Sample configuration file

You can find a sample system configuration file in the nms\oam\cfg\ directory under Windows or in /opt/nms/oam/cfg/ under UNIX.

## Configuration file sections

Statements within the system configuration file appear one to a line. Any text appearing after a number sign (#) is a comment and is ignored. Statements in all configuration files are not case sensitive, except where operating system conventions prevail (for example, file names under UNIX).

The system configuration file is divided into multiple sections, one for each board. Each section is headed with the name of the board, in square brackets ([ ]):

[Myboard]

This name can contain a space (for example: [My board]), but must not be preceded by or followed by a space. For example, the following names are not valid:

[ Myboard], [Myboard ].

Note: Board names must be unique within a system configuration file.

Below each board name are statements that apply to the board. Each statement appears on its own line. Each statement consists of a keyword name, followed by an equal sign (=) and then a value:

keyword_name=value

## Mandatory statements

In the section for each board, the following statements must appear:

Keyword | Description
Product | Name of the board product. To learn how to retrieve a list of valid strings to use, refer to Displaying board product types.
Number | Board number. Use any integer from 0 to 32767. Each board's number must be unique.
Bus | PCI bus number. The bus:slot location for each board must be unique.
Slot | PCI slot number. The bus:slot location for each board must be unique.

## Board keyword sections

To specify a keyword file for the board, use the File keyword:

File = myfile.cfg

You can specify more than one keyword file. Specify the file names on a single line following the File keyword, separated by a space:

File = file1.cfg file2.cfg file3.cfg

Alternatively, you can specify multiple File keywords, one to a line:

File = file1.cfg
File = file2.cfg
File = file3.cfg

To include embedded spaces in a file name, surround the name with quotation marks:

File = "My Configuration File.cfg"

By default, oamsys searches for the keyword files listed with this keyword in the same way it searches for the system configuration file itself (see Running oamsys). To reference a file in another directory, specify the directory along with the file name:

File = c:\mydir\file1.cfg

Keywords are set in the order in which oamsys encounters them in the files. Specifying a setting for a keyword in more than one file is not recommended.

Note: In addition to (or instead of) keyword file names, you can specify keyword settings for a board directly in the board's section in the system configuration file. Use the keyword syntax described in Specifying keywords and values.

## Configuring non-board objects

In addition to sections for boards, the system configuration file can include sections containing configuration information for non-board objects (such as EMCs, board plug-ins, or the NMS OAM Supervisor).

The section for each object is headed with the object's name, in square brackets ([ ]):

[Supervisor]

The object name for the NMS OAM Supervisor is Supervisor. The object name for a plug-in or EMC is its file name (for example, hotswap.emc).

This name must not be preceded by or followed by spaces. For example, the following names are not valid:

[ Supervisor], [Supervisor ]

Below each board name are keyword settings, specified as described in Specifying keywords and values. For example:

[Supervisor]
AutoStartEnabled=Yes
AutoStopEnabled=Yes

The File statement can also be used to specify a keyword file containing settings for the object:

[Supervisor]
File=supvparms.cfg

To learn what keywords can be set for board plug-ins, refer to the board-specific documentation. To learn what keywords can be set for EMCs or the NMS OAM Supervisor, refer to the NMS OAM Service Developer's Reference Manual.

## Sample configuration file

The following system configuration file describes two CG 6000C boards, one at PCI bus 0, slot 20, and the other at PCI bus 0, slot 21. The first board is assigned keyword file a6wnk.cfg, which sets up the board to use the wink start protocol. The second board uses keyword file a6ops.cfg, which sets up the board to use the off premises station protocol. Supervisor keywords are set to start the boards automatically when the system boots or when they are Hot Swap inserted, and to stop automatically when the system shuts down:

# This is the NMS OAM system configuration file.
# It describes all the boards in my system.
[My board]
Product = CG_6000C_QUAD
Number = 1
Bus = 0
Slot = 20
File = 6wnk.cfg #Wink Start protocol
[My other board]
Product = CG_6000C_QUAD
Number = 2
Bus = 0
Slot = 21
File = 6ops.cfg #Off Premises Station protocol
[Supervisor]
AutoStartEnabled=Yes
AutoStopEnabled=Yes

To start boards automatically when the Supervisor starts up, set the AutoStart keyword for each board. For more information about this keyword, refer to the NMS OAM Service Developer's Reference Manual.