(Page 1 of 111 in this chapter) Version

Chapter 6

CG Keyword Reference

6.1 Introduction

6.2 Keyword Types

: 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 Plug-in Keywords

6.6 Alphabetical Keyword Reference

6.1 Introduction

This chapter describes CG 6000C board and plug-in keywords including: A brief overview of NMS OAM board keywords, and how to set and retrieve them. A summary of the CG 6000C board keywords An alphabetical reference of the CG 6000C board keywords
To learn how to use NMS OAM utilities such as oamsys, refer to the NMS OAM System User's Manual. To learn how to set and retrieve keywords with OAM service functions, refer to the NMS OAM Service Developer's Reference Manual.

6.2 Keyword Types

The keywords in the managed object for a given CG 6000C 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.
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. I Integer keywords require fixed numeric range of legal values. String keywords either require a fixed set of legal values, or accept any string.
This chapter also describes CG plug-in keywords. These keywords provide specific board family information for CG boards. All CG 6000C plug-in keywords except BootDiagnosticLevel are read only.

6.2.1 Setting Keyword Values

There are several ways to set the values of read/write keywords: Duplicate the keyword file corresponding to your country and board type, modify the new file, specify the name of this new file in the File statement in oamsys.cfg, and run oamsys again. For information NMS OAM keyword file syntax, refer to the NMS OAM System User's Manual. Create a new keyword file, either with additional keywords, or keywords whose values override earlier settings. Specify parameter settings directly with the oamcfg utility. For more information about oamcfg, refer to the NMS OAM System User's Manual. Specify the settings with OAM service functions. For more information refer to the NMS OAM Service Developer's Reference Manual. Note: Keyword values set in CG board keyword files take effect after the board is rebooted. The only exception is the DebugMask keyword, which takes effect immediately.

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 -b option (specifying the board number) on the command line:

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

Retrieve the settings using functions from the OAM service. For more information, refer to the NMS OAM Service Developer's Reference Manual.

6.3 Summary of Editable Keywords

The following table summarizes the keywords that you can change: If you want to... Use these keywords... Specify information about the board AutoStart AutoStop Buffer[x].Size EnableMonitor MaxChannels Name Number Specify CG 6000C line interfaces as T1 or E1 NetworkInterface.T1E1[x].Type Set up trunk information for the board NetworkInterface.T1E1[x].FrameType NetworkInterface.T1E1[x].Impedance NetworkInterface.T1E1[x].Length NetworkInterface.T1E1[x].LineCode NetworkInterface.T1E1[x].SignalingType NetworkInterface.T1E1[x].Type NetworkInterface.T1E1[x].CRCMFMode 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[y].Board NetworkInterface.T1E1[x].ISDN.NFAS_Member[y].NAI NetworkInterface.T1E1[x].ISDN.NFAS_Member[y].Trunk NetworkInterface.T1E1[x].ISDN.NFASGroup Set the IP addressing and static IP routing table information for the CG 6000C board IPC.AddRoute[x].DestinationAddress IPC.AddRoute[x].GatewayAddress IPC.AddRoute[x].Interface IPC.AddRoute[x].Mask Set up clocking information Clocking.HBus.ClockMode Clocking.HBus.ClockSource Clocking.HBus.ClockSourceNetwork Configure clock fallback Clocking.HBus.AutoFallBack Clocking.HBus.FallBackClockSource Clocking.HBus.FallBackNetwork Set up information specific to NETREF or NETREF2 Clocking.HBus.NetRefSource Clocking.HBus.NetRefSourceNetwork Clocking.HBus.NetRefSpeed Clocking.HBus.NetRef2Source Clocking.HBus.NetRef2SourceNetwork Clocking.HBus.NetRef2Speed Clocking.HBus.SClockSpeed Clocking.HBus.Segment Set up switching information SwitchConnections SwitchConnectMode DSPStream.SlotCount DSPStream.SignalIdleCode[x] DSPStream.VoiceIdleCode[x] Manage the resources on the CG 6000C board Resource[x].Definitions Resource[x].Name Resource[x].Size Resource[x].TCPNum Resource[x].TCPs TCPFiles[x] Set up debug level information BootDiagnosticMask DebugMask EnableMonitor Configure HDLC signaling Hdlc[x].Boot Hdlc[x].Comet.RxTimeSlot Hdlc[x].Comet.TxTimeSlot Configure on-board DSP programs DSP.C5x[x].Files DSP.C5x[x].Image DSP.C5x[x].Libs[y] DSP.C5x[x].NumRxTimeSlots DSP.C5x[x].NumTxTimeSlots DSP.C5x[x].Os DSP.C5x[x].XLaw Specifying the board location Location.PCI.Bus Location.PCI.Slot Location.Type Implementing Clarent ThroughPacket packet multiplexing TPKT.ComplexForwardCount TPKT.ComplexForward[x].DestinationPacketSize TPKT.ComplexForward[x].LifeTimeTicks TPKT.ComplexRxPort TPKT.ComplexTxPort TPKT.Enable TPKT.NumberOfComplexForwardConditions TPKT.SimpleRxPort TPKT.SimpleTxPort
These keywords are set with the oamsys configuration file.

If you want to...	Use these keywords...
Specify information about the board	AutoStart AutoStop Buffer[x].Size EnableMonitor MaxChannels Name Number
Specify CG 6000C line interfaces as T1 or E1	NetworkInterface.T1E1[x].Type
Set up trunk information for the board	NetworkInterface.T1E1[x].FrameType NetworkInterface.T1E1[x].Impedance NetworkInterface.T1E1[x].Length NetworkInterface.T1E1[x].LineCode NetworkInterface.T1E1[x].SignalingType NetworkInterface.T1E1[x].Type NetworkInterface.T1E1[x].CRCMFMode
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[y].Board NetworkInterface.T1E1[x].ISDN.NFAS_Member[y].NAI NetworkInterface.T1E1[x].ISDN.NFAS_Member[y].Trunk NetworkInterface.T1E1[x].ISDN.NFASGroup
Set the IP addressing and static IP routing table information for the CG 6000C board	IPC.AddRoute[x].DestinationAddress IPC.AddRoute[x].GatewayAddress IPC.AddRoute[x].Interface IPC.AddRoute[x].Mask
Set up clocking information	Clocking.HBus.ClockMode Clocking.HBus.ClockSource Clocking.HBus.ClockSourceNetwork
Configure clock fallback	Clocking.HBus.AutoFallBack Clocking.HBus.FallBackClockSource Clocking.HBus.FallBackNetwork
Set up information specific to NETREF or NETREF2	Clocking.HBus.NetRefSource Clocking.HBus.NetRefSourceNetwork Clocking.HBus.NetRefSpeed Clocking.HBus.NetRef2Source Clocking.HBus.NetRef2SourceNetwork Clocking.HBus.NetRef2Speed Clocking.HBus.SClockSpeed Clocking.HBus.Segment
Set up switching information	SwitchConnections SwitchConnectMode DSPStream.SlotCount DSPStream.SignalIdleCode[x] DSPStream.VoiceIdleCode[x]
Manage the resources on the CG 6000C board	Resource[x].Definitions Resource[x].Name Resource[x].Size Resource[x].TCPNum Resource[x].TCPs TCPFiles[x]
Set up debug level information	BootDiagnosticMask DebugMask EnableMonitor
Configure HDLC signaling	Hdlc[x].Boot Hdlc[x].Comet.RxTimeSlot Hdlc[x].Comet.TxTimeSlot
Configure on-board DSP programs	DSP.C5x[x].Files DSP.C5x[x].Image DSP.C5x[x].Libs[y] DSP.C5x[x].NumRxTimeSlots DSP.C5x[x].NumTxTimeSlots DSP.C5x[x].Os DSP.C5x[x].XLaw
Specifying the board location	Location.PCI.Bus Location.PCI.Slot Location.Type
Implementing Clarent ThroughPacket packet multiplexing	TPKT.ComplexForwardCount TPKT.ComplexForward[x].DestinationPacketSize TPKT.ComplexForward[x].LifeTimeTicks TPKT.ComplexRxPort TPKT.ComplexTxPort TPKT.Enable TPKT.NumberOfComplexForwardConditions TPKT.SimpleRxPort TPKT.SimpleTxPort

6.4 Summary of Informational Keywords

The following keywords cannot be edited: If you want to... Use these keywords... Retrieve board information Resource[x].TCPNum State Version.Major Version.Minor Retrieve driver information Driver.BoardId Driver.Name SwitchDriver.Name Retrieve EEPROM information Eeprom.AssemblyRevision Eeprom.ATETestBit Eeprom.DSPExtClk Eeprom.DSPSpeed Eeprom.DSPType Eeprom.EthernetType Eeprom.Family Eeprom.FlashBlkSz Eeprom.FlashID Eeprom.HostBusType Eeprom.MFGWeek Eeprom.MSBType Eeprom.NumCPU Eeprom.NumDaughterCard Eeprom.NumDSPCores Eeprom.NumEthernet Eeprom.NumSwitch Eeprom.NumTrunk Eeprom.Product Eeprom.SerialNum Eeprom.SoftwareCompatibility Eeprom.SwitchType Eeprom.TrunkType Retrieve miscellaneous information NetworkInterface.T1E1[x].ISDN.NFAS_Member.Count

If you want to...	Use these keywords...
Retrieve board information	Resource[x].TCPNum State Version.Major Version.Minor
Retrieve driver information	Driver.BoardId Driver.Name SwitchDriver.Name
Retrieve EEPROM information	Eeprom.AssemblyRevision Eeprom.ATETestBit Eeprom.DSPExtClk Eeprom.DSPSpeed Eeprom.DSPType Eeprom.EthernetType Eeprom.Family Eeprom.FlashBlkSz Eeprom.FlashID Eeprom.HostBusType Eeprom.MFGWeek Eeprom.MSBType Eeprom.NumCPU Eeprom.NumDaughterCard Eeprom.NumDSPCores Eeprom.NumEthernet Eeprom.NumSwitch Eeprom.NumTrunk Eeprom.Product Eeprom.SerialNum Eeprom.SoftwareCompatibility Eeprom.SwitchType Eeprom.TrunkType
Retrieve miscellaneous information	NetworkInterface.T1E1[x].ISDN.NFAS_Member.Count

6.5 Summary of Plug-in Keywords

The following table lists CG plug-in keywords: If you want to... Use these keywords... Retrieve the name of the board object Boards[x] Set the board diagnostic level BootDiagnosticLevel Retrieve the board names of detected boards DetectedBoards[x] Retrieve board product types Products[x]

If you want to...	Use these keywords...
Retrieve the name of the board object	Boards[x]
Set the board diagnostic level	BootDiagnosticLevel
Retrieve the board names of detected boards	DetectedBoards[x]
Retrieve board product types	Products[x]

6.6 Alphabetical Keyword Reference

The keywords are presented in detail in the following sections. Each keyword description includes: Syntax The syntax of the keyword Access Read/Write or Read-only 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

Syntax	The syntax of the keyword
Access	Read/Write or Read-only
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

(Page 1 of 111 in this chapter) Version

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

Chapter 6

CG Keyword Reference

Syntax

Access

Type

Default

Allowed Values

Example

Description

See Also