(Page 1 of 80 in this chapter) Version

Chapter 6

Keyword Reference

6.1 Introduction

6.2 Keywords

: 6.2.1 Setting Keyword Values
: 6.2.2 Retrieving Keyword Values

6.3 Summary of Editable Keywords

6.4 Summary of Informational Keywords

6.5 Summary of AG Plug-In Keywords

6.6 Alphabetical Keyword Reference

6.1 Introduction

This chapter documents all AG 4000C keywords. This chapter includes: A brief overview of OAM keywords and how to set and retrieve them. A summary of the AG 4000C keywords. An alphabetical reference of the AG 4000C keywords.
To learn how to use OAM utilities such as oamcfg and oamsys, refer to the OAM System User's Manual. To learn about setting and retrieving keywords programmatically, refer to the OAM Service Developer's Reference Manual.

6.2 Keywords

The keywords for a given AG 4000C board describe that board's configuration. Some keywords are read/write; others are read-only: Read/write (editable) keywords determine how the board is configured when it starts up. Changes to these keywords become effective after the board has been rebooted. Read-only (informational) keywords indicate the board's current configuration. Read-only keywords cannot be modified.
Plug-in keywords exist in a separate record in the OAM database. They indicate certain board family-level information. AG plug-in keywords are documented in this chapter.
A keyword has the general syntax:
keyword = value
Keywords are case-insensitive except where operating system conventions prevail (for example, filenames under UNIX). All values are strings, or strings that represent integers. An integer keyword may have a fixed numeric range of legal values. A string keyword may support a fixed set of legal values, or may accept any string.

6.2.1 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 OAM System User's Manual for information about board keyword file syntax.) Specify parameter settings using the oamcfg utility. Refer to the OAM System User's Manual for information about oamcfg. Create a new board keyword file, either with additional keywords or keywords whose values override earlier settings. Specify the settings programmatically using the OAM service API. (Refer to the 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 AG plug-in level keywords, specify the AG plug-in name (agplugin.bpi). Note: Keyword values take effect after the board is rebooted.

6.2.2 Retrieving Keyword Values

There are several ways to retrieve the values of read/write and read-only keywords: Run the oaminfo sample program. Specify the name of the board with the -n option on the command line: oaminfo -n boardname To access AG plug-in level keywords, specify the AG plug-in name on the command line: oaminfo -n agplugin.bpi oaminfo returns a complete list of keywords and values. For more information about oaminfo, refer to the OAM Service Developer's Reference Manual. Retrieve the settings programmatically, using the OAM service API. (Refer to the OAM Service Developer's Reference Manual for more information.)

6.3 Summary of Editable Keywords

The following table summarizes the keywords that you may want to change: If you want to... Use these keywords... Specify whether the board is started or stopped automatically AutoStart AutoStop Specify the board location Location.PCI.Bus* Location.PCI.Slot* Specify information about the board LoadFile LoadSize Name* Number* DLMFiles[x] RunFile TCPFiles[x] Set up debug level information BootDiagnosticLevel Modify memory allocation Buffers[x].Num Buffers[x].Size MaxChannels Set up trunk information for the board NetworkInterface.T1E1[x].ConfigFile NetworkInterface.T1E1[x].FrameType NetworkInterface.T1E1[x].LineCode NetworkInterface.T1E1[x].Length NetworkInterface.T1E1[x].SignalingType Set up trunk information specific to ISDN NetworkInterface.T1E1[x].D_Channel NetworkInterface.T1E1[x].ISDN.D_Channel_Backup_Trunk NetworkInterface.T1E1[x].ISDN.NFAS_ Member.Count NetworkInterface.T1E1[x].ISDN.NFAS_ MEMBER[y].Board NetworkInterface.T1E1[x].ISDN.NFAS_ MEMBER[y].NAI NetworkInterface.T1E1[x].ISDN.NFAS_ MEMBER[y].Trunk NetworkInterface.T1E1[x].ISDN.NFASGroup Set up clocking information Clocking.HBus.ClockMode Clocking.HBus.ClockSource Clocking.HBus.ClockSourceNetwork Clocking.HBus.Segment Configure clock automatic fallback Clocking.HBus.AutoFallBack Clocking.HBus.FallBackClockSource Clocking.HBus.FallBackNetwork Set up information specific to NETREF1 or NETREF2 Clocking.HBus.NetRefSource Clocking.HBus.NetRefSourceNetwork Clocking.HBus.NetRef2Source Clocking.HBus.NetRef2SourceNetwork Clocking.HBus.NetRef2Speed Clocking.HBus.NetRefSpeed Set up switching information SwitchConnectMode SwitchConnections Configure DSPs DSP.C5x[x].Files[y] DSP.C5x.DSPFiles[x] DSP.C5x.Image DSP.C5x[x].Image DSP.C5x.Lib DSP.C5x[x].Os SignalIdleCode VoiceIdleCode Xlaw * These keywords are set in the oamsys.cfg file.

If you want to...	Use these keywords...
Specify whether the board is started or stopped automatically	AutoStart AutoStop
Specify the board location	Location.PCI.Bus* Location.PCI.Slot*
Specify information about the board	LoadFile LoadSize Name* Number* DLMFiles[x] RunFile TCPFiles[x]
Set up debug level information	BootDiagnosticLevel
Modify memory allocation	Buffers[x].Num Buffers[x].Size MaxChannels
Set up trunk information for the board	NetworkInterface.T1E1[x].ConfigFile NetworkInterface.T1E1[x].FrameType NetworkInterface.T1E1[x].LineCode NetworkInterface.T1E1[x].Length NetworkInterface.T1E1[x].SignalingType
Set up trunk information specific to ISDN	NetworkInterface.T1E1[x].D_Channel NetworkInterface.T1E1[x].ISDN.D_Channel_Backup_Trunk NetworkInterface.T1E1[x].ISDN.NFAS_ Member.Count NetworkInterface.T1E1[x].ISDN.NFAS_ MEMBER[y].Board NetworkInterface.T1E1[x].ISDN.NFAS_ MEMBER[y].NAI NetworkInterface.T1E1[x].ISDN.NFAS_ MEMBER[y].Trunk NetworkInterface.T1E1[x].ISDN.NFASGroup
Set up clocking information	Clocking.HBus.ClockMode Clocking.HBus.ClockSource Clocking.HBus.ClockSourceNetwork Clocking.HBus.Segment
Configure clock automatic fallback	Clocking.HBus.AutoFallBack Clocking.HBus.FallBackClockSource Clocking.HBus.FallBackNetwork
Set up information specific to NETREF1 or NETREF2	Clocking.HBus.NetRefSource Clocking.HBus.NetRefSourceNetwork Clocking.HBus.NetRef2Source Clocking.HBus.NetRef2SourceNetwork Clocking.HBus.NetRef2Speed Clocking.HBus.NetRefSpeed
Set up switching information	SwitchConnectMode SwitchConnections
Configure DSPs	DSP.C5x[x].Files[y] DSP.C5x.DSPFiles[x] DSP.C5x.Image DSP.C5x[x].Image DSP.C5x.Lib DSP.C5x[x].Os SignalIdleCode VoiceIdleCode Xlaw

6.4 Summary of Informational Keywords

The following table summarizes the keywords that cannot be edited: If you want to query... Use these keywords... Board information Location.Type Product State Eeprom.AssemblyRevision Eeprom.BoardSpecific Eeprom.BusClkDiv Eeprom.CheckSum Eeprom.CPUSpeed Eeprom.DRAMSize Eeprom.DSPSpeed Eeprom.Family Eeprom.MFGWeek Eeprom.MFGYear Eeprom.MSBusType Eeprom.NumDSPCores Eeprom.SerialNum Eeprom.SoftwareCompatibility Eeprom.SRAMSize Eeprom.SubType Board driver information Driver.BoardID Driver.Name SwitchDriver.Name Trunk information NetworkInterface.T1E1[x].ISDN.NFAS_ Member.Count NetworkInterface.T1E1[x].Type

If you want to query...	Use these keywords...
Board information	Location.Type Product State Eeprom.AssemblyRevision Eeprom.BoardSpecific Eeprom.BusClkDiv Eeprom.CheckSum Eeprom.CPUSpeed Eeprom.DRAMSize Eeprom.DSPSpeed Eeprom.Family Eeprom.MFGWeek Eeprom.MFGYear Eeprom.MSBusType Eeprom.NumDSPCores Eeprom.SerialNum Eeprom.SoftwareCompatibility Eeprom.SRAMSize Eeprom.SubType
Board driver information	Driver.BoardID Driver.Name SwitchDriver.Name
Trunk information	NetworkInterface.T1E1[x].ISDN.NFAS_ Member.Count NetworkInterface.T1E1[x].Type

6.5 Summary of AG Plug-In Keywords

The AG plug-in keywords are: Boards[x] Products[x] LoadSize Version.Major Version.Minor

6.6 Alphabetical Keyword Reference

The keywords are presented in detail in the following sections. The keyword descriptions include: Syntax The syntax of the keyword Access Read/Write or Read-only Type The data type of the value: String, Integer, or Filename 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

Syntax	The syntax of the keyword
Access	Read/Write or Read-only
Type	The data type of the value: String, Integer, or Filename
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

(Page 1 of 80 in this chapter) Version

Want to send us feedback on our documentation? Email: Tech_Pubs@nmss.com

Chapter 6

Keyword Reference

Syntax

Access

Type

Default

Allowed Values

Example

Description

See Also