|
|
This appendix describes the following MML commands:
The ack-alm command acknowledges that an alarm event is recognized but does not clear the alarm.
ack-alm:event=alarm event
Syntax Description
alarm event The alarm category or the text that appears in the body of the alarm. Alarm event names are defined in "Cisco HSI Alarms and Troubleshooting."
Usage Guidelines
The format of the alarm category name must be the same as the format of the alarm category name that the rtrv-alms command displays. It is case sensitive.
Examples
This example recognizes the VSC_FAILURE alarm event but does not clear the alarm:
gw mml> ack-alm:event=VSC_FAILURE
GW Signaling Interface 2000-12-05 14:19:22
M SUCC
mml>
Related Commands
clr-alm Clears an alarm event rtrv-alms Displays all active alarms.
Command
Description
The clr-alm command clears an alarm event.
clr-alm:event=alarm event
Syntax Description
alarm event The alarm event name or the text that appears in the body of the alarm. Alarm names are defined in "Cisco HSI Alarms and Troubleshooting."
Usage Guidelines
The alarm category must match the format shown in the alarm when the rtrv-alms command displays it. It is case sensitive.
Examples
This example clears the alarm event VSC_FAILURE.
gw mml> clr-alm:event=VSC_FAILURE
GW Signaling Interface 2000-12-05 14:19:22
M SUCC
mml>
Related Commands
ack-alm Acknowledges that an alarm event is recognized but does not clear the alarm. rtrv-alms Displays all active alarms
Command
Description
The clr-meas command resets a measurement counter.
clr-meas:counter group:name=measurement name
Syntax Description
counter group Valid counter groups are: measurement name For a list of measurement names, see Table 4-1, Table 4-2, and Table 4-3.
Examples
This example resets a measurement counter GK_DISC_ATT_TOT (Gatekeeper Discovery Attempts) in the counter group RAS.
gw mml> clr-meas:RAS
GW Signaling Interface 2000-12-05 14:19:22
M SUCC
mml>
mml> clr-meas:RAS:name=GK_DISC_ATT_TOT
GW Signaling Interface 2000-12-05 14:19:22
M SUCC
Related Commands
rtrv-ctr Displays the measurements for a counter group.
Command
Description
The diaglog command starts and stops event logging into a diagnostics log.
diaglog:file name:start | stop
Syntax Description
file name The user-defined name of the log file. The actual file name has a .log suffix applied. The file is located in the logging directory defined in the configuration data (see "Provisioning the Cisco HSI").
Examples
This example starts event logging into a diagnostics log named test5.
gw mml> diaglog:test5:start
test5_davek15823_20010130053323.log
In this example, davek is the user who runs the command, and 15823 is the process ID of the MML process from which the command is run.
Related Commands
radlog Starts and stops RADVision logging into a specified log file. rtrv-log Displays the logging level of a package or all packages. set-log Sets the logging level of a package or all packages.
Command
Description
The h command redisplays a command or a series of commands, depending on a specified number or range. If no number is specified, only the last command is displayed.
h[::start=number[,end=number]]
Syntax Description
start Entered as a number; specifies the first command to redisplay. end Entered as a number; specifies the end of the range of commands to redisplay.
Examples
The MML command in the following example displays the last successful command entered:
mml> h
VSC H-323 Signaling Interface - H323-GW1 2000-06-20 10:04:28
M RTRV
"rtrv-log:all"
/* command 1 */
The MML command in the following example displays the third previous successful command entered:
mml> h::3
VSC H-323 Signaling Interface - H323-GW1 2000-06-20 10:04:28
M RTRV
"rtrv-ne"
/* command 3 */
The MML command in the following example displays the first and second previous commands entered.
mml> h::start=1,end=2
VSC H-323 Signaling Interface - H323-GW1 2000-06-20 10:04:28
M RTRV
"rtrv-log:all"
/* command 1 */
"rtrv-ne"
/* command 2 */
The help command displays a list of valid system commands and an explanation of their use. If you do not enter a command name as a parameter, the help command provides a list of MML commands, descriptions, and values. If you enter a command name as a parameter, a description of that command displays.
help[:command name]
Syntax Description
command name The name of the MML command.
Examples
The command shown in the following example displays help for a specific command:
mml> help:rtrv-ctr
H323 Signalling Gateway Tue Feb 12 19:09:58 2002
M SUCC
RTRV-CTR -- Display the measurements for a counter group
--------------------------------------------------------
Purpose: This MML command displays a measurement counter for a counter group
Format: rtrv-ctr:<counter group>
Description: * counter group -- The name of an MML counter group (RAS, Q931 or H245)
Example: The MML command shown in the following example displays measurement counters for the counter group RAS.
mml> rtrv-ctr:ras;
GW Signalling GateWay 2000-12--5 14:19:32
M RTRV
"H323-GW1:GROUP=RAS,NAME=\"GK_DISC_ATT_TOT\",VAL=1000"
"H323-GW1:GROUP=RAS,NAME=\"GK_REG_ATT_TOT\",VAL=1000"
"H323-GW1:GROUP=RAS,NAME=\"GK_REG_SUCC_TOT\",VAL=1000"
mml>
If you enter the help command without a parameter, the help file displays information about all available commands. The following example shows a portion of the help file that displays if you do not enter a parameter:
mml> help
VSC H323 signaling interface - H323-GW1 2000-06-20 10:04:28
M RTRV
Available commands (in alphabetical order):
ack-alm:"<alm cat>" Acknowledges an alarm category on a component
clr-alm:"<alm cat>" Clears an alarm category on a component
clr-meas:"<meas cat>" Resets a measurement category on a component
diaglog:<file name>:START|STOP Starts/stops diagnostics log
h[::<number>[,<number>]] Displays a history of commands for a specified backward number or range; the last command by default
help[:<command name>] Displays the list of MML commands or the help information on a specified command
prov-add:name=<MML name>,<param name>=<param value>,... Adds the component
prov-cpy Commits provisioning data
prov-dlt:name=<MML name> Deletes the component
The prov-add command adds a component to the Cisco H.323 Signaling Interface (HSI).
prov-add:name=MML name,param name=param value,...
Syntax Description
MML name MML name for the element you are adding. Valid MML names are: param name The name of a valid configuration parameter for the specified name. param value The value you want to assign to the parameter.
Usage Guidelines
To define more than one parameter, enter additional param name=param value descriptions on the command line. See "Provisioning the Cisco HSI," for the list of MML names, parameter names, and their associated values.
Examples
The command shown in the following example adds a provisioning element with the MML name ras, parameter name maxFail, and value 3.
gw mml> prov-add:name=ras,maxfail=3
H323 Signaling Interface Sun Jan 7 15:15:02 2001
M SUCC
Successfully added provisioning element(s):
MML Name : ras.
Parameter: maxFail.
Value : 3.
Related Commands
prov-cpy Activates the configuration settings in the current provisioning session. prov-dlt Deletes a provisioned component. prov-ed Modifies a provisioned component. prov-exp Exports the current configuration of the Cisco HSI in MML command form to a file or files. prov-rtrv Retrieves information about an existing provisioning session. prov-sta Establishes a provisioning session. prov-stp Terminates either a specified or the current provisioning session.
Command
Description
The prov-cpy command copies configuration settings from the current provisioning session to the Cisco HSI to activate the configuration. If this command is successful, it terminates the current provisioning session. If this command fails, there is no active provisioning session. If any client level parsing fails during the data session, a confirm is needed for the data to be activated.
prov-cpy[:confirm]
Syntax Description
confirm If any client level parsing fails during the data session, a confirm is needed for the data to be activated.
Examples
The command shown in the following example copies the configuration changes from the current session to the Cisco HSI.
gw mml> prov-cpy
H323 Signaling Interface Sun Jan 7 13:53:42 2001
M SUCC
Successfully activated the provisioning session.
Usage Guidelines
See "Provisioning the Cisco HSI," for a list of MML names, parameter names and their associated values.
Related Commands
prov-add Adds a component. prov-dlt Deletes a provisioned component. prov-ed Modifies a provisioned component. prov-exp Exports the current configuration of the Cisco HSI in MML command form to a file or files. prov-rtrv Retrieves information about an existing provisioning session. prov-sta Establishes a provisioning session. prov-stp Terminates either a specified or the current provisioning session.
Command
Description
The prov-dlt command deletes a provisioned component. This command allows you to delete a parameter rather than deleting the MML group.
prov-dlt:name=MML name
Syntax Description
MML name MML name for the element you are deleting. Valid MML names are: param name The name of a valid configuration parameter for the specified name.
Usage Guidelines
See "Provisioning the Cisco HSI," for a list of MML names, parameter names, and their associated values.
Examples
The MML command in the following example deletes the ras element:
gw mml> prov-dlt:name=ras
H323 Signaling Interface Sun Jan 7 14:13:05 2001
M SUCC
Successfully deleted provisioning data for ras
The MML command in the following examples delete the maxCalls parameter of the ras element:
gw mml> prov-dlt:name=ras,param=maxCalls
gw mml> prov-dlt:name=ras,maxCalls
H323 Signaling Interface Sun Jan 7 14:46:01 2001
M SUCC
Successfully deleted provisioning data for ras:maxCalls
Related Commands
prov-add Adds a component. prov-cpy Activates the configuration settings in the current provisioning session. prov-ed Modifies a provisioned component. prov-exp Exports the current configuration of the Cisco HSI in MML command form to a file or files. prov-rtrv Retrieves information about an existing provisioning session. prov-sta Establishes a provisioning session. prov-stp Terminates either a specified or the current provisioning session.
Command
Description
The prov-ed command modifies a provisioned component.
prov-ed:name=MML name,param name=param value,... |
Note Enter only those parameters that must be modified. |
Syntax Description
MML name MML name for the element you are modifying. Valid MML names are: param name The name of a valid configuration parameter for the specified name. param value The value you want to assign to the parameter.
Usage Guidelines
To change more than one parameter, enter additional param name=value descriptions on the command line. See "Provisioning the Cisco HSI," for a list of MML names, parameter names, and their associated values.
Examples
Use the MML command shown in the following example to edit a provisioning element with the MML name ras, parameter name maxFail, and value 7:
gw mml> prov-ed:name=ras,maxfail=7
H323 Signaling Interface Sun Jan 7 15:22:02 2001
M SUCC
Successfully edited provisioning element(s):
MML Name : ras.
Parameter: maxFail.
Value : 7.
Related Commands
prov-add Adds a component. prov-cpy Activates the configuration settings in the current provisioning session. prov-dlt Deletes a provisioned component. prov-exp Exports the current configuration of the Cisco HSI in MML command form to a file or files. prov-rtrv Retrieves information about an existing provisioning session. prov-sta Establishes a provisioning session. prov-stp Terminates either a specified or the current provisioning session.
Command
Description
The prov-exp command exports the current provisioned configuration of the Cisco HSI in MML command form to a file. This configuration file allows a system to be primed with a cloned configuration from an existing system or to be restored to a baseline configuration. You can use the MML batch feature to import the exported data.
Start a dummy provisioning session with the prov-sta command before you use the prov-exp command.
prov-sta:srcver=active, dstver=dummy1
Syntax Description
export directory name Name of the directory to which the data is exported. This directory is a subdirectory within the /opt/GoldWing/export directory established at installation.
Examples
The MML command shown in the following example saves the active file as config.mml to the export/uk9/ directory:
gw mml> prov-exp:dirname=uk9
H323 Signaling Interface Sun Jan 7 14:29:11 2001
M SUCC
Successfully exported "active" to export/uk9/config.mml
The UNIX command shown in the following example executes MML in batch mode and imports the configuration file that was exported in the previous example:
mml> -b /opt/GoldWing/currentGW/export/uk9/config.mml
Related Commands
prov-add Adds a component. prov-cpy Activates the configuration settings in the current provisioning session. prov-dlt Deletes a provisioned component. prov-ed Modifies a provisioned component. prov-rtrv Retrieves information about an existing provisioning session. prov-sta Establishes a provisioning session. prov-stp Terminates either a specified or the current provisioning session.
Command
Description
This command retrieves information about an existing provisioning session.
prov-rtrv:name=MML name |
Note The prov-rtrv:list command is the only prov-rtrv command that can be executed outside of a provisioning session. The other prov-rtrv commands must be executed within a provisioning session. Use the prov-sta command to start a provisioning command. |
Syntax Description
name The MML name for the elements that you want to display. MML name The MML component name for the component you want to display. Valid MML names are: all Displays all components that have been provisioned. session Displays information about the provisioning session. list Provides a list of possible session names that you can use as the srcver parameter to prov-sta:srcver=uk9,dstver=uk10.
Usage Guidelines
See "Provisioning the Cisco HSI," for a list of MML names, parameter names and their associated values.
Examples
The MML command shown in the following example displays information about the MML name ras:
gw mml> prov-rtrv:name=ras
H323 Signaling Interface Sun Jan 7 14:46:01 2001
M SUCC
MML Name : ras.
Parameter: maxFail.
Value : 33.
The MML command shown in the following example displays information about the MML session:
gw mml> prov-rtrv:session
H323 Signaling Interface Sun Jan 7 14:46:01 2001
M RTRV
Session ID = mml 6 | davek
SRCVER = uk9
DSTVER = inter
gw mml> prov-rtrv:list
H323 Signaling Interface Sun Jan 7 14:46:01 2001
M RTRV
The following provisioning sessions are available:
uk9 matt inter
gw mml>
Related Commands
prov-add Adds a component. prov-cpy Activates the configuration settings in the current provisioning session. prov-dlt Deletes a provisioned component. prov-ed Modifies a provisioned component. prov-exp Exports the current configuration of the Cisco HSI in MML command form to a file or files. prov-sta Establishes a provisioning session. prov-stp Terminates either a specified or the current provisioning session.
Command
Description
The prov-sta command establishes a provisioning session. The data files are copied from the source version to the destination version.
prov-sta::srcver=version,dstver=version
Syntax Description
srcver=version Selects a specific configuration version as the source for configuration changes. The srcver variable represents a directory that exists in $GWBASE/var/prov/. In place of the configuration version, you can also enter: dstver=version Specifies the output version directory for the configuration session results. The dstver variable represents a directory stored in $GWBASE/var/prov/.
Usage Guidelines
If the source and destination filenames are the same, the new configuration overwrites the old configuration. It is a good practice to copy an existing configuration instead of overwriting it so that you can return to a known configuration if there are problems with the new one.
If the source provisioning session has not been verified, the message "Note: This provisioning session has not been verified" is displayed, but the session starts normally.
If you try to start with a provisioning session that does not exist, an error is displayed along with a list of available sessions.
Examples
The MML command in the following example starts a provisioning session named nowt and creates a new configuration named blah:
gw mml> prov-sta::srcver=nowt,dstver=blah
H323 Signaling Interface Sun Jan 7 13:32:07 2000
M DENY
The provisioning session called "nowt" does not exist.
The following configurations are available:
sanfran2 uk9 final
telco mgcpvia miki
transit dave matt
The MML command in the following example starts a provisioning session and creates a new configuration named ver1:
gw mml> PROV-STA::SRCVER="new", DSTVER="ver1"
H323 Signaling Interface Sun Jan 7 13:32:07 2001
M SUCC
Successfully started provisioning session "ver1" from "new".
The MML command in the following example starts a provisioning session, opens the existing configuration named ver1, and overwrites that configuration:
gw mml> PROV-STA::SRCVER="ver1", DSTVER="ver1"
The MML command shown in the following example starts a provisioning session, opens the existing configuration named ver1, and saves the updated configuration as ver2:
gw mml> PROV-STA::SRCVER="ver1", DSTVER="ver2"
Related Commands
prov-add Adds a component. prov-cpy Activates the configuration settings in the current provisioning session. prov-dlt Deletes a provisioned component. prov-ed Modifies a provisioned component. prov-exp Exports the current configuration of the Cisco HSI in MML command form to a file or files. prov-rtrv Retrieves information about an existing provisioning session. prov-stp Terminates either a specified or the current provisioning session.
Command
Description
The prov-stp command terminates the provisioning session and saves the configuration.
|
Note This command does not activate the new configuration. Use the prov-cpy command to activate the configuration. You must also add confirm to the prov-stp command to successfully complete it. |
Syntax Description
session name Use the rtrv-mml command to retrieve the MML name given to the MML process that started the provisioning session. confirm If no confirm option is entered, the command is rejected and a message notifies you of the potential performance impact of this command.
Usage Guidelines
You can use the name given to an MML session to stop a provisioning session. Each MML session (not Telnet) gets an MML name: for example, mml1 or mml2. The maximum number of allowable MML sessions is 12.
If you log in to the Cisco HSI from an MML session and start a provisioning session (for example, gw mml> prov-sta:srcver=new,dstver=uk9), you can use the MML name (for example, mml2) to stop the session with prov-stp (for example, prov-stp:mml2:confirm).
Use the rtrv-mml command to display all active MML sessions (see rtrv-mml).
Examples
The MML command in the following example terminates the current provisioning session:
gw mml> prov-stp:confirm
H323 Signaling Interface Sun Jan 7 14:46:01 2001
M SUCC
Successfully stopped provisioning session "ver1"
The MML command in the following example terminates the uk9 provisioning session:
gw mml> prov-stp:uk9:confirm
H323 Signaling Interface Day Mon 1 hh:mm:ss YYYY
M SUCC
Successfully stopped provisioning session "uk9"
gw mml>
If the previous session starts from an MML process assigned the name mml2, you can use the following MML command:
gw mml> prov-stp:mml2:confirm
H323 Signaling Interface Day Mon 1 hh:mm:ss YYYY
M SUCC
Successfully stopped provisioning session "uk9"
gw mml>
Related Commands
prov-add Adds a component. prov-cpy Activates the configuration settings in the current provisioning session. prov-dlt Deletes a provisioned component. prov-ed Modifies a provisioned component. prov-exp Exports the current configuration of the Cisco HSI in MML command form to a file or files. prov-rtrv Retrieves information about an existing provisioning session. prov-sta Establishes a provisioning session.
Command
Description
The quit command ends an MML session.
quit
Syntax Description
This command has no arguments or keywords.
Examples
The command in following example ends an MML session.
gw mml> quit
The radlog command starts and stops RADVision logging into a specified log file.
radlog:[file name]:start | stop |
Caution This command is processor intensive and results in very large log files. Use this command only to retrieve information for single test calls, and do not run on a live network that is processing numerous calls. |
Syntax Description .
file name The user-defined name of the log file. The actual filename has a .log suffix. The file is located in the logging directory defined in the configuration data (see "Provisioning the Cisco HSI").
Examples
The command in the following example starts logging into a diagnostics log named file1:
gw mml> radlog:file1:start
H323 Signaling Interface Day Mon 1 hh:mm:ss YYYY
M SUCC
RADLogging requested to start
The following command logs RADVision to the standard log file:
gw mml> radlog::start
H323 Signaling Interface Day Mon 1 hh:mm:ss YYYY
M SUCC
RADLogging to standard log file
Related Commands
diaglog Starts and stops event logging into a diagnostics log. rtrv-log Displays the logging level of a package or all packages. set-log Sets the logging level of a package or all packages.
Command
Description
The restart-softw command restarts the call processing application. It applies the provisioning data specified in the configVersion (if present) that overrides the existing active provisioning data.
restart-softw[:configVersion][:confirm]
Syntax Description
configVersion In configVersion, init is a keyword, and this command restarts the call processing application applying the etc/GWmain.conf configuration file as the provisioning data. If configVersion is an unverified provisioning session, the command fails. confirm If there are active calls, a notification is sent to the craft, and the command must be reentered with the confirm parameter to take effect.
Examples
In the following example, the call processing application restarts using the etc/GWmain.conf configuration files as the provisioning data.
gw mml> restart-softw:init
H323 Signaling Interface Day Mon 1 hh:mm:ss YYYY
M SUCC
Application is now restarting using the default provisioning session.
There are no active calls.
New call requests are rejected.
Call Processing now stopped.
Application will restart in 60 seconds
In the following example, the application would restart using the active provisioning session. There are no active calls. New call requests are rejected. Call processing is now stopped. The application is set to restart in 12 seconds.
gw mml> restart-softw
H323 Signaling Interface Day Mon 1 hh:mm:ss YYYY
M SUCC
In the following example, a restart passes an unverified provisioning session. The command fails. You cannot use an unverified provisioning session:
gw mml> restart-softw:config2
H323 Signaling Interface Day Mon 1 hh:mm:ss YYYY
M DENY
In the following example, a restart uses a specified verified provisioning session. The application restarts by using original as the provisioning session. There are no active calls. New call requests are rejected. Call processing is now stopped. The application is set to restart in 12 seconds.
gw mml> restart-softw:original
H323 Signaling Interface Day Mon 1 hh:mm:ss YYYY
M SUCC
The rtrv-alms command retrieves all active alarms.
rtrv-alms
Syntax Description
cont This parameter displays alarm events until you press Ctrl-C. All active alarms are displayed, and then a message appears (for example: "/* Listening for alarm events . . . (Ctrl-C to stop) */").
Examples
In the following example, the output contains the standard alarm definition and also NACK or ACK for noninformational alarms to indicate the acknowledgement status of the alarm.
gw mml> rtrv-alms
GW Signaling Interface 2000-12-05 14:19:22
M RTRV
"H323-GW1: 2000-11-27 11:25:12.259, ** ALM=\"VSC FAILURE\",SEV=MJ" NACK
"H323-GW1: 2000-11-27 11:25:13.260, ** ALM=\"CONFIGURATION FAILURE\",SEV=MJ" ACK
"H323-GW1: 2000-11-27 11:25:14.011, A^ ALM=\"ENDPOINT CHANNEL INTERFACE FAILURE\",SEV=IF"
"H323-GW1: 2000-11-27 11:25:14.012, A^ ALM=\"ENDPOINT CHANNEL INTERFACE FAILURE\",SEV=IF"
In the following example, the output displays alarm events until you press Ctrl-C.
gw mml> rtrv-alms:cont
GW Signaling Interface 2000-12-05 14:19:22
M RTRV
"H323-GW1: 2000-11-27 11:25:12.259, ** ALM=\"VSC FAILURE\",SEV=MJ"
"H323-GW1: 2000-11-27 11:25:13.259, ALM=\"VSC FAILURE\",SEV=MJ" STATE=CLEARED
"H323-GW1: 2000-11-27 11:25:13.260, ** ALM=\"CONFIGURATION FAILURE\",SEV=MJ"
"H323-GW1: 2000-11-27 11:25:14.011, A^ ALM=\"ENDPOINT CHANNEL INTERFACE FAILURE\",SEV=IF"
"H323-GW1: 2000-11-27 11:25:14.012, A^ ALM=\"ENDPOINT CHANNEL INTERFACE FAILURE\",SEV=IF"
/* Listening for alarm events... (Ctrl-C to stop) */
"H323-GW1: 2000-11-27 11:25:13.259, ** ALM=\"VSC FAILURE\",SEV=MJ"
/* Ctrl-C pressed */
Related Commands
ack-alm Acknowledges that an alarm event is recognized but does not clear the alarm. clr-alm Clears an alarm event.
Command
Description
The rtrv-calls command displays all actively connected calls. If the time elapsed parameter is provided (in units of minutes), calls display only if they exceed the specified time. The format of the output includes the call direction, time connected, calling and called address, and call reference.
rtrv-calls[:time elapsed]
Syntax Description
time elapsed If the time elapsed parameter is provided (in units of minutes), calls display only if they have exceeded the specified time.
Examples
In the following example, the command displays all actively connected calls.
gw mml> rtrv-calls
H323 Signaling Interface Day Mon 1 hh:mm:ss YYYY
M SUCC
CallId SrcAddr DestAddr StartTime
124 04161234567 0299598125 2000-11-27 11:25:13.259
The rtrv-ctr command displays the measurements for a counter group.
rtrv-ctr:counter group
Syntax Description
counter group The name of an MML counter group (RAS, Q931, or H245).
Examples
In the following example, the command displays the measurements for the RAS counter group.
gw mml> rtrv-ctr:RAS
GW Signaling Interface 2000-12-05 14:19:22
M RTRV
"H323-GW1:GROUP=\"RAS\",NAME=\"GK DISC ATT TOT\",VAL=10"
"H323-GW1:GROUP=\"RAS\",NAME=\"GK REG ATT TOT\",VAL=0"
"H323-GW1:GROUP=\"RAS\",NAME=\"GK REG SUCC TOT\",VAL=12"
"H323-GW1:GROUP=\"RAS\",NAME=\"GK RCV UNR ATT TOT\",VAL=100"
"H323-GW1:GROUP=\"RAS\",NAME=\"GK XMIT UNR SUCC TOT \",VAL=2000"
"H323-GW1:GROUP=\"RAS\",NAME=\"GK XMIT UNR ATT TOT\",VAL=20"
"H323-GW1:GROUP=\"RAS\",NAME=\"GK RCV UNR SUCC TOT\",VAL=10"
"H323-GW1:GROUP=\"RAS\",NAME=\""GK RLS ATT TOT\",VAL=20"
"H323-GW1:GROUP=\"RAS\",NAME=\"GK RLS SUCC TOT\",VAL=30"
"H323-GW1:GROUP=\"RAS\",NAME=\"GK INFO REPORT TOT\",VAL=40"
Related Commands
clr-meas Resets a measurement counter.
Command
Description
The rtrv-dest command retrieves status information about the IP links and E-ISUP signaling path to the PGW 2200.
rtrv-dest:point code
Syntax Description
point code The MML component name of a point code component. sig path The MML name of the logical signaling channel for which you want to display information. This path should be made up of sig path DSS IP or sig path NAS entities. Use the help:prov-add command to obtain a description of sig path components. all Displays information about all external point codes and signal paths.
Examples
The MML command in the following example retrieves the destination of point code dpcl:
gw mml> retrv-dest:dpc1
MGC-01 Media Gateway Controller 2000-01-12 15:19:51
M RTRV
"dpc1:PKG=SS7-ANSI,ASSOC=UNK,PST=IS
Related Commands
set-dest-state Changes the service state of an IP link or E-ISUP signaling path to in service (IS) or out of service (OOS).
Command
Description
The rtrv-gapping command retrieves information about overload-triggered call gapping.
In both cases, the following information displays:
Syntax Description
This command has no arguments or keywords
Examples
The following MML command retrieves the current levels of call gapping for all gapping clients:
gw mml> rtrv-gapping
Client Name
Direction
Level
Call Type
Active
Overload
Outgoing
10
Normal
No
Overload
Incoming
10
Normal
No
MML
Outgoing
20
All
Yes
MML
Incoming
30
All
Yes
Related Commands
set-gapping Sets the type of calls to be gapped.
Command
Description
The rtrv-log command displays the logging level of a package or all packages.
rtrv-log:package=x
Syntax Description
package=x Displays the logging level for the various packages that make up the Cisco HSI. For package names, see the "Log Message Packages" section. all Displays the logging levels of all packages.
Examples
In the following example, the command displays the logging levels of all packages.
gw mml> rtrv-log:all
H323 Signaling Interface Thu Dec 14 16:28:44 2000
M RTRV
Logging levels:
Application........0x0000
CallControl........0xFFFF
Connection.........0x0000
DataManager........0x0000
Eisup..............0xFFFF
FaultManager.......0x0000
Gapping............0x0000
H323...............0xFFFF
Infrastructure.....0x0000
OverLoad...........0x0000
ProcessManager.....0x0000
Provisioning.......0x0000
Signal.............0x0000
Snmp...............0x0000
SnmpSubagent.......0x0000
Statistics.........0x0000
Trace..............0x0000
UserInterface.. .....0x0000
Related Commands
diaglog Starts and stops event logging into a diagnostics log. radlog Starts and stops RADVision logging into a specified log file. set-log Sets the logging level of a package or all packages.
Command
Description
The rtrv-mml command displays the following information:
Syntax Description
This command has no arguments or keywords.
Examples
In the following example, the command displays all active MML sessions and their sessions numbers and the user IDs of the session originators.
gw mml> rtrv-mml
VSC H-323 Signaling Interface - H323-GW1 2000-06-20 10:04:28
M RTRV
mml1:matthewl
mml2:davek
The rtrv-ne command displays the type, hardware platform, vendor, location, version, and status of the Cisco HSI.
rtrv-ne
Syntax Description
This command has no arguments or keywords.
Examples
In the following example, the command displays the type, hardware platform, vendor, location, version, and status of the Cisco HSI.
gw mml> rtrv-ne
H323 Signaling Interface Thu Dec 14 16:29:19 2000
M RTRV
Type: H323 Signaling Interface
Hardware platform: Sun netra t1
Vendor: Cisco Systems, Inc.
Location: H323 - GW1
Version: R1_1_0
Platform Status:
Signaling interface: Active
Call processing: Running
The rtrv-ne-health command displays the following information about the Cisco HSI status:
Syntax Description
This command has no arguments or keywords.
Examples
In the following example, the command displays information about the Cisco HSI status:
gw mml> rtrv-ne-health
VSC H-323 Signaling Interface - H323-GW1 2000-06-20 10:04:28
M RTRV
CPU Load: 23%
Disk space: 123456
Number of connected calls: 23
Number of calls in setup: 12
The rtrv-overload command displays overload status information and value settings for the three provisionable levels of overload.
rtrv-overload
Syntax Description
This command has no arguments or keywords.
Examples
In the following example, the command displays overload status information.
gw mml> rtrv-overload
H323 Signaling Interface Tue Jan 30 11:21:45 2001
M SUCC
Overload/Gapping Information
NumCalls : 0 | CPU : 7% | DiskUsage : 27%
Status : Not in Ovld
Overload Configuration
DiskUsageLimit : 29%
OvldSampleRate : 3000ms
OvldLevel1Percent : 65%
OvldLevel1Filter : NORMAL
OvldLevel1ThreshLowerCpu : 30%
OvldLevel1ThreshUpperCpu : 35%
OvldLevel1ThreshLowerCalls : 800
OvldLevel1ThreshUpperCalls : 1000
OvldLevel2Percent : 75%
OvldLevel2Filter : ALL
OvldLevel2ThreshLowerCpu : 45%
OvldLevel2ThreshUpperCpu : 50%
OvldLevel2ThreshLowerCalls : 1100
OvldLevel2ThreshUpperCalls : 1400
OvldLevel3Percent : 90%
OvldLevel3Filter : NORMAL
OvldLevel3ThreshLowerCpu : 55%
OvldLevel3ThreshUpperCpu : 65%
OvldLevel3ThreshLowerCalls : 1400
OvldLevel3ThreshUpperCalls : 1600
Related Commands set-overload Defines the overload handling criteria and behavior.
Command
Description
The rtrv-softw command displays the status of the Cisco HSI and call processing activity. The following software states can be displayed for the Cisco HSI:
The following software states can be displayed for call processing:
|
Note When the Cisco HSI is in the restart pending, halt pending, or reboot pending software state, the sta-callproc command cancels the pending state. |
Syntax Description
This command has no arguments or keywords.
Examples
In the following example, the command displays the status of the Cisco HSI and call processing activity.
gw mml> rtrv-softw
VSC H-323 Signaling Interface - H323-GW1 2000-06-20 10:04:28
M RTRV
Platform Status:
Signaling interface: Active
Call processing: Running
The set-dest-state command changes the service state of an IP link or E-ISUP signaling path to IS (in service) or OOS (out of service).
set-dest-state:ipLink1toVscA:IS|OOS
Syntax Description
IS In service. OOS Out of service.
Examples
In the following example, the command changes the service state of an IP link signaling path to IS.
gw mml> set-dest-state:ipLink1toVscA:state=IS
H323 Signaling Interface Day Mon 1 hh:mm:ss YYYY
M SUCC
Initiating state change of ipLink1toVscA to IS
gw mml> set-dest-state:ipLink1toVscA:state=OOS
H323 Signaling Interface Day Mon 1 hh:mm:ss YYYY
M SUCC
Initiating state change of ipLink1toVscA to OOS
Related Commands
rtrv-dest Retrieves status information about the IP links and E-ISUP signaling path to the PGW 2200.
Command
Description
The set-gapping command sets the type of calls to be gapped.
set-gapping: inc | otg | both : calltype=normal | all, percent=number
Syntax Description
inc Gaps calls from the H.323 network. otg Gaps calls from the PSTN over E-ISUP. both Gaps calls originating from either side. normal Gaps all calls except priority and emergency calls. all Gaps calls of all types. number Specifies the percentage of calls rejected due to call gapping.
Usage Guidelines
If call gapping is set to 100 percent, all calls are gapped irrespective of the normal or all parameter setting.
If the overload condition is active and call gapping is active, the higher of the two percentage values determines whether new call attempts are accepted or rejected.
Examples
In the following example, the command sets all calls to be gapped and specifies that 50 percent of the calls be rejected due to call gapping.
gw mml> set-gapping:both:calltype=all,percent=50
H323 Signaling Interface Day Mon 1 hh:mm:ss YYYY
M SUCC
Successfully set gapping for target 'both', calltype 'all', and percentage 50
Related Commands
rtrv-gapping Retrieves information about overload-triggered call gapping.
Command
Description
The set-log command sets the logging level of a package or all packages.
set-log:package:level=level, [confirm]
Syntax Description
package One of the packages in the Cisco HSI. For a list of package names, see the "Log Message Packages" section. level Logging levels are set through the use of hexadecimal numbers between 0x0000 and 0xFFFF. The higher the number, the higher the level of debug. confirm If any client level parsing fails on the data session, a confirm is needed for the data to be activated.
Usage Guidelines
Logging at any level implies that upper levels are included. When you are setting logging with the level DEBUG, a confirmation is required because the amount of data logged would affect service. For a list of the packages that can log messages, see the "Log Message Packages" section.
Examples
In the following example, the command sets the logging level of the package gapping to 0xFFE0:
gw mml> set-log:gapping:0xFFE0
M SUCC
logging level for package gapping set to 0xFFE0
Related Commands
diaglog Starts and stops event logging into a diagnostics log. radlog Starts and stops RADVision logging into a specified log file. rtrv-log Displays the logging level of a package or all packages.
Command
Description
The set-overload command defines the overload handling criteria and behavior.
set-overload: level1|level2|level3:cpu,lower=number, upper=number
Syntax Description
level 1 | level 2 | level 3 Overload behavior can be provisioned at three separate levels: 1, 2, and 3 (rising in severity). lower=number The lower threshold for overload detection and restoration of normal call handling service. upper=number The upper threshold for overload detection and restoration of normal call handling service.
Usage Guidelines
The set-overload command defines the upper and lower thresholds for overload detection and restoration of normal call handling service. The percentage of calls to be gapped and the type of calls to be gapped can also be configured. Any changes made become active immediately.
The lower value must always be less than the upper value. If the call gap percentage is set to 0, the system takes no recovery action when overload is encountered, but the appropriate alarm is raised.
Inconsistent threshold settings for different levels can destabilize call processing. For successful execution of this command, ensure that threshold settings are consistent, as follows:
Examples
In the following example, the command defines the overload handling criteria and behavior at level 1, and the cpu to the lower threshold of 10, upper threshold of 14.
gw mml> set-overload:level1:cpu, lower =10, upper = 14
H323 Signaling Interface Day Mon 1 11:21:28 2001
M SUCC
Successfully added that configuration item.
Related Commands
rtrv-overload Displays the overload status and the data values for the three provisionable levels of overload
Command
Retrieve
The sta-callproc command starts call processing.
sta-callproc
Syntax Description
This command has no arguments or keywords.
Examples
In the following example, the command starts call processing.
gw mml> sta-softw
gw mml> sta-callproc
H323 Signaling Interface Thu Dec 14 16:31:09 2000
M SUCC
Starting call processing.
Related Commands
sta-softw Starts the call processing application.
Command
Description
The sta-softw command starts the call processing application.
sta-softw
Syntax Description
This command has no arguments or keywords.
Examples
In the following example, the command starts the call processing application.
gw mml> sta-softw
H323 Signaling Interface Day Mon 1 hh:mm:ss YYYY
M SUCC
The Call Processing Application is starting.
Related Commands
sta-callproc Starts call processing
Command
Description
The sta-trc command starts the call processing tracing function.
sta-trc:Calltype=calltype,TraceLevel=trace level[,CdAddress=address]
Syntax Description
Calltype=calltype This parameter defines the type of call to be traced. The possible values are: TraceLevel=trace level This parameter defines the level of detail that is recorded in the call trace. The possible values are: CdAddress=address A filter used to trace calls only with the specified leading digits with called address. A match is performed on these digits and the initial called address digits contained within the E-ISUP IAM message or the H225 SETUP message. CgAddress=address A filter used to trace calls only with the specified leading digits with calling address. A match is performed on these digits and the initial calling address digits contained within the E-ISUP IAM message or the H.225 SETUP message. log=filename The filename for the trace output. prd=n The trace period (in seconds). At expiration of this period, the trace log is closed. If no value is specified, the period defaults to 1800 seconds (30 minutes).
Defaults
The default trace for all calls is 30 minutes.
Usage Guidelines
Only one trace command at a time can be active. If an additional request is issued, the command should be rejected with a call trace already active indication.
Examples
In the following example, the command starts the call processing tracing function:
gw mml> sta-trc:Calltype=both, TraceLevel=terse, dAddress=012,CgAddress=013, log=tlog.txt, prd=10
H323 Signaling Interface Day Mon 1 hh:mm:ss YYYY
M SUCC
Related Commands
stp-trc Halts the tracing currently active and closes the trace file.
Command
Description
The stp-call command terminates a currently active call by forcing a release of the call. Disconnect/release messages are sent in both directions.
stp-call:callref=x
Syntax Description
callref Refers to a positive integer. all Stops all calls.
Examples
In the following example, the command terminates a currently active call by forcing a release of the call with a callref of 33..
gw mml> stp-call:callref=33
H323 Signaling Interface Thu Dec 14 16:43:54 2000
M SUCC
Stopped call 33
Related Commands
rtrv-calls Displays all actively connected calls.
Command
Description
The stp-callproc command stops further call processing by immediately terminating the handling of new call requests.
stp-callproc[:timeout=T]
Syntax Description
timeout If no timeout period is provided, existing calls are released immediately. If a timeout period is provided, existing calls are released after the specified amount of time has elapsed. When all calls have been released, a notification message is sent to the craft terminal. T T is in seconds.
Examples
In the following example, the command stops further call processing by immediately terminating the handling of new call requests.
gw mml> stp-callproc
H323 Signaling Interface Thu Dec 14 16:27:07 2000
M SUCC
Stopped accepting new calls. Existing calls will be released in 5 seconds.
Stopping Call Processing.
The stp-softw command stops the call processing application. This command causes the Cisco HSI to terminate.
stp-softw[:confirm]
Syntax Description
confirm If there are active calls, a notification is sent to the craft. In order for the command to take effect, it must be reentered with the confirm parameter.
Examples
In the following example, the command stops the call processing application.
gw mml> stp-softw
H323 Signaling Interface Thu Dec 14 16:27:36 2000
M SUCC
There are no active calls.
Application is now stopping
The stp-trc command halts the currently active tracing and closes the trace file.
stp-trcSyntax Description
This command has no arguments or keywords
Examples
In the following example, the command halts the currently active tracing and closes the trace file.
gw mml> stp-trc
H323 Signaling Interface Day Mon 1 hh:mm:ss YYYY
M SUCC
Tracing deactivated.
Related Commands
sta-trc Starts the call processing tracing function.
Command
Description
Posted: Thu Aug 15 15:30:21 PDT 2002
All contents are Copyright © 1992--2002 Cisco Systems, Inc. All rights reserved.
Important Notices and Privacy Statement.