Corporate Headquarters
Cisco H.323 Signaling Interface User Guide
Cisco H.323 Signaling Interface User Guide
N T E N T S
Introduction to MML Command Operation for HSI
Hairpin 38 Fax
RADVision Logging
Eisuppathfailure
Endpointcallcontrolinterfacefailure
MML Help
OL-4806-01 Rev. A14
Skeleton Configuration File
Xii
Audience
System Administrator
Document Objectives
System Operator
Document Organization
System Technician
This document is organized as follows Preface
Document Conventions
Command abc
Meaning Comments and Examples
Boldface
Related Documentation
Global configuration mode
Release Notes
Hardware Documentation
Software Documentation
Obtaining Documentation
Related Documentation
World Wide Web
Ordering Documentation
Obtaining Technical Assistance
Documentation Feedback
Cisco.com
Cisco TAC Web Site
Technical Assistance Center
Cisco TAC Escalation Center
Cisco HSI Overview
Introduction
IP Network
Cisco HSI System Description
PGW
Call Control Subsystem
OAM Subsystem
Operational Environment
New Features in Cisco HSI Release
Hardware Requirements
RADVision H.323
Cisco HSI does not implement security features
Cisco HSI Recovery
Cisco HSI System Limitations
Software Requirements
OL-4806-01 Rev. A14
Hardware and Software Requirements
Installing and Configuring Cisco HSI Software Introduction
Installing the Operating System
Configuring Groups and Users
Installing the Cisco HSI
Check Preinstallation Task
Before You Start
Source /opt/GoldWing/currentPM/local/setup.gw.csh
Cisco HSI Installation Information
# vi .cshrc
# chmod 777 .cshrc
Subdirectory Contents
# tar xvf GoldWing-4.1.tar
Installing Cisco HSI
This command displays the following text
Following text displays
# cd /export/BUILDS/4.1 # ./install.sh
Type the VSC1 name and press Enter Following text displays
## Executing checkinstall script. Modified Environment is
VERSION=4.1
Cisco HSI-A
Starting the Cisco HSI
Dual HSI Example Configuration Script
Example
# /etc/init.d/CiscoGW start
Stopping the Cisco HSI
Configuring the Cisco HSI
Upgrading the Cisco HSI
# /etc/init.d/CiscoGW stop
# cd /opt/GoldWing # ls -l
# ./uninstall.sh
Removing the Cisco HSI
Type y and press Enter. The following text displays
## Removing installed package instance OTTgw000
Provisioning the Cisco HSI
Cisco HSI Configuration
Command
MML Configuration Commands
Command Description
Prov-sta Prov-cpy Prov-stp
Initiating an MML Session to Enable Dtmf on the HSI
Introduction to MML Command Operation for HSI
Verifying the Configuration
Etc/init.d/CiscoGW start
Static System Data
System Configuration Data
Reverting to the Base Configuration
Parameter Type Description
Can receive T.38 FAX data. The default value is
Parameter, set it to Enabled
Default value is 0xc8
Option. The default value is
Changing Static System Data
Issue the command restart-softwconfirm
Dynamic System Data
Parameter Description Default
OVLDLEVEL3PERCENT
OVLDLEVEL1PERCENT
OVLDLEVEL1FILTER
OVLDLEVEL1THRESHLOWER
Stack Configuration
MML Provisionable Data
Nonprovisionable Data
System Parameters
Parameters
Prov-addname=q931,maxCalls=2000
Parameter Name Description Type Example Update Type
Null
Parameter Name Description Type Example
RAS Parameters
ManualRAS If this parameter is present
Prov-addname=ras,maxfail=3
AllowCallsWhenNonReg If this parameter is present, it
R0.2.4 Immediate Assigns to each version
Prov-addname=h245,masterSlave.timeout=5
String H323ESP
Parameter Name Type
Update
INTEGER0,1
Parameter Name Parameter Value Description
Codec Selection
Quick Reference for Important Parameters
14presents important static system data parameters
Parameter Name Parameter Values Description
15presents common RAS parameters
VSCBIPADDR1/2
VSCBPORTNUMBER1/2
Parameter Name Parameter Value
HSI Feature Configuration
Hairpin
Asymmetric Codec Treatment
Empty Capability Set
Configuring T.38 Fax on a Cisco IOS H.323 Gateway
Configuring T.38 Fax on the Cisco Pstn Gateway
Configuring T.38 Fax on a Cisco IOS Mgcp Gateway
38 Fax
Prov-addname=sysconfigstatic,informationmsgdisabled = True
Configuring Clear Channel on the Cisco HSI
HSI Support for Tech Prefixes
Prov-edname=ccpackage,hash=C
Clear Channel Parameters Example Value Example Configuration
Configuring G.726 on the Cisco HSI
Configuring Cisco HSI g726-cisco
Parameter Example Value Configuration Example
Configuring the Payload Type for the Mgcp
Configuring Cisco HSI g726-generic
OL-4806-01 Rev. A14
Parameter
Configuring G.729 Annex and G.729 Annex B
OL-4806-01 Rev. A14
Stopping Call Processing
Restarting the Cisco HSI Application
Stopping the Call Processing Application
Starting Call Processing
Starting the Call Processing Application
Reporting the Cisco HSI Status
Counter Name Measurement Type Comments
Call-Related Measurements
Fcinccallsucctot
Fcinccallatttot
Fcotg Callatttot
Fcotgcallsucctot
Masterslaveatttot
Avgroundtripdelay
Masterslavesucctot
Termcapxchgatttot
Retrieving Counters
Resetting Measurements
Overload
Overload Level
Retrieving Overload Data
Setting Overload Data
Following MML commands set overload data
Rotating Log Files
Logging
Convention for Naming the Log File
Log File Location
Logging Levels
Log Messages
Log Message Packages
Log messages have the following format
Setting Logging Levels
Setting Gapping
Gapping
RADVision Logging
Set-gappingbothcalltype=all,percent=60
Retrieving Call Gapping Data
Debounce
Alarms Overview
Alarm Severity Levels
Snmp Trap Types
Retrieving and Reporting Alarms
Informational Event Requirements
Severity Level Description
Noncontinuous Mode
Retrieving Alarm Messages
Continuous Mode
To display all current alarms, use the rtrv-almsMML command
Element Description
Acknowledging and Clearing Alarms
SystemId Name of your device and its identifier
YYYY-MM-DD
Alarm Event and Reference Severity Level
Alarms List
Troubleshooting
Troubleshooting
Description
Severity Level and Trap Type
Eisuppathfailure
One of the two links to a single Cisco PGW 2200 has failed
This alarm has not been implemented
Lowdiskspace
Percentage of disk usage is greater than the alarm limit
Vscfailure
Use the clr-almcommand to attempt to clear the alarm
Severity level is minor. The trap type is
Running configuration has been modified
Severity level is information. The trap type is
This is an informational event
Endpointcallcontrolinterfacefailure
RADVision stack reports this alarm
Gappedcallnormal
OVERLOADLEVEL1
User has entered the stp-callproccommand through the MML
Provisioningsessiontimeout
Detailed Logging
Etc/init.d/CiscoGW start Exit out of superuser
MML User Interface and Command Reference Introduction
Starting an MML Command Session in the Cisco HSI
MML Command Conventions
MML Commands
MML Command Syntax
Starting an MML Session
Symbol Description
Case Sensitivity
Mml
Starting a Batch File
Batch Files
Creating a Batch File
Status Messages
MML Responses
Status Message Description
Rtrv
Error Message Definition Description
Error Messages
MML Help
Quitting an MML Session
This section describes the following MML commands
MML Command Reference
Ack-alm
Ack-almevent=alarm event
Clr-alm
Clr-almcommand clears an alarm event
Clr-almevent=alarm event
Examples
Diaglog
Start
Help
End
Redisplay
RTRV-CTR
Helprtrv-ctr
Prov-add
Prov-addcommand adds a component to the Cisco HSI
Confirm
Prov-cpy
Usage Guidelines
Prov-add
Related Commands Description
Sysconfigstatic Sysconfigdynamic H323sys Ras H245 Q931
Prov-dlt
Session
Gw mml prov-edname=ras,maxfail=7
Prov-edcommand modifies a provisioned component
Prov-ed
Installation
MML batch feature to import the exported data
Prov-exp
Prov-stasrcver=active, dstver=dummy1
Prov-rtrv
Gw mml prov-rtrvname=ras
Name ras
Gw mml prov-rtrvsession
Gw mml prov-rtrvlist
Prov-stasrcver=version,dstver=version
Prov-sta
Prov-stpconfirm prov-stpsession nameconfirm
Prov-stp
Session name
Process that started the provisioning session
Gw mml prov-stpmml2confirm
Gw mml prov-stpconfirm
Gw mml prov-stpuk9confirm
Radlog
Quit
Quit
Radlogfile namestart stop
Restart-softw
Gw mml restart-softwconfig2
Gw mml restart-softwinit
Gw mml restart-softw
Rtrv-alms rtrv-almscont
Rtrv-alms
Cont
Ack-alm
Rtrv-calls
Clr-meas Resets a measurement counter
Rtrv-ctr
Syntax Description Examples
Service is or out of service OOS
Signalling path to the PGW
Rtrv-dest
Set-dest-state
Syntax Description
Rtrv-gapping
Rtrv-log
Rtrv-mml
Rtrv-ne-health
Rtrv-ne
Rtrv-ne
Status of the Cisco HSI
Rtrv-overload
Rtrv-overload
Gw mml rtrv-ne-health
Gw mml rtrv-overload
Gw mml rtrv-softw
Rtrv-softw
Rtrv-dest
Set-dest-state
OOS
Set-gapping
Package
Set-log
One of the packages in the Cisco HSI
Data to be activated
Level 1 level 2 level
Set-overload
Lower=number
Upper=number
Sta-softw
Related Commands Retrieve
Sta-callproc
Sta-callproc Starts call processing
Sta-trccommand starts the call processing tracing function
Sta-trc
Stp-callcallref=x stp-callall
Stp-call
Callref
Rtrv-calls
Stp-callproc
Stp-callproctimeout=T
Sta-trc Starts the call processing tracing function
Stp-trc
Stp-trc
OL-4806-01 Rev. A14
RASmaxFailD1-200
Skeleton Configuration File
Sysconfigstatic HOSTPORTNUMBER1 S
Sysconfigstatic
Sysconfigstatic HOSTPORTNUMBER2 S
Sysconfigstatic VSCAPORTNUMBER2
CCECCugAccessBarred
CCECChannelOutOfService
CCECNetworkAddressExtensionError S
CCECOperatorPriorityAccess
Sysconfigstatic CCECPrefix1DialledInError
Sysconfigstatic CCECPrefix0DialledInError
Sysconfigstatic CCECPrefix1NotDialled
Sysconfigstatic CCECPriorityForcedRelease
Sysconfigdynamic
ResponseTimeOut 200
AlarmDebounceTime 60000
OvldLevel2ThreshUpperCPU 100
OvldLevel3Percent 100
Q931 OverlappedSending
H245 MasterSlave.timeout 65535 MasterSlave.manualOperation
Q931 EarlyH245
Q931 H245tunneling
H245 Modesi.audio.g711Alaw56k
H245 Modesi.audio.g711Alaw64k
H245 Modesi.audio.g711Ulaw64k
H245 Modesi.audio.g711Ulaw56k
Eisup
Accgdtd
Accgdes
Accnocivc
Accnociecdi
Accwaitrlcfail
Accnumrelretries
Accwaitrelretry
CCPackage CCECServiceOrOptionNotImpUnspec
CCPackage CCECServiceOrOptionNotAvail
CCPackage CCECInvalidElemContents
CCPackage CCECRecoveryOnTimerExpiry
CCPackage CCHCPermanentFrameModeConnectionOutOfService C
CCPackage CCHCExchangeRouteError
CCPackage CCHCSwitchingEquipmentCongestion
CCPackage CCHCAccessInformationDiscarded
CCPackage CCHCInvalidInformationElementContents
CCPackage CCHCServiceOrOptionNotImplemented
CCPackage CCHCRecoveryOnTimerExpiry
CCPackage CCHCBearerCapabilityNotImplemented
Cisco H.323 Signaling Interface User Guide
Trace Trigger2.h323.OriginatingIPAddress
Trace Trigger2.h323.CalledPartyNumber
Trace Trigger2.h323.OriginatingIPMask
Trace Trigger2.h323.TerminatingIPAddress
Eisup Waittimebeforefailovermillisec
Eisup Rudptimercheckperiodmsec
Q931 ConnectTimeoutConst
H323 MaxTimers TickPeriod DefaultSDPt
NumberNoRangeConst
Q931 NonQuotedConst
# Logging Package
Example of an HSI Configuration File
Appendix C Example of an HSI Configuration File
Appendix C Example of an HSI Configuration File
Appendix C Example of an HSI Configuration File
# Call Control Package
Accgdes =
# FCI
Accgdtd =
Accnociecdi = Accnocicci = Accnocisi = Acctmr =
Appendix C Example of an HSI Configuration File
Appendix C Example of an HSI Configuration File
Appendix C Example of an HSI Configuration File
Appendix C Example of an HSI Configuration File
# Gapping Package
# Faultmanagement Package
# Trace Package
Appendix C Example of an HSI Configuration File
# Application Package
# Eisup Package
Alternategatekeeperip
# Dynamic System Data
Alternategatekeeperport = Alternategatekeeperid
Logprio = Trace
OVLDLEVEL2FILTER = Normal
= Cchcdefault
Normal OVLDLEVEL2THRESHUPPERCPU
OVLDLEVEL3FILTER = Normal
CCECBlacklistBNumberMatched
CCECNetworkAddressExtensionError
CCECBlacklistCliLengthInvalid
CCECCallingDroppedWhileOnHold
CCECPrefix1DialledInError
CCECPrefix0DialledInError
CCECProtocolErrorUnspec
CCECRemoteProcError
Appendix C Example of an HSI Configuration File
OL-4806-01 Rev. A14
Name Value
Isup Name-to-Cause Value Lookup
Appendix D E-ISUP Name-to-Cause Value Lookup
Cisco H.323 Signaling Interface User Guide
OL-4806-01 Rev. A14
Value Name
Isup Cause Value-to-Name Lookup
Appendix E E-ISUP Cause Value-to-Name Lookup
Appendix E E-ISUP Cause Value-to-Name Lookup
OL-4806-01 Rev. A14
Name-to-Cause Value Lookup
Appendix F H.323 Name-to-Cause Value Lookup
Cause Value-to-Name Lookup
Appendix G H.323 Cause Value-to-Name Lookup
Lowdiskspace OVERLOADLEVEL1 OVERLOADLEVEL2 OVERLOADLEVEL3
Configchange
Stopcallprocessing
Vscfailure
Codec parameters Commands ack-alm clr-alm clr-meas diaglog
Clr-meas command
Configchange alarm
Data Configurable B-1 Constant B-1
Endpointcallcontrolinterfacefailur
Isup
Endpointchannelinterfacefailure
HSI
Man-machine language
MML commands case sensitivity A-3conventions A-2
Codec Dynamic system data 245 System
Alarmdebouncetime Ciagentscanperiod
Logdirectory Logfilerotateinterval Logfilerotatesize
Nonprovisionable data OverlappedSending
Reliable User Datagram Protocol
Related documentation
931 See Rudp
Pkinst file
Vscfailure alarm
Stp-softw command
Snmp
Manager MIB Subagent