3.1 Introduction

3.2 Referencing the QX Managers for Natural Access

3.3 Adding QX Configurations to the NMS OAM Database

3.4 Configuring the System Using oamsys

3.4.1 Using Board Keyword Files

Sample Board Keyword File

Specifying Configuration File Locations

3.4.2 Creating a System Configuration File for oamsys

Sample System Configuration File

3.4.3 Launching oamsys

3.5 Changing Configuration Parameter Settings

3.1 Introduction

This chapter describes how to configure and start your QX boards, once the software is installed. This chapter includes:

• Instructions for referencing the QX managers in your Natural Access configuration file.

• Instructions for adding configuration information for the boards into the NMS OAM database, and starting the boards.

3.2 Referencing the QX Managers for Natural Access

For the QX manager component to be available to the Natural Access server when it boots, it must be referenced in your Natural Access configuration file, cta.cfg. To add the reference:

1. Stop the Natural Access server (ctdaemon).
   The Natural Access server is automatically installed during a standard NMS installation, and is configured to start at boot-up time. You can stop it in either of the following ways:

2. Access a command prompt, and enter net stop ctdaemon

3. In the Windows Control Panel, double-click on Services, and stop the Natural Access server within this applet.

4. Edit the \nms\ctaccess\cfg\cta.cfg file, and add the QX managers under the [ctasys] heading, as shown in boldface below:

   [ctasys]
   Service = adi, adimgr
   Service = ncc, qdimgr
   Service = adi, qdimgr
   Service = ppx, ppxmgr
   Service = swi, swimgr
   Service = vce, vcemgr
   Service = oam, oammgr
   Service = fxm, qdimgr # Add this line only if you will use
                         # NaturalFax with QX  2000 boards
   Service = nfx, nfxmgr # Add this line only if using NaturalFax
   Service = fax, faxmgr # Add this line only if using NaturalFax
   
   

5. Restart ctdaemon. You can start it in either of the following ways:

6. Access a command prompt, and enter net start ctdaemon

7. In the Windows Control Panel, double-click on Services, and start the Natural Access server within this applet.

For more information about cta.cfg and its contents, refer to the Natural Access Developer's Reference Manual.

3.3 Adding QX Configurations to the NMS OAM Database

For the NMS OAM software to be able to configure and start the boards, each board must have a separate set of configuration parameters and values in the NMS OAM database. Each parameter and value is expressed as a keyword name/value pair (for example, Xlaw = MU_LAW).

The following utilities shipped with NMS OAM allow you to set up the database:

Utility	Description
oamsys	Performs system-wide configuration and startup of boards. Configures the NMS OAM database based on system configuration files you supply. Then attempts to start all boards listed in the database.
oamcfg	Provides greater access to individual NMS OAM configuration functions. For more information about this utility, refer to the NMS OAM System User's Manual.
oaminfo	Displays keywords and settings for one or more components. Can also set individual keywords. For more information about this utility, refer to the NMS OAM System User's Manual.

Note: An application can control NMS OAM programmatically, using the OAM service API. For more information, refer to the NMS OAM Service Developer's Reference Manual.

For general documentation of NMS OAM utilities, refer to the NMS OAM System User's Manual.

3.4 Configuring the System Using oamsys

To configure a system using the oamsys utility:

1. Install your boards and software as described in Chapter 2.

2. Determine the PCI bus and slot locations of the boards, using the pciscan utility. The pciscan utility identifies the NMS PCI boards installed in the system, and returns each board's bus, slot, interrupt, and board type.
   For more information about pciscan, refer to the NMS OAM System User's Manual.

3. Create a board keyword file for each board, containing keywords and values to configure the board.
   Sample board keyword files are supplied, which you can copy and modify as needed. You can use the same board keyword file for multiple boards, if the boards' configurations are identical.

4. Create a system configuration file describing the overall board configuration. In this file, give each board a unique name and board number, and assign it a board keyword file.

5. Use oamsys to create records for your boards in the NMS OAM database based on the system configuration file, and to start all installed boards.

3.4.1 Using Board Keyword Files

A board keyword file contains a list of parameters and values to configure a board. The board keyword file for each board is assigned to the board in another file, called a system configuration file. When oamsys runs, it creates a record for each board in the NMS OAM database, and stores the parameters and values of the board. It then starts the board, configured as described in the database. (See Figure 15.)

Figure 15. NMS OAM Configuration Files

A sample set of board keyword files are installed during the QX 2000 installation. A generic configuration file (qxpi2000.cfg) is installed in the nms\qx\cfg directory. It contains information specific to the default country selected when the board was installed. The file content differs, depending upon:

• The country the board will be used in, and

• The board type (QX 2000/100-4L or QX 2000/80-4L).

The files are located in the nms\qx\ctry\xxx directory. xxx is the three-letter country code of the target country. For example, the code for the United States is usa. Thus the files for the United States are in nms\qx\ctry\usa.

In each country-specific directory xxx, the following files appear:

File	Description
q2k1004l.cfg	Sample configuration file for QX 2000/100-4L boards, specific to country xxx
q2k804l.cfg	Sample configuration file for QX 2000/80-4L boards, specific to country xxx

For information on specific QX keywords, refer to Chapter 8. For general information about board keyword files, refer to the NMS OAM System User's Manual.

Sample Board Keyword File

The qxpi2000.cfg file shown below is an example keyword configuration file. It shows the set of configuration keywords necessary to configure and start a QX 2000/100-4L board in the USA. The corresponding file (q2k1004l.cfg) contents can be found in \mms\qx\ctry\usa:

# QX  2000/100-4L boards : OAM QX plugin default parameter file for 
# United States
  FPGA.ConfigFile                            = q422.hex
  NetworkInterface.Analog.ConfigFile[0]      = q4usals6.slc
  DSP.C5x[0].Image                           = qx100.dsp
  Clocking.HBus.ClockMode                    = STANDALONE
  Clocking.HBus.ClockSource                  = OSC
  Xlaw                                       = MU-LAW
  BootDiagnosticLevel                        = 1

Specifying Configuration File Locations

Files to be downloaded on the QX boards are specified with keywords in the QX board keyword file. For example:

NetworkInterface.Analog.ConfigFile[0] = filename

If filename contains a path specification, NMS OAM searches for the file in the specified directory. Otherwise, NMS OAM searches for the file in the current working directory of ctdaemon. If the file does not exist in this current working directory, NMS OAM searches for the file in the load_directory defined by the QXLOAD environment variable.

3.4.2 Creating a System Configuration File for oamsys

When your board keyword file(s) are complete, create a system configuration file describing the overall configuration of your system, and assigning a board keyword file to each board. oamsys creates records in the NMS OAM database for your boards based on this file.

The system configuration file is typically named oamsys.cfg. By default, oamsys looks for a file with this name when it starts up.

Refer to the NMS OAM System User's Manual for specific information on the syntax and structure of this file. The following chart describes the QX board-specific settings to include in the file for each QX board:

Keyword	Description	Values
[name]	The name of the board, to be used to refer to the board in software. The board name must be unique.	Any string, in square brackets [].
Product	The name of the board product.	· QX 2000/80-4L boards: QX 2000/80-4L · QX 2000/100-4L boards: QX 2000/100-4L
Number	The board number you will use in your Natural Access application to refer to the board.	Any integer from 0 upward. Each board's number must be unique.
Bus	The PCI bus number. The bus:slot location for each board must be unique.	Values returned by pciscan.
Slot	The PCI slot number. The bus:slot location for each board must be unique.	Values returned by pciscan.
File	The name of the board keyword file containing settings for the board. Several board keyword files are installed with the QX software, one for each country or region. The board keyword file for a specific country is located in nms\qx\ctry\xxx\, where xxx stands for the ISO code of the country.	Set to the path and name of the board keyword file you wish to assign the board. You can specify more than one file after the File keyword: File=mya.cfg myb.cfg myc.cfg Alternatively, you can specify the File keyword more than once: File=mya.cfg File=myb.cfg File=myc.cfg Board keyword files are sent in the order listed. The value for a given keyword in each file overrides any value specified for the keyword in earlier files.

Keywords and values can also be specified directly in the system configuration file. This is often useful if your board configurations are identical, except for one or two parameters (such as clocking information).

Sample System Configuration File

The following system configuration file describes two QX 2000/100-4L boards:

• The first board is assigned name FirstQx and board number 0, and is located at bus 0, slot 15. It is assigned keyword file qxpi2000.cfg which configures the board with default country settings. It is set up as the primary H.100 bus clock master, using its on-board oscillator as its timing reference.

• The second board is assigned name SecondQx and board number 1, and is located at bus 0, slot 16. It is assigned the same keyword file as the first board. It is set up as a slave to the primary master.

  [FirstQx]
  Product = QX  2000/100-4L
  Number  = 0
  Bus     = 0
  Slot    = 15
  File    = qxpi2000.cfg
  
  Clocking.HBus.ClockMode   = MASTER_A
  Clocking.HBus.ClockSource = OSC
  
  
  [SecondQx]
  Product = QX  2000/100-4L
  Number  = 1
  Bus     = 0
  Slot    = 16
  File    = qxpi2000.cfg
  
  Clocking.HBus.ClockMode   = SLAVE
  Clocking.HBus.ClockSource = A_CLOCK
  

3.4.3 Launching oamsys

To launch oamsys, enter oamsys on the command line.

If you invoke oamsys without command line options, it searches for a file named oamsys.cfg in the paths specified in the AGLOAD environment variable.

When invoked with a valid filename, oamsys does the following:

• Checks the syntax of your system configuration file, and that all required keywords are present.
  Note: oamsys checks the syntax only on the system configuration file, and not on any board keyword files referenced in the system configuration file. oamsys reports all syntax errors it finds.

• Checks for uniqueness of board name, number and bus/slot.

• Deletes all board configuration information currently stored in the NMS OAM database (if there is any).

• Sets up the NMS OAM database, and creates all records as described in the system configuration file.

• Attempts to start all boards, as described in the database.
  Note: ctdaemon must be running for oamsys to operate. For details on ctdaemon, refer to the Natural Access Developer's Reference Manual.

3.5 Changing Configuration Parameter Settings

Once you have initialized the database with oamsys, to make further parameter changes you can do any of the following:

• Modify the board keyword file for the board, make sure the name is correctly specified in the File statement in oamsys.cfg, and run oamsys again.

• Specify parameter settings using the oamcfg utility. For information about this utility, refer to the NMS OAM System User's Manual.

• Specify the settings programmatically, using the OAM service API. (See the NMS OAM Service Developer's Reference Manual for more information.)