Table of Contents Index NMS Glossary Previous Page Next Page Version

Chapter 9

Demonstration Programs

9.1 Using the Demonstration Programs
9.1.1 nms303tool and nmsv5tool
9.1.2 Building Program Executables
Example 1: Building nms303tool as a Standalone Program
Example 2: Building nmsv5tool as an Integrated Program
9.1.3 Running nms303tool in Standalone Mode
Example: nms303tool in Standalone Mode
9.1.4 Running nms303tool in Integrated Mode
Example: nms303tool in Integrated Mode
9.1.5 Running nmsv5tool in Standalone mode
Example: nmsv5tool in Standalone Mode
9.1.6 Running nmsv5tool in Integrated Mode
Example: nmsv5tool in Integrated Mode

9.1 Using the Demonstration ProgramsTop of Page

This chapter describes how to use the nms303tool and nmsv5tool demonstration programs provided with Platform Support for DLCP software. Each demonstration program is shipped as source code with a makefile.

Before you start the demonstration programs:

Refer to the CG board installation manual for more information about installing CG boards.

9.1.1 nms303tool and nmsv5toolTop of Page

nms303tool and nmsv5tool are interactive menu-driven demonstration programs. Use nms303tool and nmsv5tool to:

You can build the nms303tool and nmsv5tool demonstration programs in two modes:

9.1.2 Building Program ExecutablesTop of Page

To build the executable for the nms303tool and nmsv5tool, NMS recommends using the provided makefiles. Use the nmake utility to build the executable under Windows or the gmake utility to build the executable under Unix.

Before you can compile the nms303tool or nmsv5tool program excutables, you must perform the following tasks:

  1. Build the Access303, Exchange303, or AV5 library. 

    

  2. Add the location of the 303rdt library (for the Access303 stack), 303idt library (for the Exchange303 stack), or the v5an library (for the AV5 stack) to the LIB system environment variable. This is necessary so that the linker can create an executable. 
    




You can build the nms303tool and nmsv5tool executables under Windows by entering the following:  





 To build this utility...



 Enter the following command...




 nms303tool for Access303



 nmake [AZTEKROOT_RDT=path]




 nms303tool for Exchange303



 nmake [AZTEKROOT_IDT=path]




 nmsv5tool for AV5



 nmake [AZTEKROOT=path]
















Where path provides the directory path to the root directory of the Aztek protocol stack. Specify this argument if you want to build an executable that is integrated with the Access303, Exchange303, or AV5 stack software. The demonstration program makefiles use the AZTEKROOT variable to find the Access303, Exchange303, or AV5 header files needed to compile the integration portion of the demonstration program code.






 Example 1: Building nms303tool as a Standalone ProgramTop of Page





To build a nms303tool executable for use with CG boards under Windows, compile a Windows standalone version of the nms303tool executable by entering:


> nmake              


To build an nms303tool executable for use with CG boards under UNIX:


    


  1. Set the Lib environment variable to include the directory where the Access303 stack library (303rdt) resides (in this case /opt/nms/dlcp/access303/coreimage), by entering the following:
    

    
setenv LIB /opt/nms/dlcp/access303/coreimage:$LIB%
    

  2. Compile a UNIX standalone version of the nms303tool executable by entering:
    

    
> gmake 






 Example 2: Building nmsv5tool as an Integrated ProgramTop of Page





To build a nmsv5tool executable that it is integrated with the AV5 stack under Windows, enter the following:


> nmake AZTEKROOT=d:\nms\dlcp\an5


In this example, the AV5 library (v5an) resides in the d:\nms\dlcp\an5 directory.



To build an nmsv5tool executable that it is integrated with the AV5 stack and can be used with CG boards under UNIX, enter the following:


> gmake AZTEKROOT=/opt/nms/dlcp/an5


In this example, the AV5 library (v5an) resides in the /opt/nms/dlcp/an5 directory.






9.1.3 Running nms303tool in Standalone ModeTop of Page





Before running nms303tool, make sure you have configured and booted a CG board, connected it to the appropriate T1 links, and compiled the nms303tool executable. 



To run nms303tool in standalone mode: 


    


  1. Start nms303tool, entering the following at the command prompt:
    

    
nms303tool
    
The nms303tool prompts you to enter a global program trace mask variable that specifies the amount of on-screen HDLC information the program displays while it runs. 
    

  2. Specify a trace debug mask for nms303tool. Available trace masks include: 

    


    
 Trace Mask
    

    		
 Description
    


    
 GLOBAL_TRACEMASK_HDLC_NONE
    

    		
 nms303tool does not print any HDLC related output.
    


    
 GLOBAL_TRACEMASK_HDLC_BUFFERS
    

    		
 nms303tool prints received and transmitted HDLC frame buffers.
    


    
 GLOBAL_TRACEMASK_HDLC_ERRORS
    

    		
 nms303tool prints HDLC receive and transmit errors.
    


    
 GLOBAL_TRACEMASK_HDLC_ALL
    

    		
 nms303tool print HDLC receive and transmit errors and buffers.
    



    


    

    

    

    

    
nms303tool displays a main menu of available options that directly correspond to functions in the NMS GR303 library. 
    

  3. Enter options to execute functions from the NMS GR303 library. These options include: 

    


    
 Index
    

    		
 Option
    

    		
 Description
    


    
 1
    

    		
 Call NMS_GR303Initialize
    

    		
 Initializes the NMS GR303 library.
    


    
 2
    

    		
 Call NMS_GR303SetTrace
    

    		
 Sets the trace level for NMS GR303 library.
    


    
 3
    

    		
 Call NMS_GR303Exit
    

    		
 Exits the NMS GR303 library.
    


    
 4
    

    		
 Call NMS_GR303ProvisionInterface
    

    		
 Provisions a GR-303 physical layer interface through the NMS GR303 library.
    


    
 5
    

    		
 Call NMS_GR303DestroyInterface
    

    		
 Destroys an existing GR-303 physical layer interface through the NMS GR303 library.
    


    
 6
    

    		
 Call NMS_GR303ModifyChannelLocation
    

    		
 Moves a provisioned HDLC channel (if specified) or adds a new HDLC channel to an interface without re-provisioning the interface.
    


    
 7
    

    		
 Call NMS_GR303StartInterface
    

    		
 Starts a GR-303 interface.
    


    
 8
    

    		
 Call NMS_GR303StopInterface
    

    		
 Stops a GR-303 interface.
    


    
 9
    

    		
 Call NMS_GR303GetChannelStatistics
    

    		
 Retrieves channel statistics for a channel associated with a GR-303 physical layer interface.
    


    
 10
    

    		
 Call NMS_GR303ResetChannelStatistics
    

    		
 Resets channel statistics for a channel associated with a GR-303 physical layer interface.
    


    
 11
    

    		
 Call NMS_GR303GetDS1Status
    

    		
 Retrieve status information for a DS1 link associated with a GR-303 physical layer interface.
    


    
 12
    

    		
 Call NMS_GR303ResetDS1Status
    

    		
 Resets status information for a DS1 link associated with a GR-303 physical layer interface.
    


    
 13
    

    		
 Call NMS_GR303PhSendData 
    

    		
 Sends test HDLC frames to an HDLC channel.
    


    
 N/A
    

    		
 l
    

    		
 Starts a load test for a provisioned interface.
    


    
 N/A
    

    		
 p
    

    		
 Prints the current provisioned configuration.
    


    
 N/A
    

    		
 h 
    

    		
 Displays a Help menu.
    


    
 N/A
    

    		
 q
    

    		
 Exits the program.
    



    


    

    

    

    

    
When necessary, nms303tool prompts for you to enter associated arguments or parameters for the specified function. 
    

  4. To validate the HDLC connections you can use option 13 (NMS_GR303PhSendData) to send and receive HDLC frames on the HDLC channels. 
    

    

  5. To exit nms303tool enter q.
    







 Example: nms303tool in Standalone ModeTop of Page





This example shows the nms303tool options used to perform the following tasks:




To perform these tasks:


    


  1. Start nms303tool, by entering the following at the command prompt:
    

    
nms303tool
    

  2. Enter option: 1 (NMS_GR303Initialize).
    

    
nms303tool displays the following message:
    
NMS_GR303Initialize: Result=NMSGR303_SUCCESS
    

  3.  Enter option 4 (NMS_GR303ProvisionInterface).
    

    

  4. nms303tool requests the following additional information: 

    


    
 Prompt
    

    		
 User Response
    


    
 Enter interfaceId: 
    

    		
 0
    


    
 Enter ChannelRxBufferSize (Min=260):
    

    		
 260
    


    
 Add a new channel? (y/n):
    

    		
 y
    


    
 NMS boardNb: 
    

    		
 0
    


    
 NMS trunkNb:
    

    		
 0 
    


    
 NMS timeslotNb
    

    		
 24
    


    
 Add a new channel? (y/n):
    

    		
 y
    


    
 NMS boardNb: 
    

    		
 0
    


    
 NMS trunkNb:
    

    		
 0
    


    
 NMS timeslotNb
    

    		
 12
    


    
 Add a new channel? (y/n):
    

    		
 y
    


    
 NMS boardNb: 
    

    		
 0
    


    
 NMS trunkNb:
    

    		
 1
    


    
 NMS timeslotNb
    

    		
 24
    


    
 Add a new channel? (y/n):
    

    		
 y
    


    
 NMS boardNb: 
    

    		
 0
    


    
 NMS trunkNb: 
    

    		
 1
    


    
 NMS timeslotNb
    

    		
 12
    



    


    

    

    

    

    
nms303tool displays a Result=NMSGR303_SUCCESS message when the interface is provisioned.
    

  5. Enter option 7 (NMS_GR303StartInterface).
    

    
nms303tool prompts you to enter the interface ID of the interface to start.
    

  6. Enter the interface ID of the provisioned interface (0).
    

    
nms303tool displays a Result=NMSGR303_SUCCESS message.
    

  7. Enter option p to display the configuration of interface 0.
    

    
nms303tool displays configuration information for interface 0:
    
InterfaceId=0:
    
NMS: boardNb=0 trunkNb=0 timeslotNb=24
    
NMS: boardNb=0 trunkNb=0 timeslotNb=12
    
NMS: boardNb=0 trunkNb=1 timeslotNb=24
    
NMS: boardNb=0 trunkNb=1 timeslotNb=12
    

  8. To validate that HDLC channels can send and receive HDLC frames over HDLC links, enter option 13 (NMS_GR303PhSendData). 
    

    

  9. Enter other command line options to test additional NMS GR303 library functions.
    

    

  10. To exit nms303tool, enter q.
    







9.1.4 Running nms303tool in Integrated ModeTop of Page





Before running nms303tool, make sure you have configured and booted a CG board, connected T1 trunks to the peer side of the GR-303 interface, and compiled the nms303tool and aim303tool executables. 



To run nms303tool integrated with the Aztek Access303 or Exchange303: 


    


  1. Start nms303tool by entering the following at the command prompt:
    

    
nms303tool
    
nms303tool initializes the Access303 or Exchange303 library. Access303 starts internal tasks including the AimTaskAr303 which makes it possible for nms303tool to communicate with the Aztek aim303 utility. aim303 is a part of the Aztek software and should be used in conjunction with nms303tool integration tests.
    
nms303tool displays the following message:
    
AR303AimTask: waiting for AIM Socket Connection on port 4200
    

  2. nms303tool prompts you to enter a global program trace mask variable that specifies the amount of on-screen HDLC information the program displays while it runs. 
    

    

  3. Specify a trace debug mask for nms303tool. Available trace masks include: 

    


    
 Trace Mask
    

    		
 Description
    


    
 GLOBAL_TRACEMASK_HDLC_NONE
    

    		
 nms303tool does not print any HDLC related output.
    


    
 GLOBAL_TRACEMASK_HDLC_BUFFERS
    

    		
 nms303tool prints received and transmitted HDLC frame buffers.
    


    
 GLOBAL_TRACEMASK_HDLC_ERRORS
    

    		
 nms303tool prints HDLC receive and transmit errors.
    


    
 GLOBAL_TRACEMASK_HDLC_ALL
    

    		
 nms303tool print HDLC receive and transmit errors and buffers.
    



    


    

    

    

    

    
nms303tool displays a main menu of available options. These options directly correspond to functions in the NMS GR303 library and are the same options that appear if you run in standalone mode, except NMS_GR303PhDataRequest. For more information about available functions, refer to Chapter  8.
    
Note:  nms303tool calls NMS_GR303PhDataRequest internally when the Access303 or Exchange303 library calls Ar303PhDataRequest. All HDLC data received from the IDT or RDT side, as well as any HDLC transmit or receive errors, are passed to the Access303 or Exchange303 stack through the Ar303PhDataIndication function.


  4. Start the aim303tool utility by entering the following:
    

    
aim303 hostname
    
where hostname is the host name of the machine where nms303tool is running.
    
nms303tool displays the following message:
    
 AR303AimTask: Menu Socket Connected on port 4200
    

  5. Enter options to execute functions from the NMS GR303 library. 
    

    
When necessary, nms303tool prompts you to enter associated arguments or parameters for the specified function. 
    
Enter options at the aim303tool menu (for controlling Access303 or Exchange303 stack).
    

  6. To exit nms303tool enter q.
    







 Example: nms303tool in Integrated ModeTop of Page





The following example shows how to use nms303tool in integrated mode to initialize the NMS GR303 library, provision and start an interface (interface 0) with four HDLC channels on a CG board. The example creates the following parameter mapping between the Aztek Access303 and NMS GR303 libraries: 





 Aztek AV5 Library Parameters



 NMS V5 Library Parameters




 DS1=1, DS0=24



 boardNb=0, trunkNb=0, timeslotNb=24




 DS1=1, DS0=12



 boardNb=0, trunkNb=0, timeslotNb=12




 DS1=2, DS0=24



 boardNb=0, trunkNb=1, timeslotNb=24




 DS1=2, DS0=12



 boardNb=0, trunkNb=1, timeslotNb=12
















This example shows the nms303tool options used to perform the following tasks while integrated with the Access303 library:




To perform these tasks:


    


  1. Start nms303tool by entering the following at the command prompt:
    

    
nms303tool
    

  2. Start aim303 by entering the following at the command prompt:
    

    
aim303tool hostname
    
where hostname specifies the system where the NMS GR303 library is running.
    

  3. Enter option: 1 (NMS_GR303Initialize) at the nms303tool command line.
    

    
nms303tool displays the following message:
    
NMS_GR303Initialize: Result=NMSGR303_SUCCESS
    

  4.  Enter option 4 (NMS_GR303ProvisionInterface).
    

    
nms303tool requests the following additional information: 

    


    
 Prompt
    

    		
 User Response
    


    
 Enter interfaceId: 
    

    		
 0
    


    
 Enter ChannelRxBufferSize (Min=260):
    

    		
 260
    


    
 Add a new channel? (y/n):
    

    		
 y
    


    
 Aztek DS1 (1-128):
    

    		
 1
    


    
 Aztek DS0 (12 = EOC, 24 = TMC): 
    

    		
 12
    


    
 NMS boardNb: 
    

    		
 0
    


    
 NMS trunkNb:
    

    		
 0 
    


    
 NMS timeslotNb
    

    		
 12
    


    
 Add a new channel? (y/n):
    

    		
 y
    


    
 Aztek DS1 (1-128):
    

    		
 1
    


    
 Aztek DS0 (12 = EOC, 24 = TMC): 
    

    		
 24
    


    
 NMS boardNb: 
    

    		
 0
    


    
 NMS trunkNb:
    

    		
 0
    


    
 NMS timeslotNb
    

    		
 24
    


    
 Add a new channel? (y/n):
    

    		
 y
    


    
 Aztek DS1 (1-128):
    

    		
 2
    


    
 Aztek DS0 (12 = EOC, 24 = TMC): 
    

    		
 24
    


    
 NMS boardNb: 
    

    		
 0
    


    
 NMS trunkNb:
    

    		
 1 
    


    
 NMS timeslotNb
    

    		
 24
    


    
 Add a new channel? (y/n):
    

    		
 y
    


    
 Aztek DS1 (1-128):
    

    		
 2
    


    
 Aztek DS0 (12 = EOC, 24 = TMC): 
    

    		
 12
    


    
 NMS boardNb: 
    

    		
 0
    


    
 NMS trunkNb: 
    

    		
 1 
    


    
 NMS timeslotNb
    

    		
 12
    



    


    

    

    

    
nms303tool displays a Result=NMSGR303_SUCCESS message when the interface is provisioned.
    

  5. Enter option 7 (NMS_GR303StartInterface).
    

    
nms303tool prompts you to enter the interface ID of the interface to start.
    

  6. Enter the interface ID of the provisioned interface (0).
    

    
nms303tool displays a Result=NMSGR303_SUCCESS message.
    

  7. Enter option p to display the configuration of interface 0.
    

    
nms303tool displays configuration information for interface 0:
    
InterfaceId=0:
    
NMS: boardNb=24 trunkNb=0 timeslotNb=24
    
NMS: boardNb=12 trunkNb=0 timeslotNb=12
    
NMS: boardNb=24 trunkNb=1 timeslotNb=24
    
NMS: boardNb=12 trunkNb=1 timeslotNb=12
    

  8. Enter options from the nms303tool and aim303 program menus to execute NMS GR303 and Access303 library functions.
    

    

  9. Exit nms303tool by entering q.
    

    

  10. Exit the aim303 utility.
    







9.1.5 Running nmsv5tool in Standalone modeTop of Page





Before running nmsv5tool, make sure you have configured and booted a CG board, connected its E1 trunks, and compiled the nmsv5tool executable. 



To run the nmsv5tool in standalone mode:


    


  1. Start nmsv5tool, entering the following at the command prompt:
    

    
nmsv5tool
    
The nmsv5tool prompts you to enter a global program trace mask variable that specifies the amount of on-screen HDLC information the program displays while it runs. Available trace masks include: 

    


    
 Trace Mask
    

    		
 Description
    


    
 GLOBAL_TRACEMASK_HDLC_NONE
    

    		
 nmsv5tool does not print any HDLC related output.
    


    
 GLOBAL_TRACEMASK_HDLC_BUFFERS
    

    		
 nmsv5tool prints received and transmitted HDLC frame buffers.
    


    
 GLOBAL_TRACEMASK_HDLC_ERRORS
    

    		
 nmsv5tool prints HDLC receive and transmit errors.
    


    
 GLOBAL_TRACEMASK_HDLC_ALL
    

    		
 nmsv5tool print HDLC receive and transmit errors and buffers.
    



    


    

    

    

    

  2. Specify a trace debug mask for nmsv5tool.
    

    
nmsv5tool displays a main menu of available options. These options directly correspond to functions in the NMS V5 library. Options include: 

    


    
 Index
    

    		
 Option
    

    		
 Description
    


    
 1
    

    		
 Call NMS_V5Initialize
    

    		
 Initialize NMS V5 library.
    


    
 2
    

    		
 Call NMS_V5SetTrace
    

    		
 Set trace level for NMS V5 library.
    


    
 3
    

    		
 Call NMS_V5Exit
    

    		
 Exits NMS V5 library.
    


    
 4
    

    		
 Call NMS_V5ProvisionInterface
    

    		
 Provisions a V5.2 physical layer interface.
    


    
 5
    

    		
 Call NMS_V5ProvisionStandbyVariant
    

    		
 Provisions a V5.2 physical layer interface standby variant.
    


    
 6
    

    		
 Call NMS_V5DestroyInterface
    

    		
 Destroys an existing V5.2 physical layer interface.
    


    
 7
    

    		
 Call NMS_V5DestroyStandbyVariant
    

    		
 Destroys a V5.2 physical layer interface standby variant.
    


    
 8
    

    		
 Call NMS_V5AddE1
    

    		
 Adds an E1 link associated with voice channels to a provisioned active variant on a specified interface.
    


    
 9
    

    		
 Call NMS_V5DeleteE1
    

    		
 Deletes an E1 link from a provisioned active variant on a specified interface.
    


    
 10
    

    		
 Call NMS_V5SwitchOverVariantData
    

    		
 Switches interface to the standby variant.
    


    
 11
    

    		
 Call NMS_V5StartInterface
    

    		
 Starts a V5.2 physical layer interface.
    


    
 12
    

    		
 Call NMS_V5StopInterface
    

    		
 Stops a V5.2 physical layer interface.
    


    
 13
    

    		
 Call NMS_V5GetChannelStatistics
    

    		
 Retrieves channel statistics for an HDLC channel associated with a V5.2 physical layer interface.
    


    
 14
    

    		
 Call NMS_V5ResetChannelStatistics
    

    		
 Resets channel statistics for an HDLC channel associated with a V5.2 physical layer interface.
    


    
 15
    

    		
 Call NMS_V5GetE1Status
    

    		
 Retrieve status information for an E1 link associated with a V5.2 physical layer interface.
    


    
 16
    

    		
 Call NMS_V5ResetE1Status
    

    		
 Resets status information for an E1 link associated with a V5.2 physical layer interface.
    


    
 17
    

    		
 Call NMS_V5PhSendData 
    

    		
 Sends test frames to the NMS V5 library.
    


    
 18
    

    		
 Call NMS_V5SendSA7Bit
    

    		
 Sets the value of the SA7 E1 framing bit to 0 or 1.
    


    
 N/A
    

    		
 l
    

    		
 Starts a load test for a provisioned interface.
    


    
 N/A
    

    		
 p
    

    		
 Prints the current provisioned configuration
    


    
 N/A
    

    		
 h 
    

    		
 Displays a Help menu.
    


    
 N/A
    

    		
 q
    

    		
 Exits the program.
    



    


    

    

    

    
Note:  Options 17 and 18 (calling NMS_V5PhSendData and NMS_V5SendSA7Bit) are only available in standalone mode. When the NMS V5 library is integrated with the AV5 library, nmv5demo calls NMS_V5PhSendData and NMS_V5SendSA7Bit internally as requested by the AV5 library V5PhDataRequest, V5SetSA7ToOne and V5SetSA7ToZero functions.


  3. Enter options to execute functions from the NMS V5 library. 
    

    
When necessary, nmsv5tool prompts for you to enter associated arguments or parameters for the specified board family. 
    

  4. To validate the HDLC channels can send and receive HDLC frames, use option 13 (NMS_V5PhSendData). 
    

    

  5. Before exiting nmsv5tool, stop (option 8) and destroy (option 5) the interface 
    

    

  6. To exit nmsv5tool enter q.
    







 Example: nmsv5tool in Standalone ModeTop of Page





This example shows the nmsv5tool options used to perform the following tasks:




To perform these tasks:


    


  1. Start nmsv5tool, by entering the following at the command prompt:
    

    
nmsv5tool
    

  2. Enter option: 1 (NMS_V5Initialize).
    

    
nmsv5tool displays the following
    
NMS_V5Initialize: Result=NMSV5_SUCCESS
    

  3.  Enter option 4 (NMS_V5ProvisionInterface).
    

    

  4. nmsv5tool requests the following additional information: 

    


    
 Prompt
    

    		
 User Response
    


    
 Enter interfaceId: 
    

    		
 0
    


    
 Enter ChannelRxBufferSize (Min=260):
    

    		
 260
    


    
 Add a new E1? (y/n):
    

    		
 y
    


    
 NMS boardNb: 
    

    		
 0
    


    
 NMS trunkNb:
    

    		
 0 
    


    
 Add a new E1? (y/n):
    

    		
 y
    


    
 NMS boardNb: 
    

    		
 0
    


    
 NMS trunkNb:
    

    		
 1 
    


    
 Add a new E1? (y/n): 
    

    		
 n
    


    
 Add a new channel? (y/n):
    

    		
 y
    


    
 NMS boardNb: 
    

    		
 0
    


    
 NMS trunkNb:
    

    		
 0 
    


    
 NMS timeslotNb
    

    		
 16
    


    
 Add a new channel? (y/n):
    

    		
 y
    


    
 NMS boardNb: 
    

    		
 0
    


    
 NMS trunkNb: 
    

    		
 0 
    


    
 NMS timeslotNb
    

    		
 15
    


    
 Add a new channel? (y/n):
    

    		
 y
    


    
 NMS boardNb: 
    

    		
 0
    


    
 NMS trunkNb: 
    

    		
 1 
    


    
 NMS timeslotNb
    

    		
 16
    


    
 Add a new channel? (y/n):
    

    		
 y
    


    
 NMS boardNb: 
    

    		
 0
    


    
 NMS trunkNb: 
    

    		
 1 
    


    
 NMS timeslotNb
    

    		
 15
    


    
 Add a new channel? (y/n):
    

    		
 n
    



    


    

    

    

    

    
nmsv5tool displays a Result=NMSV5_SUCCESS message when the interface is provisioned.
    

  5. Enter option 11 (NMS_V5StartInterface).
    

    
nmsv5tool prompts you to enter the interface ID of the interface to start.
    

  6. Enter the interface of the provisioned interface (0).
    

    

  7. After the interface has been started the nmv5demo prints the E1 link status for each provisioned E1 link to the screen and displays an NMSV5_SUCCESS event:
    

    
17:30:43E1Status Function InterfaceId=0 Status: LOS=0 LOF=0 AIS=0 RAI=0 CRCErr=0 FEBE=0 N_SA7_0=0 N_SA7_1=1
    
NMS: boardNb=0 trunkNb=0
    
17:30:43E1Status Function InterfaceId=0 Status: LOS=0 LOF=0 AIS=0 RAI=0 CRCErr=0 FEBE=0 N_SA7_0=0 N_SA7_1=1
    
NMS: boardNb=0 trunkNb=1
    
NMS_V5StartInterface: Result=NMSV5_SUCCESS
    

  8. To validate that HDLC connections can send and receive HDLC frames over, enter option 17 (NMS_V5PhSendData). 
    

    

  9. Enter other command line options to test additional NMS V5 library functions.
    

    

  10. To exit nmsv5tool, enter q.
    







9.1.6 Running nmsv5tool in Integrated ModeTop of Page





Before running nmsv5tool, make sure you have configured and booted a CG board, connected its E1 trunks, and compiled the nmsv5tool and aimv5tool executables. 



To run nmsv5tool integrated with the Aztek AV5: 


    


  1. Start nmsv5tool, entering the following at the command prompt:
    

    
nmsv5tool
    
nmsv5tool initializes the AV5 library. The AV5 library starts internal tasks including the AIM task, which makes it possible for the aimv5 utility to communicate with the Aztek AV5 stack. 
    
nmsv5tool displays the following message:
    
Aztek_waitconnect: waiting for Menu Socket Connection on port 5200
    

  2. nmsv5tool prompts you to enter a global program trace mask variable that specifies the amount of on-screen HDLC information the program displays while it runs. Available trace masks include: 

    


    
 Trace Mask
    

    		
 Description
    


    
 GLOBAL_TRACEMASK_HDLC_NONE
    

    		
 nmsv5tool does not print any HDLC related output.
    


    
 GLOBAL_TRACEMASK_HDLC_BUFFERS
    

    		
 nmsv5tool prints received and transmitted HDLC frame buffers.
    


    
 GLOBAL_TRACEMASK_HDLC_ERRORS
    

    		
 nmsv5tool prints HDLC receive and transmit errors.
    


    
 GLOBAL_TRACEMASK_HDLC_ALL
    

    		
 nmsv5tool print HDLC receive and transmit errors and buffers.
    



    


    

    

    

    

    

  3. Specify a trace debug mask for nmsv5tool.
    

    
nmsv5tool displays a main menu of available options. These options directly correspond to functions in the NMS V5 library and are the same options that appear if you run in standalone mode, except NMS_GR303PhDataRequest and NMS_GR303SendSA7Bit. For more information about available functions, refer to Chapter  8.
    
Note:  nms303tool calls NMS_GR303PhDataRequest and NMS_GR303SendSA7Bit and the AV5 stack calls V5PhDataRequest, V5SetSA7ToOne, and V5SetSA7ToZero. nmsv5tool passes all HDLC data received from the IDT side, as well as any HDLC transmit and receive errors, to the AV5 stack by using the AV5PhDataIndication function. nmsv5tool also sends E1 status reports to the AV5 library by calling the AV5 library function V5E1Status. 


  4. Start the aimv5 utility by entering the following:
    

    
aim hostname
    
where hostname is the host name of the machine where nmsv5tool is running.
    
nmsv5tool displays the following message:
    
Aztek_waitconnect: AIM socket connected on port 5200, file descriptor 648
    

  5. Enter options to execute functions from the NMS V5 library. 
    

    
When necessary, nmv53tool prompts you to enter associated arguments or parameters for the specified function. 
    
Enter options at the aim303 menu for controlling Access303 stack.
    

  6. To exit nms303tool enter q.
    







 Example: nmsv5tool in Integrated ModeTop of Page





This example shows the nmsv5tool options used to perform the following tasks while integrated with the V5 library:




The example creates the following parameter mapping between the Aztek Access303 and NMS GR303 libraries: 





 Aztek AV5 Library Parameters



 NMS V5 Library Parameters




 E1=0 CChannel=16



 boardNb=0, trunkNb=0, trunkNb=16




 E1=1 CChannel=16



 boardNb=0, trunkNb=1, trunkNb=16
















To perform these tasks:


    


  1. Start nmsv5tool, by entering the following at the command prompt:
    

    
nmsv5tool
    

  2. Start aimv5, by entering the following at the command prompt:
    

    
aimv5
    

  3. Enter option 1 (NMS_V5Initialize) at the nmsv5tool command line.
    

    
nmsv5tool displays the following
    
NMS_V5Initialize: Result=NMSV5_SUCCESS
    

  4.  Enter option 4 (NMS_V5ProvisionInterface).
    

    
nmsv5tool requests the following additional information: 

    


    
 Prompt
    

    		
 User Response
    


    
 Enter interfaceId: 
    

    		
 0
    


    
 Enter ChannelRxBufferSize (Min=260):
    

    		
 260
    


    
 Add a new E1? (y/n):
    

    		
 y
    


    
 Aztek E1 (0-15):
    

    		
 0
    


    
 NMS boardNb: 
    

    		
 0
    


    
 NMS trunkNb:
    

    		
 0 
    


    
 Add a new E1? (y/n):
    

    		
 y
    


    
 Aztek E1 (0-15):
    

    		
 1
    


    
 NMS boardNb: 
    

    		
 0
    


    
 NMS trunkNb:
    

    		
 1 
    


    
 Add a new E1? (y/n): 
    

    		
 n
    


    
 Add a new channel? (y/n):
    

    		
 y
    


    
 Aztek E1 (0-15):
    

    		
 0
    


    
 Aztek C-Channel (15,16,or 31):
    

    		
 16
    


    
 NMS boardNb: 
    

    		
 0
    


    
 NMS trunkNb:
    

    		
 0 
    


    
 NMS timeslotNb
    

    		
 16
    


    
 Add a new channel? (y/n):
    

    		
 y
    


    
 Aztek E1 (0-15):
    

    		
 1
    


    
 Aztek C-Channel (15,16,or 31):
    

    		
 16
    


    
 NMS boardNb: 
    

    		
 0
    


    
 NMS trunkNb: 
    

    		
 1
    


    
 NMS timeslotNb
    

    		
 16
    


    
 Add a new channel? (y/n):
    

    		
 n
    



    


    

    

    

    
nmsv5tool displays a Result=NMSGRV5_SUCCESS message when the interface is provisioned.
    

  5. Enter option 11 (NMS_V5StartInterface).
    

    
nmsv5tool prompts you to enter the interface ID of the interface to start.
    

  6. Enter the interface ID of the provisioned interface (0).
    

    
nmsv5tool displays the following configuration information:
    
19:31:46E1Status Function InterfaceId=0 Status: LOS=0 LOF=0 AIS=0 RAI=0 CRCErr=0 FEBE=0 N_SA7_0=0 N_SA7_1=1
    
NMS: boardNb=0 trunkNb=0
    
V5PhDataIndication AztecReturn=0x30
    
19:31:46E1Status Function InterfaceId=0 Status: LOS=0 LOF=0 AIS=0 RAI=0 CRCErr=0 FEBE=0 N_SA7_0=0 N_SA7_1=1
    
NMS: boardNb=0 trunkNb=1
    
V5PhDataIndication AztecReturn=0x30
    
Then, nmsv5tool displays a Result=NMSV5_SUCCESS message.
    

  7. Enter options from the nmsv5tool and aimv5 program menus to execute NMS V5 and AV5 library functions.
    

    

  8. Exit nmsv5tool by entering q.
    

    

  9. Exit the aimv5 utility.
    









 
Table of Contents Index NMS Glossary Previous Page Next Page Version




 




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



Copyright © 2001, NMS Communications Corporation.   All rights
reserved.