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