Running nms303tool in standalone mode

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:

Step

Action

1

Start nms303tool by entering the following command at the prompt:

nms303tool

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

2

Enter options to execute functions from the NMS GR303 library. See nms303tool options.

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

3

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

4

To exit nms303tool, enter q.


nms303tool options

Index

Option

Description

1

Call NMS_GR303Initialize

Initializes the NMS GR303 library.

2

Call NMS_GR303SetTrace

Sets the trace level for the NMS GR303 library.

3

Call NMS_GR303Exit

Exits the NMS GR303 library.

4

Call NMS_GR303ProvisionInterface

Provisions a GR303 physical layer interface through the NMS GR303 library.

5

Call NMS_GR303DestroyInterface

Destroys an existing GR303 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 GR303 interface.

8

Call NMS_GR303StopInterface

Stops a GR303 interface.

9

Call NMS_GR303GetChannelStatistics

Retrieves channel statistics for a channel associated with a GR303 physical layer interface.

10

Call NMS_GR303ResetChannelStatistics

Resets channel statistics for a channel associated with a GR303 physical layer interface.

11

Call NMS_GR303GetDS1Status

Retrieves status information for a DS1 link associated with a GR303 physical layer interface.

12

Call NMS_GR303ResetDS1Status

Resets status information for a DS1 link associated with a GR303 physical layer interface.

13

Call NMS_GR303PhSendData

Sends test HDLC frames to an HDLC channel.

g

 

Sets application global trace mask. Enter one of the following options:

0x0: No trace mask.

0x1: Trace HDLC buffers.

0x2: Trace HDLC errors.

l

 

Starts a load test for a provisioned interface.

p

 

Prints the current provisioned configuration.

h

 

Displays a Help menu.

q

 

Exits the program.


Example: nms303tool in standalone mode

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

  1. Enter option 1 to initialize the library.

nms303tool displays the following message:

NMS_GR303Initialize: Result=NMSGR303_SUCCESS

  1. Enter option 4 to provision the interface.

  1. nms303tool requests the following additional information:

Prompt

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 the following message when the interface is provisioned:

Result =NMSGR303_SUCCESS

  1. Enter option 7 to start the interface.

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

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

nms303tool displays the following message:

Result=NMSGR303_SUCCESS

  1. 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

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

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

  3. To exit nms303tool, enter q.