-
Cisco H.323 Signaling Interface User Guide, Release 4.3
-
Cisco H.323 Signaling Interface
-
Installing and Configuring Cisco HSI Software
-
Provisioning the Cisco HSI
-
Managing the Cisco HSI
-
Troubleshooting Cisco HSI Alarms
-
Cisco HSI Backup and Restore Procedures
-
MML User Interface and Command Reference
-
Skeleton Configuration File
-
Example of an HSI Configuration File
-
E-ISUP Name-to-Cause Value Lookup
-
E-ISUP Cause-to-Name Value Lookup
-
H.323 Name-to-Cause Value Lookup
-
H.323 Cause-to-Name Value Lookup
-
Table Of Contents
Restarting the Cisco HSI Application
Stopping the Call Processing Application
Starting the Call Processing Application
Reporting the Cisco HSI Status
Convention for Naming the Log File
Managing the Cisco HSI
Revised: April, 2010, OL-11616-08Introduction
This chapter provides information about operation and management tasks for the Cisco H.323 Signaling Interface (HSI) application. This chapter contains the following sections:
•
Restarting the Cisco HSI Application
•
•
•
Restarting the Cisco HSI Application
To restart the Cisco HSI at the MML command prompt, use the restart-softw MML command. For more information about this command, see Appendix A, "MML User Interface and Command Reference."
To start the Cisco HSI application, see the "Installing the Cisco HSI" section on page 2-2.
Stopping Call Processing
To stop call processing, use the stp-callproc MML command. This command causes the handling of new call requests to cease immediately, and, if no timeout period is specified, all existing calls are released immediately. If a timeout period is specified, existing calls are released after the specified amount of time has elapsed. For more information about the stp-callproc command, see Appendix A, "MML User Interface and Command Reference."
Starting Call Processing
To start call processing, use the sta-callproc MML command. For more information about this command, see Appendix A, "MML User Interface and Command Reference."
Stopping the Call Processing Application
To stop the call processing application, use the stp-softw MML command. For more information about this command, see Appendix A, "MML User Interface and Command Reference."
Starting the Call Processing Application
To start the call processing application, use the sta-softw MML command. For more information about this command, see Appendix A, "MML User Interface and Command Reference."
Reporting the Cisco HSI Status
To display the status of the Cisco HSI, use the rtrv-softw MML command. For more information about this command, see Appendix A, "MML User Interface and Command Reference."
Measurements
The following sections describe two measurement categories:
•
•
System-Related Measurements
The CIagent is a Simple Network Management Protocol (SNMP) subagent. It handles the collection and storage of the following system performance measurements:
•
•
•
•
Use the CIAGENTSCANPERIOD parameter to define the period that the CIagent polls the CPU for utilization (see Chapter 3, "Provisioning the Cisco HSI").
Call-Related Measurements
The Cisco HSI application handles all call-related measurements. An SNMP MIB handles the collection of call-related measurement data.
The call-related measurements are organized into counter groups. The following MML counter groups are required:
•
•
•
The measurements in these groups are written to a file on disk every 30 minutes. The file name includes the date and time that measurements were written to disk.
Resetting Measurements
The clr-meas MML command resets the measurement counters. This command resets an individual counter or all counters in a counter group. The following are valid counter groups:
•
•
•
For more information about the clr-meas command, see Appendix A, "MML User Interface and Command Reference."
Retrieving Counters
Use the rtrv-ctr MML command to retrieve measurement counters. This command displays the measurements for a counter group. Valid counter groups are RAS, Q.931, and H.245. For more information about the rtrv-ctr command, see Appendix A, "MML User Interface and Command Reference."
Overload
The system continuously checks call totals and CPU utilization. Each of these values is compared to predefined limits. Three call total limits are available. Each limit has a hysteresis value and an alarm associated with it. When the call total reaches the limit, an alarm is raised. When the call total falls below the limit minus the hysteresis value, the alarm is cleared after the appropriate recovery action is taken.
Cisco HSI supports the following three levels of overload:
•
•
•
The following factors can trigger any one of the overload levels:
•
•
Disk usage can trigger a LOW_DISK_SPACE alarm. For more information about this alarm, see Chapter 5, "Troubleshooting Cisco HSI Alarms."
Overload Level 1
Use the following configuration parameters for overload level 1 (see Chapter 3, "Provisioning the Cisco HSI"):
•
•
•
•
•
•
Overload Level 2
Use the following configuration parameters for overload level 2 (see Chapter 3, "Provisioning the Cisco HSI"):
•
•
•
•
•
•
Overload Level 3
Use the following configuration parameters for overload level 3 (see Chapter 3, "Provisioning the Cisco HSI"):
•
•
•
•
•
•
Setting Overload Data
The following MML commands set overload data:
set-overload:level1|level2|level3:cpu, lower=number, upper=number
set-overload:level1|level2|level3:calls, lower=number, upper=number
set-overload:level1|level2|level3:gap, filter=normal|all, percent=number
The upper parameter specifies the threshold for overload detection, and the lower parameter specifies the hysteresis point at which the overload condition is removed.
The lower value should be greater than the upper value of the next lower severity level.
For example:
set-overload:level1:cpu, lower=45, upper=50
set-overload:level1:gap, filter=normal, percent=50
set-overload:level2:cpu, lower=63, upper=70
set-overload:level2:gap, filter=normal, percent=75
set-overload:level3:cpu, lower=81, upper=90
set-overload:level3:gap, filter=normal, percent=95
These values mean that:
•
•
•
•
•
Note
Refer to the Cisco Media Gateway Controller Software Release 9 Provisioning Guide for further information.
Retrieving Overload Data
Use the rtrv-overload MML command to display the overload status and related overload data. For information about this command, see Appendix A, "MML User Interface and Command Reference."
Logging
To set the logging level of one or more service packages, use the set-log MML command. For more information about this command, see Appendix A, "MML User Interface and Command Reference."
Rotating Log Files
Log files are rotated at system startup or when either of the following conditions occurs:
•
•
Convention for Naming the Log File
Log rotation occurs when the system ceases to write to the current log file and commences to write to a new log file. The LOGFILENAMEPREFIX parameter defines the name of the active log file (see Chapter 3, "Provisioning the Cisco HSI"). The default is platform.log.
When log rotation is triggered, the existing file (for example, platform.log) is renamed with the format platform_yyyymmddhhmmss.log (see Table 4-4). For example, a platform error file rotated on September 30, 1999 at 12:36:24 is renamed platform_19990930123624.
Table 4-4 Log Filename Format
LOGFILENAMEPREFIX
Provisioned filename (default is platform.log)
yyyy
Year
mm
Month
dd
Day
hh
Hour
mm
Minute
ss
Second
Note
Log File Location
The LOGDIRECTORY parameter defines the directory for active log files and rotated log files (see Chapter 3, "Provisioning the Cisco HSI"). The default is $GWHOME/var/log/.
Log Messages
Log messages have the following format:
Date and timestamp, Package Name, <log level>, LogID:<text of the message>.
The following are examples of log messages:
Thu Dec 7 03:55:32:837 2000, Infrastructure, <DEBUG>, 205: GWModule Registration - shutdownList() - NbOfItems 10 - Item 8Thu Dec 7 03:55:32:837 2000, Infrastructure, <DEBUG>, 206 : GWModuleRegistration - shutdownList() - NbOfItems 10 - Item 9Thu Dec 7 03:55:32:838 2000, Infrastructure, <DEBUG>, 207 : GWReactor::thdId() returns 6.Thu Dec 7 03:55:32:838 2000, Infrastructure, <DEBUG>, 208 : GWReactorModule::shutdown() - Thread has joined.Logging Categories
Logging can be enabled on the Cisco HSI for a number of categories. The list below indicates the names of the categories. For each category, 0xffff is the highest log level, and 0x0000 is the lowest log level (the log level is a 16-bit hexadecimal value, which is itself bit-mapped to provide 16 discrete sub-categories per category). The most-significant-bit positions correspond to higher (that is, more processor intensive) levels of debugging. You set logging by using the MML set-log command. For testing in a lab network, you can modify the log levels. For a live network, all log levels always should be set to the default 0x0000 setting, unless advised otherwise by Cisco TAC.
The following service packages can log messages:
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
Note
Setting Log Levels
The set-log MML command dynamically alters the log level setting while the system is running. For more information about the set-log command, see Appendix A, "MML User Interface and Command Reference."
Note
The following examples show the MML commands required to enable EISUP and Provisioning logging and how to disable all logging:
Example 1—Enabling EISUP and provisioning logging
mml>set-log:eisup:level=0xffffset-log:provisioning:level=0xffffExample 2—Disabling all logging
mml>Set-log:all:level=0x0000Extended H.323 Logging
The Cisco HSI application provides the capability (through MML) to initiate extended H.323 logging call-flow debugging in a test network environment. With extended H.323 logging enabled, the Cisco HSI places H.323 message content into the log file in addition to the standard category logging listed earlier. H.323 messages are large, so this extended logging will consume resources while it is running.
You enable extended H.323 logging by issuing the MML command radlog::start. You must set the H.323 category log level to 0xffff for extended logging to operate.
You can switch off extended logging by issuing the command radlog::stop; however, you also must set the H.323 category log level to zero. The command set-log:all:level=0x0000 is not sufficient, you also must execute the command radlog::stop.
If overload level 3 occurs, the H.323 category log level is set to zero automatically; however, you still must issue the command radlog::stop.
Caution
The following examples show the MML commands you issue to start and stop extended H.323 logging.
Example 1—Enabling extended H.323 logging
mm>set-log:h323:level=0xffffradlog::startExample 2—Disabling extended H.323 logging
mml>radlog:stopset-log:h323:level=0x0000Logging Shortcuts
If the Cisco HSI is restarted, all log levels are reset to 0x0000, and extended H323 logging is switched off.
During a test network configuration, it is useful to be able to enable logging rapidly. You can do so from the Unix command line prompt by issuing the calllog command (assuming that you have run the script setup.gw.csh or sourced the script within the your user .cshrc file).
This Unix alias command automatically sets the three most popular log levels to 0xffff, and automatically enables extended H.323 logging.
To disable all logging from the Unix command line prompt, issue the nolog command.
Interpreting the HSI Log File
To debug an individual call (in a test network), enable the following three items of logging: H323, EISUP, and CallControl. In addition, you can issue the command radlog::start.
The following commands enable full logging for the three main modules, which are the most useful:
set-log:eisup:level=0xffffset-log:callcontrol:level=0xffffset-log:h323:level=0xffffradlog::startTo check that logging has been enabled, enter the command rtrv-log.
The radlog::start command enables extra logging for the H323 module. If the H323 module level is not 0xffff, radlog will not work. The extra logging provided by this command intersperses H.225/H.245 decode into the log file.
Tip
The logged information is recorded in a file called platform.log, in the directory /opt/GoldWing/currentPM/var/log. To move to this directory rapidly, issue the Unix command cdlog.
The following command are helpful when performing logging tasks:
•
•
•
•
Note
Sample Debugging Session
This section presents a sample debugging session that focuses on helpful aspects of the process.
Example
calllogcdloglog_erase<< make the test call >>nologminiparse platform.logParsing file : platform.logPSTN H323---- ----InitialAddress -->--> admissionRequest<-- admissionConfirm--> setup<-- callProceedingAddressComplete <--You can record the log for later retrieval by copying it to a different name, for example:
cp platform.,log mytest.logYou can view the log by issuing the command:
miniparse mytest.logIf you want to see the messages in detail, then you can view the platform.log file in a text editor and search for specific information. For example, if you want to see EISUP messages, search for three hyphens (that is, ---).
Example
---- InitialAddress --------------------------------incoming InitialAddress.CallId = 00000000000000000000011010000010incoming InitialAddress.OriginatingVSCAddress = 00001010001101000100001110000111incoming InitialAddress.NatureOfConnectionInd.EchoControlDeviceInd = 00000001 0x01 1incoming InitialAddress.NatureOfConnectionInd.VirtualCallInd = 00000000 0x00 0incoming InitialAddress.NatureOfConnectionInd.SatelliteInd = 00000000 0x00 0incoming InitialAddress.NatureOfConnectionInd.ContinuityCheckInd = 00000000 0x00 0incoming InitialAddress.ForwardCallInd.NationalInternationalCallInd = 00000001 0x01All parameters are displayed and the message ends with many dashes. The parameter values are EISUP Cisco values, which, usually, are not the same as ISUP.
If you want to see H.323 messages, search for New message (with an uppercase N).
Example
: INFO - New message (channel 38) sent --> setup:: DEBUG - Message:: DEBUG - 0> <1414> Q931Message . SEQUENCE [PRIVATE 1]: DEBUG - 1> . <1929> protocolDiscriminator = 8 . INTEGER (0..2: DEBUG - 1> . <1157> callReferenceValue . CHOICE: DEBUG - 2> . . <2114> twoBytes = 13446 . INTEGER [EMPTY 2] (0: DEBUG - 1> . <990> message . CHOICE ...: DEBUG - 2> . . <1585> setup . SET [EMPTY 5] ...: DEBUG - 3> . . . <1148> bearerCapability . SEQUENCE [EMPTY 4]: DEBUG - 4> . . . . <1500> octet3 . SEQUENCE ...You can vary your searches for information. For example, to search for an incoming H.323 message, search for <--.
To search for an outgoing H.323 message, search for -->.
Gapping
The gapping level can be set from 0 to 100 percent. From 0 to 99 percent, the call type (normal or priority) is checked against the gapping level call status type. At 100 percent gapping, all calls are gapped, regardless of call type.
Setting Gapping
To activate call gapping, complete the following steps:
Step 1
•
•
•
Step 2
•
•
Step 3
Step 4
set-gapping:both:calltype=all,percent=60
Retrieving Call Gapping Data
To retrieve the current levels of call gapping for all gapping clients, enter the rtrv-gapping command. The command displays text similar to the following:
The output shows the gapping levels set by the overload function and the MML command set-gapping. The highest gapping level is used as the level to gap calls, which is indicated as Yes in the column titled Active. In this example, the MML levels for outgoing and incoming calls are active.
