(Page 1 of 1 in this chapter) Version

Chapter 3

Editing AG Configuration Files

3.1 Introduction

3.2 Creating the AG Configuration File

3.3 Sample AG Configuration Files

: 3.3.1 AG 2000 Board: Loop Start Protocol
: 3.3.2 AG-E1 Board: MFC-R2 Protocol
: 3.3.3 AG Quad T1 Board: WNK Protocol

3.1 Introduction

An AG configuration file is a text file that lists the type, location and role of each AG board on a PC chassis. It also specifies what software modules are loaded to each board's memory. The agmon utility is used to load and monitor AG boards according to AG configuration files. agmon reads the AG configuration file and configures the AG boards accordingly.
One or more sample configuration files are installed with each protocol software package. These sample configuration are country-specific, and include statements that make the protocol run appropriately for a particular country.
This chapter: Describes how to edit AG configuration files so that agmon configures boards properly for the protocol software you are using. Describes sample AG configuration files for various boards and protocols.
For information about the AG configuration file format, refer to the AG Runtime Configuration and Developer's Manual.

3.2 Creating the AG Configuration File

The easiest way to create an AG configuration file for your setup is to modify or combine the contents of the example files installed on your system. Use a text editor to edit your existing AG configuration file. Include any necessary entries from the sample configuration files included with the protocol software. Save the file with the file name ag.cfg (by default agmon looks for a file with this name).
agmon uses the following algorithm to search for the AG configuration file: Windows NT: agmon searches in the current working directory, and then in the directories specified in the AGLOAD environment variable. UNIX: agmon searches in the current working directory, and then in the directory /opt/nms/ag/cfg. Note: Several other sample configuration files also reside in the same directory as ag.cfg. These are installed with various NMS software packages to accommodate different types of board configurations. For board specific settings, refer to the appropriate hardware installation and developer's manual.

3.3 Sample AG Configuration Files

The following sections show sample AG configuration files for CAS protocol applications on various hardware configurations. CAS protocol-specific items appear shaded. Note: Certain statements (for example Idlecode) may be included in either the COMMON section or the BOARDS section of the AG configuration file. Statements in the COMMON section apply to all boards in the system. Statements in the BOARDS sections apply to specific boards in the system.

3.3.1 AG 2000 Board: Loop Start Protocol

The following sample AG configuration file describes an AG 2000 board using a loop start protocol in the USA (with four ports with 900 ohm network line impedance and four ports with 600 ohm network line impedance). The board is configured to run as a stand alone unit, without MVIP connectivity.
Shaded statements are country-specific settings for the LPS0 TCP. For more information about board-specific entries, refer to the AG 2000 Installation and Developer's Manual. [AGBOARD] The AG configuration file must begin with this statement. #--- COMMON section --- Any statements in this section of the file will apply to all boards listed in the BOARDS sections below. TCP = nocc.tcp TCP = lps0.tcp These statements indicate the TCP to load to the board. The setting here is protocol-specific. The first statement loads the no call control protocol. The second statement loads the loop start protocol. AG2DspFile = voice.m54 AG2DspFile = tone.m54 AG2DspFile = signal.m54 AG2DspFile = callp.m54 AG2DspFile = ptf.m54 AG2DspFile = dtmf.m54 These statements install DSP program files. They are installed on all boards listed in this file, since they appear in the COMMON section of this file. For this configuration, you will need at least the statements shown. The following DSP functionality is defined by this configuration: · NMS ADPCM play and record · Beep, tone generation, dial · Out-of-band channel associated signaling · Call Progress detection · Cleardown and precise tone detection · DTMF and silence/energy detectors RunModule = gtp.leo RunModule = svc.leo RunModule = voice.leo These statements specify optional runtime components to be transferred to the coprocessor on the board. (leo files are Loadable Executable Objects). #--- BOARDS section --- Board 0 This statement indicates the beginning of a description of a particular board. The number appearing here will be used to refer to the board in software. PCIBUS = 0 Defines the PCI bus location of the board. PCISLOT = 19 Defines the slot location of the board on the PCI bus. ClockRef = OSC This line configures the telephony bus clock. Setting OSC defines the board as a clock master. EnableMvip = No This line determines whether MVIP switching is enabled for the board. Set to Yes to enable switching. Note: Certain default switch connections are made on AG boards when EnableMVIP=No, that are not made when EnableMVIP=Yes. For more information, see your AG board documentation. IdleCode = MU-LAW Defines voice signaling bit patterns sent to the network when the TCP is not active. This is country-specific. Note: Mu-law is a companding algorithm used for digital trunks. AG 2000 boards need to know the originating companding law in order to generate an analog voice signal. QSLAC 0..4 = a2usals9.slc QSLAC 5..7 = a2usals6.slc This statement defines SLAC files to program QSLAC devices. In this case, these statement define US loop start signaling 900 ohm lines on 0,1,2,3,4 and defines US loop start signaling 600 ohm lines on ports 5,6,7. End Board This statement indicates the end of the description for board 0.

`[AGBOARD]`	The AG configuration file must begin with this statement.
`#--- COMMON section ---`	Any statements in this section of the file will apply to all boards listed in the BOARDS sections below.
`TCP = nocc.tcp` `TCP = lps0.tcp`	These statements indicate the TCP to load to the board. The setting here is protocol-specific. The first statement loads the no call control protocol. The second statement loads the loop start protocol.
`AG2DspFile = voice.m54` `AG2DspFile = tone.m54` `AG2DspFile = signal.m54` `AG2DspFile = callp.m54` `AG2DspFile = ptf.m54` `AG2DspFile = dtmf.m54`	These statements install DSP program files. They are installed on all boards listed in this file, since they appear in the `COMMON` section of this file. For this configuration, you will need at least the statements shown. The following DSP functionality is defined by this configuration: · NMS ADPCM play and record · Beep, tone generation, dial · Out-of-band channel associated signaling · Call Progress detection · Cleardown and precise tone detection · DTMF and silence/energy detectors
`RunModule = gtp.leo` `RunModule = svc.leo` `RunModule = voice.leo`	These statements specify optional runtime components to be transferred to the coprocessor on the board. (`leo` files are Loadable Executable Objects).
`#--- BOARDS section ---`
`Board 0`	This statement indicates the beginning of a description of a particular board. The number appearing here will be used to refer to the board in software.
`PCIBUS = 0`	Defines the PCI bus location of the board.
`PCISLOT = 19`	Defines the slot location of the board on the PCI bus.
`ClockRef = OSC`	This line configures the telephony bus clock. Setting `OSC` defines the board as a clock master.
`EnableMvip = No`	This line determines whether MVIP switching is enabled for the board. Set to `Yes` to enable switching. Note: Certain default switch connections are made on AG boards when `EnableMVIP=No`, that are not made when `EnableMVIP=Yes`. For more information, see your AG board documentation.
`IdleCode = MU-LAW`	Defines voice signaling bit patterns sent to the network when the TCP is not active. This is country-specific. Note: Mu-law is a companding algorithm used for digital trunks. AG 2000 boards need to know the originating companding law in order to generate an analog voice signal.
`QSLAC 0..4 = a2usals9.slc` `QSLAC 5..7 = a2usals6.slc`	This statement defines SLAC files to program QSLAC devices. In this case, these statement define US loop start signaling 900 ohm lines on 0,1,2,3,4 and defines US loop start signaling 600 ohm lines on ports 5,6,7.
`End Board`	This statement indicates the end of the description for board 0.

3.3.2 AG-E1 Board: MFC-R2 Protocol

The following sample AG configuration file describes an AG-E1 board (at I/O address 2C0, IRQ 12) running an MFC-R2 TCP specific to the People's Republic of China.
Shaded statements are settings specific to the MFC-R2 TCP. For more information about board-specific entries, refer to the appropriate installation and developer's manual. [AGBOARD] The AG configuration file must begin with this statement. #-- COMMON section -- Any statements in this section of the file will apply to all boards listed in the Board sections below. Interrupt = 12 The interrupt you specify here will be used by all ISA AG boards in your system. DspFile = voice_a.dsp DspFile = signal_a.dsp DspFile = dtmf_a.dsp DspFile = callp_a.dsp DspFile = tone_a.dsp DspFile = mf_a.dsp These statements install DSP program files. They are installed on all boards listed in this file, since they appear in the COMMON section of this file. For this configuration, you will need at least the statements shown. You can add others also, if you wish. The _a following each file name indicates that these files are for A-law encoding. If your setup calls for mu-law encoding, remove the _a from each file name. RunFile = systn.run This line defines the coprocessor software to be used. It is board and protocol-specific. For AG-T1 and AG-E1 boards with digital CAS protocol software, use systn.run. #-- BOARDS section -- Board 0 This statement indicates the beginning of a description of a particular board. The number appearing here will be used to refer to the board in software. Address = 2C0 This is the board's I/O address. Each board must have a unique address. The address is set here and on the board's face using switches. The Address statement is not necessary for PCI-based boards, but is necessary for ISA boards. TCP = mfc0.tcp This statement indicates the TCP to load to the board. The setting here is protocol-specific. For MFC-R2 under CT Access, specify mfc0.tcp. IdleCode = 0xD5,0xB Defines voice signaling bit patterns sent to the network when the TCP is not active. This is country-specific. The setting shown here is specific to the People's Republic of China. The first hexadecimal number represents the digital pattern to be output on the voice channels of the E1 trunk. 0xD5 is the "silence" pattern for A-law companding. The second number is the value of the signaling bit associated with each voice channel. 0xB (ABCD = 1011) is the MFC-R2 idle signaling code in the PRC. ClockRef = NET1 This statement configures the clock. NET1 causes the board to derive the local clock using the clock extracted from the E1 line. EnableMVIP = No This line determines whether MVIP switching is enabled for the board. Set to Yes to enable switching. Note: Certain default switch connections are made on AG boards when EnableMVIP=No, that are not made when EnableMVIP=Yes. For more information, see your AG board documentation. LineCode = HDB3 The LineCode statement defines the trunk line coding algorithm. The setting made here is high-density bipolar 3, which is the default setting for the AG-E1. End Board This statement indicates the end of the description for board 0.

`[AGBOARD]`	The AG configuration file must begin with this statement.
`#-- COMMON section --`	Any statements in this section of the file will apply to all boards listed in the `Board` sections below.
`Interrupt = 12`	The interrupt you specify here will be used by all ISA AG boards in your system.
`DspFile = voice_a.dsp` `DspFile = signal_a.dsp` `DspFile = dtmf_a.dsp` `DspFile = callp_a.dsp` `DspFile = tone_a.dsp` `DspFile = mf_a.dsp`	These statements install DSP program files. They are installed on all boards listed in this file, since they appear in the `COMMON` section of this file. For this configuration, you will need at least the statements shown. You can add others also, if you wish. The `_a` following each file name indicates that these files are for A-law encoding. If your setup calls for mu-law encoding, remove the `_a` from each file name.
`RunFile = systn.run`	This line defines the coprocessor software to be used. It is board and protocol-specific. For AG-T1 and AG-E1 boards with digital CAS protocol software, use `systn.run`.
`#-- BOARDS section --`
`Board 0`	This statement indicates the beginning of a description of a particular board. The number appearing here will be used to refer to the board in software.
`Address = 2C0`	This is the board's I/O address. Each board must have a unique address. The address is set here and on the board's face using switches. The `Address` statement is not necessary for PCI-based boards, but is necessary for ISA boards.
`TCP = mfc0.tcp`	This statement indicates the TCP to load to the board. The setting here is protocol-specific. For MFC-R2 under CT Access, specify `mfc0.tcp`.
`IdleCode = 0xD5,0xB`	Defines voice signaling bit patterns sent to the network when the TCP is not active. This is country-specific. The setting shown here is specific to the People's Republic of China. The first hexadecimal number represents the digital pattern to be output on the voice channels of the E1 trunk. `0xD5` is the "silence" pattern for A-law companding. The second number is the value of the signaling bit associated with each voice channel. `0xB` (ABCD = 1011) is the MFC-R2 idle signaling code in the PRC.
`ClockRef = NET1`	This statement configures the clock. `NET1` causes the board to derive the local clock using the clock extracted from the E1 line.
`EnableMVIP = No`	This line determines whether MVIP switching is enabled for the board. Set to `Yes` to enable switching. Note: Certain default switch connections are made on AG boards when `EnableMVIP=No`, that are not made when `EnableMVIP=Yes`. For more information, see your AG board documentation.
`LineCode = HDB3`	The `LineCode` statement defines the trunk line coding algorithm. The setting made here is high-density bipolar 3, which is the default setting for the AG-E1.
`End Board`	This statement indicates the end of the description for board 0.

3.3.3 AG Quad T1 Board: WNK Protocol

The following sample AG configuration file describes one AG Quad board set up using the Wink Start TCP for Hong Kong. [AGBOARD} #---COMMON section--- Any statements in this section of the file will apply to all boards. DspFile = dtmf.dsp DspFile = voice.dsp DspFile = callp.dsp DspFile = tone.dsp These statements install the DSP files. They are installed on all boards, since they appear in the COMMON section. TCP = wnk0.tcp Indicates the TCP to load to the board. The setting here is protocol-specific. For Wink Start under CT Access, specify wnk0.tcp. IdleCode = MU-LAW #IdleCode = 0x7f, 0xa Default for Hong Kong. Change to this setting if the protocol uses a pulse-on-idle signaling polarity. (see Chapter 8 for details on the WNK protocol implementation in Hong Kong) RunFile = sysqn.run This line defines the runfile software to be loaded to the board. #-- BOARDS section -- Board 0 The beginning of the configuration for a specific board. PCIbus = 0 PCIslot = 1 CCMode = HIGH EnableMVIP = NO DigitalMode=CAS LineLength = 100 Applies to all trunks, since it is outside of the Trunk section (run the blocate utility to find the correct PCI bus and slot). Trunk 0 Beginning of description for Trunk 0. FrameType = D4 LineCode = AMI End Trunk Trunk 1..3 Beginning of description for Trunks 1, 2, and 3. LineCode = AMI_ZCS End Trunk End Board End of configuration for Board 0.

`[AGBOARD}`
`#---COMMON section---`	Any statements in this section of the file will apply to all boards.
`DspFile = dtmf.dsp DspFile = voice.dsp DspFile = callp.dsp DspFile = tone.dsp`	These statements install the DSP files. They are installed on all boards, since they appear in the `COMMON` section.
`TCP = wnk0.tcp`	Indicates the TCP to load to the board. The setting here is protocol-specific. For Wink Start under CT Access, specify `wnk0.tcp`.
`IdleCode = MU-LAW` `#IdleCode = 0x7f, 0xa`	Default for Hong Kong. Change to this setting if the protocol uses a pulse-on-idle signaling polarity. (see Chapter 8 for details on the WNK protocol implementation in Hong Kong)
`RunFile = sysqn.run`	This line defines the runfile software to be loaded to the board.
`#-- BOARDS section --`
`Board 0`	The beginning of the configuration for a specific board.
`PCIbus = 0 PCIslot = 1 CCMode = HIGH EnableMVIP = NO DigitalMode=CAS LineLength = 100`	Applies to all trunks, since it is outside of the `Trunk` section (run the `blocate` utility to find the correct PCI bus and slot).
`Trunk 0`	Beginning of description for Trunk 0.
`FrameType = D4 LineCode = AMI`
`End Trunk`
`Trunk 1..3`	Beginning of description for Trunks 1, 2, and 3.
`LineCode = AMI_ZCS`
`End Trunk`
`End Board`	End of configuration for Board 0.

(Page 1 of 1 in this chapter) Version

tech_support@nmss.com