Voice Interworking Service Module, Release 2.0
Command Line Interface

Table Of Contents

Command Line Interface (CLI)

Command Line Features

Entering Commands

General Command Items

Command Sequences

Mandatory/Optional Commands

Logging In

Logging Out

VISM Commands

?

addcasvar

addccs

addcid

addcon

addconloop

adddn

addendpt

addendptloop

addendpts

addlapd

addln

addlnloop

addmgc

addmgcprotocol

addport

addrscprtn

addses

addsesgrp

addsesset

cc

chkflash

clralm

clralmcnt

clralmcnts

clralms

clrsarcnt

clrsarcnts

clrsarmsgcnt

clrscrn

clrtaskinfo

cnfaal2subcellmuxing

cnfalm

cnfcac

cnfcascode

cnfcasendpt

cnfcasvar

cnfcasxgcp

cnfcodecparams

cnfcodectmpl

cnfcompsize

cnfcompvad

cnfcon

cnfconcac

cnfconprotect

cnfdeftos

cnfds0localcas

cnfds0loop

cnfecanenable

cnfecannrn

cnfecanrec

cnfecantail

cnfecantone

cnfendptcadence

cnferl

cnfgwis

cnfgwoos

cnfjtrinitdelay

cnfjtrmode

cnflapdretrans

cnflapdtimer

cnflapdtype

cnflapdwinsize

cnfln

cnflnis

cnflnoos

cnflnsig

cnflntrunkcond

cnfmgc

cnfrtcprepint

cnfrtprxtimer

cnfsesack

cnfsesmaxreset

cnfsesmaxseg

cnfsesmaxwindow

cnfsesnullsegtmout

cnfsesoutofseq

cnfsesport

cnfsesretrans

cnfsesstatetmout

cnfsessyncatmps

cnfsrcppeer

cnftftpdn

cnfvismdn

cnfvismip

cnfvismmode

cnfxgcpinteropsdpost

cnfxgcpmwd

cnfxgcppeer

cnfxgcpretry

delcasvar

delccs

delcid

delcon

delconloop

deldn

delendpt

delendptloop

delendpts

dellapd

delln

dellnloop

delmgc

delmgcprotocol

delport

delrscprtn

delses

delsesgrp

delsesset

dspaal2profile

dspalm

dspalmcnf

dspalmcnt

dspalms

dspcarddsp

dspcasendpts

dspcasvar

dspcasvarendpts

dspcasvars

dspcasxgcps

dspccs

dspccschans

dspccscnt

dspcd

dspcid

dspcids

dspcodecparams

dspcodectmpls

dspcon

dspconcac

dspconcnt

dspcons

dspdn

dspdns

dspds0localcasstatus

dspds0loop

dspendpt

dspendpts

dspgwstate

dsplapd

dsplapds

dsplapdstat

dspln

dsplncids

dsplndsp

dsplndsx0s

dsplnendptstatus

dsplns

dsplnstate

dsploops

dspmaxmgcs

dspmgc

dspmgcs

dspmgcprotocols

dspmgprotocols

dspmngcidcnt

dspport

dsprscprtn

dspsarcnt

dspsarcnts

dspsarmsgcnt

dspses

dspsesgrp

dspsesgrps

dspsess

dspsesset

dspsesstat

dspsrcpcnt

dspsrcpcnts

dspsrcppeer

dspsrcppeers

dspsrcpport

dsptaskinfo

dspvismdn

dspvismip

dspvismparam

dspxgcpcnf

dspxgcpcons

dspxgcpcnt

dspxgcpcnts

dspxgcpdefpkg

dspxgcpdetailcnt

dspxgcpdetailcnts

dspxgcperrcnt

dspxgcpinterops

dspxgcppeers

dspxgcpport

Help

pinglndsp

tstcon

tstdelay

version


Command Line Interface (CLI)


This chapter describes the VISM Command Line Interface (CLI) that is used to configure, manage, and troubleshoot the VISM 2.0 card.

Command Line Features

Commands can be entered either through:

An alphanumeric terminal (or PC emulating an alphanumeric terminal) connected to the control port on the shelf's PXM card.

A PC or workstation using Telnet and connected to the PXM LAN port using TCP/IP through its LAN port (the IP address used is that of the MGX 8850 and which must already be configured).

Entering Commands

The CLI is a DOS-like interface in which each command has a mnemonic followed by a string of parameters (some commands have no parameters, some have one, and some have several). Commands are entered by typing the mnemonic followed by the value of each parameter in order and ending with the Enter key. Spaces are used to separate the mnemonic and all the parameters.

An example command is the command to add an endpoint in VISM which can be used to defined one end of a connection. The command is Add Endpoint and its mnemonic is addendpt. This command has three parameters, namely, an endpoint number (to identify the endpoint from other endpoints), the ds1 line to be associated with the endpoint, and the ds0 channel within the ds1 line to be associated with the endpoint. The format of this command is:

addendpt <endpoint_num> <ds1_num> <ds0_num>

where

<endpoint_num>

An endpoint number in the range 1-240 for E1 and 1-192 for T1.

<ds1_num>

The physical line number in the range 1-8

<ds0_num>

The ds0 configured for this endpoint. ds0s are numbered 1 to 31 for E lines and 1 to 24 for T lines.


:

Thus, for example, to add an endpoint with number 10 which defines ds1 number 4 and ds0 channel number 3, the command is:

addendpt 10 4 3 (Enter)

Some commands require a parameter identifier to be entered before the parameter value. The clear alarm is an example of such a command. The format of this command is:

clralm -ds1 <LineNum>

The parameter is LineNum but requires the identifier "-ds1" to be entered also. Thus to clear alarms on line 4, the command is:

clralm -ds1 4

This chapter describes each command is detail including parameter identifiers where required.

General Command Items

Command Sequences

Many operations require several commands to be executed in a prescribed sequence. For example, configuring a line (such as addccs) requires the addln (addline) command to be executed before a configuration can take place. Likewise, the same principle applies when deleting an item in which the items are deleted in the reverse order in which they were added. Using the same example, if a line has CCS added through the addccs command, it must first be deleted (delccs) before the line can be deleted.

In most cases, if a user attempts to execute a command in the wrong sequence, a message indicating such is displayed.

Mandatory/Optional Commands

There are certain mandatory commands that must be executed before the VISM card is fully operational. The remaining commands are optional and, for these commands, VISM will assume default values for their parameters unless they are executed with other specific parameter values.

The mandatory commands (in order of execution) are shown in Table 7-1.

Table 7-1 Mandatory Commands 

VoIP Mode
AAL2 Trunking Mode

cnfvismmode

Configure VISM mode

cnfvismmode

Configure VISM mode

cnfvismip

Configure VISM IP address

   

cnfcac

Configure CAC

cnfcac

Configure CAC

addln

Add line

addln

Add line

addendpt

Add endpoing

addendpt

Add endpoing

addcon

Add connection

addcon

Add connection

cnflnsig

Configure line signaling

cnflnsig

Configure line signaling

adddn

Add domain name

addcasvar

Add CAS variant

cnftftpdn

Configure TFTP domain name

cnfcasendpt

Configure CAS endpoint

addcasvar

Add CAS variant

addcid

Add channel id

cnfcasendpt

Configure CAS endpoint

cnfcassig

Configure CAS signaling

cnfgwis

Configure gateway in service

addccs

Add CCS

   

cnfgwis

Configure gateway in service


Logging In

Before commands can be entered, the user must first log onto the system. This process requires a valid user name and password that are known to the MGX 8850 (see the MGX 8850 Command Reference for details)

When a connection is made, either serial or through Telnet, the logging in process consists of:

1. Entering your user name followed by pressing the Enter key in response to a prompt requesting user name.

2. Entering your password followed by pressing the Enter key in response to a prompt requesting a password.

3. The system responds by asking for a card number (slot number).

Login: cisco                                                                    
password:                                                                       
card number [7]:

If the slot number of the VISM card to be configured is known, enter that number and press the Enter key.

If the VISM slot number is not known, enter the number 7 or 8 to logon to the active PXM card, which is in either slot 7 or 8, and then enter the dspcds (display cards) command. This displays the card installed in each slot in the shelf as shown below.

NODENAME.1.7.PXM.a >   dspcds                                                                          
    Slot  CardState    CardType     CardAlarm  Redundancy                       
    ----  -----------  --------     ---------  -----------                      
    1.1   Empty                     Clear                                       
    1.2   Active       VISM-8T1     Clear                                       
    1.3   Empty                     Clear                                       
    1.4   Empty                     Clear                                       
    1.5   Empty                     Clear                                       
    1.6   Empty                     Clear                                       
    1.7   Active       PXM1-OC3     Minor                                       
    1.8   Empty                     Clear                                       
    1.9   Active       VISM-8E1     Clear                                       
    1.10  Empty                     Clear                                       
    1.11  Active       VISM-8T1     Clear                                       
    1.12  Boot         VISM-8T1     Clear                                       
    1.13  Active       VISM-8T1     Clear                                       
    1.14  Active       VISM-8E1     Clear                                       
    1.15  Empty                     Clear                                       
    1.16  Empty                     Clear                                       
    1.17  Empty                     Clear                                       
    1.18  Empty                     Clear                                       
    1.19  Empty                     Clear                                       
Type <CR> to continue, Q<CR> to stop:                                           
    Slot  CardState    CardType     CardAlarm  Redundancy                       
    ----  -----------  --------     ---------  -----------                      
    1.20  Empty                     Clear                                       
    1.21  Boot         VISM-8T1     Clear                                       
    1.22  Empty                     Clear                                       
    1.25  Reserved     VISM-8E1     Clear                                       
    1.26  Empty                     Clear                                       
    1.27  Empty                     Clear                                       
    1.28  Active       VISM-8E1     Clear                                       
    1.29  Empty                     Clear                                       
    1.30  Empty                     Clear                                       
    1.31  Empty                     Clear                                       
    1.32  Empty                     Clear 

Locate the slot number of the VISM card to be configured and use the cc (change cards) command with the desired VISM card slot number to switch to the required VISM card.

NODENAME.1.7.PXM.a > cc 9                                                       
(session redirected)                                                            

The command line prompt shows the name of the shelf, the number of the shelf (which is always "1"), the slot number and type for the current card, and whether the card is in the active ("a") or standby state ("s"). The following is an example of the command line prompt:

NODENAME.1.9.VISM8.a 

In this example, the current card is an active VISM in slot 9, and the name of the node is "NODENAME".

When the VISM prompt is displayed, commands can be entered and executed by the selected VISM card.

Logging Out

To end a CLI session and log out of the system, enter either the bye command or the logout command.

VISM Commands

The VISM CLI Command set are listed in the following tables.

Table 7-2 lists all the VISM commands in alphabetical order.


Note Not all commands are applicable to all modes. The X's in the table indicate which commands apply to the VoIP mode and which apply to the AAL2 Trunking mode.


Table 7-3 lists VoIP mode commands in alphabetical order.

Table 7-4 lists VoIP mode commands by functional group. For example, the Card Group includes those commands that refer to the VISM card as a whole, the DSP Group includes those commands that refer to the Digital Signal Processors.

Table 7-5 lists AAL2 Trunking mode commands in alphabetical order.

Table 7-6 lists AAL2 Trunking mode commands by functional group.

A description of each VISM command, arranged in alphabetical order, follows the command tables. If the mnemonic of a command is known, the Index at the end of this document can be used to obtain the page number of the description of that command.

Table 7-2 All VISM Commands in Alphabetical Order 

Command
Description
Group
VoIP
Mode
AAL 2 PVC
Mode

?

help

User

X

X

addcasvar

add CAS variant

Call agent

X

 

addccs

add common channel signaling

Signaling

 

X

addcid

add channel identifier

Connection

 

X

addcon

add connection

Connection

X

X

addconloop

add connection loop

Connection

X

X

adddn

add domain

Call agent

X

 

addendpt

add endpoint

Connection

X

X

addendpts

add endpoints

Connection

X

X

addendptloop

add endpoint loopback

Connection

X

X

addlapd

add lapd

Signaling

X

 

addln

add line

Line

X

X

addlnloop

add line loop

Line

X

X

addmgc

add call agent

Call agent

X

 

addmgcprotocol

add call agent protocol

Call agent

X

 

addport

addport

Card

X

X

addses

add session

Signaling

X

 

addsesgrp

add session group

Signaling

X

 

addsesset

add session set

Signaling

X

 

addrscprtn

addresource partition

Card

X

X

cc

change card

User

X

X

chkflash

check flash memory

User

X

X

clralm

clear alarm

Alarm

X

X

clralmcnts

clear alarm counts

Alarm

X

X

clralms

clear alarms

Alarm

X

X

clrsarcnt

clear SAR counters

Card

X

X

clrsarcnts

clear SAR counters

Card

X

X

clrsarmsgcnt

clear SAR message count

Card

X

X

clrscn

clear screen

User

X

X

clrtaskinfo

clear task information

Card

X

X

cnfaal2subcellmuxing

configure AAL2 sub-cell multiplexing

Connection

 

X

cnfalm

configure alarm

Alarm

X

X

cnfcac

configurfe CAC

Connection

X

X

cnfcascode

configure CAS coding

Connection

 

X

cnfcasendpt

configure CAS endpoint

Connection

X

 

cnfcasvar

configure CAS variant

Connection

X

 

cnfcodecparams

configure codec parameters

DSP

X

 

cnfcodectmpl

configure codec template

Card

X

X

cnfcompsize

configure compression packet size

DSP

X

X

cnfcompvad

configure compression VAD

DSP

X

X

cnfcon

configure connection

Connection

X

X

cnfconcac

configure connection CAC

Connection

 

X

cnfconprotect

configure connection protection

Connection

X

 

cnfdeftos

configure type of service

Connection

X

 

cnfds0localcas

configure ds0 local CAS

Signaling

X

X

cnfds0loop

configure ds0 loopback

Line

X

X

cnfecanenable

configure echo canceler enable

DSP

X

X

cnfecannrn

configure echo canceler nrn

DSP

X

X

cnfecanrec

configure echo canceler rec

DSP

X

X

cnfecantail

configure echo canceler tail

DSP

X

X

cnfecantone

configure echo canceler tone

DSP

X

X

cnfendptcadence

configure endpoint cadence

Signaling

X

 

cnferl

configure echo return loss

DSP

X

X

cnfgwis

configure VISM in service

Card

X

 

cnfgwoos

configure VISM out of service

Card

X

 

cnfjtrinitdelay

configure initial jitter delay

DSP

X

X

cnfjtrmode

configure jitter mode

DSP

X

X

cnflapdretrans

configure lapd retransmissions

Signaling

X

 

cnflapdtimer

configure lapd timer

Signaling

X

 

cnflapdtype

configure lapd type

Signaling

X

 

cnflapdwinsize

configure lapd window size

Signaling

X

 

cnfln

configure line

Line

X

X

cnflnis

configure line in service

Line

X

 

cnflnoos

configure line out of service

Line

X

 

cnflnsig

configure line signal

Line

 

X

cnflntrunkcond

configure line trunk conditioning

Line

 

X

cnfmgc

configure call agent

Call agent

X

 

cnfrtcprepint

configure RTCP report interval

Call agent

X

 

cnfrtprxtimer

configure RTP recieve timer

Call agent

X

 

cnfsesack

configure session acknowledgements

Signaling

X

 

cnfsesmaxreset

configure session maximum resets

Signaling

X

 

cnfsesmaxseg

configure session maximum segments

Signaling

X

 

cnfsesmaxwindow

configure session maximum window size

Signaling

X

 

cnfsesnullsegtmout

configure session null segment timeouts

Signaling

X

 

cnfsesesoutofseq

configure session out of sequence

Signaling

X

 

cnfsesport

configure session port

Signaling

X

 

cnfsesretrans

configure session retransmissions

Signaling

X

 

cnfsesstatemout

configure session state timeout

Signaling

X

 

cnfsessyncatmps

configure session sync attempts

Signaling

X

 

cnfsrcppeer

configure srcp peer UDP port

Call agent

X

 

cnftftpdn

configure TFTP domain name

Card

X

X

cnfvismdn

configure vism domain

Card

X

 

cnfvismip

configure vism IP address

Card

X

 

cnfvismmode

configure mode

Card

X

X

cnfxgcpinteropsdpost

Configure xgcp PSD OST interoperability

Call agent

X

 

cnfxgcpmwd

configure xgcp max. wait delay

Call agent

X

 

cnfxgcppeer

configure xgcp peer

Call agent

X

 

cnfxgcpretry

configure xgcp retries

Call agent

X

 

delcasvar

delete CAS variant

Signaling

X

 

delccs

delete common channel signaling

Signaling

 

X

delcid

delete channel identifier

Connection

 

X

delcon

delete connection

Connection

X

X

delconloop

delete connection loopback

Connection

X

X

deldn

delete domain name

Call agent

X

 

delendpt

delete endpoint

Connection

X

X

delendptloop

delete endpoint loopback

Connection

X

X

delendpts

delete endpoints

Connection

X

X

dellapd

delete lapd

Signaling

X

 

delln

delete line

Line

X

X

dellnloop

delete line loop

Line

X

X

delmgc

del call agent

Call agent

X

 

delmgcprotocol

delete call agent protocol

Call agent

X

 

delport

delete port

Card

X

X

delrscprtn

delete resource partition

Card

X

X

delaes

delete session

Signaling

X

 

delsesgrp

delete session group

Signaling

X

 

delsesset

delete session set

Signaling

X

 

dspaal2profile

display AAL2 profile

Connection

 

X

dspalm

display alarm

Alarm

X

X

dspalmcnf

display alarm configuration

Alarm

X

X

dspalmcnt

dispaly alarm count

Alarm

X

X

dspalms

display alarms

Alarm

X

X

dspcarddsp

display card DSPs

DSP

X

X

dspcasendpts

display CAS endpoints

Signaling

X

 

dspcasvar

dsplay CAS variant

signaling

X

 

dspcasvars

display CAS variants

signaling

X

 

dspcasvarendpts

display CAS variant endpoints

Signaling

X

 

dspcasxgcps

display CAS XGCP

Call agent

X

 

dspccs

display common channel signaling

Connection

 

X

dspccschans

display CCS channels

Signaling

 

X

dspccscnt

display CCS counters

Signaling

 

X

dspcd

display card

Card

X

X

dspcid

display channel identifier

Connection

 

X

dspcids

display channel identifiers

Connection

 

X

dspcodecparams

display codec parameters

DSP

X

 

dspcodectempls

display codec template

DSP

X

X

dspcon

display connection

Connection

X

X

dspconcac

display channel CAC

Connection

 

X

dspconcnt

display channel counters

Connection

X

X

dspcons

display connections

Connection

X

X

dspdn

display domain name

Call agent

X

 

dspdns

display domain names

Call agent

X

 

dspds0localcasstatus

display ds0 local status

Signaling

X

X

dspds0loop

display ds0 loopback

Line

X

X

dspendpt

display endpoint

Connection

X

X

dspendpts

display endpoints

Connection

X

X

dspgwstate

display VISM

Card

X

 

dsplapd

display lapd

Signaling

X

 

dsplapds

display lapds

Signaling

X

 

dsplapdstat

display lapd statistics

Signaling

X

 

dspln

display line

Line

X

X

dsplncids

display line CIDs

Connection

 

X

dsplndsp

display line DSP

DSP

X

X

dsplndsx0s

dsplay line ds0s

Line

X

X

dsplnendptstatus

display endpoint status

Connection

X

X

dsplns

display lines

Line

X

X

dsplnstate

dsplay line state

Line

Xx

X

dsploops

dsplay loopbacks

Connection

X

X

dspmaxmgcs

display maximum number of call agents

Call agent

X

 

dspmgc

display call agent

Call agent

X

 

dspmgcprotocols

display call agent protocol

Call agent

X

 

dspmgcs

display call agents

Call agent

X

 

dspmgprotocols

display gateway control protocols

Call agent

X

 

dspmngcidcnt

display cid count

Connection

 

X

dspport

display port

Card

X

X

dsprscprtn

display resource partition

Card

X

X

dspsarcnt

display SAR counters (line

Card

X

X

dspsarcnts

display SAR counters (all)

Card

X

X

dspsarmsgcnt

display SAR message counters

Card

X

X

dspses

display session

Signaling

X

 

dspsesgrp

display session group

Signaling

X

 

dspsesgrps

display session groups

Signaling

X

 

dspsess

display session sessions

Signaling

X

 

dspsesset

display session set

Signaling

X

 

dspsesstat

display session statistics

Signaling

X

 

dspsrcpcnt

display SRCP counters (line)

Call agent

X

 

dspsrcpcnts

display SRCP counters (all)

Call agent

X

 

dspsrcpeer

display SRCP peer UDP port

Call agent

X

 

dspsrcpeers

display SRCP peer UDP ports

Call agent

X

 

dspsrcpport

display SRCP UDP port

Call agent

X

 

dsptaskinfo

display task information

Card

X

X

dspvismdn

display card domain

Card

X

 

dspvismip

display vism IP address

Card

X

 

dspvismparam

display VISM parameters

Card

X

X

dspxgcpcnf

display xgcp configuration

Call agent

X

 

dspxgcpcons

display xgcp connections

Call agent

X

 

dspxgcpdefpxg

display xgcp default package

Call agent

X

 

dspxgcpdetailcnt

display xgcp detail count

Call agent

X

 

dspxgcpdetailcnts

display xgcp detail counts

Call agent

X

 

dspxgcpinterops

display xgcp interoperability

Call agent

X

 

dspxgcperrcnt

display xgcp error count

Call agent

X

 

dspxgcppeer

display xgcp peer

Call agent

X

 

dspxgcpport

display xgcp port

Call agent

X

 

dspxgcpcnt

display xgcp count

Call agent

X

 

dspxgcpcnts

display all xgcp counts

Call agent

X

 

Help

help

User

X

X

pinglndsp

ping line dsp

DSP

X

X

tstcon

test connection

Connection

X

X

tstdelay

test delay

Connection

X

X

version

version

Card

X

X


Table 7-3 VoIP Mode Commands in Alphabetical Order 

Command
Description

?

help

addcasvar

add CAS variant

addcon

add connection

addconloop

add connection loop

adddn

add domain

addendpt

add endpoint

addendptloop

add endpoint loopback

addendpts

add endpoints

addlapd

add lapd

addln

add line

addlnloop

add line loop

addmgc

add call agent

addmgcprotocol

add call agent protocol

addport

addport

addses

add session

addsesgrp

add session group

addsesset

add session set

addrscprtn

addresource partition

cc

change card

chkflash

check flash memory

clralm

clear alarm

clralmcnts

clear alarm counts

clralms

clear alarms

clrsarcnt

clear SAR counters

clrsarcnts

clear SAR counters

clrsarmsgcnt

clear SAR message count

clrscn

clear screen

clrtaskinfo

clear task information

cnfalm

configure alarm

cnfcac

configurfe CAC

cnfcasendpt

configure CAS endpoint

cnfcasvar

configure CAS variant

cnfcodecparams

configure codec parameters

cnfcodectmpl

configure codec template

cnfcompsize

configure compression packet size

cnfcompvad

configure compression VAD

cnfcon

configure connection

cnfconprotect

configure connection protection

cnfdeftos

configure type of service

cnfds0localcas

configure ds0 local CAS

cnfds0loop

configure ds0 loopback

cnfecanenable

configure echo canceler enable

cnfecannrn

configure echo canceler nrn

cnfecanrec

configure echo canceler rec

cnfecantail

configure echo canceler tail