NaturalText, Fusion, Open Telecommunications, Natural Platforms, NMS HearSay, AccessGate, MyCaller, and HMIC are trademarks or service marks of NMS Communications Corporation or its subsidiaries. Multi- Vendor Integration Protocol (MVIP) is a registered trademark of GO-MVIP, Inc. UNIX is a registered trademark in the United States and other countries, licensed exclusively through X/Open Company, Ltd.
Connecting to a T1 network .................40 Connecting to an E1 network ...............41 Connecting a four-trunk CG 6565 to an E1 120 ohm ........42 Connecting a four-trunk CG 6565 to an E1 75 ohm........42 Connecting an eight-trunk CG 6565 to an E1 120 ohm ........42 Connecting an eight-trunk CG 6565 to an E1 75 ohm........42...
Page 4
Specifying configuration file locations ............51 Configuring board clocking................51 CG 6565 clocking capabilities ..............52 Configuring clocking.................55 Configuring CG 6565 board clocking using keywords........55 Multiple board system example..............57 Managing board DSP resources ..............59 Setting up a single resource pool ...............60 Setting up multiple resource pools .............60 Using multiple resource pools ..............61...
Page 5
CG 6565 Installation and Developer's Manual Table of Contents H.100 and local streams ................84 Voice and signaling information routing on T1 trunks (CAS mode) ....85 Voice and signaling information routing on E1 trunks (CAS mode) ....86 Default connections (CAS mode)..............87 PRI mode switching ..................89...
Introduction The CG 6565 Installation and Developer's Manual explains how to perform the following tasks: • Install and configure a CG 6565 board. • Verify that the board is installed and operating correctly. • Use the CG 6565 board keywords to configure the board.
Migration information The CG 6565 board is based on the CG 6000/C, CG 6100C, and CG 6500C boards. Although the boards are very similar, be aware of the following hardware and software differences as you migrate from one of these boards to the CG 6565 board.
DSP values: DSP.C5x[0].Files = qtsignal DSP.C5x[0..1].Files = 8tsignal • The CG 6565 board merges the core file and the run module to create a file named cg6565core.ulm. The CG 6565 board does not require the following DLMFiles[x] settings: DLMFiles[x] = cg6krun...
Page 13
CG 6565 Installation and Developer's Manual Overview of the CG 6565 board • In the CG 6565 configuration file, only set the DLMFiles[x] keyword when using the board with the following software: Software Setting Generic ISDN DLMFiles[x] = c6565igen Fusion...
Page 14
The CG 6565 board booting sequence differs from the booting sequence of the CG 6000/C, CG 6100C, and CG 6500C boards in the following ways: • CG 6565 boards do not require that you run the burnall script to update the flash memory on any CG 6565 boards in the chassis. •...
Page 15
Using echo cancellation control on page 101. • Trunk impedance on the CG 6565 board applies to two trunks and must be identical for trunk pairs. For information about the pairings, refer to NetworkInterface.T1E1[x].Impedance on page 181.
• PCI bus connectivity Each CG 6565 board is designed to reside in a single PCI bus slot. Each board contains a universal (5 V or 3.3 V signaling) PCI bus interface compliant with the PCI Local Bus Specification, Revision 2.2. The PCI interface is a 33 or 66 MHz 32/64-bit device.
Page 17
Ethernet connectivity and support of both IPv4 and IPv6. For more information, refer to Connecting to an Ethernet network on page 45. • Echo cancellation CG 6565 boards support up to 480 ports of line echo cancellation with 64 ms tails. NMS Communications...
Page 18
Overview of the CG 6565 board CG 6565 Installation and Developer's Manual The following illustration shows where various components are located on a CG 6565 board: Ethernet connectors Ethernet interfaces Daughterboard connector PCI to PCI bridge SDRAM PowerPC processor with fan...
Page 19
CG 6565 Installation and Developer's Manual Overview of the CG 6565 board The following illustration shows the location of components on a 4-port CG 6565 daughterboard: Trunk status LEDs Trunk RJ-45 connectors Transformers Main board T1/E1 framer connector Echo chip...
CG 6565 Installation and Developer's Manual Software components Natural Access is a development environment that provides such services as call control, system configuration, and voice store and forward. CG 6565 boards require the following software components that are available with Natural Access: •...
CG 6565 Installation and Developer's Manual Overview of the CG 6565 board Each NMS OAM database parameter and value is expressed as a keyword name and value pair (for example, Clocking.HBus.ClockMode = MASTER_A). You can query the NMS OAM database for keyword values in any component. Keywords and values can be added, modified, or deleted.
Runtime software The runtime software is stored in a run file on the host computer. CG 6565 boards download the run file, cg6565core.ulm, directly into SDRAM when the boards boot up using NMS OAM. This file is installed in the \nms\cg\load directory.
Overview of the CG 6565 board Trunk control programs (TCPs) CG 6565 boards are compatible with a variety of PSTN signaling schemes, called protocols. A trunk control program (TCP) performs all of the signaling tasks to interface with the protocol used on a channel. TCPs run on the board, relieving the host computer of the task of processing the protocol directly.
Fusion software and Fusion CG 6565 board configurations, refer to the Fusion Developer's Manual. Fusion 4.0 (or later) configurations use CG 6565 boards to receive and transmit data to PSTN and to IP networks. Fusion applications use NCC (Natural Call Control)
CG 6565 Installation and Developer's Manual Overview of the CG 6565 board Temperature monitoring system CG 6565 boards include a temperature monitoring system. If the board temperature becomes too high, oammon generates either a warning or a critical error message. Warning error message A warning error message displays when the board temperature reaches 70 °C.
The UPS does not need to power the PC video monitor except in areas prone to severe lightning storms. CG driver software NMS recommends that you install the CG 6565 hardware before you install the CG 6565 driver software. The following drivers for operating CG boards are installed with Natural Access...
Caution: The CG 6565 board is shipped in a protective anti-static container. Leave the board in its container until you are ready to install it. Handle the board carefully and hold it only by its handles.
NONE, which is the default. Configuring the T1 or E1 interface If the CG 6565 board you are installing has an attached daughterboard, it is shipped to you configured as a T1/E1 120 ohm board. To configure the T1 or E1 interface,...
0 through 7 trunks. Configuring hardware echo cancellation NMS recommends using the CG 6565 daugtherboard with the echo chip to provide hardware echo cancellation capabilities and free up DSP resources. When using the hardware echo cancellation capabilities, echo cancellation parameters are fixed. An application cannot change the parameters in the ADI_ECHOCANCEL_PARMS structure with the adiModifyEchoCanceller function.
Installing the board Warning: The CG 6565 board powers up and functions only in a PCI chassis that supplies the PCI bus slot with 5.0 V and 3.3 V of power. Complete the following steps to initially install the CG 6565 board:...
Ethernet connectors To connect the CG 6565 board to a 10Base-T, 100Base-T, or 1000Base-T network, use two shielded twisted pair (STP) Category 5 or better Ethernet cables. The two 10/100/1000Base-T Ethernet connectors provide the CG 6565 board with Ethernet connections supporting auto-negotiation for 10, 100, and 1000 Base-T full duplex and half duplex transmissions.
Page 34
• Two NMS RJ-45 interfaces • Two RJ-45 Ethernet connectors The following illustration shows a CG 6565 board with four trunks: Trunk status LEDs for trunks 0 - 3 Trunk 0 Two NMS RJ-45 interfaces (and Trunk 2, if applicable) When used as is, there is one trunk per interface.
Page 35
CG 6565 Installation and Developer's Manual Establishing network connections T1 and E1 120 ohm splitter cables To access all four trunks configured as T1 trunks or as 120 ohm E1 trunks, use two dual T1/E1 120 ohm adapter cables (NMS P/N 32851). These cables can be ordered with the board at no extra charge.
Page 36
Establishing network connections CG 6565 Installation and Developer's Manual The following table describes each of the 75 ohm BNC adapter cables: Cable Description NMS P/N 32852 Shield is not connected to transmit and receive connectors. NMS P/N 32853 Shield is connected to transmit connector outer conductor.
CG 6565 Installation and Developer's Manual Establishing network connections Splitter cable NMS P/N 32853 7 5 o h m B N C f e m a l e ( r e c e i v e ) T r u n k 0 ( 2 )
Page 38
Eight trunk status LEDs • An NMS Mini RJ-21 interface • Two RJ-45 Ethernet connectors The following illustration shows a CG 6565 board with eight trunks: Trunk status LEDs NMS Mini RJ-21 interface Trunk status LEDs Ethernet 1 Ethernet 2...
Page 39
Establishing network connections NMS Mini RJ-21 interface pin assignments The eight-trunk version of the CG 6565 board has an NMS Mini RJ-21 interface. Use a shielded 50-pin Telco cable (NMS P/N 6000-34236) to connect the NMS Mini RJ-21 interface to either a signal entry panel (SEP) or a punchdown block. The following...
Establishing network connections CG 6565 Installation and Developer's Manual Connecting to a T1 network Before connecting a CG 6565 board to a T1 network, ensure that you have: • Specified NetworkInterface.T1E1[x].Type = T1 for the keyword value in the board keyword file.
CSU, or by connecting the CSU to a functioning CG 6565 board. The best way to loop back the signal is to unplug the cable from the CSU. The modular connection on most CSUs loops back the transmit signal to the receive signal when nothing is plugged in.
Trunks synchronize when NMS OAM boots the board. Connecting a four-trunk CG 6565 to an E1 120 ohm Use a shielded RJ-48 cable to connect a CG 6565 board configured as 120 ohm to an E1 trunk. If connecting Trunk 2 or Trunk 3, connect a dual T1/E1 120 ohm adapter cable to one or both NMS RJ-45 interfaces on the board.
Testing with four trunks The following illustration shows the loopback configuration connecting trunk 0 and trunk 1 with crossover cable NMS P/N 6000-34219 on a CG 6565 board with four trunks: Crossover cable P/N 6000-34219...
Connect a crossover cable (NMS P/N 6000-34219) for each transition board trunk interface to set up the loopback configuration. Use a shielded 50-pin Telco cable to connect the CG 6565 to the signal entry panel or punchdown block. The crossover cable connects the transmit signals from one trunk to the receive signals on another.
Establishing network connections Connecting to an Ethernet network To connect a CG 6565 board to an Ethernet network, insert a Category 5 shielded twisted pair (STP) cable into one or both of the board's Ethernet connectors. To set up IPv4 or IPv6 connections, specify appropriate keyword settings in the board keyword file.
Install the boards and software as described in the installation summary on page 27. Determine which board keyword file to use, or edit one of the sample CG 6565 board keyword files to specify appropriate configuration information for each board. For more information, refer to Using board keyword files on page 50.
Name of the board to be used to refer to the board in the software. The board name must be unique. Product Name of the board product. CG_6565 is the product name for the CG 6565 board with no trunks. CG_6565_4 is for four-trunk boards and CG_6565_8 is for eight-trunk boards. Number Board number you use in the Natural Access application to refer to the board.
CG 6565 Installation and Developer's Manual Configuring the board Running oamsys To run oamsys, enter the following command from the command line: oamsys -f filename where filename is the name of an NMS OAM system configuration file. If you invoke oamsys without command line options, NMS OAM searches for a file named oamsys.cfg in the paths specified in the AGLOAD environment variable.
Configuring the board CG 6565 Installation and Developer's Manual Using board keyword files A board keyword file contains a list of parameters to configure a board. The board keyword file for each board is assigned to the board in a system configuration file.
CG 6565 Installation and Developer's Manual Configuring the board Specifying configuration file locations Some board keywords require file names as parameters. If the file name keyword value contains a path specification, NMS OAM searches for the file in the specified directory.
This topic describes the rules and limitations that apply to setting up CT bus clocking on CG 6565 boards. When a CG 6565 board is configured as the system primary clock master: • The board's first timing reference must be set to a network trunk, a NETREF clock, or OSC.
Page 53
CG 6565 Installation and Developer's Manual Configuring the board The following tables summarize the CT bus clocking capabilities of the CG 6565 board: Clocking capabilities as primary master Capability Yes/No Comments Serve as primary master Drive A_CLOCK Drive B_CLOCK Available primary timing references:...
Page 54
Configuring the board CG 6565 Installation and Developer's Manual Clocking capabilities as secondary master Capability Yes/No Comments Serve as secondary master Drive A_CLOCK If the primary master drives B_CLOCK, the secondary master drives A_CLOCK. Drive B_CLOCK If the primary master drives A_CLOCK, the secondary master drives B_CLOCK.
Otherwise, the two methods interfere with one another, and board clocking may not operate properly. Configuring CG 6565 board clocking using keywords CG 6565 board keywords enable you to configure the board in the following ways: • System primary clock master •...
Page 56
Configuring the board CG 6565 Installation and Developer's Manual Configuring the CG 6565 as primary clock master Use the following board keywords to configure the CG 6565 as a primary clock master: Keyword Description Clocking.HBus.ClockSource Specifies the source from which this board derives its timing. Set this keyword to a network source (NETREF or NETWORK).
(B_CLOCK or A_CLOCK). Configuring the CG 6565 as a standalone board To configure a CG 6565 board in standalone mode so the board references its own clocking information, set Clocking.HBus.ClockMode to STANDALONE. The board can use either its own oscillator or a signal received from a digital trunk as a timing signal reference.
Page 58
Configuring the board CG 6565 Installation and Developer's Manual The following illustration shows an example of a multiple-board system with a primary and secondary clock master: D r i v i n g c l o c k F i r s t t i m i n g r e f e r e n c e...
• Using multiple resource pools The CG 6565 board provides a flexible resource management scheme to allow you to reserve DSP resources at board boot time to ensure deterministic behavior under load. Resources are reserved in one or more pools. Each pool contains a number of DSPs loaded with a set of identical functions, and a number of universal ports running on those DSPs.
Configuring the board CG 6565 Installation and Developer's Manual Setting up a single resource pool In many cases, a single resource pool is all that is required. With a single pool, all ports on the board have the same capability, and each port uses a physical DSP core chosen by the board.
CG 6565 Installation and Developer's Manual Configuring the board Using multiple resource pools Since resource pools are bound to sets of logical timeslots, the pools can be chosen when opening a Natural Access port with the ctaOpenServices function. It is the application's responsibility to manage logical timeslot usage.
Page 62
Configuring the board CG 6565 Installation and Developer's Manual ################################################################ # Before modifying this resource definition string refer to the CG6565 # Installation and Developers Manual. # NOTE: echo.ln20_apt25 - echo running on DSP has been removed from resource definitions.
CG 6565 board. Depending upon the desired mode of operation, you can configure each Ethernet interface on the CG 6565 board with its own IP addressing information. To do this, specify the IPv4 address, the IPv4 subnet mask, and the particular Ethernet interface.
Page 64
IPv4 subnet associated with the CG 6565 board and the IP network. The IP stack on the CG 6565 board uses standard IPv4 routing algorithms to determine how to route outbound packets.
CG 6565 Installation and Developer's Manual Configuring Ethernet interfaces Configuring IPv6 Ethernet connections This topic provides the following information about IPv6 Ethernet interfaces: • IPv6 Ethernet interface keywords • IPv6 addresses and routing • IPv6 and neighbor discovery • IP security and IPv6 •...
Configuring Ethernet interfaces CG 6565 Installation and Developer's Manual When enabled, the CG board IPv6 stack automatically configures itself with the following IPv6 addresses: Address Definition Link-local unicast FE80::EUI-64 Link local scope all nodes FF02::1 multicast address Each unicast address...
IPv4 stack. The CG 6565 IPv4 stack can detect link failures between the board Ethernet port and its directly connected link partner (typically an Ethernet switch), but not component failures that occur elsewhere on the network (for example, link failures between the Ethernet switch and either another Ethernet switch or router).
Configuring Ethernet interfaces CG 6565 Installation and Developer's Manual IPv6 standards The following table lists some of the standards from the IETF that are relevant to IPv6: Document Title RFC 2460 Internet Protocol, Version 6 (IPv6) Specification RFC 2373 IP Version 6 Addressing Architecture...
CG 6565 Installation and Developer's Manual Configuring Ethernet interfaces Setting up multi-homed configurations On CG boards, each Ethernet interface can be configured to a different IP subnet, and associated with a separate default router. This type of configuration is called a multi-homed configuration.
Page 70
Configuring Ethernet interfaces CG 6565 Installation and Developer's Manual Load balancing in dual subnet configurations In multi-homed, multi-router configurations, applications can balance the amount of data transferred through each Ethernet interface by using the Fusion MSPP service to specify which Ethernet interface an RTP or UDP endpoint uses to transmit data.
CG 6565 Installation and Developer's Manual Configuring Ethernet interfaces The following illustration shows the relationship between the RTP endpoints and the CG board's Ethernet interface: C G b o a r d R T P R T P e n d p o i n t 1...
Example The following example shows how to configure a CG 6565 board in redundant Ethernet mode. This example shows a CG 6565 board on a Class C subnet (198.62.139.x) with a single router providing access to the external IP network.
Example The following example shows how to configure a CG 6565 board in dual subnet mode. Each Ethernet interface is configured for a separate Class C subnet, and each specifies a separate router. However, the second router is configured so that only IPv4 addresses in the Class A subnet of 10.x.y.z are forwarded to the second router.
Configuring Ethernet interfaces CG 6565 Installation and Developer's Manual Monitoring Ethernet link status events The oammon utility displays Ethernet link status events. NMS OAM also provides a way for applications to monitor board level events associated with CG board Ethernet interfaces.
• Board LEDs Trunk LEDs The CG 6565 board has two-color LED indicators (yellow or red) to indicate the status of each trunk. Four-trunk version The trunk status LEDs on the end bracket of the four-trunk version of the board are...
Page 76
Verifying the installation CG 6565 Installation and Developer's Manual Eight-trunk version The location of the LEDs on the eight-trunk version of the board is shown in the following illustration: Trunk status LEDs NMS Mini RJ-21 interface Trunk status LEDs Ethernet 1...
CG 6565 Installation and Developer's Manual Verifying the installation Ethernet LEDs The CG 6565 board provides LEDs, as shown in the following illustration, to indicate the status of each Ethernet interface: Description SPEED Data rate of the Ethernet link. Data Rate...
Verifying the installation CG 6565 Installation and Developer's Manual Board LEDs The CG 6565 board provides a green, yellow, and red LED, as shown in the following illustration, to indicate the board status. Board status LEDs The board status LEDs provide the following indications:...
Step Action Create a board keyword file to boot the CG 6565 board by copying or editing one of the sample board keyword files to match your specific configuration. Refer to Using board keyword files on page 50 for more information.
DSP resource on which to run the program. For example, on a CG 6565 board configured as an E1 CAS board, the DSP resources on stream 64, timeslots 0..29 are connected to the first trunk. Timeslots 30..59 are connected to the second trunk, and so on.
CG 6565 switch models The CG 6565 supports the following three switch models: • Channel associated signaling (CAS) • Primary Rate Interface (PRI) • To define a switch model for CG 6565 boards configured for T1/E1, use the NetworkInterface.T1E1[x].SignalingType keyword. NMS Communications...
Default connections CAS switching limitations CG 6565 boards terminate CAS signaling on local T1 and E1 trunks. In CAS mode, CG 6565 boards support signaling streams on the DSPs and the framers. These streams are provided for backward compatibility with applications that switch signaling streams.
CG 6565 Installation and Developer's Manual CG 6565 switching CAS mode switch model The following illustration shows the CG 6565 switching model in CAS mode: C T _ D 0 . . 3 1 H.100 bu s H . 1 0 0 b u s...
CG 6565 switching CG 6565 Installation and Developer's Manual H.100 and local streams The following tables list the specific use of each stream in the CG 6565 CAS switching model: H.100 streams H.100 bus Streams 0..31, timeslots 0..127 (Streams clocked at 8 MHz)
The signaling information for a given channel is placed in the same timeslot number as the voice information for that channel. Note: The CG 6565 board does not allow signaling streams to be connected to the CT bus.
The signaling information for a given channel is placed in the same timeslot number as the voice information for that channel. Note: The CG 6565 board does not allow signaling streams to be connected to the CT bus.
STANDALONE), the DSPs and trunks are connected as shown in the following table. Note: The SwitchConnections keyword can override this setting. The exact settings for CG 6565 boards configured as T1 or E1 depend upon the setting of the NetworkInterface.T1E1[x].SignalingType keyword.
Page 88
CG 6565 switching CG 6565 Installation and Developer's Manual Voice information and DSP resources Trunk Full duplex connection between the trunk voice information and the DSP type resources... Trunk 1: 0:0..23 => 65:0..23 64:0..23 => 1:0..23 Trunk 2: 4:0..23 => 65:24..47 64:24..47 =>...
CG 6565 Installation and Developer's Manual CG 6565 switching PRI mode switching This topic contains the following PRI mode switching information: • PRI mode switch model • H.100 and local streams • Voice information routing on T1 trunks • Voice information routing on E1 trunks •...
CG 6565 switching CG 6565 Installation and Developer's Manual PRI mode switch model The following illustration shows the CG 6565 switching model in PRI mode: C T _ D 0 . . 3 1 H . 1 0 0 b u s H .
CG 6565 Installation and Developer's Manual CG 6565 switching H.100 and local streams The following tables list the specific use of each stream in the CG 6565 PRI switch model: H.100 streams H.100 bus Streams 0..31, timeslots 0..127 (Streams clocked at 8 MHz)
CG 6565 switching CG 6565 Installation and Developer's Manual Voice information routing on T1 trunks (PRI mode) If NetworkInterface.T1E1[x].SignalingType = PRI, signaling information is routed to accommodate the T1 ISDN common channel signaling configuration, where voice information is transmitted in the first 23 channels. Each voice channel on the T1...
In PRI mode, the trunk signaling streams are not used. In this case, each trunk signaling stream has zero timeslots. On CG 6565 boards, framer signaling is hard wired to internal HDLCs when the board runs in PRI mode. Refer to the PRI mode switch model on page 90. HDLC signaling is automatically terminated by an internal HDLC.
STANDALONE), the DSPs and trunks are connected as shown in the following table. Note: The SwitchConnections keyword can override this setting. The exact settings for CG 6565 boards configured as T1 or E1 depend upon the NetworkInterface.T1E1[x].SignalingType keyword setting. The following table shows the default routing for CG 6565 boards in PRI mode: Trunk type Full duplex connection between trunk voice information and the DSP resources...
CG 6565 Installation and Developer's Manual CG 6565 switching RAW mode switch model The following illustration shows the CG 6565 switching model in RAW mode: C T _ D 0 . . 3 1 H . 1 0 0 b u s H .
CG 6565 switching CG 6565 Installation and Developer's Manual H.100 and local streams The following tables list the specific use of each stream in the CG 6565 RAW switching model: H.100 streams H.100 bus Streams 0..31, timeslots 0..127 (Streams clocked at 8 MHz)
CG 6565 Installation and Developer's Manual CG 6565 switching Voice information routing on T1 trunks (RAW mode) If NetworkInterface.T1E1[x].SignalingType is set to RAW, information is routed to accommodate a configuration where no signaling is present on the T1 trunk. Voice information is transmitted in all 24 channels.
If a board is configured for standalone operation (that is, Clocking.HBus.ClockMode = STANDALONE), the DSPs and trunks are connected as shown in the following table. Note: The SwitchConnections keyword can override this setting. The exact settings for CG 6565 boards configured as E1 depend upon the NetworkInterface.T1E1[x].SignalingType keyword setting. NMS Communications...
Page 99
CG 6565 Installation and Developer's Manual CG 6565 switching The following table shows the default routing for CG 6565 boards in RAW mode: Trunk type Full duplex connection between trunk voice information and DSP resources... Trunk 1: 0:0..23 => 65:0..23 64:0..23 =>...
Since the echo chip is wired in series between the switch and trunking framers, individual echo cancellation channels are identified by specifying the MVIP address of the associated trunk port. Refer to the CG 6565 switch models on page 81 for your board, to identify the MVIP address.
Identifies the target trunk on the local bus. Specify the number of either the transmit or receive voice stream. Refer to CG 6565 switch models on page 81 for more information. localtimeslot Identifies the target timeslot on the trunk. Specify the timeslot number of the target trunk port on the local bus.
CG 6565 Installation and Developer's Manual Echo cancellation control Setting the bypass state example The following example shows how to set the echo canceler bypass state. #include "swidef.h" Switching service #include "mvip95.h" MVIP-95 definitions #include "nmshw.h" NMS hardware-specific definitions DWORD mySetBypass(SWIHD swihd, SWI_TERMINUS terminus, int bBypassEnabled) SWI_LOCALTIMESLOT_ARGS args;...
Identifies the target trunk on the local bus. Specify the number of either the transmit or receive voice stream. Refer to CG 6565 switch models on page 81 for more information. localtimeslot Identifies the target timeslot on the trunk. Specify the timeslot number of the target trunk port on the local bus.
CG 6565 Installation and Developer's Manual Echo cancellation control Setting the NLP state example The following example shows how to enable or disable NLP: #include "swidef.h" Switching service #include "mvip95.h" MVIP-95 definitions #include "nmshw.h" NMS hardware-specific definitions DWORD mySetNLP(SWIHD swihd, SWI_TERMINUS terminus, int bNLPEnabled) SWI_LOCALTIMESLOT_ARGS args;...
Identifies the target trunk on the local bus. Specify the number of either the transmit or receive voice stream. Refer to CG 6565 switch models on page 81 for more information. localtimeslot Identifies the target timeslot on the trunk. Specify the timeslot number of the target trunk port on the local bus.
CG 6565 Installation and Developer's Manual Echo cancellation control Setting the acoustic echo control state example The following example shows how to enable or disable AEC: #include "swidef.h" Switching service #include "mvip95.h" MVIP-95 definitions #include "nmshw.h" NMS hardware-specific definitions DWORD mySetAEC(SWIHD swihd, SWI_TERMINUS terminus, int bAECEnabled) SWI_LOCALTIMESLOT_ARGS args;...
Keyword summary Keyword types The keywords for a CG 6565 board describe that board's configuration. Some keywords are read/write; others are read-only: Keyword type Description Read/write Determines how the board is configured when it starts up. Changes to these (editable) keywords become effective after the board is rebooted.
If you want to... Use these keywords... Specify information about the board AutoStart AutoStop EnableMonitor MaxChannels Name Number Specify CG 6565 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...
Page 111
CG 6565 Installation and Developer's Manual Keyword summary If you want to... Use these keywords... Set IPv6 addressing for the board IPv6.Link[x].Enable IPv6.Link[x].EnablePing IPv6.Link[x].HopLimit IPv6.Link[x].ICMPRateLimit IPv6.Link[x].IPSec IPv6.Link[x].MTU IPv6.Link[x].NDAttempts IPv6.Link[x].NDReachabilityTimer IPv6.Link[x].NDRetranTimer Set up clocking information Clocking.HBus.ClockMode Clocking.HBus.ClockSource Clocking.HBus.ClockSourceNetwork Configure clock fallback Clocking.HBus.AutoFallBack...
Keyword summary CG 6565 Installation and Developer's Manual If you want to... Use these keywords... Implement ThroughPacket packet TPKT.ComplexForward.Count multiplexing TPKT.ComplexForward[x].DestinationPacketSize TPKT.ComplexForward[x].LifeTimeTicks TPKT.ComplexRxPort TPKT.ComplexTxPort TPKT.Enable TPKT.NumberOfComplexForwardConditions TPKT.SimpleRxPort TPKT.SimpleTxPort Modify the hardware echo cancellation HardwareEcho.EchoChipEnabled settings HardwareEcho.Trunk[x].OnOffTimeslots HardwareEcho.XLaw Informational keywords This topic describes read-only keywords for retrieving information. Do not edit the keywords listed in this topic.
CG 6565 Installation and Developer's Manual Keyword summary Retrieving EEPROM information The data type for all EEPROM keywords is Integer. Keyword Description Eeprom.AssemblyRevision Hardware assembly level. Eeprom.ATETestBit Indicates whether the ATE test was successful. A non-zero value indicates success. Eeprom.DSPExtClk Oscillator used to trigger the DSP.
Keyword summary CG 6565 Installation and Developer's Manual Plug-in keywords CG plug-in keywords provide specific board family information for CG boards. All CG 6565 plug-in keywords (as opposed to board keywords) except BootDiagnosticLevel are read-only. The following table lists CG plug-in keywords:...
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 Details A detailed description of the keyword's function See also A list of related keywords NMS Communications...
Keyword reference CG 6565 Installation and Developer's Manual AutoStart Specifies whether the board automatically starts when ctdaemon is started. Syntax AutoStart = start Access Read/Write Type String Default Allowed values YES | NO Example AutoStart = YES Details The Supervisor-level keyword AutoStartEnabled enables or disables the autostart feature.
CG 6565 Installation and Developer's Manual Keyword reference AutoStop Specifies whether the board automatically stops when ctdaemon is stopped. Syntax AutoStop = stop Access Read/Write Type String Default Allowed values YES | NO Example AutoStop = YES Details The Supervisor-level keyword AutoStopEnabled enables or disables the autostop feature.
Keyword reference CG 6565 Installation and Developer's Manual Boards[x] Indicates the name of the board object. Syntax Boards[x] = name Access Read-only (CG plug-in level) Type String Default Not applicable. Allowed values Not applicable. See also Name, Number NMS Communications...
CG 6565 Installation and Developer's Manual Keyword reference BootDiagnosticLevel Specifies the level of diagnostics during initialization of the board. Syntax BootDiagnosticLevel = level Access Read/Write (CG plug-in level) Type Integer Default Allowed values 0 | 1 Example BootDiagnosticLevel = 1...
Access Read/Write Type Integer Default 16400 Allowed values 0 - 1000000 Example Buffers[0].Size = 16400 Details The CG 6565 has been optimized for the following values: Buffers[0].Size = 16400 Buffers[1].Size = 1000 See also DynamicRecordBuffers NMS Communications...
Enables clock fallback on the board. For more information about setting up CT bus clocking and about the rules and restrictions that apply to setting up clocking with CG 6565 boards, refer to Configuring board clocking on page 51. Syntax Clocking.HBus.AutoFallBack = mode...
Page 122
Keyword reference CG 6565 Installation and Developer's Manual In addition: • If the primary clock master's first timing reference fails and then returns, the primary master's timing reference (and consequently the timing reference for any clock slaves) tries to switch back to the first source.
Specifies the board's control of the H.110 clock. For more information about setting up CT bus clocking and about the rules and restrictions that apply to setting up clocking with CG 6565 boards, refer to Configuring board clocking on page 51.
Specifies the timing reference for the board to use based on the Clocking.HBus.ClockMode setting. For more information about setting up CT bus clocking and about the rules and restrictions that apply to setting up clocking with CG 6565 boards, refer to Configuring board clocking on page 51. Syntax Clocking.HBus.ClockSource = clock_source...
Specifies the trunk to use as an external network timing reference for the board's internal clock. For more information about setting up CT bus clocking and about the rules and restrictions that apply to setting up clocking with CG 6565 boards, refer to Configuring board clocking on page 51. Syntax Clocking.HBus.ClockSourceNetwork = trunk_number...
Specifies the alternate timing reference to use when the first timing reference does not function properly. For more information about setting up CT bus clocking and about the rules and restrictions that apply to setting up clocking with CG 6565 boards, refer to Configuring board clocking on page 51. Syntax Clocking.HBus.FallBackClockSource = clock_source...
Page 127
CG 6565 Installation and Developer's Manual Keyword reference When this keyword is set to NETWORK, you must also specify the fallback network timing reference source with the Clocking.HBus.FallBackNetwork keyword. If the Clocking.HBus.AutoFallBack keyword is set to NO, this keyword is ignored.
Specifies the trunk to use as an external network timing reference if the clock source defined with Clocking.HBus.ClockSource fails. For more information about setting up CT bus clocking and about the rules and restrictions that apply to setting up clocking with CG 6565 boards, refer to Configuring board clocking on page 51. Syntax Clocking.HBus.FallBackNetwork = trunk_number...
Specifies a source to drive the NETREF timing signal on the CT bus. For more information about setting up CT bus clocking and about the rules and restrictions that apply to setting up clocking with CG 6565 boards, refer to Configuring board clocking on page 51.
Specifies the trunk used to drive the NETREF timing signal on the CT bus. For more information about setting up CT bus clocking and about the rules and restrictions that apply to setting up clocking with CG 6565 boards, refer to Configuring board clocking on page 51.
Specifies the speed of the NETREF timing signal on the CT bus. For more information about setting up CT bus clocking and about the rules and restrictions that apply to setting up clocking with CG 6565 boards, refer to Configuring board clocking on page 51.
Specifies the speed (in MHz) of the driven Sclock when a board acts as primary master. For more information about setting up CT bus clocking and about the rules and restrictions that apply to setting up clocking with CG 6565 boards, refer to Configuring board clocking on page 51. Syntax Clocking.HBus.SClockSpeed = speed...
Specifies the CT bus segment to which the board is connected. In most cases, the chassis contains only one segment. For more information about setting up CT bus clocking and about the rules and restrictions that apply to setting up clocking with CG 6565 boards, refer to Configuring board clocking on page 51. Syntax Clocking.HBus.Segment = number...
Keyword reference CG 6565 Installation and Developer's Manual ConferencingStream.Enable Determines if the conferencing stream is available for switching. Set this keyword to YES when using NaturalConference. Syntax ConferencingStream.Enable = setting Access Read/Write Type String Default Allowed values NO | YES Example ConferencingStream.Enable = NO...
CG 6565 Installation and Developer's Manual Keyword reference ConferencingStream.SlotCount Specifies the number of logical timeslots allocated to logical conferencing streams 68 and 69. Syntax ConferencingStream.SlotCount = slotcount_number Access Read/Write Type Integer Default Example ConferencingStream.SlotCount = 128 Allowed values 1 - 900 Details The number of reserved timeslots varies by user configuration.
Allowed values A value shown in the following table. Example DebugMask = 0x00000200 Details To view the results of CG 6565 tracing, you must be running oammon. You can specify the following DebugMask parameters: Value Description 0x00000001 Additional initialization messages.
CG 6565 Installation and Developer's Manual Keyword reference DetectedBoards[x] Indicates the user-defined name of the detected board. Syntax DetectedBoards[x] = boardid x = index of the board name Access Read-only (CG plug-in level) Type String Allowed values Not applicable. NMS Communications...
For the CG 6565 board, the core file and the run module are merged to create a file named cg6565core.ulm. In the CG 6565 configuration file, only set DLMFiles[x] when using...
CG 6565 Installation and Developer's Manual Keyword reference DSP.C5x[x].Image Specifies a pre-linked DSP image file for CG 6565 boards. Syntax DSP.C5x[x].Image = filename x = 0-(n-1) (A range of DSP cores where n equals the total number of DSP cores available.)
Keyword reference CG 6565 Installation and Developer's Manual DSP.C5x[x].Libs[y] Specifies the DSP library file name. Syntax DSP.C5x[x].Lib[y] = filename x = 0-(n-1) (A range of DSP cores where n equals the total number of DSP cores available.) y = 0..15 (An index of a DSP library.)
DSPs on a stream, the board does not boot and returns a resource error. For information about CG board switching, refer to CG 6565 switch models on page 81. Each stream has a maximum of 128 transmitting and 128 receiving available timeslots.
DSPs on a stream, the board does not boot and returns a resource error. For information about CG board switching, refer to CG 6565 switch models on page 81. Each stream has a maximum of 128 transmitting and 128 receiving available timeslots.
CG 6565 Installation and Developer's Manual Keyword reference DSP.C5x[x].OS Specifies the digital signal processor (DSP) operating system to use on the DSP core of the current board(s). Syntax DSP.C5x[x].OS = filename x = 0-(n-1) (A range of DSP cores where n equals the total number of DSP cores available.)
Keyword reference CG 6565 Installation and Developer's Manual DSP.C5x[x].XLaw Determines the DSP hardware companding mode. Syntax DSP.C5x[x].XLaw = mode x = 0-(n-1) (A range of DSP cores where n equals the total number of DSP cores available.) Access Read/Write Type...
0x00 - 0xFF Example DSPStream.SignalIdleCode[0..7] = 0x00 Details The CG 6565 board signaling DSP uses this value to generate the idle pattern on the outbound signaling trunk. All trunks must be configured with the same DSPStream.SignalIdleCode setting. See also DSPStream.SlotCount, DSPStream.VoiceIdleCode[x]...
Keyword reference CG 6565 Installation and Developer's Manual DSPStream.SlotCount Specifies the number of logical timeslots on logical streams. Refer to CG 6565 switch models on page 81 for more information. Syntax DSPStream.SlotCount = slotcount_number Access Read/Write Type Integer Default Example DSPStream.SlotCount = 128...
CG 6565 Installation and Developer's Manual Keyword reference DSPStream.VoiceIdleCode[x] Sets the voice idle code for timeslots on the specified DSP voice streams. Syntax DSPStream.VoiceIdleCode[x] = voice_idlecode x = 0-(n-1) (0-based trunk number or range of trunk numbers where n equals the number of trunks on the board.)
Keyword reference CG 6565 Installation and Developer's Manual DynamicRecordBuffers Specifies the maximum number of overflow buffers that the board automatically allocates for recording, when recording is initiated in asynchronous board-to-host data transfer mode (using the adiRecordAsync function). Syntax DynamicRecordBuffers = buffercount...
Page 149
CG 6565 Installation and Developer's Manual Keyword reference For example, suppose you set the buffer size to 200 ms (Buffers[1].Size = 1600 for mu-law encoding), and DynamicRecordBuffers = 6. These settings mean that once the first buffer is filled and sent to the host, the host can delay up to 1.4 seconds...
Keyword reference CG 6565 Installation and Developer's Manual Echo.AutoSwitchingRefSource Determines if the on-board switching manager performs automatic switching of the echo canceler reference stream. Syntax Echo.AutoSwitchingRefSource = setting Access Read/Write Type String Default Allowed values NO | YES Example Echo.AutoSwitchingRefSource = NO Details Echo.EnableExternalPins must be set to YES to use the Echo.AutoSwitchingRefSource...
CG 6565 Installation and Developer's Manual Keyword reference Echo.EnableExternalPins Determines if the echo canceler reference and output can be switched. Syntax Echo.EnableExternalPins = setting Access Read/Write Type String Default Allowed values NO | YES Example Echo.EnableExternalPins = NO Details Setting this keyword to YES enables the echo canceler reference input and the echo canceler output to be switched.
Keyword reference CG 6565 Installation and Developer's Manual EnableMonitor Determines whether error messages are displayed. Syntax EnableMonitor = message_number Access Read/Write Type Integer Default Allowed values 0 | 1 Example EnableMonitor = 1 Details The following entries are valid: Value Description No error messages are displayed.
CG 6565 Installation and Developer's Manual Keyword reference HardwareEcho.EchoChipEnabled Enables or disables the echo cancellation hardware. Syntax HardwareEcho.EchoChipEnabled = setting Access Read/Write Type String Default Allowed values NO | YES Example HardwareEcho.EchoChipEnabled = YES Details HardwareEcho.EchoChipEnabled must be set to YES to use the echo cancellation hardware.
Keyword reference CG 6565 Installation and Developer's Manual HardwareEcho.Trunk[x].OnOffTimeslots Enables or disables hardware echo cancellation by trunk timeslot. Syntax HardwareEcho.Trunk[x].OnOffTimeslots = bit_mask x = Trunk number starting at 0 Access Read/Write Type Unsigned integer (bit mask) Default 0xFFFFFFFF (enabled for all timeslots)
CG 6565 Installation and Developer's Manual Keyword reference HardwareEcho.XLaw Determines the echo hardware companding mode. Syntax HardwareEcho.XLaw = mode Access Read/Write Type String Default A_LAW Allowed values A_LAW | MU_LAW Example HardwareEcho.XLaw = MU_LAW Details The hardware companding mode must match the DSP operating system (DSPOS) service library used.
Keyword reference CG 6565 Installation and Developer's Manual Hdlc[x].Boot Enables or disables the HDLC channel associated with a particular trunk. Syntax Hdlc[x].Boot = boot x = 0-(n-1) (0-based trunk number or range of trunk numbers where n equals the number of trunks on the board.)
CG 6565 Installation and Developer's Manual Keyword reference Hdlc[x].RxTimeSlot Specifies the TDM timeslot of the receiving HDLC channel for a specific trunk. Syntax Hdlc[x].RxTimeSlot = timeslot x = 0-(n-1) (0-based trunk number or range of trunk numbers where n equals the number of trunks on the board.)
Keyword reference CG 6565 Installation and Developer's Manual Hdlc[x].TxTimeSlot Specifies the TDM timeslot of the transmitting HDLC channel for a specific trunk. Syntax Hdlc[x].TxTimeSlot = timeslot x = 0-(n-1) (0-based trunk number or range of trunk numbers where n equals the number of trunks on the board.)
CG 6565 Installation and Developer's Manual Keyword reference IPC.AddRoute[x].DestinationAddress Specifies the IPv4 address of the Ethernet interface. Syntax IPC.AddRoute[x].DestinationAddress = IP_address x = index of the route entry Access Read/Write Type IP address Default 255.255.255.255 Allowed values Valid IP address.
Keyword reference CG 6565 Installation and Developer's Manual IPC.AddRoute[x].GatewayAddress Specifies the IPv4 address of the router. Syntax IPC.AddRoute[x].GatewayAddress = IP_address x = index of the route entry Access Read/Write Type IP address Default 255.255.255.255 Allowed values Valid IP address. Example IPC.AddRoute[1].GatewayAddress = 198.62.139.1...
CG 6565 Installation and Developer's Manual Keyword reference IPC.AddRoute[x].Interface Specifies the Ethernet interface (1 or 2) associated with IPv4 connections. Syntax IPC.AddRoute[x].Interface = Ethernet_number x = index of the route entry Access Read/Write Type Integer Default Allowed values 1 | 2 Example IPC.AddRoute[1].Interface = 1...
Keyword reference CG 6565 Installation and Developer's Manual IPC.AddRoute[x].Mask Specifies a subnet mask for the IPv4 address specified in IPC.AddRoute[x].DestinationAddress. For more information, refer to Configuring IPv4 Ethernet connections on page 63. Syntax IPC.AddRoute[x].Mask = subnet_mask x = index of the route entry...
CG 6565 Installation and Developer's Manual Keyword reference IPv6.Link[x].Enable Enables or disables IPv6 on the specified Ethernet interface. For more information, refer to Configuring IPv6 Ethernet connections on page 65. Syntax IPv6.Link[x].Enable = mode x = index of the link entry...
Keyword reference CG 6565 Installation and Developer's Manual IPv6.Link[x].EnablePing Enables or disables IPv6 PING on the specified Ethernet interface. Syntax IPv6.Link[x].EnablePing = mode x = index of the link entry Access Read/Write Type String Default Allowed values YES | NO Example IPv6.Link[1].EnablePing = YES...
CG 6565 Installation and Developer's Manual Keyword reference IPv6.Link[x].HopLimit Specifies the default IPv6 hop limit value for the specified Ethernet interface. Syntax IPv6.Link[x].HopLimit = hoplimit x = index of the link entry Access Read/Write Type Integer Default Allowed values 1 - 255 Example IPv6.Link[1].HopLimit = 255...
Keyword reference CG 6565 Installation and Developer's Manual IPv6.Link[x].ICMPRateLimit Specifies the IPv6 ICMP rate limit for the specified Ethernet interface. Syntax IPv6.Link[x].ICMPRateLimit = icmplimit x = index of the link entry Access Read/Write Type String Default Allowed values 0 - 9999 Example IPv6.Link[1].ICMPRateLimit = 5250...
CG 6565 Installation and Developer's Manual Keyword reference IPv6.Link[x].IPSec Enables or disables IPSec for IPv6 on the specified Ethernet interface. Syntax IPv6.Link[x].IPSec = mode x = index of the link entry Access Read/Write Type String Default Allowed values YES | NO Example IPv6.Link[1].IPSec = YES...
Keyword reference CG 6565 Installation and Developer's Manual IPv6.Link[x].MTU Sets the IPv6 maximum transmission unit (MTU) for the specified Ethernet interface. Syntax IPv6.Link[x].MTU = mtuvalue x = index of the link entry Access Read/Write Type Integer Default 1500 Allowed values...
CG 6565 Installation and Developer's Manual Keyword reference IPv6.Link[x].NDAttempts Specifies the neighbor discovery attempt (NDA) limit for the specified Ethernet interface. Syntax IPv6.Link[x].NDAttempts = ndalimit x = index of the link entry Access Read/Write Type Integer Default Allowed values 0 - 99 Example IPv6.Link[1].NDAttempts = 55...
Keyword reference CG 6565 Installation and Developer's Manual IPv6.Link[x].NDReachabilityTimer Specifies the neighbor discovery reachability timer (in milliseconds) for the specified Ethernet interface. Syntax IPv6.Link[x].NDReachabilityTimer = ndreach x = index of the link entry Access Read/Write Type Integer Default 30000 Allowed values...
CG 6565 Installation and Developer's Manual Keyword reference IPv6.Link[x].NDRetranTimer Specifies the neighbor discovery retransmission timer (in milliseconds) for the specified Ethernet interface. Syntax IPv6.Link[x].NDRetranTimer = ndretran x = index of the link entry Access Read/Write Type Integer Default 1000 Allowed values...
Keyword reference CG 6565 Installation and Developer's Manual Location.PCI.Bus Specifies the PCI logical bus location of the board. Syntax Location.PCI.Bus = busnum Access Read/Write Type Integer Default Example Location.PCI.Bus = 2 Allowed values 0 - 256 Details A PCI bus and slot number identifies every slot in the system. Identify a board by specifying its logical bus and slot number.
CG 6565 Installation and Developer's Manual Keyword reference Location.PCI.Slot Defines the logical slot location of the board on the PCI bus. Syntax Location.PCI.Slot = slotnum Access Read/Write Type Integer Default Example Location.PCI.Slot = 5 Allowed values 0 - 9999 Details A PCI bus and slot number identifies every slot in the system.
Keyword reference CG 6565 Installation and Developer's Manual MaxChannels Specifies the maximum number of channels to allocate on the board. A channel is needed for each instance of the ADI service that is opened by an application. Syntax MaxChannels = num_channels...
CG 6565 Installation and Developer's Manual Keyword reference Name Specifies the name assigned to the CG 6565 board. Syntax Name = board_name Access Read/Write Type String Default CG_6565 Allowed values String up to 64 characters long. Example Name = Brd1...
NetworkInterface.Ethernet[x].MAC_Address Specifies the MAC address. Syntax NetworkInterface.Ethernet[x].MAC_Address = MAC_address x varies depending on the number of Ethernet interfaces on the board. The CG 6565 board has two Ethernet interfaces. The first one is the primary Ethernet interface. Access Read-only Type...
CG 6565 Installation and Developer's Manual Keyword reference NetworkInterface.T1E1[x].AlarmMode For T1 interfaces, specifies if alarm conditions are declared immediately or after a specific period of time when an alarm event (for example, out of frame) occurs. This keyword is not applicable for E1 interfaces.
Keyword reference CG 6565 Installation and Developer's Manual NetworkInterface.T1E1[x].CRCMFMode Specifies whether or not the board performs CRC signal checking. Syntax NetworkInterface.T1E1[x].CRCMFMode = mode x = 0-(n-1) (0-based trunk number or range of trunk numbers where n equals the number of trunks on the board.)
CG 6565 Installation and Developer's Manual Keyword reference NetworkInterface.T1E1[x].D_Channel Specifies whether the trunk has a primary D channel with ISDN running on it. Syntax NetworkInterface.T1E1[x].D_Channel = setting x = 0-(n-1) (0-based trunk number or range of trunk numbers where n equals the number of trunks on the board.)
Keyword reference CG 6565 Installation and Developer's Manual NetworkInterface.T1E1[x].FrameType Defines the T1 or E1 trunk framing format for current boards or current trunks. Syntax NetworkInterface.T1E1[x].FrameType = frame_format x = 0-(n-1) (0-based trunk number or range of trunk numbers where n equals the number of trunks on the board.)
For DSX1 cables (up to 655 feet - short haul). G703_120_OHM (E1 only) For G.703-standard 120 ohm cables. If you are connecting a CG 6565 board to a 75 ohm E1 trunk, run the board at 120 ohm. NMS Communications...
Page 182
Keyword reference CG 6565 Installation and Developer's Manual Note: To connect an eight trunk CG 6565 board variant to a 75 ohm E1 trunk, use a shielded 50-pin Telco cable (NMS P/N 6000-34236). Connect the Telco table to either a signal entry panel (SEP) or a punchdown block, and then connect the SEP or punchdown block to a 20-port balun (NMS P/N 5600-33050) or equivalent.
CG 6565 Installation and Developer's Manual Keyword reference NetworkInterface.T1E1[x].ISDN.D_Channel_Backup_Trunk Specifies the 0-based trunk to carry the backup D channel for this NFAS group. Syntax NetworkInterface.T1E1[x].ISDN.D_Channel_Backup_Trunk = trunk x = 0-(n-1) (0-based trunk number or range of trunk numbers where n equals the number of trunks on the board.)
Keyword reference CG 6565 Installation and Developer's Manual NetworkInterface.T1E1[x].ISDN.NFAS_Member[y].Board Specifies the board number (as defined in oamsys.cfg) on which this NFAS member resides. Syntax NetworkInterface.T1E1[x].ISDN.NFAS_Member[y].Board = setting x = 0-(n-1) (0-based trunk number or range of trunk numbers where n equals the number of trunks on the board.)
CG 6565 Installation and Developer's Manual Keyword reference NetworkInterface.T1E1[x].ISDN.NFAS_Member[y].NAI Identifies the Network Access Identifier (NAI) for this NFAS member. Syntax NetworkInterface.T1E1[x].ISDN.NFAS_Member[y].NAI = nai x = 0-(n-1) (0-based trunk number or range of trunk numbers where n equals the number of trunks on the board.)
Keyword reference CG 6565 Installation and Developer's Manual NetworkInterface.T1E1[x].ISDN.NFAS_Member[y].Trunk Specifies the zero-based trunk number of a member trunk of an NFAS group. Syntax NetworkInterface.T1E1[x].ISDN.NFAS_Member[y].Trunk = trunk x = 0-(n-1) (0-based trunk number or range of trunk numbers where n equals the number of trunks on the board.)
CG 6565 Installation and Developer's Manual Keyword reference NetworkInterface.T1E1[x].ISDN.NFASGroup Specifies the NFAS group number. Syntax NetworkIInterface.T1E1[x].ISDN.NFASGroup = groupnum x = 0-(n-1) (0-based trunk number or range of trunk numbers where n equals the number of trunks on the board.) Access...
Keyword reference CG 6565 Installation and Developer's Manual NetworkInterface.T1E1[x].Length Specifies the length (in feet) of the cable connecting the board to the network so that the framer can adjust the pulse shape accordingly. Only applicable in T1 mode. Syntax NetworkInterface.T1E1[x].Length = length x = 0-(n-1) (0-based trunk number or range of trunk numbers where n equals the number of trunks on the board.)
CG 6565 Installation and Developer's Manual Keyword reference NetworkInterface.T1E1[x].LineCode Specifies the ones density maintenance method used on the trunk line to maintain a clear channel transmission. Syntax NetworkInterface.T1E1[x].LineCode = code x = 0-(n-1) (0-based trunk number or range of trunk numbers where n equals the number of trunks on the board.)
Page 190
Keyword reference CG 6565 Installation and Developer's Manual The valid E1 trunk formats are: Format Definition Alternate mark inversion - standard line coding with no zero code suppression. HDB3 High density bipolar 3 code that uses patterns of bipolar violations to replace sequences of 4 zero data bits to maintain ones density on clear channel transmission.
CG 6565 Installation and Developer's Manual Keyword reference NetworkInterface.T1E1[x].SignalingType Determines how voice and signaling information is routed to and from the T1 or E1 trunk and DSP resources. Syntax NetworkInterface.T1E1[x].SignalingType = type x = 0-(n-1) (0-based trunk number or range of trunk numbers where n equals the number of trunks on the board.)
Keyword reference CG 6565 Installation and Developer's Manual NetworkInterface.T1E1[x].Type Specifies the trunk type for each trunk on the board. This setting must be the same for all active trunks. Syntax NetworkInterface.T1E1[x].Type = trunk_type x = 0-(n-1) (0-based trunk number or range of trunk numbers where n equals the number of trunks on the board.)
CG 6565 Installation and Developer's Manual Keyword reference Number Specifies a logical board number for this board. Syntax Number = board_number Access Read/Write Type Integer Default Allowed values Non-zero integer. Example Number = 1 Details This setting is assigned by the NMS OAM Supervisor if the user does not specify a number in the system configuration file.
Keyword reference CG 6565 Installation and Developer's Manual Products[x] At the plug-in level, indicates the product supported by the plug-in. Syntax Products[x] = product_type Access Read-only (CG plug-in level) Type String Allowed values Not applicable. See also Name NMS Communications...
CG 6565 Installation and Developer's Manual Keyword reference Resource[x].Definitions Provides a relational string of data processing functions (DPFs) that describes the functionality that can occur on a single port and how the DSP functions execute in relation to each other.
Page 196
Keyword reference CG 6565 Installation and Developer's Manual It is not necessary for you to specify the DPFs for the trunk control programs (TCPs) with the Resource[x].Definitions keyword. To use a TCP, specify the name of the TCP(s) to use with the Resource[x].TCPs keyword. The on-board resource manager uses the OR operation to compare the TCPs with the DPFs specified in the Resource[x].Definitions string.
CG 6565 Installation and Developer's Manual Keyword reference Resource[x].DSPs Specifies the DSPs associated with a resource pool (identified by x). Syntax Resource[x].DSPs = dspIDnumber x = 0..9 (index of the associated resource pool) Access Read/Write Type Integer Default None. Allowed values A list of DSP numbers.
Keyword reference CG 6565 Installation and Developer's Manual Resource[x].Name Specifies a name to associate with a resource pool (identified by x). For more information, refer to Managing board DSP resources on page 59. Syntax Resource[x].Name = label x = 0..9 (index of the associated resource pool)
CG 6565 Installation and Developer's Manual Keyword reference Resource[x].Size Specifies the number of channels or ports for the pool reserved by the on-board DSP resource manager. Syntax Resource[x].Size = number x = 0..9 (index of the associated resource pool) Access...
Keyword reference CG 6565 Installation and Developer's Manual Resource[x].StartTimeSlot Specifies the starting timeslot for a pool. Syntax Resource[x].StartTimeSlot = y x = 0..9 (index of the associated resource pool) y = the first timeslot of a range to associate with this pool...
CG 6565 Installation and Developer's Manual Keyword reference Resource[x].TCPs Specifies the names of the TCPs used on the board to set up and tear down calls. For a list of available TCPs, refer to the NMS CAS for Natural Call Control Developer's Manual.
Keyword reference CG 6565 Installation and Developer's Manual SwitchConnections Specifies whether the board nails up default switch connections when initialized. Syntax SwitchConnections = mode Access Read/Write Type String Default AUTO Allowed values YES | NO | AUTO Example SwitchConnections = No...
CG 6565 Installation and Developer's Manual Keyword reference SwitchConnectMode Specifies how switch connections are made on the board. Syntax SwitchConnectMode = setting Access Read/Write Type String Default ByChannel Allowed values AllConstantDelay | AllDirect | ByChannel Example SwitchConnectMode = AllDirect Details...
Keyword reference CG 6565 Installation and Developer's Manual TPKT.ComplexForward.Count Specifies the number of condition sets for the system when sending ThroughPacket packets. Syntax TPKT.ComplexForward.Count = numconditions Access Read/Write Type Integer Default None. Allowed values Example TPKT.ComplexForward.Count = 8 Details These condition sets are defined by TPKT.ComplexForward[x].LifeTimeTicks, TPKT.ComplexForward[x].DestinationPacketSize keyword pairs.
Page 205
CG 6565 Installation and Developer's Manual Keyword reference For information about the Clarent ThroughPacket multiplexing algorithm and its implementation in Fusion software, refer to the Fusion Developer's Manual. See also TPKT.ComplexRxPort, TPKT.ComplexTxPort, TPKT.NumberOfComplexForwardConditions NMS Communications...
Keyword reference CG 6565 Installation and Developer's Manual TPKT.ComplexForward[x].DestinationPacketSize Specifies the amount of packet data (in bytes) that must accumulate before a ThroughPacket packet can be sent out. Syntax TPKT.ComplexForward[x].DestinationPacketSize = packetsize x = index of a particular ThroughPacket transmission condition...
Page 207
CG 6565 Installation and Developer's Manual Keyword reference In the previous example, the system sends out ThroughPacket packets only when the following conditions are met: Within this period of time... At least this much data must accumulate... 0 ms 1440 bytes...
Keyword reference CG 6565 Installation and Developer's Manual TPKT.ComplexForward[x].LifeTimeTicks Specifies the number of 10 millisecond timer ticks to wait before sending out a ThroughPacket packet. Syntax TPKT.ComplexForward[x].LifeTimeTicks = numticks x = index of a particular ThroughPacket transmission condition Access Read/Write...
Page 209
CG 6565 Installation and Developer's Manual Keyword reference In the previous example, the system sends out ThroughPacket packets only if the following conditions are met: Within this period of time... At least this much data must accumulate... 0 ms 1440 bytes...
Keyword reference CG 6565 Installation and Developer's Manual TPKT.ComplexRxPort Specifies a UDP port number on which to receive complex ThroughPacket packets. Syntax TPKT.ComplexRxPort = portnumber Access Read/Write Type Integer Default None. Allowed values A valid UDP port number. Example TPKT.ComplexRxPort = 49152...
CG 6565 Installation and Developer's Manual Keyword reference TPKT.ComplexTxPort Specifies a UDP port number on which to transmit complex ThroughPacket packets. Syntax TPKT.ComplexTxPort = portnumber Access Read/Write Type Integer Default None. Allowed values A valid UDP port number. Example TPKT.ComplexTxPort = 49152...
Keyword reference CG 6565 Installation and Developer's Manual TPKT.Enable Enables or disables ThroughPacket packet multiplexing functionality on the board. Syntax TPKT.Enable = value Access Read/Write Type Integer Default Allowed values 0 | 1 Example TPKT.Enable = 1 Details Set TPKT.Enable to 1 to enable ThroughPacket multiplexing. Set TPKT.Enable to 0 to disable ThroughPacket multiplexing.
CG 6565 Installation and Developer's Manual Keyword reference TPKT.NumberOfComplexForwardConditions Specifies the number of conditions specified for ThroughPacket data transmission. Syntax TPKT.NumberOfComplexForwardConditions = numconditions Access Read/Write Type Integer Default None. Allowed values Number of conditions set for transmitting complex packets. Example TPKT.NumberOfComplexForwardConditions = 4...
Keyword reference CG 6565 Installation and Developer's Manual TPKT.SimpleRxPort Specifies a valid UDP port number on which to receive simple ThroughPacket packets. Syntax TPKT.SimpleRxPort = portnumber Access Read/Write Type Integer Default None. Allowed values A valid UDP port number. Example TPKT.SimpleRxPort = 49152...
CG 6565 Installation and Developer's Manual Keyword reference TPKT.SimpleTxPort Specifies a UDP port number on which to transmit simple ThroughPacket packets. Syntax TPKT.SimpleTxPort = portnumber Access Read/Write Type Integer Default None. Allowed values A valid UDP port number. Example TPKT.SimpleTxPort = 49152...
Keyword reference CG 6565 Installation and Developer's Manual Version.Major Indicates the major version number of the CG plug-in. Syntax Version.Major = number Access Read-only (CG plug-in level) Type Integer Default Allowed values Not applicable. Details The keyword value is incremented when a change is made to the plug-in.
CG 6565 Installation and Developer's Manual Keyword reference Version.Minor Indicates the minor version number of the CG plug-in. Syntax Version.Minor = number Access Read-only (CG plug-in level) Type Integer Default Allowed values Not applicable. Details The keyword value is incremented when a change is made to the plug-in.
CG 6565 Installation and Developer's Manual Hardware specifications H.100 compliant interface • Flexible connectivity between DS0 streams and H.100 bus • 2048 full-duplex connections to bus • 1024 local connections • Switchable access to any of 4096 H.100 timeslots •...
CG 6565 Installation and Developer's Manual Hardware specifications Compliance and regulatory certification NMS Communications obtains board-level approvals certificates for supported countries. In addition to the approval obtained by NMS for the board and its associated software, some countries require a system-level approval before connecting the system to the public network.
CG board's DSP resource management settings. You should understand how the CG DSP resource manager allocates resources before modifying the standard DSP resource definitions. NMS Communications...
DSP resource management CG 6565 Installation and Developer's Manual DSPs, DPMs, and DPFs DSP programs are distributed in files called data processing modules (DPMs). These files use the extension .f41, and contain executable code for a family of algorithms. Algorithms in the family are called data processing functions (DPFs). They can be referenced by a unique string generated by combining the family string ID that corresponds to the DPM with the function ID string that corresponds to the DPF.
CG 6565 Installation and Developer's Manual DSP resource management DSP resources CG board DSP resource usage is calculated based on the following categories: • MIPS • Memory • Timeslots • Packet queues • Buffer size Each DPF that executes on a DSP core consumes resources from each of these categories.
DSP resource management CG 6565 Installation and Developer's Manual The following table summarizes resources available on each CG board DSP core: Resource category Available resource MIPS Approximately 128 MIPS per DSP External timeslots (input and output) 16 or 32 full duplex...
Page 229
CG 6565 Installation and Developer's Manual DSP resource management The following table shows approximate resources consumed by the DSP functions in this scenario: MIPS Input Output Data Input Output DSP-to- Comments slots slots memory coprocessor queue queue buffer size echo...
DSP resource management CG 6565 Installation and Developer's Manual Resource calculations Based on the previous example, you can calculate the following resource limitations for the sample application: Resource Worst case usage category MIPS MIPS used by this worst case example are the sum of the MIPS requirements for all of the functions, or 11.1 MIPS.
CG 6565 Installation and Developer's Manual DSP resource management Determining the maximum number of ports available The following steps describe how to determine the maximum number of ports available when using a specific resource definition: Step Action Set the Resource[x].Size keyword to an impossibly high number (for example, 1000).
DSP resource management CG 6565 Installation and Developer's Manual DSP image and resource definitions The DPMs specified in Resource[x].Definitions and the TCPs listed in the Resource[x].TCPs keyword are used to create the image. The image is loaded to the DSPs specified in the Resource[x].DSPs keyword.
Page 233
CG 6565 Installation and Developer's Manual DSP resource management The resources consumed by the DPFs in this resource string are shown in the following table, which lists the resources consumed by each function: MIPS Input Output Data Input Output DSP-to-...
Page 234
DSP resource management CG 6565 Installation and Developer's Manual Example: Some DPFs running simultaneously In the following example, only the echo and voice DPFs can execute at the same time. The Resource[x].Definitions keyword string is set as follows: Resource[1].Definitions = ( ptf.det_2f | dtmf.det_all | \ ( echo.ln20_apt100 &...
CG 6565 Installation and Developer's Manual DSP resource management Conditional relationships between DPFs The following examples define complex conditional relationships between DPFs using the AND operators, OR operators, and parentheses to combine DPF string IDs. Example 1 In the following example, OKI play and OKI record DPFs run simultaneously with: •...
DSP resource management CG 6565 Installation and Developer's Manual Natural Access media masks and call progress masks Natural Access uses a media mask and call progress mask that affect DSP resource management. The following table lists the names of these masks: If you are using this service...
CG 6565 Installation and Developer's Manual DSP resource management Trunk control program resource usage The Resource[x].TCPs keyword specifies which TCPs are used to perform call control for a resource definition. A number of TCPs are supplied with CG boards. The...
DSP resource management CG 6565 Installation and Developer's Manual Debugging resource management There are several ways to debug the resource management strings defined in CG boards. This topic describes: • Using CG board debug masks • Resource management board errors •...
CG 6565 Installation and Developer's Manual DSP resource management Debugging resource management with cgtrace cgtrace is an interactive debugging tool that enables you to debug CG board output. Once the CG board is booted, use cgtrace to evaluate CG board DSP resource management on a per-port and per-DSP basis.
Page 240
DSP resource management CG 6565 Installation and Developer's Manual DSP file/ Function MIPS Related API function Related arguments ASCII ID string dtmf.f41/dtmfe.f41 DTMF, 2.72 adiStartToneDetector post- and dtmf.det_all pre-tone silence, one tone pair, and frequency dtmf.f41/dtmfe.f41 Post- and 1.57 adiStartToneDetector pre-tone dtmf.det_sil_clrdwn_ced...
Page 241
CG 6565 Installation and Developer's Manual DSP resource management DSP file/ Function MIPS Related API function Related arguments ASCII ID string f_g711.f41 G.711 0.75 mspCreateChannel channelType= decode G711DecodeSimplex f_g711.dec_rfc2833 with RFC FilterAttribs= 2833 MSP_FCN_ATTRIB_RFC2833 f_g711vad.f41 G .711 1.50 mspCreateChannel channelType=...
Page 242
DSP resource management CG 6565 Installation and Developer's Manual DSP file/ Function MIPS Related API function Related arguments ASCII ID string f_ilbc_20.f41 iLBC 16.60 mspCreateChannel channelType= encode ILBC20EncodeSimplex f_ilbc_20.cod_rfc2833 FilterAttribs= 20 ms MSP_FCN_ATTRIB_RFC2833 with RFC 2833 f_ilbc_20.f41 iLBC 8.60 mspCreateChannel...
Page 243
CG 6565 Installation and Developer's Manual DSP resource management DSP file/ Function MIPS Related API function Related arguments ASCII ID string ima.f41 IMA/DVI 1.91 adiStartPlaying encoding = ADPCM ima.play_24 ADI_ENCODE_IMA_24 Play 6 kHz ima.f41 IMA/DVI 1.62 adiStartPlaying encoding = ADPCM ima.play_32...
Page 244
DSP resource management CG 6565 Installation and Developer's Manual DSP file/ Function MIPS Related API function Related arguments ASCII ID string oki.f41 OKI Play 5.43 adiStartPlaying encoding = oki.play_24_200 6 kHz 2.0X ADI_ENCODE_OKI_24 maxspeed = 200 oki.f41 OKI Play 5.00...
Page 245
CG 6565 Installation and Developer's Manual DSP resource management DSP file/ Function MIPS Related API function Related arguments ASCII ID string rvoice_vad.f41 A-law 0.85 adiCommandRecord encoding = Record rvoice_vad.rec_alaw adiStartRecording ADI_ENCODE_ ALAW rvoice_vad.f41 WAVE 0.85 adiCommandRecord encoding = Record, rvoice_vad.rec_lin...
Page 246
DSP resource management CG 6565 Installation and Developer's Manual DSP file/ Function MIPS Related API function Related arguments ASCII ID string voice.f41 NMS Play 7.53 adiStartPlaying encoding = voice.play_32_200 32 kbit/s ADI_ENCODE_ NMS_32 2.0X maxspeed = 200 speedup voice.f41 NMS Play 2.85...
DSP resource management Software echo cancellation MIPS NMS recommends using the CG 6565 daughterboard with an echo chip to provide echo cancellation capabilities. If you are installing a CG 6565 board without an attached daughterboard, you can use DSP resources to provide software echo cancellation capabilities.
The CG 6565 echo function has an adapt period of 8 ms. Therefore, an echo function with a 20 ms tail length and 100% rate will adapt all the coefficients in 8 ms while the same function with a 25% rate will adapt in 32 ms.
Page 254
DSP resource management CG 6565 Installation and Developer's Manual DSP file Description echo_v4.f41 Combines echo_v3.f41 functionality with comfort noise generation and tone disabling enhancements. f_amr.f41 Contains AMR encoder and decoder for voice over IP transmissions. See readme_amr.txt for more information.
Page 255
CG 6565 Installation and Developer's Manual DSP resource management DSP file Description rvoice.f41 Contains PCM play and record functions. rvoice.f41 is required to play or record with an encoding of ADI_ENCODE_MULAW, ADI_ENCODE_ALAW, or ADI_ENCODE_PCM8M16. rvoice_vad.f41 Contains PCM play and record functions. Record functions can enable the voice activity detection (VAD) capability.
1,536,000 b/s. An extra 8000 b/s are used to carry framing and other information (as described in Framing on page 259). DS-1 for T1 is 1,544,000 b/s. • For E1, 32 channels, each carrying 64,000 b/s, yield a rate of 2,048,000 b/s. NMS Communications...
T1 and E1 trunk channels CG 6565 Installation and Developer's Manual Signaling Two types of information are carried on a trunk: • Voice information • Signaling information (indicating, for example, if a channel is on-hook or off- hook) Signaling information can be conveyed using either channel associated signaling (CAS) or common channel signaling (CCS).
• T1 framing • E1 framing When configuring the CG 6565 board, you specify which framing format to use with the NetworkInterface.T1E1[x].FrameType keyword. T1 framing On T1 trunks, a frame consists of 24 timeslots, sent every 125 µsec (1/8000 sec).
Page 260
T1 and E1 trunk channels CG 6565 Installation and Developer's Manual The following illustration shows the framing bits on a T1 trunk: F bits 22 23 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 0 1 2...
CG 6565 Installation and Developer's Manual T1 and E1 trunk channels The following illustration shows an extended superframe: O n e e x t e n d e d s u p e r f r a m e = Bits used for framing...
( t r a n s m i t t e d i n c h a n n e l 1 6 ) . Voice encoding For the CG 6565 board, the information received is already pulse code modulation (PCM) encoded.
CG 6565 boards configured as E1 boards can be set up to transmit without zero code suppression, or to use the high density bipolar 3 code (HDB3) algorithm. In HDB3, sequences of 4 zero data bits are replaced by patterns of bipolar violations.
Utilities Utility summary This section provides detailed information about the following CG 6565 board utilities: Utility Description f41info Parses the contents of an .f41 file and displays resources used by the DPFs associated with the specified DPM. cg6kcon Gathers information and statistics about an active CG board.
Utilities CG 6565 Installation and Developer's Manual f41info - Displaying DPF file resource usage Parses the contents of a .f41 file and displays resources used by the DPFs associated with the specified DPM. Usage f41info f41name [options] where f41name is the name of a supported CG board DPM file.
Page 275
CG 6565 Installation and Developer's Manual Utilities Example 1 If you run this command: f41info dtmf -d Information similar to the following example appears: NMS Communications Show F41 File Info Version 1.00 File name: C:\NMS\CG\LOAD\dtmf.f41 Revision : 0.2 Size : 12964 bytes...
Page 276
Utilities CG 6565 Installation and Developer's Manual Example 2 If you run this command: f41info crc -t Information similar to the following example appears: NMS Communications Show F41 File Info Version 1.00 File name: C:\NMS\CG\LOAD\crc.f41 Revision : 0.2 Size : 8154 bytes...
CG 6565 Installation and Developer's Manual Utilities cg6kcon - Displaying statistics about CG board activity Gathers information and statistics about an active CG board. Usage cg6kcon options Valid options include: Option Function -b boardnumb CG board number. Default = 0...
Page 278
Utilities CG 6565 Installation and Developer's Manual Command Description ipv6nd Displays the IPv6 neighbor discovery table. For more information, see ipv6nd command on page 287. ipv6dest Displays the IPv6 destination table. For more information, see ipv6dest command on page 287.
Page 279
CG 6565 Installation and Developer's Manual Utilities Procedure Complete the following steps to run cg6kcon: Step Action Open a command line window. Enter the following command: cg6kcon -b boardnumber Enter one of the cg6kcon commands. cg6kcon performs the commands. Exit the program by entering q or quit.
Page 280
Utilities CG 6565 Installation and Developer's Manual The following example shows enabling and disabling remote access for cg6kcon: C:\>cg6kcon Console program V1.0 : ['quit' to Exit] [For multi-screen reply, 'more' to scroll] > >ipenable Socket interface enabled > >ipallow 198.62.139.32 IP Address 198.62.139.32 added successfully...
Page 281
CG 6565 Installation and Developer's Manual Utilities eth command Use the eth command to display detailed information about the operational status and statistical information for each Ethernet connection on the CG board. The operational status is provided in the following fields: Field Indicates if the...
Page 282
Utilities CG 6565 Installation and Developer's Manual The following sample shows the eth command output: Context Adp# Ethernet Addr Mode Duplex State ========= ==== ================= ===== ====== ===== $FDA72AC 0001 1A:90:2E:01:CD:15 1GBT FULL Statistics ========== TX Collision TX Late Collision: 0...
Page 283
Average number of packets transmitted and received over the last 16 seconds. Maximum number of packets transmitted or received. Set to zero (0) on read. If there is no activity, the next call command results in a 0 display (CG 6565/C only). Interrupt Current and average interrupt rates for the Ethernet.
Page 284
Utilities CG 6565 Installation and Developer's Manual ethcfg command The ethcfg command takes the following arguments: ethcfg [int=interface#] [auto | [[half|full] [10|100|1000]]] [prom] where... Argument Description int=interface# Configures only the interface indicated by the interface#. auto Determines speed selection and duplex mode through auto-negotiation. If interface# is omitted, both interfaces 1 and 2 are configured.
Page 285
CG 6565 Installation and Developer's Manual Utilities When you create an RTP Endpoint, cg6kcon displays three additional PPEs associated with each RTP session: Description RTP In (simplex) Connects to the UDP layer using a socket, receives all RTP packets from the IP network with the matching UDP port number and the local IP address (if specified).
Page 286
Utilities CG 6565 Installation and Developer's Manual IPv6 command examples The following examples show how to use the IPv6 commands supported by cg6kcon. They include: • ipv6 command • ipv6if command • ipv6nd command • ipv6dest command • ipv6rtr command •...
A command applies to all boards if you do not specify either -l or -e. cg6ktool supports multiple NMS boards. Some of these commands are shown for reference only and may not pertain to the CG 6565 board. NMS Communications...
Utilities CG 6565 Installation and Developer's Manual Description Use cgroute to add or delete routes from the routing table and print current routing table contents. Caution: cgroute adds and deletes routing table entries from the CG board routing table but does not update the host operating system's routing table.
Page 291
CG 6565 Installation and Developer's Manual Utilities Operations specified through standard input or through a file must use the following syntax: operation arguments; Operations Valid operations include: Operation Description add arguments; Adds an SAD entry. The add operation takes the following form: add src dst protocol spi -t tag algorithm...
Page 292
Utilities CG 6565 Installation and Developer's Manual Arguments Valid arguments include: Argument Description Source of the secure communication specified in numeric form. DNS lookups are not performed. Destination of the secure communication specified in numeric form. DNS lookups are not performed.
Page 293
CG 6565 Installation and Developer's Manual Utilities Argument Description src_range IPv6 source address or range of IPv6 source addresses to add or delete. This argument can be accompanied by a TCP/UDP port specification. Addresses and address ranges take the following form: •...
Page 294
Utilities CG 6565 Installation and Developer's Manual Argument Description policy IPSec policy argument that takes one of the following forms: • -P direction discard • -P direction bypass • -P direction ipsec protocol/transport/tag:index where: Value Description direction Direction of the policy can be set to either out or in.
Page 295
CG 6565 Installation and Developer's Manual Utilities Details Use cgsetkey to add, change, or delete IPv6 security keys and policies. The IPSec authentication header and the encapsulating security payload are supported. The security policy database (SPD) consists of a list of policies that describe a set of packets to match and an action to be taken for those packets.
Page 296
Utilities CG 6565 Installation and Developer's Manual Example 3: Adding an entry to the SAD The following operation adds an entry to the security association database: add 3ffe:501:4819::1 3ffe:501:481d::1 esp 0x10001 -E des-cbc "ESP with" -A hmac-md5 "authentication!!" ; where: •...
Page 297
CG 6565 Installation and Developer's Manual Utilities Example cgsetkey command file The following sample cgsetkey command file shows how to use cgsetkey commands in a text file to set up SAD and SPD entries for a particular board: ###################################################################### # This file assumes that one of the CG board's IPv6 interfaces has the # link-local address FE80::220:22FF:FE31:4C46.
Utilities CG 6565 Installation and Developer's Manual cgtrace - Performing CG board debugging Enables debugging and tracing of CG boards. Usage cgtrace -bboardnum options where boardnum is the CG board number (0 by default) and options are: Option Description -gglobalmask Sends the specified global trace mask globalmask in hexadecimal format to the board.
Page 299
CG 6565 Installation and Developer's Manual Utilities Procedure Complete the following procedure to run cgtrace: Step Action Enter the following command after a board has been booted: cgtrace -bboardnumber options If options are omitted, the following menu of commands appears:...
Page 300
Utilities CG 6565 Installation and Developer's Manual Details Use the D command to determine valid trace masks, as well as valid integer and string parameters, for a given manager. For example, selecting the filter manager (Manager ID = 1) displays the following...
Page 301
CG 6565 Installation and Developer's Manual Utilities cgtrace and resource management To display a list of resource management trace values available with a brief description of what each value traces, enter 9. cgtrace displays the following list: Tracing data for Resource Manager...